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 | 140805 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: pinpoint_sms_voice_v2
using AWS.Compat
using AWS.UUIDs
"""
associate_origination_identity(iso_country_code, origination_identity, pool_id)
associate_origination_identity(iso_country_code, origination_identity, pool_id, params::Dict{String,<:Any})
Associates the specified origination identity with a pool. If the origination identity is a
phone number and is already associated with another pool, an error is returned. A sender ID
can be associated with multiple pools. If the origination identity configuration doesn't
match the pool's configuration, an error is returned.
# Arguments
- `iso_country_code`: The new two-character code, in ISO 3166-1 alpha-2 format, for the
country or region of the origination identity.
- `origination_identity`: The origination identity to use, such as PhoneNumberId,
PhoneNumberArn, SenderId, or SenderIdArn. You can use DescribePhoneNumbers to find the
values for PhoneNumberId and PhoneNumberArn, while DescribeSenderIds can be used to get the
values for SenderId and SenderIdArn.
- `pool_id`: The pool to update with the new Identity. This value can be either the PoolId
or PoolArn, and you can find these values using DescribePools.
# 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. If you don't specify a client token, a randomly generated token
is used for the request to ensure idempotency.
"""
function associate_origination_identity(
IsoCountryCode,
OriginationIdentity,
PoolId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"AssociateOriginationIdentity",
Dict{String,Any}(
"IsoCountryCode" => IsoCountryCode,
"OriginationIdentity" => OriginationIdentity,
"PoolId" => PoolId,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_origination_identity(
IsoCountryCode,
OriginationIdentity,
PoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"AssociateOriginationIdentity",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IsoCountryCode" => IsoCountryCode,
"OriginationIdentity" => OriginationIdentity,
"PoolId" => PoolId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_protect_configuration(configuration_set_name, protect_configuration_id)
associate_protect_configuration(configuration_set_name, protect_configuration_id, params::Dict{String,<:Any})
Associate a protect configuration with a configuration set. This replaces the configuration
sets current protect configuration. A configuration set can only be associated with one
protect configuration at a time. A protect configuration can be associated with multiple
configuration sets.
# Arguments
- `configuration_set_name`: The name of the ConfigurationSet.
- `protect_configuration_id`: The unique identifier for the protect configuration.
"""
function associate_protect_configuration(
ConfigurationSetName,
ProtectConfigurationId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"AssociateProtectConfiguration",
Dict{String,Any}(
"ConfigurationSetName" => ConfigurationSetName,
"ProtectConfigurationId" => ProtectConfigurationId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_protect_configuration(
ConfigurationSetName,
ProtectConfigurationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"AssociateProtectConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigurationSetName" => ConfigurationSetName,
"ProtectConfigurationId" => ProtectConfigurationId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_configuration_set(configuration_set_name)
create_configuration_set(configuration_set_name, params::Dict{String,<:Any})
Creates a new configuration set. After you create the configuration set, you can add one or
more event destinations to it. A configuration set is a set of rules that you apply to the
SMS and voice messages that you send. When you send a message, you can optionally specify a
single configuration set.
# Arguments
- `configuration_set_name`: The name to use for the new configuration set.
# 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. If you don't specify a client token, a randomly generated token
is used for the request to ensure idempotency.
- `"Tags"`: An array of key and value pair tags that's associated with the new
configuration set.
"""
function create_configuration_set(
ConfigurationSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"CreateConfigurationSet",
Dict{String,Any}(
"ConfigurationSetName" => ConfigurationSetName, "ClientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_configuration_set(
ConfigurationSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"CreateConfigurationSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigurationSetName" => ConfigurationSetName,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_event_destination(configuration_set_name, event_destination_name, matching_event_types)
create_event_destination(configuration_set_name, event_destination_name, matching_event_types, params::Dict{String,<:Any})
Creates a new event destination in a configuration set. An event destination is a location
where you send message events. The event options are Amazon CloudWatch, Amazon Kinesis Data
Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can
send information about that event to an event destination, or send notifications to
endpoints that are subscribed to an Amazon SNS topic. Each configuration set can contain
between 0 and 5 event destinations. Each event destination can contain a reference to a
single destination, such as a CloudWatch or Kinesis Data Firehose destination.
# Arguments
- `configuration_set_name`: Either the name of the configuration set or the configuration
set ARN to apply event logging to. The ConfigurateSetName and ConfigurationSetArn can be
found using the DescribeConfigurationSets action.
- `event_destination_name`: The name that identifies the event destination.
- `matching_event_types`: An array of event types that determine which events to log. If
\"ALL\" is used, then Amazon Pinpoint logs every event type. The TEXT_SENT event type is
not supported.
# 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. If you don't specify a client token, a randomly generated token
is used for the request to ensure idempotency.
- `"CloudWatchLogsDestination"`: An object that contains information about an event
destination for logging to Amazon CloudWatch Logs.
- `"KinesisFirehoseDestination"`: An object that contains information about an event
destination for logging to Amazon Kinesis Data Firehose.
- `"SnsDestination"`: An object that contains information about an event destination for
logging to Amazon SNS.
"""
function create_event_destination(
ConfigurationSetName,
EventDestinationName,
MatchingEventTypes;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"CreateEventDestination",
Dict{String,Any}(
"ConfigurationSetName" => ConfigurationSetName,
"EventDestinationName" => EventDestinationName,
"MatchingEventTypes" => MatchingEventTypes,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_event_destination(
ConfigurationSetName,
EventDestinationName,
MatchingEventTypes,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"CreateEventDestination",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigurationSetName" => ConfigurationSetName,
"EventDestinationName" => EventDestinationName,
"MatchingEventTypes" => MatchingEventTypes,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_opt_out_list(opt_out_list_name)
create_opt_out_list(opt_out_list_name, params::Dict{String,<:Any})
Creates a new opt-out list. If the opt-out list name already exists, an error is returned.
An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS
or voice messages to them. If end user replies with the keyword \"STOP,\" an entry for the
phone number is added to the opt-out list. In addition to STOP, your recipients can use any
supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out
keywords, see SMS opt out in the Amazon Pinpoint User Guide.
# Arguments
- `opt_out_list_name`: The name of the new OptOutList.
# 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. If you don't specify a client token, a randomly generated token
is used for the request to ensure idempotency.
- `"Tags"`: An array of tags (key and value pairs) to associate with the new OptOutList.
"""
function create_opt_out_list(
OptOutListName; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"CreateOptOutList",
Dict{String,Any}(
"OptOutListName" => OptOutListName, "ClientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_opt_out_list(
OptOutListName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"CreateOptOutList",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"OptOutListName" => OptOutListName, "ClientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_pool(iso_country_code, message_type, origination_identity)
create_pool(iso_country_code, message_type, origination_identity, params::Dict{String,<:Any})
Creates a new pool and associates the specified origination identity to the pool. A pool
can include one or more phone numbers and SenderIds that are associated with your Amazon
Web Services account. The new pool inherits its configuration from the specified
origination identity. This includes keywords, message type, opt-out list, two-way
configuration, and self-managed opt-out configuration. Deletion protection isn't inherited
from the origination identity and defaults to false. If the origination identity is a phone
number and is already associated with another pool, an error is returned. A sender ID can
be associated with multiple pools.
# Arguments
- `iso_country_code`: The new two-character code, in ISO 3166-1 alpha-2 format, for the
country or region of the new pool.
- `message_type`: The type of message. Valid values are TRANSACTIONAL for messages that are
critical or time-sensitive and PROMOTIONAL for messages that aren't critical or
time-sensitive.
- `origination_identity`: The origination identity to use such as a PhoneNumberId,
PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the
values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the
values for SenderId and SenderIdArn.
# 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. If you don't specify a client token, a randomly generated token
is used for the request to ensure idempotency.
- `"DeletionProtectionEnabled"`: By default this is set to false. When set to true the pool
can't be deleted. You can change this value using the UpdatePool action.
- `"Tags"`: An array of tags (key and value pairs) associated with the pool.
"""
function create_pool(
IsoCountryCode,
MessageType,
OriginationIdentity;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"CreatePool",
Dict{String,Any}(
"IsoCountryCode" => IsoCountryCode,
"MessageType" => MessageType,
"OriginationIdentity" => OriginationIdentity,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_pool(
IsoCountryCode,
MessageType,
OriginationIdentity,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"CreatePool",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IsoCountryCode" => IsoCountryCode,
"MessageType" => MessageType,
"OriginationIdentity" => OriginationIdentity,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_protect_configuration()
create_protect_configuration(params::Dict{String,<:Any})
Create a new protect configuration. By default all country rule sets for each capability
are set to ALLOW. Update the country rule sets using
UpdateProtectConfigurationCountryRuleSet. A protect configurations name is stored as a Tag
with the key set to Name and value as the name of the protect configuration.
# 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. If you don't specify a client token, a randomly generated token
is used for the request to ensure idempotency.
- `"DeletionProtectionEnabled"`: When set to true deletion protection is enabled. By
default this is set to false.
- `"Tags"`: An array of key and value pair tags that are associated with the resource.
"""
function create_protect_configuration(; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint_sms_voice_v2(
"CreateProtectConfiguration",
Dict{String,Any}("ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_protect_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"CreateProtectConfiguration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_registration(registration_type)
create_registration(registration_type, params::Dict{String,<:Any})
Creates a new registration based on the RegistrationType field.
# Arguments
- `registration_type`: The type of registration form to create. The list of
RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
# 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. If you don't specify a client token, a randomly generated token
is used for the request to ensure idempotency.
- `"Tags"`: An array of tags (key and value pairs) to associate with the registration.
"""
function create_registration(
RegistrationType; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"CreateRegistration",
Dict{String,Any}(
"RegistrationType" => RegistrationType, "ClientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_registration(
RegistrationType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"CreateRegistration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"RegistrationType" => RegistrationType, "ClientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_registration_association(registration_id, resource_id)
create_registration_association(registration_id, resource_id, params::Dict{String,<:Any})
Associate the registration with an origination identity such as a phone number or sender ID.
# Arguments
- `registration_id`: The unique identifier for the registration.
- `resource_id`: The unique identifier for the origination identity. For example this could
be a PhoneNumberId or SenderId.
"""
function create_registration_association(
RegistrationId, ResourceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"CreateRegistrationAssociation",
Dict{String,Any}("RegistrationId" => RegistrationId, "ResourceId" => ResourceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_registration_association(
RegistrationId,
ResourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"CreateRegistrationAssociation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"RegistrationId" => RegistrationId, "ResourceId" => ResourceId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_registration_attachment()
create_registration_attachment(params::Dict{String,<:Any})
Create a new registration attachment to use for uploading a file or a URL to a file. The
maximum file size is 1MiB and valid file extensions are PDF, JPEG and PNG. For example,
many sender ID registrations require a signed “letter of authorization” (LOA) to be
submitted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AttachmentBody"`: The registration file to upload. The maximum file size is 1MiB and
valid file extensions are PDF, JPEG and PNG.
- `"AttachmentUrl"`: A URL to the required registration file. For example, you can provide
the S3 object URL.
- `"ClientToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don't specify a client token, a randomly generated token
is used for the request to ensure idempotency.
- `"Tags"`: An array of tags (key and value pairs) to associate with the registration
attachment.
"""
function create_registration_attachment(; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint_sms_voice_v2(
"CreateRegistrationAttachment",
Dict{String,Any}("ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_registration_attachment(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"CreateRegistrationAttachment",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_registration_version(registration_id)
create_registration_version(registration_id, params::Dict{String,<:Any})
Create a new version of the registration and increase the VersionNumber. The previous
version of the registration becomes read-only.
# Arguments
- `registration_id`: The unique identifier for the registration.
"""
function create_registration_version(
RegistrationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"CreateRegistrationVersion",
Dict{String,Any}("RegistrationId" => RegistrationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_registration_version(
RegistrationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"CreateRegistrationVersion",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RegistrationId" => RegistrationId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_verified_destination_number(destination_phone_number)
create_verified_destination_number(destination_phone_number, params::Dict{String,<:Any})
You can only send messages to verified destination numbers when your account is in the
sandbox. You can add up to 10 verified destination numbers.
# Arguments
- `destination_phone_number`: The verified destination phone number, in E.164 format.
# 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. If you don't specify a client token, a randomly generated token
is used for the request to ensure idempotency.
- `"Tags"`: An array of tags (key and value pairs) to associate with the destination number.
"""
function create_verified_destination_number(
DestinationPhoneNumber; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"CreateVerifiedDestinationNumber",
Dict{String,Any}(
"DestinationPhoneNumber" => DestinationPhoneNumber,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_verified_destination_number(
DestinationPhoneNumber,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"CreateVerifiedDestinationNumber",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DestinationPhoneNumber" => DestinationPhoneNumber,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_account_default_protect_configuration()
delete_account_default_protect_configuration(params::Dict{String,<:Any})
Removes the current account default protect configuration.
"""
function delete_account_default_protect_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DeleteAccountDefaultProtectConfiguration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_account_default_protect_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DeleteAccountDefaultProtectConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_configuration_set(configuration_set_name)
delete_configuration_set(configuration_set_name, params::Dict{String,<:Any})
Deletes an existing configuration set. A configuration set is a set of rules that you apply
to voice and SMS messages that you send. In a configuration set, you can specify a
destination for specific types of events related to voice and SMS messages.
# Arguments
- `configuration_set_name`: The name of the configuration set or the configuration set ARN
that you want to delete. The ConfigurationSetName and ConfigurationSetArn can be found
using the DescribeConfigurationSets action.
"""
function delete_configuration_set(
ConfigurationSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DeleteConfigurationSet",
Dict{String,Any}("ConfigurationSetName" => ConfigurationSetName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_configuration_set(
ConfigurationSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"DeleteConfigurationSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ConfigurationSetName" => ConfigurationSetName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_default_message_type(configuration_set_name)
delete_default_message_type(configuration_set_name, params::Dict{String,<:Any})
Deletes an existing default message type on a configuration set. A message type is a type
of messages that you plan to send. If you send account-related messages or time-sensitive
messages such as one-time passcodes, choose Transactional. If you plan to send messages
that contain marketing material or other promotional content, choose Promotional. This
setting applies to your entire Amazon Web Services account.
# Arguments
- `configuration_set_name`: The name of the configuration set or the configuration set
Amazon Resource Name (ARN) to delete the default message type from. The
ConfigurationSetName and ConfigurationSetArn can be found using the
DescribeConfigurationSets action.
"""
function delete_default_message_type(
ConfigurationSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DeleteDefaultMessageType",
Dict{String,Any}("ConfigurationSetName" => ConfigurationSetName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_default_message_type(
ConfigurationSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"DeleteDefaultMessageType",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ConfigurationSetName" => ConfigurationSetName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_default_sender_id(configuration_set_name)
delete_default_sender_id(configuration_set_name, params::Dict{String,<:Any})
Deletes an existing default sender ID on a configuration set. A default sender ID is the
identity that appears on recipients' devices when they receive SMS messages. Support for
sender ID capabilities varies by country or region.
# Arguments
- `configuration_set_name`: The name of the configuration set or the configuration set
Amazon Resource Name (ARN) to delete the default sender ID from. The ConfigurationSetName
and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
"""
function delete_default_sender_id(
ConfigurationSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DeleteDefaultSenderId",
Dict{String,Any}("ConfigurationSetName" => ConfigurationSetName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_default_sender_id(
ConfigurationSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"DeleteDefaultSenderId",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ConfigurationSetName" => ConfigurationSetName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_event_destination(configuration_set_name, event_destination_name)
delete_event_destination(configuration_set_name, event_destination_name, params::Dict{String,<:Any})
Deletes an existing event destination. An event destination is a location where you send
response information about the messages that you send. For example, when a message is
delivered successfully, you can send information about that event to an Amazon CloudWatch
destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.
# Arguments
- `configuration_set_name`: The name of the configuration set or the configuration set's
Amazon Resource Name (ARN) to remove the event destination from. The ConfigurateSetName and
ConfigurationSetArn can be found using the DescribeConfigurationSets action.
- `event_destination_name`: The name of the event destination to delete.
"""
function delete_event_destination(
ConfigurationSetName,
EventDestinationName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"DeleteEventDestination",
Dict{String,Any}(
"ConfigurationSetName" => ConfigurationSetName,
"EventDestinationName" => EventDestinationName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_event_destination(
ConfigurationSetName,
EventDestinationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"DeleteEventDestination",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigurationSetName" => ConfigurationSetName,
"EventDestinationName" => EventDestinationName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_keyword(keyword, origination_identity)
delete_keyword(keyword, origination_identity, params::Dict{String,<:Any})
Deletes an existing keyword from an origination phone number or pool. A keyword is a word
that you can search for on a particular phone number or pool. It is also a specific word or
phrase that an end user can send to your number to elicit a response, such as an
informational message or a special offer. When your number receives a message that begins
with a keyword, Amazon Pinpoint responds with a customizable message. Keywords \"HELP\" and
\"STOP\" can't be deleted or modified.
# Arguments
- `keyword`: The keyword to delete.
- `origination_identity`: The origination identity to use such as a PhoneNumberId,
PhoneNumberArn, PoolId or PoolArn. You can use DescribePhoneNumbers to find the values for
PhoneNumberId and PhoneNumberArn and DescribePools to find the values of PoolId and PoolArn.
"""
function delete_keyword(
Keyword, OriginationIdentity; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DeleteKeyword",
Dict{String,Any}(
"Keyword" => Keyword, "OriginationIdentity" => OriginationIdentity
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_keyword(
Keyword,
OriginationIdentity,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"DeleteKeyword",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Keyword" => Keyword, "OriginationIdentity" => OriginationIdentity
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_media_message_spend_limit_override()
delete_media_message_spend_limit_override(params::Dict{String,<:Any})
Deletes an account-level monthly spending limit override for sending multimedia messages
(MMS). Deleting a spend limit override will set the EnforcedLimit to equal the MaxLimit,
which is controlled by Amazon Web Services. For more information on spend limits (quotas)
see Quotas for Server Migration Service in the Server Migration Service User Guide.
"""
function delete_media_message_spend_limit_override(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DeleteMediaMessageSpendLimitOverride";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_media_message_spend_limit_override(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DeleteMediaMessageSpendLimitOverride",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_opt_out_list(opt_out_list_name)
delete_opt_out_list(opt_out_list_name, params::Dict{String,<:Any})
Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are
deleted. If the specified opt-out list name doesn't exist or is in-use by an origination
phone number or pool, an error is returned.
# Arguments
- `opt_out_list_name`: The OptOutListName or OptOutListArn of the OptOutList to delete. You
can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.
"""
function delete_opt_out_list(
OptOutListName; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DeleteOptOutList",
Dict{String,Any}("OptOutListName" => OptOutListName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_opt_out_list(
OptOutListName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"DeleteOptOutList",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("OptOutListName" => OptOutListName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_opted_out_number(opt_out_list_name, opted_out_number)
delete_opted_out_number(opt_out_list_name, opted_out_number, params::Dict{String,<:Any})
Deletes an existing opted out destination phone number from the specified opt-out list.
Each destination phone number can only be deleted once every 30 days. If the specified
destination phone number doesn't exist or if the opt-out list doesn't exist, an error is
returned.
# Arguments
- `opt_out_list_name`: The OptOutListName or OptOutListArn to remove the phone number from.
- `opted_out_number`: The phone number, in E.164 format, to remove from the OptOutList.
"""
function delete_opted_out_number(
OptOutListName, OptedOutNumber; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DeleteOptedOutNumber",
Dict{String,Any}(
"OptOutListName" => OptOutListName, "OptedOutNumber" => OptedOutNumber
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_opted_out_number(
OptOutListName,
OptedOutNumber,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"DeleteOptedOutNumber",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"OptOutListName" => OptOutListName, "OptedOutNumber" => OptedOutNumber
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_pool(pool_id)
delete_pool(pool_id, params::Dict{String,<:Any})
Deletes an existing pool. Deleting a pool disassociates all origination identities from
that pool. If the pool status isn't active or if deletion protection is enabled, an error
is returned. A pool is a collection of phone numbers and SenderIds. A pool can include one
or more phone numbers and SenderIds that are associated with your Amazon Web Services
account.
# Arguments
- `pool_id`: The PoolId or PoolArn of the pool to delete. You can use DescribePools to find
the values for PoolId and PoolArn .
"""
function delete_pool(PoolId; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint_sms_voice_v2(
"DeletePool",
Dict{String,Any}("PoolId" => PoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_pool(
PoolId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DeletePool",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("PoolId" => PoolId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_protect_configuration(protect_configuration_id)
delete_protect_configuration(protect_configuration_id, params::Dict{String,<:Any})
Permanently delete the protect configuration. The protect configuration must have deletion
protection disabled and must not be associated as the account default protect configuration
or associated with a configuration set.
# Arguments
- `protect_configuration_id`: The unique identifier for the protect configuration.
"""
function delete_protect_configuration(
ProtectConfigurationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DeleteProtectConfiguration",
Dict{String,Any}("ProtectConfigurationId" => ProtectConfigurationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_protect_configuration(
ProtectConfigurationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"DeleteProtectConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ProtectConfigurationId" => ProtectConfigurationId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_registration(registration_id)
delete_registration(registration_id, params::Dict{String,<:Any})
Permanently delete an existing registration from your account.
# Arguments
- `registration_id`: The unique identifier for the registration.
"""
function delete_registration(
RegistrationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DeleteRegistration",
Dict{String,Any}("RegistrationId" => RegistrationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_registration(
RegistrationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"DeleteRegistration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RegistrationId" => RegistrationId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_registration_attachment(registration_attachment_id)
delete_registration_attachment(registration_attachment_id, params::Dict{String,<:Any})
Permanently delete the specified registration attachment.
# Arguments
- `registration_attachment_id`: The unique identifier for the registration attachment.
"""
function delete_registration_attachment(
RegistrationAttachmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DeleteRegistrationAttachment",
Dict{String,Any}("RegistrationAttachmentId" => RegistrationAttachmentId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_registration_attachment(
RegistrationAttachmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"DeleteRegistrationAttachment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("RegistrationAttachmentId" => RegistrationAttachmentId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_registration_field_value(field_path, registration_id)
delete_registration_field_value(field_path, registration_id, params::Dict{String,<:Any})
Delete the value in a registration form field.
# Arguments
- `field_path`: The path to the registration form field. You can use
DescribeRegistrationFieldDefinitions for a list of FieldPaths.
- `registration_id`: The unique identifier for the registration.
"""
function delete_registration_field_value(
FieldPath, RegistrationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DeleteRegistrationFieldValue",
Dict{String,Any}("FieldPath" => FieldPath, "RegistrationId" => RegistrationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_registration_field_value(
FieldPath,
RegistrationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"DeleteRegistrationFieldValue",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FieldPath" => FieldPath, "RegistrationId" => RegistrationId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_text_message_spend_limit_override()
delete_text_message_spend_limit_override(params::Dict{String,<:Any})
Deletes an account-level monthly spending limit override for sending text messages.
Deleting a spend limit override will set the EnforcedLimit to equal the MaxLimit, which is
controlled by Amazon Web Services. For more information on spend limits (quotas) see Amazon
Pinpoint quotas in the Amazon Pinpoint Developer Guide.
"""
function delete_text_message_spend_limit_override(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DeleteTextMessageSpendLimitOverride";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_text_message_spend_limit_override(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DeleteTextMessageSpendLimitOverride",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_verified_destination_number(verified_destination_number_id)
delete_verified_destination_number(verified_destination_number_id, params::Dict{String,<:Any})
Delete a verified destination phone number.
# Arguments
- `verified_destination_number_id`: The unique identifier for the verified destination
phone number.
"""
function delete_verified_destination_number(
VerifiedDestinationNumberId; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DeleteVerifiedDestinationNumber",
Dict{String,Any}("VerifiedDestinationNumberId" => VerifiedDestinationNumberId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_verified_destination_number(
VerifiedDestinationNumberId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"DeleteVerifiedDestinationNumber",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"VerifiedDestinationNumberId" => VerifiedDestinationNumberId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_voice_message_spend_limit_override()
delete_voice_message_spend_limit_override(params::Dict{String,<:Any})
Deletes an account level monthly spend limit override for sending voice messages. Deleting
a spend limit override sets the EnforcedLimit equal to the MaxLimit, which is controlled by
Amazon Web Services. For more information on spending limits (quotas) see Amazon Pinpoint
quotas in the Amazon Pinpoint Developer Guide.
"""
function delete_voice_message_spend_limit_override(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DeleteVoiceMessageSpendLimitOverride";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_voice_message_spend_limit_override(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DeleteVoiceMessageSpendLimitOverride",
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 supported account attributes
include account tier, which indicates whether your account is in the sandbox or production
environment. When you're ready to move your account out of the sandbox, create an Amazon
Web Services Support case for a service limit increase request. New Amazon Pinpoint
accounts are placed into an SMS or voice sandbox. The sandbox protects both Amazon Web
Services end recipients and SMS or voice recipients from fraud and abuse.
# 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 each request.
- `"NextToken"`: The token to be used for the next set of paginated results. You don't need
to supply a value for this field in the initial request.
"""
function describe_account_attributes(; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint_sms_voice_v2(
"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 pinpoint_sms_voice_v2(
"DescribeAccountAttributes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_account_limits()
describe_account_limits(params::Dict{String,<:Any})
Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your account. The
description for a quota includes the quota name, current usage toward that quota, and the
quota's maximum value. When you establish an Amazon Web Services account, the account has
initial quotas on the maximum number of configuration sets, opt-out lists, phone numbers,
and pools that you can create in a given Region. For more information see Amazon Pinpoint
quotas in the Amazon Pinpoint Developer Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to return per each request.
- `"NextToken"`: The token to be used for the next set of paginated results. You don't need
to supply a value for this field in the initial request.
"""
function describe_account_limits(; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint_sms_voice_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 pinpoint_sms_voice_v2(
"DescribeAccountLimits",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_configuration_sets()
describe_configuration_sets(params::Dict{String,<:Any})
Describes the specified configuration sets or all in your account. If you specify
configuration set names, the output includes information for only the specified
configuration sets. If you specify filters, the output includes information for only those
configuration sets that meet the filter criteria. If you don't specify configuration set
names or filters, the output includes information for all configuration sets. If you
specify a configuration set name that isn't valid, an error is returned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConfigurationSetNames"`: An array of strings. Each element can be either a
ConfigurationSetName or ConfigurationSetArn.
- `"Filters"`: An array of filters to apply to the results that are returned.
- `"MaxResults"`: The maximum number of results to return per each request.
- `"NextToken"`: The token to be used for the next set of paginated results. You don't need
to supply a value for this field in the initial request.
"""
function describe_configuration_sets(; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint_sms_voice_v2(
"DescribeConfigurationSets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_configuration_sets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DescribeConfigurationSets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_keywords(origination_identity)
describe_keywords(origination_identity, params::Dict{String,<:Any})
Describes the specified keywords or all keywords on your origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is
also a specific word or phrase that an end user can send to your number to elicit a
response, such as an informational message or a special offer. When your number receives a
message that begins with a keyword, Amazon Pinpoint responds with a customizable message.
If you specify a keyword that isn't valid, an error is returned.
# Arguments
- `origination_identity`: The origination identity to use such as a PhoneNumberId,
PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the
values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the
values for SenderId and SenderIdArn.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An array of keyword filters to filter the results.
- `"Keywords"`: An array of keywords to search for.
- `"MaxResults"`: The maximum number of results to return per each request.
- `"NextToken"`: The token to be used for the next set of paginated results. You don't need
to supply a value for this field in the initial request.
"""
function describe_keywords(
OriginationIdentity; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DescribeKeywords",
Dict{String,Any}("OriginationIdentity" => OriginationIdentity);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_keywords(
OriginationIdentity,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"DescribeKeywords",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("OriginationIdentity" => OriginationIdentity),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_opt_out_lists()
describe_opt_out_lists(params::Dict{String,<:Any})
Describes the specified opt-out list or all opt-out lists in your account. If you specify
opt-out list names, the output includes information for only the specified opt-out lists.
Opt-out lists include only those that meet the filter criteria. If you don't specify
opt-out list names or filters, the output includes information for all opt-out lists. If
you specify an opt-out list name that isn't valid, an error 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 return per each request.
- `"NextToken"`: The token to be used for the next set of paginated results. You don't need
to supply a value for this field in the initial request.
- `"OptOutListNames"`: The OptOutLists to show the details of. This is an array of strings
that can be either the OptOutListName or OptOutListArn.
"""
function describe_opt_out_lists(; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint_sms_voice_v2(
"DescribeOptOutLists"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_opt_out_lists(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DescribeOptOutLists",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_opted_out_numbers(opt_out_list_name)
describe_opted_out_numbers(opt_out_list_name, params::Dict{String,<:Any})
Describes the specified opted out destination numbers or all opted out destination numbers
in an opt-out list. If you specify opted out numbers, the output includes information for
only the specified opted out numbers. If you specify filters, the output includes
information for only those opted out numbers that meet the filter criteria. If you don't
specify opted out numbers or filters, the output includes information for all opted out
destination numbers in your opt-out list. If you specify an opted out number that isn't
valid, an error is returned.
# Arguments
- `opt_out_list_name`: The OptOutListName or OptOutListArn of the OptOutList. You can use
DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An array of OptedOutFilter objects to filter the results on.
- `"MaxResults"`: The maximum number of results to return per each request.
- `"NextToken"`: The token to be used for the next set of paginated results. You don't need
to supply a value for this field in the initial request.
- `"OptedOutNumbers"`: An array of phone numbers to search for in the OptOutList.
"""
function describe_opted_out_numbers(
OptOutListName; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DescribeOptedOutNumbers",
Dict{String,Any}("OptOutListName" => OptOutListName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_opted_out_numbers(
OptOutListName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"DescribeOptedOutNumbers",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("OptOutListName" => OptOutListName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_phone_numbers()
describe_phone_numbers(params::Dict{String,<:Any})
Describes the specified origination phone number, or all the phone numbers in your account.
If you specify phone number IDs, the output includes information for only the specified
phone numbers. If you specify filters, the output includes information for only those phone
numbers that meet the filter criteria. If you don't specify phone number IDs or filters,
the output includes information for all phone numbers. If you specify a phone number ID
that isn't valid, an error is returned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An array of PhoneNumberFilter objects to filter the results.
- `"MaxResults"`: The maximum number of results to return per each request.
- `"NextToken"`: The token to be used for the next set of paginated results. You don't need
to supply a value for this field in the initial request.
- `"PhoneNumberIds"`: The unique identifier of phone numbers to find information about.
This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.
"""
function describe_phone_numbers(; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint_sms_voice_v2(
"DescribePhoneNumbers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_phone_numbers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DescribePhoneNumbers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_pools()
describe_pools(params::Dict{String,<:Any})
Retrieves the specified pools or all pools associated with your Amazon Web Services
account. If you specify pool IDs, the output includes information for only the specified
pools. If you specify filters, the output includes information for only those pools that
meet the filter criteria. If you don't specify pool IDs or filters, the output includes
information for all pools. If you specify a pool ID that isn't valid, an error is returned.
A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone
numbers and SenderIds that are associated with your Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An array of PoolFilter objects to filter the results.
- `"MaxResults"`: The maximum number of results to return per each request.
- `"NextToken"`: The token to be used for the next set of paginated results. You don't need
to supply a value for this field in the initial request.
- `"PoolIds"`: The unique identifier of pools to find. This is an array of strings that can
be either the PoolId or PoolArn.
"""
function describe_pools(; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint_sms_voice_v2(
"DescribePools"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_pools(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DescribePools", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_protect_configurations()
describe_protect_configurations(params::Dict{String,<:Any})
Retrieves the protect configurations that match any of filters. If a filter isn’t
provided then all protect configurations are returned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An array of ProtectConfigurationFilter objects to filter the results.
- `"MaxResults"`: The maximum number of results to return per each request.
- `"NextToken"`: The token to be used for the next set of paginated results. You don't need
to supply a value for this field in the initial request.
- `"ProtectConfigurationIds"`: An array of protect configuration identifiers to search for.
"""
function describe_protect_configurations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DescribeProtectConfigurations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_protect_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DescribeProtectConfigurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_registration_attachments()
describe_registration_attachments(params::Dict{String,<:Any})
Retrieves the specified registration attachments or all registration attachments associated
with your Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An array of RegistrationAttachmentFilter objects to filter the results.
- `"MaxResults"`: The maximum number of results to return per each request.
- `"NextToken"`: The token to be used for the next set of paginated results. You don't need
to supply a value for this field in the initial request.
- `"RegistrationAttachmentIds"`: The unique identifier of registration attachments to find.
This is an array of RegistrationAttachmentId.
"""
function describe_registration_attachments(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DescribeRegistrationAttachments";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_registration_attachments(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DescribeRegistrationAttachments",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_registration_field_definitions(registration_type)
describe_registration_field_definitions(registration_type, params::Dict{String,<:Any})
Retrieves the specified registration type field definitions. You can use
DescribeRegistrationFieldDefinitions to view the requirements for creating, filling out,
and submitting each registration type.
# Arguments
- `registration_type`: The type of registration form. The list of RegistrationTypes can be
found using the DescribeRegistrationTypeDefinitions action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FieldPaths"`: An array of paths to the registration form field.
- `"MaxResults"`: The maximum number of results to return per each request.
- `"NextToken"`: The token to be used for the next set of paginated results. You don't need
to supply a value for this field in the initial request.
- `"SectionPath"`: The path to the section of the registration.
"""
function describe_registration_field_definitions(
RegistrationType; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DescribeRegistrationFieldDefinitions",
Dict{String,Any}("RegistrationType" => RegistrationType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_registration_field_definitions(
RegistrationType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"DescribeRegistrationFieldDefinitions",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("RegistrationType" => RegistrationType), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_registration_field_values(registration_id)
describe_registration_field_values(registration_id, params::Dict{String,<:Any})
Retrieves the specified registration field values.
# Arguments
- `registration_id`: The unique identifier for the registration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FieldPaths"`: An array of paths to the registration form field.
- `"MaxResults"`: The maximum number of results to return per each request.
- `"NextToken"`: The token to be used for the next set of paginated results. You don't need
to supply a value for this field in the initial request.
- `"SectionPath"`: The path to the section of the registration.
- `"VersionNumber"`: The version number of the registration.
"""
function describe_registration_field_values(
RegistrationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DescribeRegistrationFieldValues",
Dict{String,Any}("RegistrationId" => RegistrationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_registration_field_values(
RegistrationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"DescribeRegistrationFieldValues",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RegistrationId" => RegistrationId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_registration_section_definitions(registration_type)
describe_registration_section_definitions(registration_type, params::Dict{String,<:Any})
Retrieves the specified registration section definitions. You can use
DescribeRegistrationSectionDefinitions to view the requirements for creating, filling out,
and submitting each registration type.
# Arguments
- `registration_type`: The type of registration form. The list of RegistrationTypes can be
found using the DescribeRegistrationTypeDefinitions 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 each request.
- `"NextToken"`: The token to be used for the next set of paginated results. You don't need
to supply a value for this field in the initial request.
- `"SectionPaths"`: An array of paths for the registration form section.
"""
function describe_registration_section_definitions(
RegistrationType; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DescribeRegistrationSectionDefinitions",
Dict{String,Any}("RegistrationType" => RegistrationType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_registration_section_definitions(
RegistrationType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"DescribeRegistrationSectionDefinitions",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("RegistrationType" => RegistrationType), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_registration_type_definitions()
describe_registration_type_definitions(params::Dict{String,<:Any})
Retrieves the specified registration type definitions. You can use
DescribeRegistrationTypeDefinitions to view the requirements for creating, filling out, and
submitting each registration type.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An array of RegistrationFilter objects to filter the results.
- `"MaxResults"`: The maximum number of results to return per each request.
- `"NextToken"`: The token to be used for the next set of paginated results. You don't need
to supply a value for this field in the initial request.
- `"RegistrationTypes"`: The type of registration form. The list of RegistrationTypes can
be found using the DescribeRegistrationTypeDefinitions action.
"""
function describe_registration_type_definitions(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DescribeRegistrationTypeDefinitions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_registration_type_definitions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DescribeRegistrationTypeDefinitions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_registration_versions(registration_id)
describe_registration_versions(registration_id, params::Dict{String,<:Any})
Retrieves the specified registration version.
# Arguments
- `registration_id`: The unique identifier for the registration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An array of RegistrationVersionFilter objects to filter the results.
- `"MaxResults"`: The maximum number of results to return per each request.
- `"NextToken"`: The token to be used for the next set of paginated results. You don't need
to supply a value for this field in the initial request.
- `"VersionNumbers"`: An array of registration version numbers.
"""
function describe_registration_versions(
RegistrationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DescribeRegistrationVersions",
Dict{String,Any}("RegistrationId" => RegistrationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_registration_versions(
RegistrationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"DescribeRegistrationVersions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RegistrationId" => RegistrationId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_registrations()
describe_registrations(params::Dict{String,<:Any})
Retrieves the specified registrations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An array of RegistrationFilter objects to filter the results.
- `"MaxResults"`: The maximum number of results to return per each request.
- `"NextToken"`: The token to be used for the next set of paginated results. You don't need
to supply a value for this field in the initial request.
- `"RegistrationIds"`: An array of unique identifiers for each registration.
"""
function describe_registrations(; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint_sms_voice_v2(
"DescribeRegistrations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_registrations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DescribeRegistrations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_sender_ids()
describe_sender_ids(params::Dict{String,<:Any})
Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services
account. If you specify SenderIds, the output includes information for only the specified
SenderIds. If you specify filters, the output includes information for only those SenderIds
that meet the filter criteria. If you don't specify SenderIds or filters, the output
includes information for all SenderIds. f you specify a sender ID that isn't valid, an
error is returned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An array of SenderIdFilter objects to filter the results.
- `"MaxResults"`: The maximum number of results to return per each request.
- `"NextToken"`: The token to be used for the next set of paginated results. You don't need
to supply a value for this field in the initial request.
- `"SenderIds"`: An array of SenderIdAndCountry objects to search for.
"""
function describe_sender_ids(; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint_sms_voice_v2(
"DescribeSenderIds"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_sender_ids(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DescribeSenderIds", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_spend_limits()
describe_spend_limits(params::Dict{String,<:Any})
Describes the current Amazon Pinpoint monthly spend limits for sending voice and text
messages. When you establish an Amazon Web Services account, the account has initial
monthly spend limit in a given Region. For more information on increasing your monthly
spend limit, see Requesting increases to your monthly SMS spending quota for Amazon
Pinpoint in the Amazon Pinpoint User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to return per each request.
- `"NextToken"`: The token to be used for the next set of paginated results. You don't need
to supply a value for this field in the initial request.
"""
function describe_spend_limits(; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint_sms_voice_v2(
"DescribeSpendLimits"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_spend_limits(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DescribeSpendLimits",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_verified_destination_numbers()
describe_verified_destination_numbers(params::Dict{String,<:Any})
Retrieves the specified verified destiona numbers.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DestinationPhoneNumbers"`: An array of verified destination phone number, in E.164
format.
- `"Filters"`: An array of VerifiedDestinationNumberFilter objects to filter the results.
- `"MaxResults"`: The maximum number of results to return per each request.
- `"NextToken"`: The token to be used for the next set of paginated results. You don't need
to supply a value for this field in the initial request.
- `"VerifiedDestinationNumberIds"`: An array of VerifiedDestinationNumberid to retreive.
"""
function describe_verified_destination_numbers(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DescribeVerifiedDestinationNumbers";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_verified_destination_numbers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DescribeVerifiedDestinationNumbers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_origination_identity(iso_country_code, origination_identity, pool_id)
disassociate_origination_identity(iso_country_code, origination_identity, pool_id, params::Dict{String,<:Any})
Removes the specified origination identity from an existing pool. If the origination
identity isn't associated with the specified pool, an error is returned.
# Arguments
- `iso_country_code`: The two-character code, in ISO 3166-1 alpha-2 format, for the country
or region.
- `origination_identity`: The origination identity to use such as a PhoneNumberId,
PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers find the values
for PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the values for
SenderId and SenderIdArn.
- `pool_id`: The unique identifier for the pool to disassociate with the origination
identity. This value can be either the PoolId or PoolArn.
# 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 don't specify a client token, a randomly generated token is used for
the request to ensure idempotency.
"""
function disassociate_origination_identity(
IsoCountryCode,
OriginationIdentity,
PoolId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"DisassociateOriginationIdentity",
Dict{String,Any}(
"IsoCountryCode" => IsoCountryCode,
"OriginationIdentity" => OriginationIdentity,
"PoolId" => PoolId,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_origination_identity(
IsoCountryCode,
OriginationIdentity,
PoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"DisassociateOriginationIdentity",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IsoCountryCode" => IsoCountryCode,
"OriginationIdentity" => OriginationIdentity,
"PoolId" => PoolId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_protect_configuration(configuration_set_name, protect_configuration_id)
disassociate_protect_configuration(configuration_set_name, protect_configuration_id, params::Dict{String,<:Any})
Disassociate a protect configuration from a configuration set.
# Arguments
- `configuration_set_name`: The name of the ConfigurationSet.
- `protect_configuration_id`: The unique identifier for the protect configuration.
"""
function disassociate_protect_configuration(
ConfigurationSetName,
ProtectConfigurationId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"DisassociateProtectConfiguration",
Dict{String,Any}(
"ConfigurationSetName" => ConfigurationSetName,
"ProtectConfigurationId" => ProtectConfigurationId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_protect_configuration(
ConfigurationSetName,
ProtectConfigurationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"DisassociateProtectConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigurationSetName" => ConfigurationSetName,
"ProtectConfigurationId" => ProtectConfigurationId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
discard_registration_version(registration_id)
discard_registration_version(registration_id, params::Dict{String,<:Any})
Discard the current version of the registration.
# Arguments
- `registration_id`: The unique identifier for the registration.
"""
function discard_registration_version(
RegistrationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"DiscardRegistrationVersion",
Dict{String,Any}("RegistrationId" => RegistrationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function discard_registration_version(
RegistrationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"DiscardRegistrationVersion",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RegistrationId" => RegistrationId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_protect_configuration_country_rule_set(number_capability, protect_configuration_id)
get_protect_configuration_country_rule_set(number_capability, protect_configuration_id, params::Dict{String,<:Any})
Retrieve the CountryRuleSet for the specified NumberCapability from a protect configuration.
# Arguments
- `number_capability`: The capability type to return the CountryRuleSet for. Valid values
are SMS, VOICE, or MMS.
- `protect_configuration_id`: The unique identifier for the protect configuration.
"""
function get_protect_configuration_country_rule_set(
NumberCapability,
ProtectConfigurationId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"GetProtectConfigurationCountryRuleSet",
Dict{String,Any}(
"NumberCapability" => NumberCapability,
"ProtectConfigurationId" => ProtectConfigurationId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_protect_configuration_country_rule_set(
NumberCapability,
ProtectConfigurationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"GetProtectConfigurationCountryRuleSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"NumberCapability" => NumberCapability,
"ProtectConfigurationId" => ProtectConfigurationId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_pool_origination_identities(pool_id)
list_pool_origination_identities(pool_id, params::Dict{String,<:Any})
Lists all associated origination identities in your pool. If you specify filters, the
output includes information for only those origination identities that meet the filter
criteria.
# Arguments
- `pool_id`: The unique identifier for the pool. This value can be either the PoolId or
PoolArn.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An array of PoolOriginationIdentitiesFilter objects to filter the results..
- `"MaxResults"`: The maximum number of results to return per each request.
- `"NextToken"`: The token to be used for the next set of paginated results. You don't need
to supply a value for this field in the initial request.
"""
function list_pool_origination_identities(
PoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"ListPoolOriginationIdentities",
Dict{String,Any}("PoolId" => PoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_pool_origination_identities(
PoolId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"ListPoolOriginationIdentities",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("PoolId" => PoolId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_registration_associations(registration_id)
list_registration_associations(registration_id, params::Dict{String,<:Any})
Retreive all of the origination identies that are associated with a registration.
# Arguments
- `registration_id`: The unique identifier for the registration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An array of RegistrationAssociationFilter to apply to the results that are
returned.
- `"MaxResults"`: The maximum number of results to return per each request.
- `"NextToken"`: The token to be used for the next set of paginated results. You don't need
to supply a value for this field in the initial request.
"""
function list_registration_associations(
RegistrationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"ListRegistrationAssociations",
Dict{String,Any}("RegistrationId" => RegistrationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_registration_associations(
RegistrationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"ListRegistrationAssociations",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RegistrationId" => RegistrationId), 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 associated with a resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource to query for.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"ListTagsForResource",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_keyword(keyword, keyword_message, origination_identity)
put_keyword(keyword, keyword_message, origination_identity, params::Dict{String,<:Any})
Creates or updates a keyword configuration on an origination phone number or pool. A
keyword is a word that you can search for on a particular phone number or pool. It is also
a specific word or phrase that an end user can send to your number to elicit a response,
such as an informational message or a special offer. When your number receives a message
that begins with a keyword, Amazon Pinpoint responds with a customizable message. If you
specify a keyword that isn't valid, an error is returned.
# Arguments
- `keyword`: The new keyword to add.
- `keyword_message`: The message associated with the keyword.
- `origination_identity`: The origination identity to use such as a PhoneNumberId,
PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers get the values
for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values
for SenderId and SenderIdArn.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"KeywordAction"`: The action to perform for the new keyword when it is received.
AUTOMATIC_RESPONSE: A message is sent to the recipient. OPT_OUT: Keeps the recipient from
receiving future messages. OPT_IN: The recipient wants to receive future messages.
"""
function put_keyword(
Keyword,
KeywordMessage,
OriginationIdentity;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"PutKeyword",
Dict{String,Any}(
"Keyword" => Keyword,
"KeywordMessage" => KeywordMessage,
"OriginationIdentity" => OriginationIdentity,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_keyword(
Keyword,
KeywordMessage,
OriginationIdentity,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"PutKeyword",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Keyword" => Keyword,
"KeywordMessage" => KeywordMessage,
"OriginationIdentity" => OriginationIdentity,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_opted_out_number(opt_out_list_name, opted_out_number)
put_opted_out_number(opt_out_list_name, opted_out_number, params::Dict{String,<:Any})
Creates an opted out destination phone number in the opt-out list. If the destination phone
number isn't valid or if the specified opt-out list doesn't exist, an error is returned.
# Arguments
- `opt_out_list_name`: The OptOutListName or OptOutListArn to add the phone number to.
- `opted_out_number`: The phone number to add to the OptOutList in E.164 format.
"""
function put_opted_out_number(
OptOutListName, OptedOutNumber; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"PutOptedOutNumber",
Dict{String,Any}(
"OptOutListName" => OptOutListName, "OptedOutNumber" => OptedOutNumber
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_opted_out_number(
OptOutListName,
OptedOutNumber,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"PutOptedOutNumber",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"OptOutListName" => OptOutListName, "OptedOutNumber" => OptedOutNumber
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_registration_field_value(field_path, registration_id)
put_registration_field_value(field_path, registration_id, params::Dict{String,<:Any})
Creates or updates a field value for a registration.
# Arguments
- `field_path`: The path to the registration form field. You can use
DescribeRegistrationFieldDefinitions for a list of FieldPaths.
- `registration_id`: The unique identifier for the registration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"RegistrationAttachmentId"`: The unique identifier for the registration attachment.
- `"SelectChoices"`: An array of values for the form field.
- `"TextValue"`: The text data for a free form field.
"""
function put_registration_field_value(
FieldPath, RegistrationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"PutRegistrationFieldValue",
Dict{String,Any}("FieldPath" => FieldPath, "RegistrationId" => RegistrationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_registration_field_value(
FieldPath,
RegistrationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"PutRegistrationFieldValue",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FieldPath" => FieldPath, "RegistrationId" => RegistrationId
),
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 an existing origination phone number in your account. Once released, a phone
number is no longer available for sending messages. If the origination phone number has
deletion protection enabled or is associated with a pool, an error is returned.
# Arguments
- `phone_number_id`: The PhoneNumberId or PhoneNumberArn of the phone number to release.
You can use DescribePhoneNumbers to get the values for PhoneNumberId and PhoneNumberArn.
"""
function release_phone_number(
PhoneNumberId; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"ReleasePhoneNumber",
Dict{String,Any}("PhoneNumberId" => PhoneNumberId);
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 pinpoint_sms_voice_v2(
"ReleasePhoneNumber",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PhoneNumberId" => PhoneNumberId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
release_sender_id(iso_country_code, sender_id)
release_sender_id(iso_country_code, sender_id, params::Dict{String,<:Any})
Releases an existing sender ID in your account.
# Arguments
- `iso_country_code`: The two-character code, in ISO 3166-1 alpha-2 format, for the country
or region.
- `sender_id`: The sender ID to release.
"""
function release_sender_id(
IsoCountryCode, SenderId; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"ReleaseSenderId",
Dict{String,Any}("IsoCountryCode" => IsoCountryCode, "SenderId" => SenderId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function release_sender_id(
IsoCountryCode,
SenderId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"ReleaseSenderId",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IsoCountryCode" => IsoCountryCode, "SenderId" => SenderId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
request_phone_number(iso_country_code, message_type, number_capabilities, number_type)
request_phone_number(iso_country_code, message_type, number_capabilities, number_type, params::Dict{String,<:Any})
Request an origination phone number for use in your account. For more information on phone
number request see Requesting a number in the Amazon Pinpoint User Guide.
# Arguments
- `iso_country_code`: The two-character code, in ISO 3166-1 alpha-2 format, for the country
or region.
- `message_type`: The type of message. Valid values are TRANSACTIONAL for messages that are
critical or time-sensitive and PROMOTIONAL for messages that aren't critical or
time-sensitive.
- `number_capabilities`: Indicates if the phone number will be used for text messages,
voice messages, or both.
- `number_type`: The type of phone number to request.
# 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. If you don't specify a client token, a randomly generated token
is used for the request to ensure idempotency.
- `"DeletionProtectionEnabled"`: By default this is set to false. When set to true the
phone number can't be deleted.
- `"OptOutListName"`: The name of the OptOutList to associate with the phone number. You
can use the OptOutListName or OptOutListArn.
- `"PoolId"`: The pool to associated with the phone number. You can use the PoolId or
PoolArn.
- `"RegistrationId"`: Use this field to attach your phone number for an external
registration process.
- `"Tags"`: An array of tags (key and value pairs) associate with the requested phone
number.
"""
function request_phone_number(
IsoCountryCode,
MessageType,
NumberCapabilities,
NumberType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"RequestPhoneNumber",
Dict{String,Any}(
"IsoCountryCode" => IsoCountryCode,
"MessageType" => MessageType,
"NumberCapabilities" => NumberCapabilities,
"NumberType" => NumberType,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function request_phone_number(
IsoCountryCode,
MessageType,
NumberCapabilities,
NumberType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"RequestPhoneNumber",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IsoCountryCode" => IsoCountryCode,
"MessageType" => MessageType,
"NumberCapabilities" => NumberCapabilities,
"NumberType" => NumberType,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
request_sender_id(iso_country_code, sender_id)
request_sender_id(iso_country_code, sender_id, params::Dict{String,<:Any})
Request a new sender ID that doesn't require registration.
# Arguments
- `iso_country_code`: The two-character code, in ISO 3166-1 alpha-2 format, for the country
or region.
- `sender_id`: The sender ID string to request.
# 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. If you don't specify a client token, a randomly generated token
is used for the request to ensure idempotency.
- `"DeletionProtectionEnabled"`: By default this is set to false. When set to true the
sender ID can't be deleted.
- `"MessageTypes"`: The type of message. Valid values are TRANSACTIONAL for messages that
are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or
time-sensitive.
- `"Tags"`: An array of tags (key and value pairs) to associate with the sender ID.
"""
function request_sender_id(
IsoCountryCode, SenderId; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"RequestSenderId",
Dict{String,Any}(
"IsoCountryCode" => IsoCountryCode,
"SenderId" => SenderId,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function request_sender_id(
IsoCountryCode,
SenderId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"RequestSenderId",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IsoCountryCode" => IsoCountryCode,
"SenderId" => SenderId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_destination_number_verification_code(verification_channel, verified_destination_number_id)
send_destination_number_verification_code(verification_channel, verified_destination_number_id, params::Dict{String,<:Any})
Before you can send test messages to a verified destination phone number you need to opt-in
the verified destination phone number. Creates a new text message with a verification code
and send it to a verified destination phone number. Once you have the verification code use
VerifyDestinationNumber to opt-in the verified destination phone number to receive messages.
# Arguments
- `verification_channel`: Choose to send the verification code as an SMS or voice message.
- `verified_destination_number_id`: The unique identifier for the verified destination
phone number.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConfigurationSetName"`: The name of the configuration set to use. This can be either
the ConfigurationSetName or ConfigurationSetArn.
- `"Context"`: You can specify custom data in this field. If you do, that data is logged to
the event destination.
- `"DestinationCountryParameters"`: This field is used for any country-specific
registration requirements. Currently, this setting is only used when you send messages to
recipients in India using a sender ID. For more information see Special requirements for
sending SMS messages to recipients in India.
- `"LanguageCode"`: Choose the language to use for the message.
- `"OriginationIdentity"`: The origination identity of the message. This can be either the
PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
"""
function send_destination_number_verification_code(
VerificationChannel,
VerifiedDestinationNumberId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"SendDestinationNumberVerificationCode",
Dict{String,Any}(
"VerificationChannel" => VerificationChannel,
"VerifiedDestinationNumberId" => VerifiedDestinationNumberId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_destination_number_verification_code(
VerificationChannel,
VerifiedDestinationNumberId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"SendDestinationNumberVerificationCode",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"VerificationChannel" => VerificationChannel,
"VerifiedDestinationNumberId" => VerifiedDestinationNumberId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_media_message(destination_phone_number, origination_identity)
send_media_message(destination_phone_number, origination_identity, params::Dict{String,<:Any})
Creates a new multimedia message (MMS) and sends it to a recipient's phone number.
# Arguments
- `destination_phone_number`: The destination phone number in E.164 format.
- `origination_identity`: The origination identity of the message. This can be either the
PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConfigurationSetName"`: The name of the configuration set to use. This can be either
the ConfigurationSetName or ConfigurationSetArn.
- `"Context"`: You can specify custom data in this field. If you do, that data is logged to
the event destination.
- `"DryRun"`: When set to true, the message is checked and validated, but isn't sent to the
end recipient.
- `"MaxPrice"`: The maximum amount that you want to spend, in US dollars, per each MMS
message.
- `"MediaUrls"`: An array of URLs to each media file to send. The media files have to be
stored in a publicly available S3 bucket. Supported media file formats are listed in MMS
file types, size and character limits. For more information on creating an S3 bucket and
managing objects, see Creating a bucket and Uploading objects in the S3 user guide.
- `"MessageBody"`: The text body of the message.
- `"ProtectConfigurationId"`: The unique identifier of the protect configuration to use.
- `"TimeToLive"`: How long the text message is valid for. By default this is 72 hours.
"""
function send_media_message(
DestinationPhoneNumber,
OriginationIdentity;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"SendMediaMessage",
Dict{String,Any}(
"DestinationPhoneNumber" => DestinationPhoneNumber,
"OriginationIdentity" => OriginationIdentity,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_media_message(
DestinationPhoneNumber,
OriginationIdentity,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"SendMediaMessage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DestinationPhoneNumber" => DestinationPhoneNumber,
"OriginationIdentity" => OriginationIdentity,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_text_message(destination_phone_number)
send_text_message(destination_phone_number, params::Dict{String,<:Any})
Creates a new text message and sends it to a recipient's phone number. SMS throughput
limits are measured in Message Parts per Second (MPS). Your MPS limit depends on the
destination country of your messages, as well as the type of phone number (origination
number) that you use to send the message. For more information, see Message Parts per
Second (MPS) limits in the Amazon Pinpoint User Guide.
# Arguments
- `destination_phone_number`: The destination phone number in E.164 format.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConfigurationSetName"`: The name of the configuration set to use. This can be either
the ConfigurationSetName or ConfigurationSetArn.
- `"Context"`: You can specify custom data in this field. If you do, that data is logged to
the event destination.
- `"DestinationCountryParameters"`: This field is used for any country-specific
registration requirements. Currently, this setting is only used when you send messages to
recipients in India using a sender ID. For more information see Special requirements for
sending SMS messages to recipients in India.
- `"DryRun"`: When set to true, the message is checked and validated, but isn't sent to the
end recipient.
- `"Keyword"`: When you register a short code in the US, you must specify a program name.
If you don’t have a US short code, omit this attribute.
- `"MaxPrice"`: The maximum amount that you want to spend, in US dollars, per each text
message part. A text message can contain multiple parts.
- `"MessageBody"`: The body of the text message.
- `"MessageType"`: The type of message. Valid values are for messages that are critical or
time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
- `"OriginationIdentity"`: The origination identity of the message. This can be either the
PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
- `"ProtectConfigurationId"`: The unique identifier for the protect configuration.
- `"TimeToLive"`: How long the text message is valid for. By default this is 72 hours.
"""
function send_text_message(
DestinationPhoneNumber; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"SendTextMessage",
Dict{String,Any}("DestinationPhoneNumber" => DestinationPhoneNumber);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_text_message(
DestinationPhoneNumber,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"SendTextMessage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DestinationPhoneNumber" => DestinationPhoneNumber),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_voice_message(destination_phone_number, origination_identity)
send_voice_message(destination_phone_number, origination_identity, params::Dict{String,<:Any})
Allows you to send a request that sends a voice message through Amazon Pinpoint. This
operation uses Amazon Polly to convert a text script into a voice message.
# Arguments
- `destination_phone_number`: The destination phone number in E.164 format.
- `origination_identity`: The origination identity to use for the voice call. This can be
the PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConfigurationSetName"`: The name of the configuration set to use. This can be either
the ConfigurationSetName or ConfigurationSetArn.
- `"Context"`: You can specify custom data in this field. If you do, that data is logged to
the event destination.
- `"DryRun"`: When set to true, the message is checked and validated, but isn't sent to the
end recipient.
- `"MaxPricePerMinute"`: The maximum amount to spend per voice message, in US dollars.
- `"MessageBody"`: The text to convert to a voice message.
- `"MessageBodyTextType"`: Specifies if the MessageBody field contains text or speech
synthesis markup language (SSML). TEXT: This is the default value. When used the maximum
character limit is 3000. SSML: When used the maximum character limit is 6000 including
SSML tagging.
- `"ProtectConfigurationId"`: The unique identifier for the protect configuration.
- `"TimeToLive"`: How long the voice message is valid for. By default this is 72 hours.
- `"VoiceId"`: The voice for the Amazon Polly service to use. By default this is set to
\"MATTHEW\".
"""
function send_voice_message(
DestinationPhoneNumber,
OriginationIdentity;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"SendVoiceMessage",
Dict{String,Any}(
"DestinationPhoneNumber" => DestinationPhoneNumber,
"OriginationIdentity" => OriginationIdentity,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_voice_message(
DestinationPhoneNumber,
OriginationIdentity,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"SendVoiceMessage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DestinationPhoneNumber" => DestinationPhoneNumber,
"OriginationIdentity" => OriginationIdentity,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_account_default_protect_configuration(protect_configuration_id)
set_account_default_protect_configuration(protect_configuration_id, params::Dict{String,<:Any})
Set a protect configuration as your account default. You can only have one account default
protect configuration at a time. The current account default protect configuration is
replaced with the provided protect configuration.
# Arguments
- `protect_configuration_id`: The unique identifier for the protect configuration.
"""
function set_account_default_protect_configuration(
ProtectConfigurationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"SetAccountDefaultProtectConfiguration",
Dict{String,Any}("ProtectConfigurationId" => ProtectConfigurationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_account_default_protect_configuration(
ProtectConfigurationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"SetAccountDefaultProtectConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ProtectConfigurationId" => ProtectConfigurationId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_default_message_type(configuration_set_name, message_type)
set_default_message_type(configuration_set_name, message_type, params::Dict{String,<:Any})
Sets the default message type on a configuration set. Choose the category of SMS messages
that you plan to send from this account. If you send account-related messages or
time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to
send messages that contain marketing material or other promotional content, choose
Promotional. This setting applies to your entire Amazon Web Services account.
# Arguments
- `configuration_set_name`: The configuration set to update with a new default message
type. This field can be the ConsigurationSetName or ConfigurationSetArn.
- `message_type`: The type of message. Valid values are TRANSACTIONAL for messages that are
critical or time-sensitive and PROMOTIONAL for messages that aren't critical or
time-sensitive.
"""
function set_default_message_type(
ConfigurationSetName, MessageType; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"SetDefaultMessageType",
Dict{String,Any}(
"ConfigurationSetName" => ConfigurationSetName, "MessageType" => MessageType
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_default_message_type(
ConfigurationSetName,
MessageType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"SetDefaultMessageType",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigurationSetName" => ConfigurationSetName,
"MessageType" => MessageType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_default_sender_id(configuration_set_name, sender_id)
set_default_sender_id(configuration_set_name, sender_id, params::Dict{String,<:Any})
Sets default sender ID on a configuration set. When sending a text message to a destination
country that supports sender IDs, the default sender ID on the configuration set specified
will be used if no dedicated origination phone numbers or registered sender IDs are
available in your account.
# Arguments
- `configuration_set_name`: The configuration set to updated with a new default SenderId.
This field can be the ConsigurationSetName or ConfigurationSetArn.
- `sender_id`: The current sender ID for the configuration set. When sending a text message
to a destination country which supports SenderIds, the default sender ID on the
configuration set specified on SendTextMessage will be used if no dedicated origination
phone numbers or registered SenderIds are available in your account, instead of a generic
sender ID, such as 'NOTICE'.
"""
function set_default_sender_id(
ConfigurationSetName, SenderId; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"SetDefaultSenderId",
Dict{String,Any}(
"ConfigurationSetName" => ConfigurationSetName, "SenderId" => SenderId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_default_sender_id(
ConfigurationSetName,
SenderId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"SetDefaultSenderId",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigurationSetName" => ConfigurationSetName, "SenderId" => SenderId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_media_message_spend_limit_override(monthly_limit)
set_media_message_spend_limit_override(monthly_limit, params::Dict{String,<:Any})
Sets an account level monthly spend limit override for sending MMS messages. The requested
spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web
Services.
# Arguments
- `monthly_limit`: The new monthly limit to enforce on text messages.
"""
function set_media_message_spend_limit_override(
MonthlyLimit; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"SetMediaMessageSpendLimitOverride",
Dict{String,Any}("MonthlyLimit" => MonthlyLimit);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_media_message_spend_limit_override(
MonthlyLimit,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"SetMediaMessageSpendLimitOverride",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("MonthlyLimit" => MonthlyLimit), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_text_message_spend_limit_override(monthly_limit)
set_text_message_spend_limit_override(monthly_limit, params::Dict{String,<:Any})
Sets an account level monthly spend limit override for sending text messages. The requested
spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web
Services.
# Arguments
- `monthly_limit`: The new monthly limit to enforce on text messages.
"""
function set_text_message_spend_limit_override(
MonthlyLimit; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"SetTextMessageSpendLimitOverride",
Dict{String,Any}("MonthlyLimit" => MonthlyLimit);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_text_message_spend_limit_override(
MonthlyLimit,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"SetTextMessageSpendLimitOverride",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("MonthlyLimit" => MonthlyLimit), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_voice_message_spend_limit_override(monthly_limit)
set_voice_message_spend_limit_override(monthly_limit, params::Dict{String,<:Any})
Sets an account level monthly spend limit override for sending voice messages. The
requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon
Web Services.
# Arguments
- `monthly_limit`: The new monthly limit to enforce on voice messages.
"""
function set_voice_message_spend_limit_override(
MonthlyLimit; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"SetVoiceMessageSpendLimitOverride",
Dict{String,Any}("MonthlyLimit" => MonthlyLimit);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_voice_message_spend_limit_override(
MonthlyLimit,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"SetVoiceMessageSpendLimitOverride",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("MonthlyLimit" => MonthlyLimit), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
submit_registration_version(registration_id)
submit_registration_version(registration_id, params::Dict{String,<:Any})
Submit the specified registration for review and approval.
# Arguments
- `registration_id`: The unique identifier for the registration.
"""
function submit_registration_version(
RegistrationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"SubmitRegistrationVersion",
Dict{String,Any}("RegistrationId" => RegistrationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function submit_registration_version(
RegistrationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"SubmitRegistrationVersion",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RegistrationId" => RegistrationId), 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 Amazon Pinpoint SMS Voice,
version 2 resource. 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 an
optional value. Tag keys must be unique per resource. For more information about tags, see
Tagging Amazon Pinpoint resources in the Amazon Pinpoint Developer Guide.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
- `tags`: An array of key and value pair tags that are associated with the resource.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint_sms_voice_v2(
"TagResource",
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ResourceArn,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2
resource. For more information on tags see Tagging Amazon Pinpoint resources in the Amazon
Pinpoint Developer Guide.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
- `tag_keys`: An array of tag key values to unassociate with the resource.
"""
function untag_resource(
ResourceArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"UntagResource",
Dict{String,Any}("ResourceArn" => ResourceArn, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ResourceArn,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_event_destination(configuration_set_name, event_destination_name)
update_event_destination(configuration_set_name, event_destination_name, params::Dict{String,<:Any})
Updates an existing event destination in a configuration set. You can update the IAM role
ARN for CloudWatch Logs and Kinesis Data Firehose. You can also enable or disable the event
destination. You may want to update an event destination to change its matching event types
or updating the destination resource ARN. You can't change an event destination's type
between CloudWatch Logs, Kinesis Data Firehose, and Amazon SNS.
# Arguments
- `configuration_set_name`: The configuration set to update with the new event destination.
Valid values for this can be the ConfigurationSetName or ConfigurationSetArn.
- `event_destination_name`: The name to use for the event destination.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CloudWatchLogsDestination"`: An object that contains information about an event
destination that sends data to CloudWatch Logs.
- `"Enabled"`: When set to true logging is enabled.
- `"KinesisFirehoseDestination"`: An object that contains information about an event
destination for logging to Kinesis Data Firehose.
- `"MatchingEventTypes"`: An array of event types that determine which events to log. The
TEXT_SENT event type is not supported.
- `"SnsDestination"`: An object that contains information about an event destination that
sends data to Amazon SNS.
"""
function update_event_destination(
ConfigurationSetName,
EventDestinationName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"UpdateEventDestination",
Dict{String,Any}(
"ConfigurationSetName" => ConfigurationSetName,
"EventDestinationName" => EventDestinationName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_event_destination(
ConfigurationSetName,
EventDestinationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"UpdateEventDestination",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigurationSetName" => ConfigurationSetName,
"EventDestinationName" => EventDestinationName,
),
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 the configuration of an existing origination phone number. You can update the
opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or
disable self-managed opt-outs, and enable or disable deletion protection. If the
origination phone number is associated with a pool, an error is returned.
# Arguments
- `phone_number_id`: The unique identifier of the phone number. Valid values for this field
can be either the PhoneNumberId or PhoneNumberArn.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeletionProtectionEnabled"`: By default this is set to false. When set to true the
phone number can't be deleted.
- `"OptOutListName"`: The OptOutList to add the phone number to. Valid values for this
field can be either the OutOutListName or OutOutListArn.
- `"SelfManagedOptOutsEnabled"`: By default this is set to false. When an end recipient
sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon
Pinpoint automatically replies with a customizable message and adds the end recipient to
the OptOutList. When set to true you're responsible for responding to HELP and STOP
requests. You're also responsible for tracking and honoring opt-out requests.
- `"TwoWayChannelArn"`: The Amazon Resource Name (ARN) of the two way channel.
- `"TwoWayChannelRole"`: An optional IAM Role Arn for a service to assume, to be able to
post inbound SMS messages.
- `"TwoWayEnabled"`: By default this is set to false. When set to true you can receive
incoming text messages from your end recipients.
"""
function update_phone_number(
PhoneNumberId; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"UpdatePhoneNumber",
Dict{String,Any}("PhoneNumberId" => PhoneNumberId);
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 pinpoint_sms_voice_v2(
"UpdatePhoneNumber",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PhoneNumberId" => PhoneNumberId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_pool(pool_id)
update_pool(pool_id, params::Dict{String,<:Any})
Updates the configuration of an existing pool. You can update the opt-out list, enable or
disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed
opt-outs, enable or disable deletion protection, and enable or disable shared routes.
# Arguments
- `pool_id`: The unique identifier of the pool to update. Valid values are either the
PoolId or PoolArn.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeletionProtectionEnabled"`: When set to true the pool can't be deleted.
- `"OptOutListName"`: The OptOutList to associate with the pool. Valid values are either
OptOutListName or OptOutListArn.
- `"SelfManagedOptOutsEnabled"`: By default this is set to false. When an end recipient
sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon
Pinpoint automatically replies with a customizable message and adds the end recipient to
the OptOutList. When set to true you're responsible for responding to HELP and STOP
requests. You're also responsible for tracking and honoring opt-out requests.
- `"SharedRoutesEnabled"`: Indicates whether shared routes are enabled for the pool.
- `"TwoWayChannelArn"`: The Amazon Resource Name (ARN) of the two way channel.
- `"TwoWayChannelRole"`: An optional IAM Role Arn for a service to assume, to be able to
post inbound SMS messages.
- `"TwoWayEnabled"`: By default this is set to false. When set to true you can receive
incoming text messages from your end recipients.
"""
function update_pool(PoolId; aws_config::AbstractAWSConfig=global_aws_config())
return pinpoint_sms_voice_v2(
"UpdatePool",
Dict{String,Any}("PoolId" => PoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_pool(
PoolId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"UpdatePool",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("PoolId" => PoolId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_protect_configuration(protect_configuration_id)
update_protect_configuration(protect_configuration_id, params::Dict{String,<:Any})
Update the setting for an existing protect configuration.
# Arguments
- `protect_configuration_id`: The unique identifier for the protect configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeletionProtectionEnabled"`: When set to true deletion protection is enabled. By
default this is set to false.
"""
function update_protect_configuration(
ProtectConfigurationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"UpdateProtectConfiguration",
Dict{String,Any}("ProtectConfigurationId" => ProtectConfigurationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_protect_configuration(
ProtectConfigurationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"UpdateProtectConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ProtectConfigurationId" => ProtectConfigurationId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_protect_configuration_country_rule_set(country_rule_set_updates, number_capability, protect_configuration_id)
update_protect_configuration_country_rule_set(country_rule_set_updates, number_capability, protect_configuration_id, params::Dict{String,<:Any})
Update a country rule set to ALLOW or BLOCK messages to be sent to the specified
destination counties. You can update one or multiple countries at a time. The updates are
only applied to the specified NumberCapability type.
# Arguments
- `country_rule_set_updates`: A map of ProtectConfigurationCountryRuleSetInformation
objects that contain the details for the requested NumberCapability. The Key is the
two-letter ISO country code. For a list of supported ISO country codes, see Supported
countries and regions (SMS channel) in the Amazon Pinpoint SMS user guide.
- `number_capability`: The number capability to apply the CountryRuleSetUpdates updates to.
- `protect_configuration_id`: The unique identifier for the protect configuration.
"""
function update_protect_configuration_country_rule_set(
CountryRuleSetUpdates,
NumberCapability,
ProtectConfigurationId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"UpdateProtectConfigurationCountryRuleSet",
Dict{String,Any}(
"CountryRuleSetUpdates" => CountryRuleSetUpdates,
"NumberCapability" => NumberCapability,
"ProtectConfigurationId" => ProtectConfigurationId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_protect_configuration_country_rule_set(
CountryRuleSetUpdates,
NumberCapability,
ProtectConfigurationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"UpdateProtectConfigurationCountryRuleSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CountryRuleSetUpdates" => CountryRuleSetUpdates,
"NumberCapability" => NumberCapability,
"ProtectConfigurationId" => ProtectConfigurationId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_sender_id(iso_country_code, sender_id)
update_sender_id(iso_country_code, sender_id, params::Dict{String,<:Any})
Updates the configuration of an existing sender ID.
# Arguments
- `iso_country_code`: The two-character code, in ISO 3166-1 alpha-2 format, for the country
or region.
- `sender_id`: The sender ID to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeletionProtectionEnabled"`: By default this is set to false. When set to true the
sender ID can't be deleted.
"""
function update_sender_id(
IsoCountryCode, SenderId; aws_config::AbstractAWSConfig=global_aws_config()
)
return pinpoint_sms_voice_v2(
"UpdateSenderId",
Dict{String,Any}("IsoCountryCode" => IsoCountryCode, "SenderId" => SenderId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_sender_id(
IsoCountryCode,
SenderId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"UpdateSenderId",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IsoCountryCode" => IsoCountryCode, "SenderId" => SenderId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
verify_destination_number(verification_code, verified_destination_number_id)
verify_destination_number(verification_code, verified_destination_number_id, params::Dict{String,<:Any})
Use the verification code that was received by the verified destination phone number to
opt-in the verified destination phone number to receive more messages.
# Arguments
- `verification_code`: The verification code that was received by the verified destination
phone number.
- `verified_destination_number_id`: The unique identifier for the verififed destination
phone number.
"""
function verify_destination_number(
VerificationCode,
VerifiedDestinationNumberId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"VerifyDestinationNumber",
Dict{String,Any}(
"VerificationCode" => VerificationCode,
"VerifiedDestinationNumberId" => VerifiedDestinationNumberId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function verify_destination_number(
VerificationCode,
VerifiedDestinationNumberId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pinpoint_sms_voice_v2(
"VerifyDestinationNumber",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"VerificationCode" => VerificationCode,
"VerifiedDestinationNumberId" => VerifiedDestinationNumberId,
),
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 | 12563 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: pipes
using AWS.Compat
using AWS.UUIDs
"""
create_pipe(name, role_arn, source, target)
create_pipe(name, role_arn, source, target, params::Dict{String,<:Any})
Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the
need for specialized knowledge and integration code.
# Arguments
- `name`: The name of the pipe.
- `role_arn`: The ARN of the role that allows the pipe to send data to the target.
- `source`: The ARN of the source resource.
- `target`: The ARN of the target resource.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the pipe.
- `"DesiredState"`: The state the pipe should be in.
- `"Enrichment"`: The ARN of the enrichment resource.
- `"EnrichmentParameters"`: The parameters required to set up enrichment on your pipe.
- `"LogConfiguration"`: The logging configuration settings for the pipe.
- `"SourceParameters"`: The parameters required to set up a source for your pipe.
- `"Tags"`: The list of key-value pairs to associate with the pipe.
- `"TargetParameters"`: The parameters required to set up a target for your pipe. For more
information about pipe target parameters, including how to use dynamic path parameters, see
Target parameters in the Amazon EventBridge User Guide.
"""
function create_pipe(
Name, RoleArn, Source, Target; aws_config::AbstractAWSConfig=global_aws_config()
)
return pipes(
"POST",
"/v1/pipes/$(Name)",
Dict{String,Any}("RoleArn" => RoleArn, "Source" => Source, "Target" => Target);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_pipe(
Name,
RoleArn,
Source,
Target,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pipes(
"POST",
"/v1/pipes/$(Name)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"RoleArn" => RoleArn, "Source" => Source, "Target" => Target
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_pipe(name)
delete_pipe(name, params::Dict{String,<:Any})
Delete an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in
the Amazon EventBridge User Guide.
# Arguments
- `name`: The name of the pipe.
"""
function delete_pipe(Name; aws_config::AbstractAWSConfig=global_aws_config())
return pipes(
"DELETE",
"/v1/pipes/$(Name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_pipe(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pipes(
"DELETE",
"/v1/pipes/$(Name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_pipe(name)
describe_pipe(name, params::Dict{String,<:Any})
Get the information about an existing pipe. For more information about pipes, see Amazon
EventBridge Pipes in the Amazon EventBridge User Guide.
# Arguments
- `name`: The name of the pipe.
"""
function describe_pipe(Name; aws_config::AbstractAWSConfig=global_aws_config())
return pipes(
"GET", "/v1/pipes/$(Name)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_pipe(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pipes(
"GET",
"/v1/pipes/$(Name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_pipes()
list_pipes(params::Dict{String,<:Any})
Get the pipes associated with this account. For more information about pipes, see Amazon
EventBridge Pipes in the Amazon EventBridge User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CurrentState"`: The state the pipe is in.
- `"DesiredState"`: The state the pipe should be in.
- `"Limit"`: The maximum number of pipes to include in the response.
- `"NamePrefix"`: A value that will return a subset of the pipes associated with this
account. For example, \"NamePrefix\": \"ABC\" will return all endpoints with \"ABC\" in the
name.
- `"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.
- `"SourcePrefix"`: The prefix matching the pipe source.
- `"TargetPrefix"`: The prefix matching the pipe target.
"""
function list_pipes(; aws_config::AbstractAWSConfig=global_aws_config())
return pipes("GET", "/v1/pipes"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_pipes(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pipes(
"GET", "/v1/pipes", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Displays the tags associated with a pipe.
# Arguments
- `resource_arn`: The ARN of the pipe for which you want to view tags.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return pipes(
"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 pipes(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_pipe(name)
start_pipe(name, params::Dict{String,<:Any})
Start an existing pipe.
# Arguments
- `name`: The name of the pipe.
"""
function start_pipe(Name; aws_config::AbstractAWSConfig=global_aws_config())
return pipes(
"POST",
"/v1/pipes/$(Name)/start";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_pipe(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pipes(
"POST",
"/v1/pipes/$(Name)/start",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_pipe(name)
stop_pipe(name, params::Dict{String,<:Any})
Stop an existing pipe.
# Arguments
- `name`: The name of the pipe.
"""
function stop_pipe(Name; aws_config::AbstractAWSConfig=global_aws_config())
return pipes(
"POST",
"/v1/pipes/$(Name)/stop";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_pipe(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pipes(
"POST",
"/v1/pipes/$(Name)/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 one or more tags (key-value pairs) to the specified pipe. Tags can help you
organize and categorize your resources. You can also use them to scope user permissions by
granting a user permission to access or change only resources with certain tag values. Tags
don't have any semantic meaning to Amazon Web Services and are interpreted strictly as
strings of characters. You can use the TagResource action with a pipe that already has
tags. If you specify a new tag key, this tag is appended to the list of tags associated
with the pipe. If you specify a tag key that is already associated with the pipe, the new
tag value that you specify replaces the previous value for that tag. You can associate as
many as 50 tags with a pipe.
# Arguments
- `resource_arn`: The ARN of the pipe.
- `tags`: The list of key-value pairs associated with the pipe.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return pipes(
"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 pipes(
"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 pipes.
# Arguments
- `resource_arn`: The ARN of the pipe.
- `tag_keys`: The list of tag keys to remove from the pipe.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return pipes(
"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 pipes(
"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_pipe(name, role_arn)
update_pipe(name, role_arn, params::Dict{String,<:Any})
Update an existing pipe. When you call UpdatePipe, EventBridge only the updates fields you
have specified in the request; the rest remain unchanged. The exception to this is if you
modify any Amazon Web Services-service specific fields in the SourceParameters,
EnrichmentParameters, or TargetParameters objects. For example, DynamoDBStreamParameters or
EventBridgeEventBusParameters. EventBridge updates the fields in these objects atomically
as one and overrides existing values. This is by design, and means that if you don't
specify an optional field in one of these Parameters objects, EventBridge sets that field
to its system-default value during the update. For more information about pipes, see
Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
# Arguments
- `name`: The name of the pipe.
- `role_arn`: The ARN of the role that allows the pipe to send data to the target.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the pipe.
- `"DesiredState"`: The state the pipe should be in.
- `"Enrichment"`: The ARN of the enrichment resource.
- `"EnrichmentParameters"`: The parameters required to set up enrichment on your pipe.
- `"LogConfiguration"`: The logging configuration settings for the pipe.
- `"SourceParameters"`: The parameters required to set up a source for your pipe.
- `"Target"`: The ARN of the target resource.
- `"TargetParameters"`: The parameters required to set up a target for your pipe. For more
information about pipe target parameters, including how to use dynamic path parameters, see
Target parameters in the Amazon EventBridge User Guide.
"""
function update_pipe(Name, RoleArn; aws_config::AbstractAWSConfig=global_aws_config())
return pipes(
"PUT",
"/v1/pipes/$(Name)",
Dict{String,Any}("RoleArn" => RoleArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_pipe(
Name,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pipes(
"PUT",
"/v1/pipes/$(Name)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("RoleArn" => RoleArn), 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 | 17570 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: polly
using AWS.Compat
using AWS.UUIDs
"""
delete_lexicon(lexicon_name)
delete_lexicon(lexicon_name, params::Dict{String,<:Any})
Deletes the specified pronunciation lexicon stored in an Amazon Web Services Region. A
lexicon which has been deleted is not available for speech synthesis, nor is it possible to
retrieve it using either the GetLexicon or ListLexicon APIs. For more information, see
Managing Lexicons.
# Arguments
- `lexicon_name`: The name of the lexicon to delete. Must be an existing lexicon in the
region.
"""
function delete_lexicon(LexiconName; aws_config::AbstractAWSConfig=global_aws_config())
return polly(
"DELETE",
"/v1/lexicons/$(LexiconName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_lexicon(
LexiconName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return polly(
"DELETE",
"/v1/lexicons/$(LexiconName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_voices()
describe_voices(params::Dict{String,<:Any})
Returns the list of voices that are available for use when requesting speech synthesis.
Each voice speaks a specified language, is either male or female, and is identified by an
ID, which is the ASCII version of the voice name. When synthesizing speech (
SynthesizeSpeech ), you provide the voice ID for the voice you want from the list of voices
returned by DescribeVoices. For example, you want your news reader application to read news
in a specific language, but giving a user the option to choose the voice. Using the
DescribeVoices operation you can provide the user with a list of available voices to select
from. You can optionally specify a language code to filter the available voices. For
example, if you specify en-US, the operation returns a list of all available US English
voices. This operation requires permissions to perform the polly:DescribeVoices action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Engine"`: Specifies the engine (standard, neural, long-form or generative) used by
Amazon Polly when processing input text for speech synthesis.
- `"IncludeAdditionalLanguageCodes"`: Boolean value indicating whether to return any
bilingual voices that use the specified language as an additional language. For instance,
if you request all languages that use US English (es-US), and there is an Italian voice
that speaks both Italian (it-IT) and US English, that voice will be included if you specify
yes but not if you specify no.
- `"LanguageCode"`: The language identification tag (ISO 639 code for the language
name-ISO 3166 country code) for filtering the list of voices returned. If you don't specify
this optional parameter, all available voices are returned.
- `"NextToken"`: An opaque pagination token returned from the previous DescribeVoices
operation. If present, this indicates where to continue the listing.
"""
function describe_voices(; aws_config::AbstractAWSConfig=global_aws_config())
return polly(
"GET", "/v1/voices"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_voices(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return polly(
"GET", "/v1/voices", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_lexicon(lexicon_name)
get_lexicon(lexicon_name, params::Dict{String,<:Any})
Returns the content of the specified pronunciation lexicon stored in an Amazon Web Services
Region. For more information, see Managing Lexicons.
# Arguments
- `lexicon_name`: Name of the lexicon.
"""
function get_lexicon(LexiconName; aws_config::AbstractAWSConfig=global_aws_config())
return polly(
"GET",
"/v1/lexicons/$(LexiconName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_lexicon(
LexiconName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return polly(
"GET",
"/v1/lexicons/$(LexiconName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_speech_synthesis_task(task_id)
get_speech_synthesis_task(task_id, params::Dict{String,<:Any})
Retrieves a specific SpeechSynthesisTask object based on its TaskID. This object contains
information about the given speech synthesis task, including the status of the task, and a
link to the S3 bucket containing the output of the task.
# Arguments
- `task_id`: The Amazon Polly generated identifier for a speech synthesis task.
"""
function get_speech_synthesis_task(
TaskId; aws_config::AbstractAWSConfig=global_aws_config()
)
return polly(
"GET",
"/v1/synthesisTasks/$(TaskId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_speech_synthesis_task(
TaskId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return polly(
"GET",
"/v1/synthesisTasks/$(TaskId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_lexicons()
list_lexicons(params::Dict{String,<:Any})
Returns a list of pronunciation lexicons stored in an Amazon Web Services Region. For more
information, see Managing Lexicons.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: An opaque pagination token returned from previous ListLexicons operation.
If present, indicates where to continue the list of lexicons.
"""
function list_lexicons(; aws_config::AbstractAWSConfig=global_aws_config())
return polly(
"GET", "/v1/lexicons"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_lexicons(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return polly(
"GET",
"/v1/lexicons",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_speech_synthesis_tasks()
list_speech_synthesis_tasks(params::Dict{String,<:Any})
Returns a list of SpeechSynthesisTask objects ordered by their creation date. This
operation can filter the tasks by their status, for example, allowing users to list only
tasks that are completed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Maximum number of speech synthesis tasks returned in a List operation.
- `"NextToken"`: The pagination token to use in the next request to continue the listing of
speech synthesis tasks.
- `"Status"`: Status of the speech synthesis tasks returned in a List operation
"""
function list_speech_synthesis_tasks(; aws_config::AbstractAWSConfig=global_aws_config())
return polly(
"GET", "/v1/synthesisTasks"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_speech_synthesis_tasks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return polly(
"GET",
"/v1/synthesisTasks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_lexicon(content, lexicon_name)
put_lexicon(content, lexicon_name, params::Dict{String,<:Any})
Stores a pronunciation lexicon in an Amazon Web Services Region. If a lexicon with the same
name already exists in the region, it is overwritten by the new lexicon. Lexicon operations
have eventual consistency, therefore, it might take some time before the lexicon is
available to the SynthesizeSpeech operation. For more information, see Managing Lexicons.
# Arguments
- `content`: Content of the PLS lexicon as string data.
- `lexicon_name`: Name of the lexicon. The name must follow the regular express format
[0-9A-Za-z]{1,20}. That is, the name is a case-sensitive alphanumeric string up to 20
characters long.
"""
function put_lexicon(
Content, LexiconName; aws_config::AbstractAWSConfig=global_aws_config()
)
return polly(
"PUT",
"/v1/lexicons/$(LexiconName)",
Dict{String,Any}("Content" => Content);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_lexicon(
Content,
LexiconName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return polly(
"PUT",
"/v1/lexicons/$(LexiconName)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Content" => Content), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_speech_synthesis_task(output_format, output_s3_bucket_name, text, voice_id)
start_speech_synthesis_task(output_format, output_s3_bucket_name, text, voice_id, params::Dict{String,<:Any})
Allows the creation of an asynchronous synthesis task, by starting a new
SpeechSynthesisTask. This operation requires all the standard information needed for speech
synthesis, plus the name of an Amazon S3 bucket for the service to store the output of the
synthesis task and two optional parameters (OutputS3KeyPrefix and SnsTopicArn). Once the
synthesis task is created, this operation will return a SpeechSynthesisTask object, which
will include an identifier of this task as well as the current status. The
SpeechSynthesisTask object is available for 72 hours after starting the asynchronous
synthesis task.
# Arguments
- `output_format`: The format in which the returned output will be encoded. For audio
stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.
- `output_s3_bucket_name`: Amazon S3 bucket name to which the output file will be saved.
- `text`: The input text to synthesize. If you specify ssml as the TextType, follow the
SSML format for the input text.
- `voice_id`: Voice ID to use for the synthesis.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Engine"`: Specifies the engine (standard, neural, long-form or generative) for Amazon
Polly to use when processing input text for speech synthesis. Using a voice that is not
supported for the engine selected will result in an error.
- `"LanguageCode"`: Optional language code for the Speech Synthesis request. This is only
necessary if using a bilingual voice, such as Aditi, which can be used for either Indian
English (en-IN) or Hindi (hi-IN). If a bilingual voice is used and no language code is
specified, Amazon Polly uses the default language of the bilingual voice. The default
language for any voice is the one returned by the DescribeVoices operation for the
LanguageCode parameter. For example, if no language code is specified, Aditi will use
Indian English rather than Hindi.
- `"LexiconNames"`: List of one or more pronunciation lexicon names you want the service to
apply during synthesis. Lexicons are applied only if the language of the lexicon is the
same as the language of the voice.
- `"OutputS3KeyPrefix"`: The Amazon S3 key prefix for the output speech file.
- `"SampleRate"`: The audio frequency specified in Hz. The valid values for mp3 and
ogg_vorbis are \"8000\", \"16000\", \"22050\", and \"24000\". The default value for
standard voices is \"22050\". The default value for neural voices is \"24000\". The default
value for long-form voices is \"24000\". The default value for generative voices is
\"24000\". Valid values for pcm are \"8000\" and \"16000\" The default value is \"16000\".
- `"SnsTopicArn"`: ARN for the SNS topic optionally used for providing status notification
for a speech synthesis task.
- `"SpeechMarkTypes"`: The type of speech marks returned for the input text.
- `"TextType"`: Specifies whether the input text is plain text or SSML. The default value
is plain text.
"""
function start_speech_synthesis_task(
OutputFormat,
OutputS3BucketName,
Text,
VoiceId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return polly(
"POST",
"/v1/synthesisTasks",
Dict{String,Any}(
"OutputFormat" => OutputFormat,
"OutputS3BucketName" => OutputS3BucketName,
"Text" => Text,
"VoiceId" => VoiceId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_speech_synthesis_task(
OutputFormat,
OutputS3BucketName,
Text,
VoiceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return polly(
"POST",
"/v1/synthesisTasks",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"OutputFormat" => OutputFormat,
"OutputS3BucketName" => OutputS3BucketName,
"Text" => Text,
"VoiceId" => VoiceId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
synthesize_speech(output_format, text, voice_id)
synthesize_speech(output_format, text, voice_id, params::Dict{String,<:Any})
Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes. SSML input must be
valid, well-formed SSML. Some alphabets might not be available with all the voices (for
example, Cyrillic might not be read at all by English voices) unless phoneme mapping is
used. For more information, see How it Works.
# Arguments
- `output_format`: The format in which the returned output will be encoded. For audio
stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json. When
pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono),
little-endian format.
- `text`: Input text to synthesize. If you specify ssml as the TextType, follow the SSML
format for the input text.
- `voice_id`: Voice ID to use for the synthesis. You can get a list of available voice IDs
by calling the DescribeVoices operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Engine"`: Specifies the engine (standard, neural, long-form, or generative) for Amazon
Polly to use when processing input text for speech synthesis. Provide an engine that is
supported by the voice you select. If you don't provide an engine, the standard engine is
selected by default. If a chosen voice isn't supported by the standard engine, this will
result in an error. For information on Amazon Polly voices and which voices are available
for each engine, see Available Voices. Type: String Valid Values: standard | neural |
long-form | generative Required: Yes
- `"LanguageCode"`: Optional language code for the Synthesize Speech request. This is only
necessary if using a bilingual voice, such as Aditi, which can be used for either Indian
English (en-IN) or Hindi (hi-IN). If a bilingual voice is used and no language code is
specified, Amazon Polly uses the default language of the bilingual voice. The default
language for any voice is the one returned by the DescribeVoices operation for the
LanguageCode parameter. For example, if no language code is specified, Aditi will use
Indian English rather than Hindi.
- `"LexiconNames"`: List of one or more pronunciation lexicon names you want the service to
apply during synthesis. Lexicons are applied only if the language of the lexicon is the
same as the language of the voice. For information about storing lexicons, see PutLexicon.
- `"SampleRate"`: The audio frequency specified in Hz. The valid values for mp3 and
ogg_vorbis are \"8000\", \"16000\", \"22050\", and \"24000\". The default value for
standard voices is \"22050\". The default value for neural voices is \"24000\". The default
value for long-form voices is \"24000\". The default value for generative voices is
\"24000\". Valid values for pcm are \"8000\" and \"16000\" The default value is \"16000\".
- `"SpeechMarkTypes"`: The type of speech marks returned for the input text.
- `"TextType"`: Specifies whether the input text is plain text or SSML. The default value
is plain text. For more information, see Using SSML.
"""
function synthesize_speech(
OutputFormat, Text, VoiceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return polly(
"POST",
"/v1/speech",
Dict{String,Any}(
"OutputFormat" => OutputFormat, "Text" => Text, "VoiceId" => VoiceId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function synthesize_speech(
OutputFormat,
Text,
VoiceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return polly(
"POST",
"/v1/speech",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"OutputFormat" => OutputFormat, "Text" => Text, "VoiceId" => VoiceId
),
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 | 10024 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: pricing
using AWS.Compat
using AWS.UUIDs
"""
describe_services()
describe_services(params::Dict{String,<:Any})
Returns the metadata for one service or a list of the metadata for all services. Use this
without a service code to get the service codes for all services. Use it with a service
code, such as AmazonEC2, to get information specific to that service, such as the attribute
names available for that service. For example, some of the attribute names available for
EC2 are volumeType, maxIopsVolume, operation, locationType, and instanceCapacity10xlarge.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FormatVersion"`: The format version that you want the response to be in. Valid values
are: aws_v1
- `"MaxResults"`: The maximum number of results that you want returned in the response.
- `"NextToken"`: The pagination token that indicates the next set of results that you want
to retrieve.
- `"ServiceCode"`: The code for the service whose information you want to retrieve, such as
AmazonEC2. You can use the ServiceCode to filter the results in a GetProducts call. To
retrieve a list of all services, leave this blank.
"""
function describe_services(; aws_config::AbstractAWSConfig=global_aws_config())
return pricing(
"DescribeServices"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_services(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return pricing(
"DescribeServices", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_attribute_values(attribute_name, service_code)
get_attribute_values(attribute_name, service_code, params::Dict{String,<:Any})
Returns a list of attribute values. Attributes are similar to the details in a Price List
API offer file. For a list of available attributes, see Offer File Definitions in the
Billing and Cost Management User Guide.
# Arguments
- `attribute_name`: The name of the attribute that you want to retrieve the values for,
such as volumeType.
- `service_code`: The service code for the service whose attributes you want to retrieve.
For example, if you want the retrieve an EC2 attribute, use AmazonEC2.
# 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 response.
- `"NextToken"`: The pagination token that indicates the next set of results that you want
to retrieve.
"""
function get_attribute_values(
AttributeName, ServiceCode; aws_config::AbstractAWSConfig=global_aws_config()
)
return pricing(
"GetAttributeValues",
Dict{String,Any}("AttributeName" => AttributeName, "ServiceCode" => ServiceCode);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_attribute_values(
AttributeName,
ServiceCode,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pricing(
"GetAttributeValues",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AttributeName" => AttributeName, "ServiceCode" => ServiceCode
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_price_list_file_url(file_format, price_list_arn)
get_price_list_file_url(file_format, price_list_arn, params::Dict{String,<:Any})
This feature is in preview release and is subject to change. Your use of Amazon Web
Services Price List API is subject to the Beta Service Participation terms of the Amazon
Web Services Service Terms (Section 1.10). This returns the URL that you can retrieve
your Price List file from. This URL is based on the PriceListArn and FileFormat that you
retrieve from the ListPriceLists response.
# Arguments
- `file_format`: The format that you want to retrieve your Price List files in. The
FileFormat can be obtained from the ListPriceLists response.
- `price_list_arn`: The unique identifier that maps to where your Price List files are
located. PriceListArn can be obtained from the ListPriceLists response.
"""
function get_price_list_file_url(
FileFormat, PriceListArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return pricing(
"GetPriceListFileUrl",
Dict{String,Any}("FileFormat" => FileFormat, "PriceListArn" => PriceListArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_price_list_file_url(
FileFormat,
PriceListArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pricing(
"GetPriceListFileUrl",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FileFormat" => FileFormat, "PriceListArn" => PriceListArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_products(service_code)
get_products(service_code, params::Dict{String,<:Any})
Returns a list of all products that match the filter criteria.
# Arguments
- `service_code`: The code for the service whose products you want to retrieve.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: The list of filters that limit the returned products. only products that
match all filters are returned.
- `"FormatVersion"`: The format version that you want the response to be in. Valid values
are: aws_v1
- `"MaxResults"`: The maximum number of results to return in the response.
- `"NextToken"`: The pagination token that indicates the next set of results that you want
to retrieve.
"""
function get_products(ServiceCode; aws_config::AbstractAWSConfig=global_aws_config())
return pricing(
"GetProducts",
Dict{String,Any}("ServiceCode" => ServiceCode);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_products(
ServiceCode,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pricing(
"GetProducts",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ServiceCode" => ServiceCode), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_price_lists(currency_code, effective_date, service_code)
list_price_lists(currency_code, effective_date, service_code, params::Dict{String,<:Any})
This feature is in preview release and is subject to change. Your use of Amazon Web
Services Price List API is subject to the Beta Service Participation terms of the Amazon
Web Services Service Terms (Section 1.10). This returns a list of Price List references
that the requester if authorized to view, given a ServiceCode, CurrencyCode, and an
EffectiveDate. Use without a RegionCode filter to list Price List references from all
available Amazon Web Services Regions. Use with a RegionCode filter to get the Price List
reference that's specific to a specific Amazon Web Services Region. You can use the
PriceListArn from the response to get your preferred Price List files through the
GetPriceListFileUrl API.
# Arguments
- `currency_code`: The three alphabetical character ISO-4217 currency code that the Price
List files are denominated in.
- `effective_date`: The date that the Price List file prices are effective from.
- `service_code`: The service code or the Savings Plan service code for the attributes that
you want to retrieve. For example, to get the list of applicable Amazon EC2 price lists,
use AmazonEC2. For a full list of service codes containing On-Demand and Reserved Instance
(RI) pricing, use the DescribeServices API. To retrieve the Reserved Instance and Compute
Savings Plan price lists, use ComputeSavingsPlans. To retrieve Machine Learning Savings
Plans price lists, use MachineLearningSavingsPlans.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to return in the response.
- `"NextToken"`: The pagination token that indicates the next set of results that you want
to retrieve.
- `"RegionCode"`: This is used to filter the Price List by Amazon Web Services Region. For
example, to get the price list only for the US East (N. Virginia) Region, use us-east-1. If
nothing is specified, you retrieve price lists for all applicable Regions. The available
RegionCode list can be retrieved from GetAttributeValues API.
"""
function list_price_lists(
CurrencyCode,
EffectiveDate,
ServiceCode;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pricing(
"ListPriceLists",
Dict{String,Any}(
"CurrencyCode" => CurrencyCode,
"EffectiveDate" => EffectiveDate,
"ServiceCode" => ServiceCode,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_price_lists(
CurrencyCode,
EffectiveDate,
ServiceCode,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return pricing(
"ListPriceLists",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CurrencyCode" => CurrencyCode,
"EffectiveDate" => EffectiveDate,
"ServiceCode" => ServiceCode,
),
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 | 36789 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: privatenetworks
using AWS.Compat
using AWS.UUIDs
"""
acknowledge_order_receipt(order_arn)
acknowledge_order_receipt(order_arn, params::Dict{String,<:Any})
Acknowledges that the specified network order was received.
# Arguments
- `order_arn`: The Amazon Resource Name (ARN) of the order.
"""
function acknowledge_order_receipt(
orderArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return privatenetworks(
"POST",
"/v1/orders/acknowledge",
Dict{String,Any}("orderArn" => orderArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function acknowledge_order_receipt(
orderArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return privatenetworks(
"POST",
"/v1/orders/acknowledge",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("orderArn" => orderArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
activate_device_identifier(device_identifier_arn)
activate_device_identifier(device_identifier_arn, params::Dict{String,<:Any})
Activates the specified device identifier.
# Arguments
- `device_identifier_arn`: The Amazon Resource Name (ARN) of the device identifier.
# 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.
"""
function activate_device_identifier(
deviceIdentifierArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return privatenetworks(
"POST",
"/v1/device-identifiers/activate",
Dict{String,Any}("deviceIdentifierArn" => deviceIdentifierArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function activate_device_identifier(
deviceIdentifierArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return privatenetworks(
"POST",
"/v1/device-identifiers/activate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("deviceIdentifierArn" => deviceIdentifierArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
activate_network_site(network_site_arn, shipping_address)
activate_network_site(network_site_arn, shipping_address, params::Dict{String,<:Any})
Activates the specified network site.
# Arguments
- `network_site_arn`: The Amazon Resource Name (ARN) of the network site.
- `shipping_address`: The shipping address of the network site.
# 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.
- `"commitmentConfiguration"`: Determines the duration and renewal status of the commitment
period for all pending radio units. If you include commitmentConfiguration in the
ActivateNetworkSiteRequest action, you must specify the following: The commitment period
for the radio unit. You can choose a 60-day, 1-year, or 3-year period. Whether you want
your commitment period to automatically renew for one more year after your current
commitment period expires. For pricing, see Amazon Web Services Private 5G Pricing. If
you do not include commitmentConfiguration in the ActivateNetworkSiteRequest action, the
commitment period is set to 60-days.
"""
function activate_network_site(
networkSiteArn, shippingAddress; aws_config::AbstractAWSConfig=global_aws_config()
)
return privatenetworks(
"POST",
"/v1/network-sites/activate",
Dict{String,Any}(
"networkSiteArn" => networkSiteArn, "shippingAddress" => shippingAddress
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function activate_network_site(
networkSiteArn,
shippingAddress,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return privatenetworks(
"POST",
"/v1/network-sites/activate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"networkSiteArn" => networkSiteArn, "shippingAddress" => shippingAddress
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
configure_access_point(access_point_arn)
configure_access_point(access_point_arn, params::Dict{String,<:Any})
Configures the specified network resource. Use this action to specify the geographic
position of the hardware. You must provide Certified Professional Installer (CPI)
credentials in the request so that we can obtain spectrum grants. For more information, see
Radio units in the Amazon Web Services Private 5G User Guide.
# Arguments
- `access_point_arn`: The Amazon Resource Name (ARN) of the network resource.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cpiSecretKey"`: A Base64 encoded string of the CPI certificate associated with the CPI
user who is certifying the coordinates of the network resource.
- `"cpiUserId"`: The CPI user ID of the CPI user who is certifying the coordinates of the
network resource.
- `"cpiUserPassword"`: The CPI password associated with the CPI certificate in cpiSecretKey.
- `"cpiUsername"`: The CPI user name of the CPI user who is certifying the coordinates of
the radio unit.
- `"position"`: The position of the network resource.
"""
function configure_access_point(
accessPointArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return privatenetworks(
"POST",
"/v1/network-resources/configure",
Dict{String,Any}("accessPointArn" => accessPointArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function configure_access_point(
accessPointArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return privatenetworks(
"POST",
"/v1/network-resources/configure",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("accessPointArn" => accessPointArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_network(network_name)
create_network(network_name, params::Dict{String,<:Any})
Creates a network.
# Arguments
- `network_name`: The name of the network. You can't change the name after you create the
network.
# 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 network.
- `"tags"`: The tags to apply to the network.
"""
function create_network(networkName; aws_config::AbstractAWSConfig=global_aws_config())
return privatenetworks(
"POST",
"/v1/networks",
Dict{String,Any}("networkName" => networkName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_network(
networkName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return privatenetworks(
"POST",
"/v1/networks",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("networkName" => networkName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_network_site(network_arn, network_site_name)
create_network_site(network_arn, network_site_name, params::Dict{String,<:Any})
Creates a network site.
# Arguments
- `network_arn`: The Amazon Resource Name (ARN) of the network.
- `network_site_name`: The name of the site. You can't change the name after you create the
site.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"availabilityZone"`: The Availability Zone that is the parent of this site. You can't
change the Availability Zone after you create the site.
- `"availabilityZoneId"`: The ID of the Availability Zone that is the parent of this site.
You can't change the Availability Zone after you create the site.
- `"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 site.
- `"pendingPlan"`: Information about the pending plan for this site.
- `"tags"`: The tags to apply to the network site.
"""
function create_network_site(
networkArn, networkSiteName; aws_config::AbstractAWSConfig=global_aws_config()
)
return privatenetworks(
"POST",
"/v1/network-sites",
Dict{String,Any}("networkArn" => networkArn, "networkSiteName" => networkSiteName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_network_site(
networkArn,
networkSiteName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return privatenetworks(
"POST",
"/v1/network-sites",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"networkArn" => networkArn, "networkSiteName" => networkSiteName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deactivate_device_identifier(device_identifier_arn)
deactivate_device_identifier(device_identifier_arn, params::Dict{String,<:Any})
Deactivates the specified device identifier.
# Arguments
- `device_identifier_arn`: The Amazon Resource Name (ARN) of the device identifier.
# 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.
"""
function deactivate_device_identifier(
deviceIdentifierArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return privatenetworks(
"POST",
"/v1/device-identifiers/deactivate",
Dict{String,Any}("deviceIdentifierArn" => deviceIdentifierArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deactivate_device_identifier(
deviceIdentifierArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return privatenetworks(
"POST",
"/v1/device-identifiers/deactivate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("deviceIdentifierArn" => deviceIdentifierArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_network(network_arn)
delete_network(network_arn, params::Dict{String,<:Any})
Deletes the specified network. You must delete network sites before you delete the network.
For more information, see DeleteNetworkSite in the API Reference for Amazon Web Services
Private 5G.
# Arguments
- `network_arn`: The Amazon Resource Name (ARN) of the network.
# 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.
"""
function delete_network(networkArn; aws_config::AbstractAWSConfig=global_aws_config())
return privatenetworks(
"DELETE",
"/v1/networks/$(networkArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_network(
networkArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return privatenetworks(
"DELETE",
"/v1/networks/$(networkArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_network_site(network_site_arn)
delete_network_site(network_site_arn, params::Dict{String,<:Any})
Deletes the specified network site. Return the hardware after you delete the network site.
You are responsible for minimum charges. For more information, see Hardware returns in the
Amazon Web Services Private 5G User Guide.
# Arguments
- `network_site_arn`: The Amazon Resource Name (ARN) of the network site.
# 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.
"""
function delete_network_site(
networkSiteArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return privatenetworks(
"DELETE",
"/v1/network-sites/$(networkSiteArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_network_site(
networkSiteArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return privatenetworks(
"DELETE",
"/v1/network-sites/$(networkSiteArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_device_identifier(device_identifier_arn)
get_device_identifier(device_identifier_arn, params::Dict{String,<:Any})
Gets the specified device identifier.
# Arguments
- `device_identifier_arn`: The Amazon Resource Name (ARN) of the device identifier.
"""
function get_device_identifier(
deviceIdentifierArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return privatenetworks(
"GET",
"/v1/device-identifiers/$(deviceIdentifierArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_device_identifier(
deviceIdentifierArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return privatenetworks(
"GET",
"/v1/device-identifiers/$(deviceIdentifierArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_network(network_arn)
get_network(network_arn, params::Dict{String,<:Any})
Gets the specified network.
# Arguments
- `network_arn`: The Amazon Resource Name (ARN) of the network.
"""
function get_network(networkArn; aws_config::AbstractAWSConfig=global_aws_config())
return privatenetworks(
"GET",
"/v1/networks/$(networkArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_network(
networkArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return privatenetworks(
"GET",
"/v1/networks/$(networkArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_network_resource(network_resource_arn)
get_network_resource(network_resource_arn, params::Dict{String,<:Any})
Gets the specified network resource.
# Arguments
- `network_resource_arn`: The Amazon Resource Name (ARN) of the network resource.
"""
function get_network_resource(
networkResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return privatenetworks(
"GET",
"/v1/network-resources/$(networkResourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_network_resource(
networkResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return privatenetworks(
"GET",
"/v1/network-resources/$(networkResourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_network_site(network_site_arn)
get_network_site(network_site_arn, params::Dict{String,<:Any})
Gets the specified network site.
# Arguments
- `network_site_arn`: The Amazon Resource Name (ARN) of the network site.
"""
function get_network_site(networkSiteArn; aws_config::AbstractAWSConfig=global_aws_config())
return privatenetworks(
"GET",
"/v1/network-sites/$(networkSiteArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_network_site(
networkSiteArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return privatenetworks(
"GET",
"/v1/network-sites/$(networkSiteArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_order(order_arn)
get_order(order_arn, params::Dict{String,<:Any})
Gets the specified order.
# Arguments
- `order_arn`: The Amazon Resource Name (ARN) of the order.
"""
function get_order(orderArn; aws_config::AbstractAWSConfig=global_aws_config())
return privatenetworks(
"GET",
"/v1/orders/$(orderArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_order(
orderArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return privatenetworks(
"GET",
"/v1/orders/$(orderArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_device_identifiers(network_arn)
list_device_identifiers(network_arn, params::Dict{String,<:Any})
Lists device identifiers. Add filters to your request to return a more specific list of
results. Use filters to match the Amazon Resource Name (ARN) of an order, the status of
device identifiers, or the ARN of the traffic group. If you specify multiple filters,
filters are joined with an OR, and the request returns results that match all of the
specified filters.
# Arguments
- `network_arn`: The Amazon Resource Name (ARN) of the network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: The filters. ORDER - The Amazon Resource Name (ARN) of the order.
STATUS - The status (ACTIVE | INACTIVE). TRAFFIC_GROUP - The Amazon Resource Name (ARN)
of the traffic group. Filter values are case sensitive. If you specify multiple values
for a filter, the values are joined with an OR, and the request returns all results that
match any of the specified values.
- `"maxResults"`: The maximum number of results to return.
- `"startToken"`: The token for the next page of results.
"""
function list_device_identifiers(
networkArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return privatenetworks(
"POST",
"/v1/device-identifiers/list",
Dict{String,Any}("networkArn" => networkArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_device_identifiers(
networkArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return privatenetworks(
"POST",
"/v1/device-identifiers/list",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("networkArn" => networkArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_network_resources(network_arn)
list_network_resources(network_arn, params::Dict{String,<:Any})
Lists network resources. Add filters to your request to return a more specific list of
results. Use filters to match the Amazon Resource Name (ARN) of an order or the status of
network resources. If you specify multiple filters, filters are joined with an OR, and the
request returns results that match all of the specified filters.
# Arguments
- `network_arn`: The Amazon Resource Name (ARN) of the network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: The filters. ORDER - The Amazon Resource Name (ARN) of the order.
STATUS - The status (AVAILABLE | DELETED | DELETING | PENDING | PENDING_RETURN |
PROVISIONING | SHIPPED). Filter values are case sensitive. If you specify multiple values
for a filter, the values are joined with an OR, and the request returns all results that
match any of the specified values.
- `"maxResults"`: The maximum number of results to return.
- `"startToken"`: The token for the next page of results.
"""
function list_network_resources(
networkArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return privatenetworks(
"POST",
"/v1/network-resources",
Dict{String,Any}("networkArn" => networkArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_network_resources(
networkArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return privatenetworks(
"POST",
"/v1/network-resources",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("networkArn" => networkArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_network_sites(network_arn)
list_network_sites(network_arn, params::Dict{String,<:Any})
Lists network sites. Add filters to your request to return a more specific list of results.
Use filters to match the status of the network site.
# Arguments
- `network_arn`: The Amazon Resource Name (ARN) of the network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: The filters. Add filters to your request to return a more specific list of
results. Use filters to match the status of the network sites. STATUS - The status
(AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING). Filter values are case
sensitive. If you specify multiple values for a filter, the values are joined with an OR,
and the request returns all results that match any of the specified values.
- `"maxResults"`: The maximum number of results to return.
- `"startToken"`: The token for the next page of results.
"""
function list_network_sites(networkArn; aws_config::AbstractAWSConfig=global_aws_config())
return privatenetworks(
"POST",
"/v1/network-sites/list",
Dict{String,Any}("networkArn" => networkArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_network_sites(
networkArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return privatenetworks(
"POST",
"/v1/network-sites/list",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("networkArn" => networkArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_networks()
list_networks(params::Dict{String,<:Any})
Lists networks. Add filters to your request to return a more specific list of results. Use
filters to match the status of the network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: The filters. STATUS - The status (AVAILABLE | CREATED | DELETED |
DEPROVISIONING | PROVISIONING). Filter values are case sensitive. If you specify multiple
values for a filter, the values are joined with an OR, and the request returns all results
that match any of the specified values.
- `"maxResults"`: The maximum number of results to return.
- `"startToken"`: The token for the next page of results.
"""
function list_networks(; aws_config::AbstractAWSConfig=global_aws_config())
return privatenetworks(
"POST", "/v1/networks/list"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_networks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return privatenetworks(
"POST",
"/v1/networks/list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_orders(network_arn)
list_orders(network_arn, params::Dict{String,<:Any})
Lists orders. Add filters to your request to return a more specific list of results. Use
filters to match the Amazon Resource Name (ARN) of the network site or the status of the
order. If you specify multiple filters, filters are joined with an OR, and the request
returns results that match all of the specified filters.
# Arguments
- `network_arn`: The Amazon Resource Name (ARN) of the network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: The filters. NETWORK_SITE - The Amazon Resource Name (ARN) of the network
site. STATUS - The status (ACKNOWLEDGING | ACKNOWLEDGED | UNACKNOWLEDGED). Filter
values are case sensitive. If you specify multiple values for a filter, the values are
joined with an OR, and the request returns all results that match any of the specified
values.
- `"maxResults"`: The maximum number of results to return.
- `"startToken"`: The token for the next page of results.
"""
function list_orders(networkArn; aws_config::AbstractAWSConfig=global_aws_config())
return privatenetworks(
"POST",
"/v1/orders/list",
Dict{String,Any}("networkArn" => networkArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_orders(
networkArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return privatenetworks(
"POST",
"/v1/orders/list",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("networkArn" => networkArn), 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 privatenetworks(
"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 privatenetworks(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
ping()
ping(params::Dict{String,<:Any})
Checks the health of the service.
"""
function ping(; aws_config::AbstractAWSConfig=global_aws_config())
return privatenetworks(
"GET", "/ping"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function ping(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return privatenetworks(
"GET", "/ping", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
start_network_resource_update(network_resource_arn, update_type)
start_network_resource_update(network_resource_arn, update_type, params::Dict{String,<:Any})
Use this action to do the following tasks: Update the duration and renewal status of the
commitment period for a radio unit. The update goes into effect immediately. Request a
replacement for a network resource. Request that you return a network resource. After
you submit a request to replace or return a network resource, the status of the network
resource changes to CREATING_SHIPPING_LABEL. The shipping label is available when the
status of the network resource is PENDING_RETURN. After the network resource is
successfully returned, its status changes to DELETED. For more information, see Return a
radio unit.
# Arguments
- `network_resource_arn`: The Amazon Resource Name (ARN) of the network resource.
- `update_type`: The update type. REPLACE - Submits a request to replace a defective
radio unit. We provide a shipping label that you can use for the return process and we ship
a replacement radio unit to you. RETURN - Submits a request to return a radio unit that
you no longer need. We provide a shipping label that you can use for the return process.
COMMITMENT - Submits a request to change or renew the commitment period. If you choose this
value, then you must set commitmentConfiguration .
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"commitmentConfiguration"`: Use this action to extend and automatically renew the
commitment period for the radio unit. You can do the following: Change a 60-day
commitment to a 1-year or 3-year commitment. The change is immediate and the hourly rate
decreases to the rate for the new commitment period. Change a 1-year commitment to a
3-year commitment. The change is immediate and the hourly rate decreases to the rate for
the 3-year commitment period. Set a 1-year commitment to automatically renew for an
additional 1 year. The hourly rate for the additional year will continue to be the same as
your existing 1-year rate. Set a 3-year commitment to automatically renew for an
additional 1 year. The hourly rate for the additional year will continue to be the same as
your existing 3-year rate. Turn off a previously-enabled automatic renewal on a 1-year or
3-year commitment. You cannot use the automatic-renewal option for a 60-day commitment.
For pricing, see Amazon Web Services Private 5G Pricing.
- `"returnReason"`: The reason for the return. Providing a reason for a return is optional.
- `"shippingAddress"`: The shipping address. If you don't provide a shipping address when
replacing or returning a network resource, we use the address from the original order for
the network resource.
"""
function start_network_resource_update(
networkResourceArn, updateType; aws_config::AbstractAWSConfig=global_aws_config()
)
return privatenetworks(
"POST",
"/v1/network-resources/update",
Dict{String,Any}(
"networkResourceArn" => networkResourceArn, "updateType" => updateType
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_network_resource_update(
networkResourceArn,
updateType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return privatenetworks(
"POST",
"/v1/network-resources/update",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"networkResourceArn" => networkResourceArn, "updateType" => updateType
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds tags to the specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
- `tags`: The tags to add to the resource.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return privatenetworks(
"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 privatenetworks(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tags" => tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes tags from the specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
- `tag_keys`: The tag keys.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return privatenetworks(
"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 privatenetworks(
"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_network_site(network_site_arn)
update_network_site(network_site_arn, params::Dict{String,<:Any})
Updates the specified network site.
# Arguments
- `network_site_arn`: The Amazon Resource Name (ARN) of the network site.
# 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.
"""
function update_network_site(
networkSiteArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return privatenetworks(
"PUT",
"/v1/network-sites/site",
Dict{String,Any}("networkSiteArn" => networkSiteArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_network_site(
networkSiteArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return privatenetworks(
"PUT",
"/v1/network-sites/site",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("networkSiteArn" => networkSiteArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_network_site_plan(network_site_arn, pending_plan)
update_network_site_plan(network_site_arn, pending_plan, params::Dict{String,<:Any})
Updates the specified network site plan.
# Arguments
- `network_site_arn`: The Amazon Resource Name (ARN) of the network site.
- `pending_plan`: The pending plan.
# 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.
"""
function update_network_site_plan(
networkSiteArn, pendingPlan; aws_config::AbstractAWSConfig=global_aws_config()
)
return privatenetworks(
"PUT",
"/v1/network-sites/plan",
Dict{String,Any}("networkSiteArn" => networkSiteArn, "pendingPlan" => pendingPlan);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_network_site_plan(
networkSiteArn,
pendingPlan,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return privatenetworks(
"PUT",
"/v1/network-sites/plan",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"networkSiteArn" => networkSiteArn, "pendingPlan" => pendingPlan
),
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 | 148541 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: proton
using AWS.Compat
using AWS.UUIDs
"""
accept_environment_account_connection(id)
accept_environment_account_connection(id, params::Dict{String,<:Any})
In a management account, an environment account connection request is accepted. When the
environment account connection request is accepted, Proton can use the associated IAM role
to provision environment infrastructure resources in the associated environment account.
For more information, see Environment account connections in the Proton User guide.
# Arguments
- `id`: The ID of the environment account connection.
"""
function accept_environment_account_connection(
id; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"AcceptEnvironmentAccountConnection",
Dict{String,Any}("id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function accept_environment_account_connection(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"AcceptEnvironmentAccountConnection",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("id" => id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_component_deployment(component_name)
cancel_component_deployment(component_name, params::Dict{String,<:Any})
Attempts to cancel a component deployment (for a component that is in the IN_PROGRESS
deployment status). For more information about components, see Proton components in the
Proton User Guide.
# Arguments
- `component_name`: The name of the component with the deployment to cancel.
"""
function cancel_component_deployment(
componentName; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"CancelComponentDeployment",
Dict{String,Any}("componentName" => componentName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_component_deployment(
componentName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"CancelComponentDeployment",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("componentName" => componentName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_environment_deployment(environment_name)
cancel_environment_deployment(environment_name, params::Dict{String,<:Any})
Attempts to cancel an environment deployment on an UpdateEnvironment action, if the
deployment is IN_PROGRESS. For more information, see Update an environment in the Proton
User guide. The following list includes potential cancellation scenarios. If the
cancellation attempt succeeds, the resulting deployment state is CANCELLED. If the
cancellation attempt fails, the resulting deployment state is FAILED. If the current
UpdateEnvironment action succeeds before the cancellation attempt starts, the resulting
deployment state is SUCCEEDED and the cancellation attempt has no effect.
# Arguments
- `environment_name`: The name of the environment with the deployment to cancel.
"""
function cancel_environment_deployment(
environmentName; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"CancelEnvironmentDeployment",
Dict{String,Any}("environmentName" => environmentName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_environment_deployment(
environmentName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"CancelEnvironmentDeployment",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("environmentName" => environmentName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_service_instance_deployment(service_instance_name, service_name)
cancel_service_instance_deployment(service_instance_name, service_name, params::Dict{String,<:Any})
Attempts to cancel a service instance deployment on an UpdateServiceInstance action, if the
deployment is IN_PROGRESS. For more information, see Update a service instance in the
Proton User guide. The following list includes potential cancellation scenarios. If the
cancellation attempt succeeds, the resulting deployment state is CANCELLED. If the
cancellation attempt fails, the resulting deployment state is FAILED. If the current
UpdateServiceInstance action succeeds before the cancellation attempt starts, the resulting
deployment state is SUCCEEDED and the cancellation attempt has no effect.
# Arguments
- `service_instance_name`: The name of the service instance with the deployment to cancel.
- `service_name`: The name of the service with the service instance deployment to cancel.
"""
function cancel_service_instance_deployment(
serviceInstanceName, serviceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"CancelServiceInstanceDeployment",
Dict{String,Any}(
"serviceInstanceName" => serviceInstanceName, "serviceName" => serviceName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_service_instance_deployment(
serviceInstanceName,
serviceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"CancelServiceInstanceDeployment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"serviceInstanceName" => serviceInstanceName,
"serviceName" => serviceName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_service_pipeline_deployment(service_name)
cancel_service_pipeline_deployment(service_name, params::Dict{String,<:Any})
Attempts to cancel a service pipeline deployment on an UpdateServicePipeline action, if the
deployment is IN_PROGRESS. For more information, see Update a service pipeline in the
Proton User guide. The following list includes potential cancellation scenarios. If the
cancellation attempt succeeds, the resulting deployment state is CANCELLED. If the
cancellation attempt fails, the resulting deployment state is FAILED. If the current
UpdateServicePipeline action succeeds before the cancellation attempt starts, the resulting
deployment state is SUCCEEDED and the cancellation attempt has no effect.
# Arguments
- `service_name`: The name of the service with the service pipeline deployment to cancel.
"""
function cancel_service_pipeline_deployment(
serviceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"CancelServicePipelineDeployment",
Dict{String,Any}("serviceName" => serviceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_service_pipeline_deployment(
serviceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"CancelServicePipelineDeployment",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("serviceName" => serviceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_component(manifest, name, template_file)
create_component(manifest, name, template_file, params::Dict{String,<:Any})
Create an Proton component. A component is an infrastructure extension for a service
instance. For more information about components, see Proton components in the Proton User
Guide.
# Arguments
- `manifest`: A path to a manifest file that lists the Infrastructure as Code (IaC) file,
template language, and rendering engine for infrastructure that a custom component
provisions.
- `name`: The customer-provided name of the component.
- `template_file`: A path to the Infrastructure as Code (IaC) file describing
infrastructure that a custom component provisions. Components support a single IaC file,
even if you use Terraform as your template language.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: The client token for the created component.
- `"description"`: An optional customer-provided description of the component.
- `"environmentName"`: The name of the Proton environment that you want to associate this
component with. You must specify this when you don't specify serviceInstanceName and
serviceName.
- `"serviceInstanceName"`: The name of the service instance that you want to attach this
component to. If you don't specify this, the component isn't attached to any service
instance. Specify both serviceInstanceName and serviceName or neither of them.
- `"serviceName"`: The name of the service that serviceInstanceName is associated with. If
you don't specify this, the component isn't attached to any service instance. Specify both
serviceInstanceName and serviceName or neither of them.
- `"serviceSpec"`: The service spec that you want the component to use to access service
inputs. Set this only when you attach the component to a service instance.
- `"tags"`: An optional list of metadata items that you can associate with the Proton
component. A tag is a key-value pair. For more information, see Proton resources and
tagging in the Proton User Guide.
"""
function create_component(
manifest, name, templateFile; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"CreateComponent",
Dict{String,Any}(
"manifest" => manifest,
"name" => name,
"templateFile" => templateFile,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_component(
manifest,
name,
templateFile,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"CreateComponent",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"manifest" => manifest,
"name" => name,
"templateFile" => templateFile,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_environment(name, spec, template_major_version, template_name)
create_environment(name, spec, template_major_version, template_name, params::Dict{String,<:Any})
Deploy a new environment. An Proton environment is created from an environment template
that defines infrastructure and resources that can be shared across services. You can
provision environments using the following methods: Amazon Web Services-managed
provisioning: Proton makes direct calls to provision your resources. Self-managed
provisioning: Proton makes pull requests on your repository to provide compiled
infrastructure as code (IaC) files that your IaC engine uses to provision resources. For
more information, see Environments and Provisioning methods in the Proton User Guide.
# Arguments
- `name`: The name of the environment.
- `spec`: A YAML formatted string that provides inputs as defined in the environment
template bundle schema file. For more information, see Environments in the Proton User
Guide.
- `template_major_version`: The major version of the environment template.
- `template_name`: The name of the environment template. For more information, see
Environment Templates in the Proton User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"codebuildRoleArn"`: The Amazon Resource Name (ARN) of the IAM service role that allows
Proton to provision infrastructure using CodeBuild-based provisioning on your behalf. To
use CodeBuild-based provisioning for the environment or for any service instance running in
the environment, specify either the environmentAccountConnectionId or codebuildRoleArn
parameter.
- `"componentRoleArn"`: The Amazon Resource Name (ARN) of the IAM service role that Proton
uses when provisioning directly defined components in this environment. It determines the
scope of infrastructure that a component can provision. You must specify componentRoleArn
to allow directly defined components to be associated with this environment. For more
information about components, see Proton components in the Proton User Guide.
- `"description"`: A description of the environment that's being created and deployed.
- `"environmentAccountConnectionId"`: The ID of the environment account connection that you
provide if you're provisioning your environment infrastructure resources to an environment
account. For more information, see Environment account connections in the Proton User
guide. To use Amazon Web Services-managed provisioning for the environment, specify either
the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the
provisioningRepository parameter.
- `"protonServiceRoleArn"`: The Amazon Resource Name (ARN) of the Proton service role that
allows Proton to make calls to other services on your behalf. To use Amazon Web
Services-managed provisioning for the environment, specify either the
environmentAccountConnectionId or protonServiceRoleArn parameter and omit the
provisioningRepository parameter.
- `"provisioningRepository"`: The linked repository that you use to host your rendered
infrastructure templates for self-managed provisioning. A linked repository is a repository
that has been registered with Proton. For more information, see CreateRepository. To use
self-managed provisioning for the environment, specify this parameter and omit the
environmentAccountConnectionId and protonServiceRoleArn parameters.
- `"tags"`: An optional list of metadata items that you can associate with the Proton
environment. A tag is a key-value pair. For more information, see Proton resources and
tagging in the Proton User Guide.
- `"templateMinorVersion"`: The minor version of the environment template.
"""
function create_environment(
name,
spec,
templateMajorVersion,
templateName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"CreateEnvironment",
Dict{String,Any}(
"name" => name,
"spec" => spec,
"templateMajorVersion" => templateMajorVersion,
"templateName" => templateName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_environment(
name,
spec,
templateMajorVersion,
templateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"CreateEnvironment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name,
"spec" => spec,
"templateMajorVersion" => templateMajorVersion,
"templateName" => templateName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_environment_account_connection(environment_name, management_account_id)
create_environment_account_connection(environment_name, management_account_id, params::Dict{String,<:Any})
Create an environment account connection in an environment account so that environment
infrastructure resources can be provisioned in the environment account from a management
account. An environment account connection is a secure bi-directional connection between a
management account and an environment account that maintains authorization and permissions.
For more information, see Environment account connections in the Proton User guide.
# Arguments
- `environment_name`: The name of the Proton environment that's created in the associated
management account.
- `management_account_id`: The ID of the management account that accepts or rejects the
environment account connection. You create and manage the Proton environment in this
account. If the management account accepts the environment account connection, Proton can
use the associated IAM role to provision environment infrastructure resources in the
associated environment account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: When included, if two identical requests are made with the same client
token, Proton returns the environment account connection that the first request created.
- `"codebuildRoleArn"`: The Amazon Resource Name (ARN) of an IAM service role in the
environment account. Proton uses this role to provision infrastructure resources using
CodeBuild-based provisioning in the associated environment account.
- `"componentRoleArn"`: The Amazon Resource Name (ARN) of the IAM service role that Proton
uses when provisioning directly defined components in the associated environment account.
It determines the scope of infrastructure that a component can provision in the account.
You must specify componentRoleArn to allow directly defined components to be associated
with any environments running in this account. For more information about components, see
Proton components in the Proton User Guide.
- `"roleArn"`: The Amazon Resource Name (ARN) of the IAM service role that's created in the
environment account. Proton uses this role to provision infrastructure resources in the
associated environment account.
- `"tags"`: An optional list of metadata items that you can associate with the Proton
environment account connection. A tag is a key-value pair. For more information, see Proton
resources and tagging in the Proton User Guide.
"""
function create_environment_account_connection(
environmentName, managementAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"CreateEnvironmentAccountConnection",
Dict{String,Any}(
"environmentName" => environmentName,
"managementAccountId" => managementAccountId,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_environment_account_connection(
environmentName,
managementAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"CreateEnvironmentAccountConnection",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"environmentName" => environmentName,
"managementAccountId" => managementAccountId,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_environment_template(name)
create_environment_template(name, params::Dict{String,<:Any})
Create an environment template for Proton. For more information, see Environment Templates
in the Proton User Guide. You can create an environment template in one of the two
following ways: Register and publish a standard environment template that instructs
Proton to deploy and manage environment infrastructure. Register and publish a customer
managed environment template that connects Proton to your existing provisioned
infrastructure that you manage. Proton doesn't manage your existing provisioned
infrastructure. To create an environment template for customer provisioned and managed
infrastructure, include the provisioning parameter and set the value to CUSTOMER_MANAGED.
For more information, see Register and publish an environment template in the Proton User
Guide.
# Arguments
- `name`: The name of the environment template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A description of the environment template.
- `"displayName"`: The environment template name as displayed in the developer interface.
- `"encryptionKey"`: A customer provided encryption key that Proton uses to encrypt data.
- `"provisioning"`: When included, indicates that the environment template is for customer
provisioned and managed infrastructure.
- `"tags"`: An optional list of metadata items that you can associate with the Proton
environment template. A tag is a key-value pair. For more information, see Proton resources
and tagging in the Proton User Guide.
"""
function create_environment_template(
name; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"CreateEnvironmentTemplate",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_environment_template(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"CreateEnvironmentTemplate",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_environment_template_version(source, template_name)
create_environment_template_version(source, template_name, params::Dict{String,<:Any})
Create a new major or minor version of an environment template. A major version of an
environment template is a version that isn't backwards compatible. A minor version of an
environment template is a version that's backwards compatible within its major version.
# Arguments
- `source`: An object that includes the template bundle S3 bucket path and name for the new
version of an template.
- `template_name`: The name of the environment template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: When included, if two identical requests are made with the same client
token, Proton returns the environment template version that the first request created.
- `"description"`: A description of the new version of an environment template.
- `"majorVersion"`: To create a new minor version of the environment template, include
major Version. To create a new major and minor version of the environment template, exclude
major Version.
- `"tags"`: An optional list of metadata items that you can associate with the Proton
environment template version. A tag is a key-value pair. For more information, see Proton
resources and tagging in the Proton User Guide.
"""
function create_environment_template_version(
source, templateName; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"CreateEnvironmentTemplateVersion",
Dict{String,Any}(
"source" => source,
"templateName" => templateName,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_environment_template_version(
source,
templateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"CreateEnvironmentTemplateVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"source" => source,
"templateName" => templateName,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_repository(connection_arn, name, provider)
create_repository(connection_arn, name, provider, params::Dict{String,<:Any})
Create and register a link to a repository. Proton uses the link to repeatedly access the
repository, to either push to it (self-managed provisioning) or pull from it (template
sync). You can share a linked repository across multiple resources (like environments using
self-managed provisioning, or synced templates). When you create a repository link, Proton
creates a service-linked role for you. For more information, see Self-managed provisioning,
Template bundles, and Template sync configurations in the Proton User Guide.
# Arguments
- `connection_arn`: The Amazon Resource Name (ARN) of your AWS CodeStar connection that
connects Proton to your repository provider account. For more information, see Setting up
for Proton in the Proton User Guide.
- `name`: The repository name (for example, myrepos/myrepo).
- `provider`: The repository provider.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"encryptionKey"`: The ARN of your customer Amazon Web Services Key Management Service
(Amazon Web Services KMS) key.
- `"tags"`: An optional list of metadata items that you can associate with the Proton
repository. A tag is a key-value pair. For more information, see Proton resources and
tagging in the Proton User Guide.
"""
function create_repository(
connectionArn, name, provider; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"CreateRepository",
Dict{String,Any}(
"connectionArn" => connectionArn, "name" => name, "provider" => provider
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_repository(
connectionArn,
name,
provider,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"CreateRepository",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"connectionArn" => connectionArn, "name" => name, "provider" => provider
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_service(name, spec, template_major_version, template_name)
create_service(name, spec, template_major_version, template_name, params::Dict{String,<:Any})
Create an Proton service. An Proton service is an instantiation of a service template and
often includes several service instances and pipeline. For more information, see Services
in the Proton User Guide.
# Arguments
- `name`: The service name.
- `spec`: A link to a spec file that provides inputs as defined in the service template
bundle schema file. The spec file is in YAML format. Don’t include pipeline inputs in the
spec if your service template doesn’t include a service pipeline. For more information,
see Create a service in the Proton User Guide.
- `template_major_version`: The major version of the service template that was used to
create the service.
- `template_name`: The name of the service template that's used to create the service.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"branchName"`: The name of the code repository branch that holds the code that's
deployed in Proton. Don't include this parameter if your service template doesn't include a
service pipeline.
- `"description"`: A description of the Proton service.
- `"repositoryConnectionArn"`: The Amazon Resource Name (ARN) of the repository connection.
For more information, see Setting up an AWS CodeStar connection in the Proton User Guide.
Don't include this parameter if your service template doesn't include a service pipeline.
- `"repositoryId"`: The ID of the code repository. Don't include this parameter if your
service template doesn't include a service pipeline.
- `"tags"`: An optional list of metadata items that you can associate with the Proton
service. A tag is a key-value pair. For more information, see Proton resources and tagging
in the Proton User Guide.
- `"templateMinorVersion"`: The minor version of the service template that was used to
create the service.
"""
function create_service(
name,
spec,
templateMajorVersion,
templateName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"CreateService",
Dict{String,Any}(
"name" => name,
"spec" => spec,
"templateMajorVersion" => templateMajorVersion,
"templateName" => templateName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_service(
name,
spec,
templateMajorVersion,
templateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"CreateService",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name,
"spec" => spec,
"templateMajorVersion" => templateMajorVersion,
"templateName" => templateName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_service_instance(name, service_name, spec)
create_service_instance(name, service_name, spec, params::Dict{String,<:Any})
Create a service instance.
# Arguments
- `name`: The name of the service instance to create.
- `service_name`: The name of the service the service instance is added to.
- `spec`: The spec for the service instance you want to create.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: The client token of the service instance to create.
- `"tags"`: An optional list of metadata items that you can associate with the Proton
service instance. A tag is a key-value pair. For more information, see Proton resources and
tagging in the Proton User Guide.
- `"templateMajorVersion"`: To create a new major and minor version of the service
template, exclude major Version.
- `"templateMinorVersion"`: To create a new minor version of the service template, include
a major Version.
"""
function create_service_instance(
name, serviceName, spec; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"CreateServiceInstance",
Dict{String,Any}(
"name" => name,
"serviceName" => serviceName,
"spec" => spec,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_service_instance(
name,
serviceName,
spec,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"CreateServiceInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name,
"serviceName" => serviceName,
"spec" => spec,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_service_sync_config(branch, file_path, repository_name, repository_provider, service_name)
create_service_sync_config(branch, file_path, repository_name, repository_provider, service_name, params::Dict{String,<:Any})
Create the Proton Ops configuration file.
# Arguments
- `branch`: The repository branch for your Proton Ops file.
- `file_path`: The path to the Proton Ops file.
- `repository_name`: The repository name.
- `repository_provider`: The provider type for your repository.
- `service_name`: The name of the service the Proton Ops file is for.
"""
function create_service_sync_config(
branch,
filePath,
repositoryName,
repositoryProvider,
serviceName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"CreateServiceSyncConfig",
Dict{String,Any}(
"branch" => branch,
"filePath" => filePath,
"repositoryName" => repositoryName,
"repositoryProvider" => repositoryProvider,
"serviceName" => serviceName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_service_sync_config(
branch,
filePath,
repositoryName,
repositoryProvider,
serviceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"CreateServiceSyncConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"branch" => branch,
"filePath" => filePath,
"repositoryName" => repositoryName,
"repositoryProvider" => repositoryProvider,
"serviceName" => serviceName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_service_template(name)
create_service_template(name, params::Dict{String,<:Any})
Create a service template. The administrator creates a service template to define
standardized infrastructure and an optional CI/CD service pipeline. Developers, in turn,
select the service template from Proton. If the selected service template includes a
service pipeline definition, they provide a link to their source code repository. Proton
then deploys and manages the infrastructure defined by the selected service template. For
more information, see Proton templates in the Proton User Guide.
# Arguments
- `name`: The name of the service template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A description of the service template.
- `"displayName"`: The name of the service template as displayed in the developer interface.
- `"encryptionKey"`: A customer provided encryption key that's used to encrypt data.
- `"pipelineProvisioning"`: By default, Proton provides a service pipeline for your
service. When this parameter is included, it indicates that an Proton service pipeline
isn't provided for your service. After it's included, it can't be changed. For more
information, see Template bundles in the Proton User Guide.
- `"tags"`: An optional list of metadata items that you can associate with the Proton
service template. A tag is a key-value pair. For more information, see Proton resources and
tagging in the Proton User Guide.
"""
function create_service_template(name; aws_config::AbstractAWSConfig=global_aws_config())
return proton(
"CreateServiceTemplate",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_service_template(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"CreateServiceTemplate",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_service_template_version(compatible_environment_templates, source, template_name)
create_service_template_version(compatible_environment_templates, source, template_name, params::Dict{String,<:Any})
Create a new major or minor version of a service template. A major version of a service
template is a version that isn't backward compatible. A minor version of a service template
is a version that's backward compatible within its major version.
# Arguments
- `compatible_environment_templates`: An array of environment template objects that are
compatible with the new service template version. A service instance based on this service
template version can run in environments based on compatible templates.
- `source`: An object that includes the template bundle S3 bucket path and name for the new
version of a service template.
- `template_name`: The name of the service template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: When included, if two identical requests are made with the same client
token, Proton returns the service template version that the first request created.
- `"description"`: A description of the new version of a service template.
- `"majorVersion"`: To create a new minor version of the service template, include a major
Version. To create a new major and minor version of the service template, exclude major
Version.
- `"supportedComponentSources"`: An array of supported component sources. Components with
supported sources can be attached to service instances based on this service template
version. For more information about components, see Proton components in the Proton User
Guide.
- `"tags"`: An optional list of metadata items that you can associate with the Proton
service template version. A tag is a key-value pair. For more information, see Proton
resources and tagging in the Proton User Guide.
"""
function create_service_template_version(
compatibleEnvironmentTemplates,
source,
templateName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"CreateServiceTemplateVersion",
Dict{String,Any}(
"compatibleEnvironmentTemplates" => compatibleEnvironmentTemplates,
"source" => source,
"templateName" => templateName,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_service_template_version(
compatibleEnvironmentTemplates,
source,
templateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"CreateServiceTemplateVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"compatibleEnvironmentTemplates" => compatibleEnvironmentTemplates,
"source" => source,
"templateName" => templateName,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_template_sync_config(branch, repository_name, repository_provider, template_name, template_type)
create_template_sync_config(branch, repository_name, repository_provider, template_name, template_type, params::Dict{String,<:Any})
Set up a template to create new template versions automatically by tracking a linked
repository. A linked repository is a repository that has been registered with Proton. For
more information, see CreateRepository. When a commit is pushed to your linked repository,
Proton checks for changes to your repository template bundles. If it detects a template
bundle change, a new major or minor version of its template is created, if the version
doesn’t already exist. For more information, see Template sync configurations in the
Proton User Guide.
# Arguments
- `branch`: The repository branch for your template.
- `repository_name`: The repository name (for example, myrepos/myrepo).
- `repository_provider`: The provider type for your repository.
- `template_name`: The name of your registered template.
- `template_type`: The type of the registered template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"subdirectory"`: A repository subdirectory path to your template bundle directory. When
included, Proton limits the template bundle search to this repository directory.
"""
function create_template_sync_config(
branch,
repositoryName,
repositoryProvider,
templateName,
templateType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"CreateTemplateSyncConfig",
Dict{String,Any}(
"branch" => branch,
"repositoryName" => repositoryName,
"repositoryProvider" => repositoryProvider,
"templateName" => templateName,
"templateType" => templateType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_template_sync_config(
branch,
repositoryName,
repositoryProvider,
templateName,
templateType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"CreateTemplateSyncConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"branch" => branch,
"repositoryName" => repositoryName,
"repositoryProvider" => repositoryProvider,
"templateName" => templateName,
"templateType" => templateType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_component(name)
delete_component(name, params::Dict{String,<:Any})
Delete an Proton component resource. For more information about components, see Proton
components in the Proton User Guide.
# Arguments
- `name`: The name of the component to delete.
"""
function delete_component(name; aws_config::AbstractAWSConfig=global_aws_config())
return proton(
"DeleteComponent",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_component(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"DeleteComponent",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_deployment(id)
delete_deployment(id, params::Dict{String,<:Any})
Delete the deployment.
# Arguments
- `id`: The ID of the deployment to delete.
"""
function delete_deployment(id; aws_config::AbstractAWSConfig=global_aws_config())
return proton(
"DeleteDeployment",
Dict{String,Any}("id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_deployment(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"DeleteDeployment",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("id" => id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_environment(name)
delete_environment(name, params::Dict{String,<:Any})
Delete an environment.
# Arguments
- `name`: The name of the environment to delete.
"""
function delete_environment(name; aws_config::AbstractAWSConfig=global_aws_config())
return proton(
"DeleteEnvironment",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_environment(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"DeleteEnvironment",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_environment_account_connection(id)
delete_environment_account_connection(id, params::Dict{String,<:Any})
In an environment account, delete an environment account connection. After you delete an
environment account connection that’s in use by an Proton environment, Proton can’t
manage the environment infrastructure resources until a new environment account connection
is accepted for the environment account and associated environment. You're responsible for
cleaning up provisioned resources that remain without an environment connection. For more
information, see Environment account connections in the Proton User guide.
# Arguments
- `id`: The ID of the environment account connection to delete.
"""
function delete_environment_account_connection(
id; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"DeleteEnvironmentAccountConnection",
Dict{String,Any}("id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_environment_account_connection(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"DeleteEnvironmentAccountConnection",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("id" => id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_environment_template(name)
delete_environment_template(name, params::Dict{String,<:Any})
If no other major or minor versions of an environment template exist, delete the
environment template.
# Arguments
- `name`: The name of the environment template to delete.
"""
function delete_environment_template(
name; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"DeleteEnvironmentTemplate",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_environment_template(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"DeleteEnvironmentTemplate",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_environment_template_version(major_version, minor_version, template_name)
delete_environment_template_version(major_version, minor_version, template_name, params::Dict{String,<:Any})
If no other minor versions of an environment template exist, delete a major version of the
environment template if it's not the Recommended version. Delete the Recommended version of
the environment template if no other major versions or minor versions of the environment
template exist. A major version of an environment template is a version that's not backward
compatible. Delete a minor version of an environment template if it isn't the Recommended
version. Delete a Recommended minor version of the environment template if no other minor
versions of the environment template exist. A minor version of an environment template is a
version that's backward compatible.
# Arguments
- `major_version`: The environment template major version to delete.
- `minor_version`: The environment template minor version to delete.
- `template_name`: The name of the environment template.
"""
function delete_environment_template_version(
majorVersion,
minorVersion,
templateName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"DeleteEnvironmentTemplateVersion",
Dict{String,Any}(
"majorVersion" => majorVersion,
"minorVersion" => minorVersion,
"templateName" => templateName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_environment_template_version(
majorVersion,
minorVersion,
templateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"DeleteEnvironmentTemplateVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"majorVersion" => majorVersion,
"minorVersion" => minorVersion,
"templateName" => templateName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_repository(name, provider)
delete_repository(name, provider, params::Dict{String,<:Any})
De-register and unlink your repository.
# Arguments
- `name`: The repository name.
- `provider`: The repository provider.
"""
function delete_repository(
name, provider; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"DeleteRepository",
Dict{String,Any}("name" => name, "provider" => provider);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_repository(
name,
provider,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"DeleteRepository",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("name" => name, "provider" => provider), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_service(name)
delete_service(name, params::Dict{String,<:Any})
Delete a service, with its instances and pipeline. You can't delete a service if it has
any service instances that have components attached to them. For more information about
components, see Proton components in the Proton User Guide.
# Arguments
- `name`: The name of the service to delete.
"""
function delete_service(name; aws_config::AbstractAWSConfig=global_aws_config())
return proton(
"DeleteService",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_service(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"DeleteService",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_service_sync_config(service_name)
delete_service_sync_config(service_name, params::Dict{String,<:Any})
Delete the Proton Ops file.
# Arguments
- `service_name`: The name of the service that you want to delete the service sync
configuration for.
"""
function delete_service_sync_config(
serviceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"DeleteServiceSyncConfig",
Dict{String,Any}("serviceName" => serviceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_service_sync_config(
serviceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"DeleteServiceSyncConfig",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("serviceName" => serviceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_service_template(name)
delete_service_template(name, params::Dict{String,<:Any})
If no other major or minor versions of the service template exist, delete the service
template.
# Arguments
- `name`: The name of the service template to delete.
"""
function delete_service_template(name; aws_config::AbstractAWSConfig=global_aws_config())
return proton(
"DeleteServiceTemplate",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_service_template(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"DeleteServiceTemplate",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_service_template_version(major_version, minor_version, template_name)
delete_service_template_version(major_version, minor_version, template_name, params::Dict{String,<:Any})
If no other minor versions of a service template exist, delete a major version of the
service template if it's not the Recommended version. Delete the Recommended version of the
service template if no other major versions or minor versions of the service template
exist. A major version of a service template is a version that isn't backwards compatible.
Delete a minor version of a service template if it's not the Recommended version. Delete a
Recommended minor version of the service template if no other minor versions of the service
template exist. A minor version of a service template is a version that's backwards
compatible.
# Arguments
- `major_version`: The service template major version to delete.
- `minor_version`: The service template minor version to delete.
- `template_name`: The name of the service template.
"""
function delete_service_template_version(
majorVersion,
minorVersion,
templateName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"DeleteServiceTemplateVersion",
Dict{String,Any}(
"majorVersion" => majorVersion,
"minorVersion" => minorVersion,
"templateName" => templateName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_service_template_version(
majorVersion,
minorVersion,
templateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"DeleteServiceTemplateVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"majorVersion" => majorVersion,
"minorVersion" => minorVersion,
"templateName" => templateName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_template_sync_config(template_name, template_type)
delete_template_sync_config(template_name, template_type, params::Dict{String,<:Any})
Delete a template sync configuration.
# Arguments
- `template_name`: The template name.
- `template_type`: The template type.
"""
function delete_template_sync_config(
templateName, templateType; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"DeleteTemplateSyncConfig",
Dict{String,Any}("templateName" => templateName, "templateType" => templateType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_template_sync_config(
templateName,
templateType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"DeleteTemplateSyncConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"templateName" => templateName, "templateType" => templateType
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_account_settings()
get_account_settings(params::Dict{String,<:Any})
Get detail data for Proton account-wide settings.
"""
function get_account_settings(; aws_config::AbstractAWSConfig=global_aws_config())
return proton(
"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 proton(
"GetAccountSettings", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_component(name)
get_component(name, params::Dict{String,<:Any})
Get detailed data for a component. For more information about components, see Proton
components in the Proton User Guide.
# Arguments
- `name`: The name of the component that you want to get the detailed data for.
"""
function get_component(name; aws_config::AbstractAWSConfig=global_aws_config())
return proton(
"GetComponent",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_component(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"GetComponent",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_deployment(id)
get_deployment(id, params::Dict{String,<:Any})
Get detailed data for a deployment.
# Arguments
- `id`: The ID of the deployment that you want to get the detailed data for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"componentName"`: The name of a component that you want to get the detailed data for.
- `"environmentName"`: The name of a environment that you want to get the detailed data for.
- `"serviceInstanceName"`: The name of the service instance associated with the given
deployment ID. serviceName must be specified to identify the service instance.
- `"serviceName"`: The name of the service associated with the given deployment ID.
"""
function get_deployment(id; aws_config::AbstractAWSConfig=global_aws_config())
return proton(
"GetDeployment",
Dict{String,Any}("id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_deployment(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"GetDeployment",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("id" => id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_environment(name)
get_environment(name, params::Dict{String,<:Any})
Get detailed data for an environment.
# Arguments
- `name`: The name of the environment that you want to get the detailed data for.
"""
function get_environment(name; aws_config::AbstractAWSConfig=global_aws_config())
return proton(
"GetEnvironment",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_environment(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"GetEnvironment",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_environment_account_connection(id)
get_environment_account_connection(id, params::Dict{String,<:Any})
In an environment account, get the detailed data for an environment account connection. For
more information, see Environment account connections in the Proton User guide.
# Arguments
- `id`: The ID of the environment account connection that you want to get the detailed data
for.
"""
function get_environment_account_connection(
id; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"GetEnvironmentAccountConnection",
Dict{String,Any}("id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_environment_account_connection(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"GetEnvironmentAccountConnection",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("id" => id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_environment_template(name)
get_environment_template(name, params::Dict{String,<:Any})
Get detailed data for an environment template.
# Arguments
- `name`: The name of the environment template that you want to get the detailed data for.
"""
function get_environment_template(name; aws_config::AbstractAWSConfig=global_aws_config())
return proton(
"GetEnvironmentTemplate",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_environment_template(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"GetEnvironmentTemplate",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_environment_template_version(major_version, minor_version, template_name)
get_environment_template_version(major_version, minor_version, template_name, params::Dict{String,<:Any})
Get detailed data for a major or minor version of an environment template.
# Arguments
- `major_version`: To get environment template major version detail data, include major
Version.
- `minor_version`: To get environment template minor version detail data, include
minorVersion.
- `template_name`: The name of the environment template a version of which you want to get
detailed data for.
"""
function get_environment_template_version(
majorVersion,
minorVersion,
templateName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"GetEnvironmentTemplateVersion",
Dict{String,Any}(
"majorVersion" => majorVersion,
"minorVersion" => minorVersion,
"templateName" => templateName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_environment_template_version(
majorVersion,
minorVersion,
templateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"GetEnvironmentTemplateVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"majorVersion" => majorVersion,
"minorVersion" => minorVersion,
"templateName" => templateName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_repository(name, provider)
get_repository(name, provider, params::Dict{String,<:Any})
Get detail data for a linked repository.
# Arguments
- `name`: The repository name, for example myrepos/myrepo.
- `provider`: The repository provider.
"""
function get_repository(name, provider; aws_config::AbstractAWSConfig=global_aws_config())
return proton(
"GetRepository",
Dict{String,Any}("name" => name, "provider" => provider);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_repository(
name,
provider,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"GetRepository",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("name" => name, "provider" => provider), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_repository_sync_status(branch, repository_name, repository_provider, sync_type)
get_repository_sync_status(branch, repository_name, repository_provider, sync_type, params::Dict{String,<:Any})
Get the sync status of a repository used for Proton template sync. For more information
about template sync, see . A repository sync status isn't tied to the Proton Repository
resource (or any other Proton resource). Therefore, tags on an Proton Repository resource
have no effect on this action. Specifically, you can't use these tags to control access to
this action using Attribute-based access control (ABAC). For more information about ABAC,
see ABAC in the Proton User Guide.
# Arguments
- `branch`: The repository branch.
- `repository_name`: The repository name.
- `repository_provider`: The repository provider.
- `sync_type`: The repository sync type.
"""
function get_repository_sync_status(
branch,
repositoryName,
repositoryProvider,
syncType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"GetRepositorySyncStatus",
Dict{String,Any}(
"branch" => branch,
"repositoryName" => repositoryName,
"repositoryProvider" => repositoryProvider,
"syncType" => syncType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_repository_sync_status(
branch,
repositoryName,
repositoryProvider,
syncType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"GetRepositorySyncStatus",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"branch" => branch,
"repositoryName" => repositoryName,
"repositoryProvider" => repositoryProvider,
"syncType" => syncType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resources_summary()
get_resources_summary(params::Dict{String,<:Any})
Get counts of Proton resources. For infrastructure-provisioning resources (environments,
services, service instances, pipelines), the action returns staleness counts. A resource is
stale when it's behind the recommended version of the Proton template that it uses and it
needs an update to become current. The action returns staleness counts (counts of resources
that are up-to-date, behind a template major version, or behind a template minor version),
the total number of resources, and the number of resources that are in a failed state,
grouped by resource type. Components, environments, and service templates return less
information - see the components, environments, and serviceTemplates field descriptions.
For context, the action also returns the total number of each type of Proton template in
the Amazon Web Services account. For more information, see Proton dashboard in the Proton
User Guide.
"""
function get_resources_summary(; aws_config::AbstractAWSConfig=global_aws_config())
return proton(
"GetResourcesSummary"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_resources_summary(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"GetResourcesSummary",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_service(name)
get_service(name, params::Dict{String,<:Any})
Get detailed data for a service.
# Arguments
- `name`: The name of the service that you want to get the detailed data for.
"""
function get_service(name; aws_config::AbstractAWSConfig=global_aws_config())
return proton(
"GetService",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_service(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"GetService",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_service_instance(name, service_name)
get_service_instance(name, service_name, params::Dict{String,<:Any})
Get detailed data for a service instance. A service instance is an instantiation of service
template and it runs in a specific environment.
# Arguments
- `name`: The name of a service instance that you want to get the detailed data for.
- `service_name`: The name of the service that you want the service instance input for.
"""
function get_service_instance(
name, serviceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"GetServiceInstance",
Dict{String,Any}("name" => name, "serviceName" => serviceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_service_instance(
name,
serviceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"GetServiceInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("name" => name, "serviceName" => serviceName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_service_instance_sync_status(service_instance_name, service_name)
get_service_instance_sync_status(service_instance_name, service_name, params::Dict{String,<:Any})
Get the status of the synced service instance.
# Arguments
- `service_instance_name`: The name of the service instance that you want the sync status
input for.
- `service_name`: The name of the service that the service instance belongs to.
"""
function get_service_instance_sync_status(
serviceInstanceName, serviceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"GetServiceInstanceSyncStatus",
Dict{String,Any}(
"serviceInstanceName" => serviceInstanceName, "serviceName" => serviceName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_service_instance_sync_status(
serviceInstanceName,
serviceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"GetServiceInstanceSyncStatus",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"serviceInstanceName" => serviceInstanceName,
"serviceName" => serviceName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_service_sync_blocker_summary(service_name)
get_service_sync_blocker_summary(service_name, params::Dict{String,<:Any})
Get detailed data for the service sync blocker summary.
# Arguments
- `service_name`: The name of the service that you want to get the service sync blocker
summary for. If given only the service name, all instances are blocked.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"serviceInstanceName"`: The name of the service instance that you want to get the
service sync blocker summary for. If given bothe the instance name and the service name,
only the instance is blocked.
"""
function get_service_sync_blocker_summary(
serviceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"GetServiceSyncBlockerSummary",
Dict{String,Any}("serviceName" => serviceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_service_sync_blocker_summary(
serviceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"GetServiceSyncBlockerSummary",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("serviceName" => serviceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_service_sync_config(service_name)
get_service_sync_config(service_name, params::Dict{String,<:Any})
Get detailed information for the service sync configuration.
# Arguments
- `service_name`: The name of the service that you want to get the service sync
configuration for.
"""
function get_service_sync_config(
serviceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"GetServiceSyncConfig",
Dict{String,Any}("serviceName" => serviceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_service_sync_config(
serviceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"GetServiceSyncConfig",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("serviceName" => serviceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_service_template(name)
get_service_template(name, params::Dict{String,<:Any})
Get detailed data for a service template.
# Arguments
- `name`: The name of the service template that you want to get detailed data for.
"""
function get_service_template(name; aws_config::AbstractAWSConfig=global_aws_config())
return proton(
"GetServiceTemplate",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_service_template(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"GetServiceTemplate",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_service_template_version(major_version, minor_version, template_name)
get_service_template_version(major_version, minor_version, template_name, params::Dict{String,<:Any})
Get detailed data for a major or minor version of a service template.
# Arguments
- `major_version`: To get service template major version detail data, include major Version.
- `minor_version`: To get service template minor version detail data, include minorVersion.
- `template_name`: The name of the service template a version of which you want to get
detailed data for.
"""
function get_service_template_version(
majorVersion,
minorVersion,
templateName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"GetServiceTemplateVersion",
Dict{String,Any}(
"majorVersion" => majorVersion,
"minorVersion" => minorVersion,
"templateName" => templateName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_service_template_version(
majorVersion,
minorVersion,
templateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"GetServiceTemplateVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"majorVersion" => majorVersion,
"minorVersion" => minorVersion,
"templateName" => templateName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_template_sync_config(template_name, template_type)
get_template_sync_config(template_name, template_type, params::Dict{String,<:Any})
Get detail data for a template sync configuration.
# Arguments
- `template_name`: The template name.
- `template_type`: The template type.
"""
function get_template_sync_config(
templateName, templateType; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"GetTemplateSyncConfig",
Dict{String,Any}("templateName" => templateName, "templateType" => templateType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_template_sync_config(
templateName,
templateType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"GetTemplateSyncConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"templateName" => templateName, "templateType" => templateType
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_template_sync_status(template_name, template_type, template_version)
get_template_sync_status(template_name, template_type, template_version, params::Dict{String,<:Any})
Get the status of a template sync.
# Arguments
- `template_name`: The template name.
- `template_type`: The template type.
- `template_version`: The template major version.
"""
function get_template_sync_status(
templateName,
templateType,
templateVersion;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"GetTemplateSyncStatus",
Dict{String,Any}(
"templateName" => templateName,
"templateType" => templateType,
"templateVersion" => templateVersion,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_template_sync_status(
templateName,
templateType,
templateVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"GetTemplateSyncStatus",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"templateName" => templateName,
"templateType" => templateType,
"templateVersion" => templateVersion,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_component_outputs(component_name)
list_component_outputs(component_name, params::Dict{String,<:Any})
Get a list of component Infrastructure as Code (IaC) outputs. For more information about
components, see Proton components in the Proton User Guide.
# Arguments
- `component_name`: The name of the component whose outputs you want.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"deploymentId"`: The ID of the deployment whose outputs you want.
- `"nextToken"`: A token that indicates the location of the next output in the array of
outputs, after the list of outputs that was previously requested.
"""
function list_component_outputs(
componentName; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"ListComponentOutputs",
Dict{String,Any}("componentName" => componentName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_component_outputs(
componentName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"ListComponentOutputs",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("componentName" => componentName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_component_provisioned_resources(component_name)
list_component_provisioned_resources(component_name, params::Dict{String,<:Any})
List provisioned resources for a component with details. For more information about
components, see Proton components in the Proton User Guide.
# Arguments
- `component_name`: The name of the component whose provisioned resources you want.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: A token that indicates the location of the next provisioned resource in
the array of provisioned resources, after the list of provisioned resources that was
previously requested.
"""
function list_component_provisioned_resources(
componentName; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"ListComponentProvisionedResources",
Dict{String,Any}("componentName" => componentName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_component_provisioned_resources(
componentName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"ListComponentProvisionedResources",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("componentName" => componentName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_components()
list_components(params::Dict{String,<:Any})
List components with summary data. You can filter the result list by environment, service,
or a single service instance. For more information about components, see Proton components
in the Proton User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"environmentName"`: The name of an environment for result list filtering. Proton returns
components associated with the environment or attached to service instances running in it.
- `"maxResults"`: The maximum number of components to list.
- `"nextToken"`: A token that indicates the location of the next component in the array of
components, after the list of components that was previously requested.
- `"serviceInstanceName"`: The name of a service instance for result list filtering. Proton
returns the component attached to the service instance, if any.
- `"serviceName"`: The name of a service for result list filtering. Proton returns
components attached to service instances of the service.
"""
function list_components(; aws_config::AbstractAWSConfig=global_aws_config())
return proton("ListComponents"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_components(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"ListComponents", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_deployments()
list_deployments(params::Dict{String,<:Any})
List deployments. You can filter the result list by environment, service, or a single
service instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"componentName"`: The name of a component for result list filtering. Proton returns
deployments associated with that component.
- `"environmentName"`: The name of an environment for result list filtering. Proton returns
deployments associated with the environment.
- `"maxResults"`: The maximum number of deployments to list.
- `"nextToken"`: A token that indicates the location of the next deployment in the array of
deployment, after the list of deployment that was previously requested.
- `"serviceInstanceName"`: The name of a service instance for result list filtering. Proton
returns the deployments associated with the service instance.
- `"serviceName"`: The name of a service for result list filtering. Proton returns
deployments associated with service instances of the service.
"""
function list_deployments(; aws_config::AbstractAWSConfig=global_aws_config())
return proton("ListDeployments"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_deployments(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"ListDeployments", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_environment_account_connections(requested_by)
list_environment_account_connections(requested_by, params::Dict{String,<:Any})
View a list of environment account connections. For more information, see Environment
account connections in the Proton User guide.
# Arguments
- `requested_by`: The type of account making the ListEnvironmentAccountConnections request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"environmentName"`: The environment name that's associated with each listed environment
account connection.
- `"maxResults"`: The maximum number of environment account connections to list.
- `"nextToken"`: A token that indicates the location of the next environment account
connection in the array of environment account connections, after the list of environment
account connections that was previously requested.
- `"statuses"`: The status details for each listed environment account connection.
"""
function list_environment_account_connections(
requestedBy; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"ListEnvironmentAccountConnections",
Dict{String,Any}("requestedBy" => requestedBy);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_environment_account_connections(
requestedBy,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"ListEnvironmentAccountConnections",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("requestedBy" => requestedBy), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_environment_outputs(environment_name)
list_environment_outputs(environment_name, params::Dict{String,<:Any})
List the infrastructure as code outputs for your environment.
# Arguments
- `environment_name`: The environment name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"deploymentId"`: The ID of the deployment whose outputs you want.
- `"nextToken"`: A token that indicates the location of the next environment output in the
array of environment outputs, after the list of environment outputs that was previously
requested.
"""
function list_environment_outputs(
environmentName; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"ListEnvironmentOutputs",
Dict{String,Any}("environmentName" => environmentName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_environment_outputs(
environmentName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"ListEnvironmentOutputs",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("environmentName" => environmentName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_environment_provisioned_resources(environment_name)
list_environment_provisioned_resources(environment_name, params::Dict{String,<:Any})
List the provisioned resources for your environment.
# Arguments
- `environment_name`: The environment name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: A token that indicates the location of the next environment provisioned
resource in the array of environment provisioned resources, after the list of environment
provisioned resources that was previously requested.
"""
function list_environment_provisioned_resources(
environmentName; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"ListEnvironmentProvisionedResources",
Dict{String,Any}("environmentName" => environmentName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_environment_provisioned_resources(
environmentName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"ListEnvironmentProvisionedResources",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("environmentName" => environmentName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_environment_template_versions(template_name)
list_environment_template_versions(template_name, params::Dict{String,<:Any})
List major or minor versions of an environment template with detail data.
# Arguments
- `template_name`: The name of the environment template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"majorVersion"`: To view a list of minor of versions under a major version of an
environment template, include major Version. To view a list of major versions of an
environment template, exclude major Version.
- `"maxResults"`: The maximum number of major or minor versions of an environment template
to list.
- `"nextToken"`: A token that indicates the location of the next major or minor version in
the array of major or minor versions of an environment template, after the list of major or
minor versions that was previously requested.
"""
function list_environment_template_versions(
templateName; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"ListEnvironmentTemplateVersions",
Dict{String,Any}("templateName" => templateName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_environment_template_versions(
templateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"ListEnvironmentTemplateVersions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("templateName" => templateName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_environment_templates()
list_environment_templates(params::Dict{String,<:Any})
List environment templates.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of environment templates to list.
- `"nextToken"`: A token that indicates the location of the next environment template in
the array of environment templates, after the list of environment templates that was
previously requested.
"""
function list_environment_templates(; aws_config::AbstractAWSConfig=global_aws_config())
return proton(
"ListEnvironmentTemplates"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_environment_templates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"ListEnvironmentTemplates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_environments()
list_environments(params::Dict{String,<:Any})
List environments with detail data summaries.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"environmentTemplates"`: An array of the versions of the environment template.
- `"maxResults"`: The maximum number of environments to list.
- `"nextToken"`: A token that indicates the location of the next environment in the array
of environments, after the list of environments that was previously requested.
"""
function list_environments(; aws_config::AbstractAWSConfig=global_aws_config())
return proton(
"ListEnvironments"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_environments(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"ListEnvironments", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_repositories()
list_repositories(params::Dict{String,<:Any})
List linked repositories with detail data.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of repositories to list.
- `"nextToken"`: A token that indicates the location of the next repository in the array of
repositories, after the list of repositories previously requested.
"""
function list_repositories(; aws_config::AbstractAWSConfig=global_aws_config())
return proton(
"ListRepositories"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_repositories(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"ListRepositories", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_repository_sync_definitions(repository_name, repository_provider, sync_type)
list_repository_sync_definitions(repository_name, repository_provider, sync_type, params::Dict{String,<:Any})
List repository sync definitions with detail data.
# Arguments
- `repository_name`: The repository name.
- `repository_provider`: The repository provider.
- `sync_type`: The sync type. The only supported value is TEMPLATE_SYNC.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: A token that indicates the location of the next repository sync definition
in the array of repository sync definitions, after the list of repository sync definitions
previously requested.
"""
function list_repository_sync_definitions(
repositoryName,
repositoryProvider,
syncType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"ListRepositorySyncDefinitions",
Dict{String,Any}(
"repositoryName" => repositoryName,
"repositoryProvider" => repositoryProvider,
"syncType" => syncType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_repository_sync_definitions(
repositoryName,
repositoryProvider,
syncType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"ListRepositorySyncDefinitions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"repositoryName" => repositoryName,
"repositoryProvider" => repositoryProvider,
"syncType" => syncType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_service_instance_outputs(service_instance_name, service_name)
list_service_instance_outputs(service_instance_name, service_name, params::Dict{String,<:Any})
Get a list service of instance Infrastructure as Code (IaC) outputs.
# Arguments
- `service_instance_name`: The name of the service instance whose outputs you want.
- `service_name`: The name of the service that serviceInstanceName is associated to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"deploymentId"`: The ID of the deployment whose outputs you want.
- `"nextToken"`: A token that indicates the location of the next output in the array of
outputs, after the list of outputs that was previously requested.
"""
function list_service_instance_outputs(
serviceInstanceName, serviceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"ListServiceInstanceOutputs",
Dict{String,Any}(
"serviceInstanceName" => serviceInstanceName, "serviceName" => serviceName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_service_instance_outputs(
serviceInstanceName,
serviceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"ListServiceInstanceOutputs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"serviceInstanceName" => serviceInstanceName,
"serviceName" => serviceName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_service_instance_provisioned_resources(service_instance_name, service_name)
list_service_instance_provisioned_resources(service_instance_name, service_name, params::Dict{String,<:Any})
List provisioned resources for a service instance with details.
# Arguments
- `service_instance_name`: The name of the service instance whose provisioned resources you
want.
- `service_name`: The name of the service that serviceInstanceName is associated to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: A token that indicates the location of the next provisioned resource in
the array of provisioned resources, after the list of provisioned resources that was
previously requested.
"""
function list_service_instance_provisioned_resources(
serviceInstanceName, serviceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"ListServiceInstanceProvisionedResources",
Dict{String,Any}(
"serviceInstanceName" => serviceInstanceName, "serviceName" => serviceName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_service_instance_provisioned_resources(
serviceInstanceName,
serviceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"ListServiceInstanceProvisionedResources",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"serviceInstanceName" => serviceInstanceName,
"serviceName" => serviceName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_service_instances()
list_service_instances(params::Dict{String,<:Any})
List service instances with summary data. This action lists service instances of all
services in the Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: An array of filtering criteria that scope down the result list. By default,
all service instances in the Amazon Web Services account are returned.
- `"maxResults"`: The maximum number of service instances to list.
- `"nextToken"`: A token that indicates the location of the next service in the array of
service instances, after the list of service instances that was previously requested.
- `"serviceName"`: The name of the service that the service instance belongs to.
- `"sortBy"`: The field that the result list is sorted by. When you choose to sort by
serviceName, service instances within each service are sorted by service instance name.
Default: serviceName
- `"sortOrder"`: Result list sort order. Default: ASCENDING
"""
function list_service_instances(; aws_config::AbstractAWSConfig=global_aws_config())
return proton(
"ListServiceInstances"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_service_instances(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"ListServiceInstances",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_service_pipeline_outputs(service_name)
list_service_pipeline_outputs(service_name, params::Dict{String,<:Any})
Get a list of service pipeline Infrastructure as Code (IaC) outputs.
# Arguments
- `service_name`: The name of the service whose pipeline's outputs you want.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"deploymentId"`: The ID of the deployment you want the outputs for.
- `"nextToken"`: A token that indicates the location of the next output in the array of
outputs, after the list of outputs that was previously requested.
"""
function list_service_pipeline_outputs(
serviceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"ListServicePipelineOutputs",
Dict{String,Any}("serviceName" => serviceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_service_pipeline_outputs(
serviceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"ListServicePipelineOutputs",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("serviceName" => serviceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_service_pipeline_provisioned_resources(service_name)
list_service_pipeline_provisioned_resources(service_name, params::Dict{String,<:Any})
List provisioned resources for a service and pipeline with details.
# Arguments
- `service_name`: The name of the service whose pipeline's provisioned resources you want.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: A token that indicates the location of the next provisioned resource in
the array of provisioned resources, after the list of provisioned resources that was
previously requested.
"""
function list_service_pipeline_provisioned_resources(
serviceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"ListServicePipelineProvisionedResources",
Dict{String,Any}("serviceName" => serviceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_service_pipeline_provisioned_resources(
serviceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"ListServicePipelineProvisionedResources",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("serviceName" => serviceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_service_template_versions(template_name)
list_service_template_versions(template_name, params::Dict{String,<:Any})
List major or minor versions of a service template with detail data.
# Arguments
- `template_name`: The name of the service template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"majorVersion"`: To view a list of minor of versions under a major version of a service
template, include major Version. To view a list of major versions of a service template,
exclude major Version.
- `"maxResults"`: The maximum number of major or minor versions of a service template to
list.
- `"nextToken"`: A token that indicates the location of the next major or minor version in
the array of major or minor versions of a service template, after the list of major or
minor versions that was previously requested.
"""
function list_service_template_versions(
templateName; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"ListServiceTemplateVersions",
Dict{String,Any}("templateName" => templateName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_service_template_versions(
templateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"ListServiceTemplateVersions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("templateName" => templateName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_service_templates()
list_service_templates(params::Dict{String,<:Any})
List service templates with detail data.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of service templates to list.
- `"nextToken"`: A token that indicates the location of the next service template in the
array of service templates, after the list of service templates previously requested.
"""
function list_service_templates(; aws_config::AbstractAWSConfig=global_aws_config())
return proton(
"ListServiceTemplates"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_service_templates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"ListServiceTemplates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_services()
list_services(params::Dict{String,<:Any})
List services with summaries of detail data.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of services to list.
- `"nextToken"`: A token that indicates the location of the next service in the array of
services, after the list of services that was previously requested.
"""
function list_services(; aws_config::AbstractAWSConfig=global_aws_config())
return proton("ListServices"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_services(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"ListServices", 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 tags for a resource. For more information, see Proton resources and tagging in the
Proton User Guide.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource for the listed tags.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of tags to list.
- `"nextToken"`: A token that indicates the location of the next resource tag in the array
of resource tags, after the list of resource tags that was previously requested.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"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 proton(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
notify_resource_deployment_status_change(resource_arn)
notify_resource_deployment_status_change(resource_arn, params::Dict{String,<:Any})
Notify Proton of status changes to a provisioned resource when you use self-managed
provisioning. For more information, see Self-managed provisioning in the Proton User Guide.
# Arguments
- `resource_arn`: The provisioned resource Amazon Resource Name (ARN).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"deploymentId"`: The deployment ID for your provisioned resource.
- `"outputs"`: The provisioned resource state change detail data that's returned by Proton.
- `"status"`: The status of your provisioned resource.
- `"statusMessage"`: The deployment status message for your provisioned resource.
"""
function notify_resource_deployment_status_change(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"NotifyResourceDeploymentStatusChange",
Dict{String,Any}("resourceArn" => resourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function notify_resource_deployment_status_change(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"NotifyResourceDeploymentStatusChange",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reject_environment_account_connection(id)
reject_environment_account_connection(id, params::Dict{String,<:Any})
In a management account, reject an environment account connection from another environment
account. After you reject an environment account connection request, you can't accept or
use the rejected environment account connection. You can’t reject an environment account
connection that's connected to an environment. For more information, see Environment
account connections in the Proton User guide.
# Arguments
- `id`: The ID of the environment account connection to reject.
"""
function reject_environment_account_connection(
id; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"RejectEnvironmentAccountConnection",
Dict{String,Any}("id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reject_environment_account_connection(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"RejectEnvironmentAccountConnection",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("id" => 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})
Tag a resource. A tag is a key-value pair of metadata that you associate with an Proton
resource. For more information, see Proton resources and tagging in the Proton User Guide.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the Proton resource to apply customer
tags to.
- `tags`: A list of customer tags to apply to the Proton resource.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return proton(
"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 proton(
"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 a customer tag from a resource. A tag is a key-value pair of metadata associated
with an Proton resource. For more information, see Proton resources and tagging in the
Proton User Guide.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource to remove customer tags
from.
- `tag_keys`: A list of customer tag keys that indicate the customer tags to be removed
from the resource.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"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 proton(
"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_account_settings()
update_account_settings(params::Dict{String,<:Any})
Update Proton settings that are used for multiple services in the Amazon Web Services
account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"deletePipelineProvisioningRepository"`: Set to true to remove a configured pipeline
repository from the account settings. Don't set this field if you are updating the
configured pipeline repository.
- `"pipelineCodebuildRoleArn"`: The Amazon Resource Name (ARN) of the service role you want
to use for provisioning pipelines. Proton assumes this role for CodeBuild-based
provisioning.
- `"pipelineProvisioningRepository"`: A linked repository for pipeline provisioning.
Specify it if you have environments configured for self-managed provisioning with services
that include pipelines. A linked repository is a repository that has been registered with
Proton. For more information, see CreateRepository. To remove a previously configured
repository, set deletePipelineProvisioningRepository to true, and don't set
pipelineProvisioningRepository.
- `"pipelineServiceRoleArn"`: The Amazon Resource Name (ARN) of the service role you want
to use for provisioning pipelines. Assumed by Proton for Amazon Web Services-managed
provisioning, and by customer-owned automation for self-managed provisioning. To remove a
previously configured ARN, specify an empty string.
"""
function update_account_settings(; aws_config::AbstractAWSConfig=global_aws_config())
return proton(
"UpdateAccountSettings"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function update_account_settings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"UpdateAccountSettings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_component(deployment_type, name)
update_component(deployment_type, name, params::Dict{String,<:Any})
Update a component. There are a few modes for updating a component. The deploymentType
field defines the mode. You can't update a component while its deployment status, or the
deployment status of a service instance attached to it, is IN_PROGRESS. For more
information about components, see Proton components in the Proton User Guide.
# Arguments
- `deployment_type`: The deployment type. It defines the mode for updating a component, as
follows: NONE In this mode, a deployment doesn't occur. Only the requested metadata
parameters are updated. You can only specify description in this mode. CURRENT_VERSION
In this mode, the component is deployed and updated with the new serviceSpec,
templateSource, and/or type that you provide. Only requested parameters are updated.
- `name`: The name of the component to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: The client token for the updated component.
- `"description"`: An optional customer-provided description of the component.
- `"serviceInstanceName"`: The name of the service instance that you want to attach this
component to. Don't specify to keep the component's current service instance attachment.
Specify an empty string to detach the component from the service instance it's attached to.
Specify non-empty values for both serviceInstanceName and serviceName or for neither of
them.
- `"serviceName"`: The name of the service that serviceInstanceName is associated with.
Don't specify to keep the component's current service instance attachment. Specify an empty
string to detach the component from the service instance it's attached to. Specify
non-empty values for both serviceInstanceName and serviceName or for neither of them.
- `"serviceSpec"`: The service spec that you want the component to use to access service
inputs. Set this only when the component is attached to a service instance.
- `"templateFile"`: A path to the Infrastructure as Code (IaC) file describing
infrastructure that a custom component provisions. Components support a single IaC file,
even if you use Terraform as your template language.
"""
function update_component(
deploymentType, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"UpdateComponent",
Dict{String,Any}(
"deploymentType" => deploymentType,
"name" => name,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_component(
deploymentType,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"UpdateComponent",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"deploymentType" => deploymentType,
"name" => name,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_environment(deployment_type, name)
update_environment(deployment_type, name, params::Dict{String,<:Any})
Update an environment. If the environment is associated with an environment account
connection, don't update or include the protonServiceRoleArn and provisioningRepository
parameter to update or connect to an environment account connection. You can only update to
a new environment account connection if that connection was created in the same environment
account that the current environment account connection was created in. The account
connection must also be associated with the current environment. If the environment isn't
associated with an environment account connection, don't update or include the
environmentAccountConnectionId parameter. You can't update or connect the environment to an
environment account connection if it isn't already associated with an environment
connection. You can update either the environmentAccountConnectionId or
protonServiceRoleArn parameter and value. You can’t update both. If the environment was
configured for Amazon Web Services-managed provisioning, omit the provisioningRepository
parameter. If the environment was configured for self-managed provisioning, specify the
provisioningRepository parameter and omit the protonServiceRoleArn and
environmentAccountConnectionId parameters. For more information, see Environments and
Provisioning methods in the Proton User Guide. There are four modes for updating an
environment. The deploymentType field defines the mode. NONE In this mode, a
deployment doesn't occur. Only the requested metadata parameters are updated.
CURRENT_VERSION In this mode, the environment is deployed and updated with the new spec
that you provide. Only requested parameters are updated. Don’t include minor or major
version parameters when you use this deployment-type. MINOR_VERSION In this mode, the
environment is deployed and updated with the published, recommended (latest) minor version
of the current major version in use, by default. You can also specify a different minor
version of the current major version in use. MAJOR_VERSION In this mode, the
environment is deployed and updated with the published, recommended (latest) major and
minor version of the current template, by default. You can also specify a different major
version that's higher than the major version in use and a minor version.
# Arguments
- `deployment_type`: There are four modes for updating an environment. The deploymentType
field defines the mode. NONE In this mode, a deployment doesn't occur. Only the
requested metadata parameters are updated. CURRENT_VERSION In this mode, the
environment is deployed and updated with the new spec that you provide. Only requested
parameters are updated. Don’t include major or minor version parameters when you use this
deployment-type. MINOR_VERSION In this mode, the environment is deployed and updated
with the published, recommended (latest) minor version of the current major version in use,
by default. You can also specify a different minor version of the current major version in
use. MAJOR_VERSION In this mode, the environment is deployed and updated with the
published, recommended (latest) major and minor version of the current template, by
default. You can also specify a different major version that is higher than the major
version in use and a minor version (optional).
- `name`: The name of the environment to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"codebuildRoleArn"`: The Amazon Resource Name (ARN) of the IAM service role that allows
Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.
- `"componentRoleArn"`: The Amazon Resource Name (ARN) of the IAM service role that Proton
uses when provisioning directly defined components in this environment. It determines the
scope of infrastructure that a component can provision. The environment must have a
componentRoleArn to allow directly defined components to be associated with the
environment. For more information about components, see Proton components in the Proton
User Guide.
- `"description"`: A description of the environment update.
- `"environmentAccountConnectionId"`: The ID of the environment account connection. You can
only update to a new environment account connection if it was created in the same
environment account that the current environment account connection was created in and is
associated with the current environment.
- `"protonServiceRoleArn"`: The Amazon Resource Name (ARN) of the Proton service role that
allows Proton to make API calls to other services your behalf.
- `"provisioningRepository"`: The linked repository that you use to host your rendered
infrastructure templates for self-managed provisioning. A linked repository is a repository
that has been registered with Proton. For more information, see CreateRepository.
- `"spec"`: The formatted specification that defines the update.
- `"templateMajorVersion"`: The major version of the environment to update.
- `"templateMinorVersion"`: The minor version of the environment to update.
"""
function update_environment(
deploymentType, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"UpdateEnvironment",
Dict{String,Any}("deploymentType" => deploymentType, "name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_environment(
deploymentType,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"UpdateEnvironment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("deploymentType" => deploymentType, "name" => name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_environment_account_connection(id)
update_environment_account_connection(id, params::Dict{String,<:Any})
In an environment account, update an environment account connection to use a new IAM role.
For more information, see Environment account connections in the Proton User guide.
# Arguments
- `id`: The ID of the environment account connection to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"codebuildRoleArn"`: The Amazon Resource Name (ARN) of an IAM service role in the
environment account. Proton uses this role to provision infrastructure resources using
CodeBuild-based provisioning in the associated environment account.
- `"componentRoleArn"`: The Amazon Resource Name (ARN) of the IAM service role that Proton
uses when provisioning directly defined components in the associated environment account.
It determines the scope of infrastructure that a component can provision in the account.
The environment account connection must have a componentRoleArn to allow directly defined
components to be associated with any environments running in the account. For more
information about components, see Proton components in the Proton User Guide.
- `"roleArn"`: The Amazon Resource Name (ARN) of the IAM service role that's associated
with the environment account connection to update.
"""
function update_environment_account_connection(
id; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"UpdateEnvironmentAccountConnection",
Dict{String,Any}("id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_environment_account_connection(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"UpdateEnvironmentAccountConnection",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("id" => id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_environment_template(name)
update_environment_template(name, params::Dict{String,<:Any})
Update an environment template.
# Arguments
- `name`: The name of the environment template to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A description of the environment template update.
- `"displayName"`: The name of the environment template to update as displayed in the
developer interface.
"""
function update_environment_template(
name; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"UpdateEnvironmentTemplate",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_environment_template(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"UpdateEnvironmentTemplate",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_environment_template_version(major_version, minor_version, template_name)
update_environment_template_version(major_version, minor_version, template_name, params::Dict{String,<:Any})
Update a major or minor version of an environment template.
# Arguments
- `major_version`: To update a major version of an environment template, include major
Version.
- `minor_version`: To update a minor version of an environment template, include
minorVersion.
- `template_name`: The name of the environment template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A description of environment template version to update.
- `"status"`: The status of the environment template minor version to update.
"""
function update_environment_template_version(
majorVersion,
minorVersion,
templateName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"UpdateEnvironmentTemplateVersion",
Dict{String,Any}(
"majorVersion" => majorVersion,
"minorVersion" => minorVersion,
"templateName" => templateName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_environment_template_version(
majorVersion,
minorVersion,
templateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"UpdateEnvironmentTemplateVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"majorVersion" => majorVersion,
"minorVersion" => minorVersion,
"templateName" => templateName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_service(name)
update_service(name, params::Dict{String,<:Any})
Edit a service description or use a spec to add and delete service instances. Existing
service instances and the service pipeline can't be edited using this API. They can only be
deleted. Use the description parameter to modify the description. Edit the spec parameter
to add or delete instances. You can't delete a service instance (remove it from the spec)
if it has an attached component. For more information about components, see Proton
components in the Proton User Guide.
# Arguments
- `name`: The name of the service to edit.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The edited service description.
- `"spec"`: Lists the service instances to add and the existing service instances to
remain. Omit the existing service instances to delete from the list. Don't include edits to
the existing service instances or pipeline. For more information, see Edit a service in the
Proton User Guide.
"""
function update_service(name; aws_config::AbstractAWSConfig=global_aws_config())
return proton(
"UpdateService",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_service(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"UpdateService",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_service_instance(deployment_type, name, service_name)
update_service_instance(deployment_type, name, service_name, params::Dict{String,<:Any})
Update a service instance. There are a few modes for updating a service instance. The
deploymentType field defines the mode. You can't update a service instance while its
deployment status, or the deployment status of a component attached to it, is IN_PROGRESS.
For more information about components, see Proton components in the Proton User Guide.
# Arguments
- `deployment_type`: The deployment type. It defines the mode for updating a service
instance, as follows: NONE In this mode, a deployment doesn't occur. Only the
requested metadata parameters are updated. CURRENT_VERSION In this mode, the service
instance is deployed and updated with the new spec that you provide. Only requested
parameters are updated. Don’t include major or minor version parameters when you use this
deployment type. MINOR_VERSION In this mode, the service instance is deployed and
updated with the published, recommended (latest) minor version of the current major version
in use, by default. You can also specify a different minor version of the current major
version in use. MAJOR_VERSION In this mode, the service instance is deployed and
updated with the published, recommended (latest) major and minor version of the current
template, by default. You can specify a different major version that's higher than the
major version in use and a minor version.
- `name`: The name of the service instance to update.
- `service_name`: The name of the service that the service instance belongs to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: The client token of the service instance to update.
- `"spec"`: The formatted specification that defines the service instance update.
- `"templateMajorVersion"`: The major version of the service template to update.
- `"templateMinorVersion"`: The minor version of the service template to update.
"""
function update_service_instance(
deploymentType, name, serviceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"UpdateServiceInstance",
Dict{String,Any}(
"deploymentType" => deploymentType,
"name" => name,
"serviceName" => serviceName,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_service_instance(
deploymentType,
name,
serviceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"UpdateServiceInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"deploymentType" => deploymentType,
"name" => name,
"serviceName" => serviceName,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_service_pipeline(deployment_type, service_name, spec)
update_service_pipeline(deployment_type, service_name, spec, params::Dict{String,<:Any})
Update the service pipeline. There are four modes for updating a service pipeline. The
deploymentType field defines the mode. NONE In this mode, a deployment doesn't occur.
Only the requested metadata parameters are updated. CURRENT_VERSION In this mode, the
service pipeline is deployed and updated with the new spec that you provide. Only requested
parameters are updated. Don’t include major or minor version parameters when you use this
deployment-type. MINOR_VERSION In this mode, the service pipeline is deployed and
updated with the published, recommended (latest) minor version of the current major version
in use, by default. You can specify a different minor version of the current major version
in use. MAJOR_VERSION In this mode, the service pipeline is deployed and updated with
the published, recommended (latest) major and minor version of the current template by
default. You can specify a different major version that's higher than the major version in
use and a minor version.
# Arguments
- `deployment_type`: The deployment type. There are four modes for updating a service
pipeline. The deploymentType field defines the mode. NONE In this mode, a deployment
doesn't occur. Only the requested metadata parameters are updated. CURRENT_VERSION In
this mode, the service pipeline is deployed and updated with the new spec that you provide.
Only requested parameters are updated. Don’t include major or minor version parameters
when you use this deployment-type. MINOR_VERSION In this mode, the service pipeline is
deployed and updated with the published, recommended (latest) minor version of the current
major version in use, by default. You can specify a different minor version of the current
major version in use. MAJOR_VERSION In this mode, the service pipeline is deployed and
updated with the published, recommended (latest) major and minor version of the current
template, by default. You can specify a different major version that's higher than the
major version in use and a minor version.
- `service_name`: The name of the service to that the pipeline is associated with.
- `spec`: The spec for the service pipeline to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"templateMajorVersion"`: The major version of the service template that was used to
create the service that the pipeline is associated with.
- `"templateMinorVersion"`: The minor version of the service template that was used to
create the service that the pipeline is associated with.
"""
function update_service_pipeline(
deploymentType, serviceName, spec; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"UpdateServicePipeline",
Dict{String,Any}(
"deploymentType" => deploymentType, "serviceName" => serviceName, "spec" => spec
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_service_pipeline(
deploymentType,
serviceName,
spec,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"UpdateServicePipeline",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"deploymentType" => deploymentType,
"serviceName" => serviceName,
"spec" => spec,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_service_sync_blocker(id, resolved_reason)
update_service_sync_blocker(id, resolved_reason, params::Dict{String,<:Any})
Update the service sync blocker by resolving it.
# Arguments
- `id`: The ID of the service sync blocker.
- `resolved_reason`: The reason the service sync blocker was resolved.
"""
function update_service_sync_blocker(
id, resolvedReason; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"UpdateServiceSyncBlocker",
Dict{String,Any}("id" => id, "resolvedReason" => resolvedReason);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_service_sync_blocker(
id,
resolvedReason,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"UpdateServiceSyncBlocker",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("id" => id, "resolvedReason" => resolvedReason),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_service_sync_config(branch, file_path, repository_name, repository_provider, service_name)
update_service_sync_config(branch, file_path, repository_name, repository_provider, service_name, params::Dict{String,<:Any})
Update the Proton Ops config file.
# Arguments
- `branch`: The name of the code repository branch where the Proton Ops file is found.
- `file_path`: The path to the Proton Ops file.
- `repository_name`: The name of the repository where the Proton Ops file is found.
- `repository_provider`: The name of the repository provider where the Proton Ops file is
found.
- `service_name`: The name of the service the Proton Ops file is for.
"""
function update_service_sync_config(
branch,
filePath,
repositoryName,
repositoryProvider,
serviceName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"UpdateServiceSyncConfig",
Dict{String,Any}(
"branch" => branch,
"filePath" => filePath,
"repositoryName" => repositoryName,
"repositoryProvider" => repositoryProvider,
"serviceName" => serviceName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_service_sync_config(
branch,
filePath,
repositoryName,
repositoryProvider,
serviceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"UpdateServiceSyncConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"branch" => branch,
"filePath" => filePath,
"repositoryName" => repositoryName,
"repositoryProvider" => repositoryProvider,
"serviceName" => serviceName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_service_template(name)
update_service_template(name, params::Dict{String,<:Any})
Update a service template.
# Arguments
- `name`: The name of the service template to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A description of the service template update.
- `"displayName"`: The name of the service template to update that's displayed in the
developer interface.
"""
function update_service_template(name; aws_config::AbstractAWSConfig=global_aws_config())
return proton(
"UpdateServiceTemplate",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_service_template(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return proton(
"UpdateServiceTemplate",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_service_template_version(major_version, minor_version, template_name)
update_service_template_version(major_version, minor_version, template_name, params::Dict{String,<:Any})
Update a major or minor version of a service template.
# Arguments
- `major_version`: To update a major version of a service template, include major Version.
- `minor_version`: To update a minor version of a service template, include minorVersion.
- `template_name`: The name of the service template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"compatibleEnvironmentTemplates"`: An array of environment template objects that are
compatible with this service template version. A service instance based on this service
template version can run in environments based on compatible templates.
- `"description"`: A description of a service template version to update.
- `"status"`: The status of the service template minor version to update.
- `"supportedComponentSources"`: An array of supported component sources. Components with
supported sources can be attached to service instances based on this service template
version. A change to supportedComponentSources doesn't impact existing component
attachments to instances based on this template version. A change only affects later
associations. For more information about components, see Proton components in the Proton
User Guide.
"""
function update_service_template_version(
majorVersion,
minorVersion,
templateName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"UpdateServiceTemplateVersion",
Dict{String,Any}(
"majorVersion" => majorVersion,
"minorVersion" => minorVersion,
"templateName" => templateName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_service_template_version(
majorVersion,
minorVersion,
templateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"UpdateServiceTemplateVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"majorVersion" => majorVersion,
"minorVersion" => minorVersion,
"templateName" => templateName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_template_sync_config(branch, repository_name, repository_provider, template_name, template_type)
update_template_sync_config(branch, repository_name, repository_provider, template_name, template_type, params::Dict{String,<:Any})
Update template sync configuration parameters, except for the templateName and
templateType. Repository details (branch, name, and provider) should be of a linked
repository. A linked repository is a repository that has been registered with Proton. For
more information, see CreateRepository.
# Arguments
- `branch`: The repository branch for your template.
- `repository_name`: The repository name (for example, myrepos/myrepo).
- `repository_provider`: The repository provider.
- `template_name`: The synced template name.
- `template_type`: The synced template type.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"subdirectory"`: A subdirectory path to your template bundle version. When included,
limits the template bundle search to this repository directory.
"""
function update_template_sync_config(
branch,
repositoryName,
repositoryProvider,
templateName,
templateType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"UpdateTemplateSyncConfig",
Dict{String,Any}(
"branch" => branch,
"repositoryName" => repositoryName,
"repositoryProvider" => repositoryProvider,
"templateName" => templateName,
"templateType" => templateType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_template_sync_config(
branch,
repositoryName,
repositoryProvider,
templateName,
templateType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return proton(
"UpdateTemplateSyncConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"branch" => branch,
"repositoryName" => repositoryName,
"repositoryProvider" => repositoryProvider,
"templateName" => templateName,
"templateType" => templateType,
),
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 | 85396 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: qbusiness
using AWS.Compat
using AWS.UUIDs
"""
batch_delete_document(application_id, documents, index_id)
batch_delete_document(application_id, documents, index_id, params::Dict{String,<:Any})
Asynchronously deletes one or more documents added using the BatchPutDocument API from an
Amazon Q Business index. You can see the progress of the deletion, and any error messages
related to the process, by using CloudWatch.
# Arguments
- `application_id`: The identifier of the Amazon Q Business application.
- `documents`: Documents deleted from the Amazon Q Business index.
- `index_id`: The identifier of the Amazon Q Business index that contains the documents to
delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"dataSourceSyncId"`: The identifier of the data source sync during which the documents
were deleted.
"""
function batch_delete_document(
applicationId, documents, indexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"POST",
"/applications/$(applicationId)/indices/$(indexId)/documents/delete",
Dict{String,Any}("documents" => documents);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_delete_document(
applicationId,
documents,
indexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"POST",
"/applications/$(applicationId)/indices/$(indexId)/documents/delete",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("documents" => documents), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_put_document(application_id, documents, index_id)
batch_put_document(application_id, documents, index_id, params::Dict{String,<:Any})
Adds one or more documents to an Amazon Q Business index. You use this API to: ingest
your structured and unstructured documents and documents stored in an Amazon S3 bucket into
an Amazon Q Business index. add custom attributes to documents in an Amazon Q Business
index. attach an access control list to the documents added to an Amazon Q Business
index. You can see the progress of the deletion, and any error messages related to the
process, by using CloudWatch.
# Arguments
- `application_id`: The identifier of the Amazon Q Business application.
- `documents`: One or more documents to add to the index.
- `index_id`: The identifier of the Amazon Q Business index to add the documents to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"dataSourceSyncId"`: The identifier of the data source sync during which the documents
were added.
- `"roleArn"`: The Amazon Resource Name (ARN) of an IAM role with permission to access your
S3 bucket.
"""
function batch_put_document(
applicationId, documents, indexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"POST",
"/applications/$(applicationId)/indices/$(indexId)/documents",
Dict{String,Any}("documents" => documents);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_put_document(
applicationId,
documents,
indexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"POST",
"/applications/$(applicationId)/indices/$(indexId)/documents",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("documents" => documents), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
chat_sync(application_id)
chat_sync(application_id, params::Dict{String,<:Any})
Starts or continues a non-streaming Amazon Q Business conversation.
# Arguments
- `application_id`: The identifier of the Amazon Q Business application linked to the
Amazon Q Business conversation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"actionExecution"`: A request from an end user to perform an Amazon Q Business plugin
action.
- `"attachments"`: A list of files uploaded directly during chat. You can upload a maximum
of 5 files of upto 10 MB each.
- `"attributeFilter"`: Enables filtering of Amazon Q Business web experience responses
based on document attributes or metadata fields.
- `"authChallengeResponse"`: An authentication verification event response by a third party
authentication server to Amazon Q Business.
- `"chatMode"`: The chat modes available to an Amazon Q Business end user.
RETRIEVAL_MODE - The default chat mode for an Amazon Q Business application. When this mode
is enabled, Amazon Q Business generates responses only from data sources connected to an
Amazon Q Business application. CREATOR_MODE - By selecting this mode, users can choose
to generate responses only from the LLM knowledge, without consulting connected data
sources, for a chat request. PLUGIN_MODE - By selecting this mode, users can choose to
use plugins in chat. For more information, see Admin controls and guardrails, Plugins,
and Conversation settings.
- `"chatModeConfiguration"`: The chat mode configuration for an Amazon Q Business
application.
- `"clientToken"`: A token that you provide to identify a chat request.
- `"conversationId"`: The identifier of the Amazon Q Business conversation.
- `"parentMessageId"`: The identifier of the previous system message in a conversation.
- `"userGroups"`: The groups that a user associated with the chat input belongs to.
- `"userId"`: The identifier of the user attached to the chat input.
- `"userMessage"`: A end user message in a conversation.
"""
function chat_sync(applicationId; aws_config::AbstractAWSConfig=global_aws_config())
return qbusiness(
"POST",
"/applications/$(applicationId)/conversations?sync",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function chat_sync(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"POST",
"/applications/$(applicationId)/conversations?sync",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_application(display_name)
create_application(display_name, params::Dict{String,<:Any})
Creates an Amazon Q Business application. There are new tiers for Amazon Q Business. Not
all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For
information on what's included in Amazon Q Business Lite and what's included in Amazon Q
Business Pro, see Amazon Q Business tiers. You must use the Amazon Q Business console to
assign subscription tiers to users.
# Arguments
- `display_name`: A name for the Amazon Q Business application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"attachmentsConfiguration"`: An option to allow end users to upload files directly
during chat.
- `"clientToken"`: A token that you provide to identify the request to create your Amazon Q
Business application.
- `"description"`: A description for the Amazon Q Business application.
- `"encryptionConfiguration"`: The identifier of the KMS key that is used to encrypt your
data. Amazon Q Business doesn't support asymmetric keys.
- `"identityCenterInstanceArn"`: The Amazon Resource Name (ARN) of the IAM Identity Center
instance you are either creating for—or connecting to—your Amazon Q Business
application.
- `"qAppsConfiguration"`: An option to allow end users to create and use Amazon Q Apps in
the web experience.
- `"roleArn"`: The Amazon Resource Name (ARN) of an IAM role with permissions to access
your Amazon CloudWatch logs and metrics.
- `"tags"`: A list of key-value pairs that identify or categorize your Amazon Q Business
application. You can also use tags to help control access to the application. Tag keys and
values can consist of Unicode letters, digits, white space, and any of the following
symbols: _ . : / = + - @.
"""
function create_application(displayName; aws_config::AbstractAWSConfig=global_aws_config())
return qbusiness(
"POST",
"/applications",
Dict{String,Any}("displayName" => displayName, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_application(
displayName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"POST",
"/applications",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"displayName" => displayName, "clientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_data_source(application_id, configuration, display_name, index_id)
create_data_source(application_id, configuration, display_name, index_id, params::Dict{String,<:Any})
Creates a data source connector for an Amazon Q Business application. CreateDataSource is
a synchronous operation. The operation returns 200 if the data source was successfully
created. Otherwise, an exception is raised.
# Arguments
- `application_id`: The identifier of the Amazon Q Business application the data source
will be attached to.
- `configuration`: Configuration information to connect to your data source repository. For
configuration templates for your specific data source, see Supported connectors.
- `display_name`: A name for the data source connector.
- `index_id`: The identifier of the index that you want to use with the data source
connector.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token you provide to identify a request to create a data source
connector. Multiple calls to the CreateDataSource API with the same client token will
create only one data source connector.
- `"description"`: A description for the data source connector.
- `"documentEnrichmentConfiguration"`:
- `"roleArn"`: The Amazon Resource Name (ARN) of an IAM role with permission to access the
data source and required resources.
- `"syncSchedule"`: Sets the frequency for Amazon Q Business to check the documents in your
data source repository and update your index. If you don't set a schedule, Amazon Q
Business won't periodically update the index. Specify a cron- format schedule string or an
empty string to indicate that the index is updated on demand. You can't specify the
Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a
ValidationException exception.
- `"tags"`: A list of key-value pairs that identify or categorize the data source
connector. You can also use tags to help control access to the data source connector. Tag
keys and values can consist of Unicode letters, digits, white space, and any of the
following symbols: _ . : / = + - @.
- `"vpcConfiguration"`: Configuration information for an Amazon VPC (Virtual Private Cloud)
to connect to your data source. For more information, see Using Amazon VPC with Amazon Q
Business connectors.
"""
function create_data_source(
applicationId,
configuration,
displayName,
indexId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"POST",
"/applications/$(applicationId)/indices/$(indexId)/datasources",
Dict{String,Any}(
"configuration" => configuration,
"displayName" => displayName,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_data_source(
applicationId,
configuration,
displayName,
indexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"POST",
"/applications/$(applicationId)/indices/$(indexId)/datasources",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"configuration" => configuration,
"displayName" => displayName,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_index(application_id, display_name)
create_index(application_id, display_name, params::Dict{String,<:Any})
Creates an Amazon Q Business index. To determine if index creation has completed, check the
Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when
the index is ready to use. Once the index is active, you can index your documents using the
BatchPutDocument API or the CreateDataSource API.
# Arguments
- `application_id`: The identifier of the Amazon Q Business application using the index.
- `display_name`: A name for the Amazon Q Business index.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"capacityConfiguration"`: The capacity units you want to provision for your index. You
can add and remove capacity to fit your usage needs.
- `"clientToken"`: A token that you provide to identify the request to create an index.
Multiple calls to the CreateIndex API with the same client token will create only one index.
- `"description"`: A description for the Amazon Q Business index.
- `"tags"`: A list of key-value pairs that identify or categorize the index. You can also
use tags to help control access to the index. Tag keys and values can consist of Unicode
letters, digits, white space, and any of the following symbols: _ . : / = + - @.
- `"type"`: The index type that's suitable for your needs. For more information on what's
included in each type of index, see Amazon Q Business tiers.
"""
function create_index(
applicationId, displayName; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"POST",
"/applications/$(applicationId)/indices",
Dict{String,Any}("displayName" => displayName, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_index(
applicationId,
displayName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"POST",
"/applications/$(applicationId)/indices",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"displayName" => displayName, "clientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_plugin(application_id, auth_configuration, display_name, type)
create_plugin(application_id, auth_configuration, display_name, type, params::Dict{String,<:Any})
Creates an Amazon Q Business plugin.
# Arguments
- `application_id`: The identifier of the application that will contain the plugin.
- `auth_configuration`:
- `display_name`: A the name for your plugin.
- `type`: The type of plugin you want to create.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token that you provide to identify the request to create your Amazon Q
Business plugin.
- `"customPluginConfiguration"`: Contains configuration for a custom plugin.
- `"serverUrl"`: The source URL used for plugin configuration.
- `"tags"`: A list of key-value pairs that identify or categorize the data source
connector. You can also use tags to help control access to the data source connector. Tag
keys and values can consist of Unicode letters, digits, white space, and any of the
following symbols: _ . : / = + - @.
"""
function create_plugin(
applicationId,
authConfiguration,
displayName,
type;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"POST",
"/applications/$(applicationId)/plugins",
Dict{String,Any}(
"authConfiguration" => authConfiguration,
"displayName" => displayName,
"type" => type,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_plugin(
applicationId,
authConfiguration,
displayName,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"POST",
"/applications/$(applicationId)/plugins",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"authConfiguration" => authConfiguration,
"displayName" => displayName,
"type" => type,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_retriever(application_id, configuration, display_name, type)
create_retriever(application_id, configuration, display_name, type, params::Dict{String,<:Any})
Adds a retriever to your Amazon Q Business application.
# Arguments
- `application_id`: The identifier of your Amazon Q Business application.
- `configuration`:
- `display_name`: The name of your retriever.
- `type`: The type of retriever you are using.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token that you provide to identify the request to create your Amazon Q
Business application retriever.
- `"roleArn"`: The ARN of an IAM role used by Amazon Q Business to access the basic
authentication credentials stored in a Secrets Manager secret.
- `"tags"`: A list of key-value pairs that identify or categorize the retriever. You can
also use tags to help control access to the retriever. Tag keys and values can consist of
Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
"""
function create_retriever(
applicationId,
configuration,
displayName,
type;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"POST",
"/applications/$(applicationId)/retrievers",
Dict{String,Any}(
"configuration" => configuration,
"displayName" => displayName,
"type" => type,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_retriever(
applicationId,
configuration,
displayName,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"POST",
"/applications/$(applicationId)/retrievers",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"configuration" => configuration,
"displayName" => displayName,
"type" => type,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_user(application_id, user_id)
create_user(application_id, user_id, params::Dict{String,<:Any})
Creates a universally unique identifier (UUID) mapped to a list of local user ids within an
application.
# Arguments
- `application_id`: The identifier of the application for which the user mapping will be
created.
- `user_id`: The user emails attached to a user mapping.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token that you provide to identify the request to create your Amazon Q
Business user mapping.
- `"userAliases"`: The list of user aliases in the mapping.
"""
function create_user(
applicationId, userId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"POST",
"/applications/$(applicationId)/users",
Dict{String,Any}("userId" => userId, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_user(
applicationId,
userId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"POST",
"/applications/$(applicationId)/users",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("userId" => userId, "clientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_web_experience(application_id)
create_web_experience(application_id, params::Dict{String,<:Any})
Creates an Amazon Q Business web experience.
# Arguments
- `application_id`: The identifier of the Amazon Q Business web experience.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token you provide to identify a request to create an Amazon Q Business
web experience.
- `"roleArn"`: The Amazon Resource Name (ARN) of the service role attached to your web
experience.
- `"samplePromptsControlMode"`: Determines whether sample prompts are enabled in the web
experience for an end user.
- `"subtitle"`: A subtitle to personalize your Amazon Q Business web experience.
- `"tags"`: A list of key-value pairs that identify or categorize your Amazon Q Business
web experience. You can also use tags to help control access to the web experience. Tag
keys and values can consist of Unicode letters, digits, white space, and any of the
following symbols: _ . : / = + - @.
- `"title"`: The title for your Amazon Q Business web experience.
- `"welcomeMessage"`: The customized welcome message for end users of an Amazon Q Business
web experience.
"""
function create_web_experience(
applicationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"POST",
"/applications/$(applicationId)/experiences",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_web_experience(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"POST",
"/applications/$(applicationId)/experiences",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_application(application_id)
delete_application(application_id, params::Dict{String,<:Any})
Deletes an Amazon Q Business application.
# Arguments
- `application_id`: The identifier of the Amazon Q Business application.
"""
function delete_application(
applicationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"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 qbusiness(
"DELETE",
"/applications/$(applicationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_chat_controls_configuration(application_id)
delete_chat_controls_configuration(application_id, params::Dict{String,<:Any})
Deletes chat controls configured for an existing Amazon Q Business application.
# Arguments
- `application_id`: The identifier of the application the chat controls have been
configured for.
"""
function delete_chat_controls_configuration(
applicationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"DELETE",
"/applications/$(applicationId)/chatcontrols";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_chat_controls_configuration(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"DELETE",
"/applications/$(applicationId)/chatcontrols",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_conversation(application_id, conversation_id)
delete_conversation(application_id, conversation_id, params::Dict{String,<:Any})
Deletes an Amazon Q Business web experience conversation.
# Arguments
- `application_id`: The identifier of the Amazon Q Business application associated with the
conversation.
- `conversation_id`: The identifier of the Amazon Q Business web experience conversation
being deleted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"userId"`: The identifier of the user who is deleting the conversation.
"""
function delete_conversation(
applicationId, conversationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"DELETE",
"/applications/$(applicationId)/conversations/$(conversationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_conversation(
applicationId,
conversationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"DELETE",
"/applications/$(applicationId)/conversations/$(conversationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_data_source(application_id, data_source_id, index_id)
delete_data_source(application_id, data_source_id, index_id, params::Dict{String,<:Any})
Deletes an Amazon Q Business data source connector. While the data source is being deleted,
the Status field returned by a call to the DescribeDataSource API is set to DELETING.
# Arguments
- `application_id`: The identifier of the Amazon Q Business application used with the data
source connector.
- `data_source_id`: The identifier of the data source connector that you want to delete.
- `index_id`: The identifier of the index used with the data source connector.
"""
function delete_data_source(
applicationId, dataSourceId, indexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"DELETE",
"/applications/$(applicationId)/indices/$(indexId)/datasources/$(dataSourceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_data_source(
applicationId,
dataSourceId,
indexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"DELETE",
"/applications/$(applicationId)/indices/$(indexId)/datasources/$(dataSourceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_group(application_id, group_name, index_id)
delete_group(application_id, group_name, index_id, params::Dict{String,<:Any})
Deletes a group so that all users and sub groups that belong to the group can no longer
access documents only available to that group. For example, after deleting the group
\"Summer Interns\", all interns who belonged to that group no longer see intern-only
documents in their chat results. If you want to delete, update, or replace users or sub
groups of a group, you need to use the PutGroup operation. For example, if a user in the
group \"Engineering\" leaves the engineering team and another user takes their place, you
provide an updated list of users or sub groups that belong to the \"Engineering\" group
when calling PutGroup.
# Arguments
- `application_id`: The identifier of the application in which the group mapping belongs.
- `group_name`: The name of the group you want to delete.
- `index_id`: The identifier of the index you want to delete the group from.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"dataSourceId"`: The identifier of the data source linked to the group A group can be
tied to multiple data sources. You can delete a group from accessing documents in a certain
data source. For example, the groups \"Research\", \"Engineering\", and \"Sales and
Marketing\" are all tied to the company's documents stored in the data sources Confluence
and Salesforce. You want to delete \"Research\" and \"Engineering\" groups from Salesforce,
so that these groups cannot access customer-related documents stored in Salesforce. Only
\"Sales and Marketing\" should access documents in the Salesforce data source.
"""
function delete_group(
applicationId, groupName, indexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"DELETE",
"/applications/$(applicationId)/indices/$(indexId)/groups/$(groupName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_group(
applicationId,
groupName,
indexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"DELETE",
"/applications/$(applicationId)/indices/$(indexId)/groups/$(groupName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_index(application_id, index_id)
delete_index(application_id, index_id, params::Dict{String,<:Any})
Deletes an Amazon Q Business index.
# Arguments
- `application_id`: The identifier of the Amazon Q Business application the Amazon Q
Business index is linked to.
- `index_id`: The identifier of the Amazon Q Business index.
"""
function delete_index(
applicationId, indexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"DELETE",
"/applications/$(applicationId)/indices/$(indexId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_index(
applicationId,
indexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"DELETE",
"/applications/$(applicationId)/indices/$(indexId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_plugin(application_id, plugin_id)
delete_plugin(application_id, plugin_id, params::Dict{String,<:Any})
Deletes an Amazon Q Business plugin.
# Arguments
- `application_id`: The identifier the application attached to the Amazon Q Business plugin.
- `plugin_id`: The identifier of the plugin being deleted.
"""
function delete_plugin(
applicationId, pluginId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"DELETE",
"/applications/$(applicationId)/plugins/$(pluginId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_plugin(
applicationId,
pluginId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"DELETE",
"/applications/$(applicationId)/plugins/$(pluginId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_retriever(application_id, retriever_id)
delete_retriever(application_id, retriever_id, params::Dict{String,<:Any})
Deletes the retriever used by an Amazon Q Business application.
# Arguments
- `application_id`: The identifier of the Amazon Q Business application using the retriever.
- `retriever_id`: The identifier of the retriever being deleted.
"""
function delete_retriever(
applicationId, retrieverId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"DELETE",
"/applications/$(applicationId)/retrievers/$(retrieverId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_retriever(
applicationId,
retrieverId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"DELETE",
"/applications/$(applicationId)/retrievers/$(retrieverId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_user(application_id, user_id)
delete_user(application_id, user_id, params::Dict{String,<:Any})
Deletes a user by email id.
# Arguments
- `application_id`: The identifier of the application from which the user is being deleted.
- `user_id`: The user email being deleted.
"""
function delete_user(
applicationId, userId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"DELETE",
"/applications/$(applicationId)/users/$(userId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_user(
applicationId,
userId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"DELETE",
"/applications/$(applicationId)/users/$(userId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_web_experience(application_id, web_experience_id)
delete_web_experience(application_id, web_experience_id, params::Dict{String,<:Any})
Deletes an Amazon Q Business web experience.
# Arguments
- `application_id`: The identifier of the Amazon Q Business application linked to the
Amazon Q Business web experience.
- `web_experience_id`: The identifier of the Amazon Q Business web experience being deleted.
"""
function delete_web_experience(
applicationId, webExperienceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"DELETE",
"/applications/$(applicationId)/experiences/$(webExperienceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_web_experience(
applicationId,
webExperienceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"DELETE",
"/applications/$(applicationId)/experiences/$(webExperienceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_application(application_id)
get_application(application_id, params::Dict{String,<:Any})
Gets information about an existing Amazon Q Business application.
# Arguments
- `application_id`: The identifier of the Amazon Q Business application.
"""
function get_application(applicationId; aws_config::AbstractAWSConfig=global_aws_config())
return qbusiness(
"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 qbusiness(
"GET",
"/applications/$(applicationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_chat_controls_configuration(application_id)
get_chat_controls_configuration(application_id, params::Dict{String,<:Any})
Gets information about an chat controls configured for an existing Amazon Q Business
application.
# Arguments
- `application_id`: The identifier of the application for which the chat controls are
configured.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of configured chat controls to return.
- `"nextToken"`: If the maxResults response was incomplete because there is more data to
retrieve, Amazon Q Business returns a pagination token in the response. You can use this
pagination token to retrieve the next set of Amazon Q Business chat controls configured.
"""
function get_chat_controls_configuration(
applicationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"GET",
"/applications/$(applicationId)/chatcontrols";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_chat_controls_configuration(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"GET",
"/applications/$(applicationId)/chatcontrols",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_data_source(application_id, data_source_id, index_id)
get_data_source(application_id, data_source_id, index_id, params::Dict{String,<:Any})
Gets information about an existing Amazon Q Business data source connector.
# Arguments
- `application_id`: The identifier of the Amazon Q Business application.
- `data_source_id`: The identifier of the data source connector.
- `index_id`: The identfier of the index used with the data source connector.
"""
function get_data_source(
applicationId, dataSourceId, indexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"GET",
"/applications/$(applicationId)/indices/$(indexId)/datasources/$(dataSourceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_data_source(
applicationId,
dataSourceId,
indexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"GET",
"/applications/$(applicationId)/indices/$(indexId)/datasources/$(dataSourceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_group(application_id, group_name, index_id)
get_group(application_id, group_name, index_id, params::Dict{String,<:Any})
Describes a group by group name.
# Arguments
- `application_id`: The identifier of the application id the group is attached to.
- `group_name`: The name of the group.
- `index_id`: The identifier of the index the group is attached to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"dataSourceId"`: The identifier of the data source the group is attached to.
"""
function get_group(
applicationId, groupName, indexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"GET",
"/applications/$(applicationId)/indices/$(indexId)/groups/$(groupName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_group(
applicationId,
groupName,
indexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"GET",
"/applications/$(applicationId)/indices/$(indexId)/groups/$(groupName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_index(application_id, index_id)
get_index(application_id, index_id, params::Dict{String,<:Any})
Gets information about an existing Amazon Q Business index.
# Arguments
- `application_id`: The identifier of the Amazon Q Business application connected to the
index.
- `index_id`: The identifier of the Amazon Q Business index you want information on.
"""
function get_index(
applicationId, indexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"GET",
"/applications/$(applicationId)/indices/$(indexId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_index(
applicationId,
indexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"GET",
"/applications/$(applicationId)/indices/$(indexId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_plugin(application_id, plugin_id)
get_plugin(application_id, plugin_id, params::Dict{String,<:Any})
Gets information about an existing Amazon Q Business plugin.
# Arguments
- `application_id`: The identifier of the application which contains the plugin.
- `plugin_id`: The identifier of the plugin.
"""
function get_plugin(
applicationId, pluginId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"GET",
"/applications/$(applicationId)/plugins/$(pluginId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_plugin(
applicationId,
pluginId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"GET",
"/applications/$(applicationId)/plugins/$(pluginId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_retriever(application_id, retriever_id)
get_retriever(application_id, retriever_id, params::Dict{String,<:Any})
Gets information about an existing retriever used by an Amazon Q Business application.
# Arguments
- `application_id`: The identifier of the Amazon Q Business application using the retriever.
- `retriever_id`: The identifier of the retriever.
"""
function get_retriever(
applicationId, retrieverId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"GET",
"/applications/$(applicationId)/retrievers/$(retrieverId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_retriever(
applicationId,
retrieverId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"GET",
"/applications/$(applicationId)/retrievers/$(retrieverId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_user(application_id, user_id)
get_user(application_id, user_id, params::Dict{String,<:Any})
Describes the universally unique identifier (UUID) associated with a local user in a data
source.
# Arguments
- `application_id`: The identifier of the application connected to the user.
- `user_id`: The user email address attached to the user.
"""
function get_user(applicationId, userId; aws_config::AbstractAWSConfig=global_aws_config())
return qbusiness(
"GET",
"/applications/$(applicationId)/users/$(userId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_user(
applicationId,
userId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"GET",
"/applications/$(applicationId)/users/$(userId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_web_experience(application_id, web_experience_id)
get_web_experience(application_id, web_experience_id, params::Dict{String,<:Any})
Gets information about an existing Amazon Q Business web experience.
# Arguments
- `application_id`: The identifier of the Amazon Q Business application linked to the web
experience.
- `web_experience_id`: The identifier of the Amazon Q Business web experience.
"""
function get_web_experience(
applicationId, webExperienceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"GET",
"/applications/$(applicationId)/experiences/$(webExperienceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_web_experience(
applicationId,
webExperienceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"GET",
"/applications/$(applicationId)/experiences/$(webExperienceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_applications()
list_applications(params::Dict{String,<:Any})
Lists Amazon Q Business applications.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of Amazon Q Business applications to return.
- `"nextToken"`: If the maxResults response was incomplete because there is more data to
retrieve, Amazon Q Business returns a pagination token in the response. You can use this
pagination token to retrieve the next set of Amazon Q Business applications.
"""
function list_applications(; aws_config::AbstractAWSConfig=global_aws_config())
return qbusiness(
"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 qbusiness(
"GET",
"/applications",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_conversations(application_id)
list_conversations(application_id, params::Dict{String,<:Any})
Lists one or more Amazon Q Business conversations.
# Arguments
- `application_id`: The identifier of the Amazon Q Business application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of Amazon Q Business conversations to return.
- `"nextToken"`: If the maxResults response was incomplete because there is more data to
retrieve, Amazon Q Business returns a pagination token in the response. You can use this
pagination token to retrieve the next set of Amazon Q Business conversations.
- `"userId"`: The identifier of the user involved in the Amazon Q Business web experience
conversation.
"""
function list_conversations(
applicationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"GET",
"/applications/$(applicationId)/conversations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_conversations(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"GET",
"/applications/$(applicationId)/conversations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_data_source_sync_jobs(application_id, data_source_id, index_id)
list_data_source_sync_jobs(application_id, data_source_id, index_id, params::Dict{String,<:Any})
Get information about an Amazon Q Business data source connector synchronization.
# Arguments
- `application_id`: The identifier of the Amazon Q Business application connected to the
data source.
- `data_source_id`: The identifier of the data source connector.
- `index_id`: The identifier of the index used with the Amazon Q Business data source
connector.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"endTime"`: The end time of the data source connector sync.
- `"maxResults"`: The maximum number of synchronization jobs to return in the response.
- `"nextToken"`: If the maxResults response was incpmplete because there is more data to
retriever, Amazon Q Business returns a pagination token in the response. You can use this
pagination token to retrieve the next set of responses.
- `"startTime"`: The start time of the data source connector sync.
- `"syncStatus"`: Only returns synchronization jobs with the Status field equal to the
specified status.
"""
function list_data_source_sync_jobs(
applicationId, dataSourceId, indexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"GET",
"/applications/$(applicationId)/indices/$(indexId)/datasources/$(dataSourceId)/syncjobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_data_source_sync_jobs(
applicationId,
dataSourceId,
indexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"GET",
"/applications/$(applicationId)/indices/$(indexId)/datasources/$(dataSourceId)/syncjobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_data_sources(application_id, index_id)
list_data_sources(application_id, index_id, params::Dict{String,<:Any})
Lists the Amazon Q Business data source connectors that you have created.
# Arguments
- `application_id`: The identifier of the Amazon Q Business application linked to the data
source connectors.
- `index_id`: The identifier of the index used with one or more data source connectors.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of data source connectors to return.
- `"nextToken"`: If the maxResults response was incomplete because there is more data to
retrieve, Amazon Q Business returns a pagination token in the response. You can use this
pagination token to retrieve the next set of Amazon Q Business data source connectors.
"""
function list_data_sources(
applicationId, indexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"GET",
"/applications/$(applicationId)/indices/$(indexId)/datasources";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_data_sources(
applicationId,
indexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"GET",
"/applications/$(applicationId)/indices/$(indexId)/datasources",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_documents(application_id, index_id)
list_documents(application_id, index_id, params::Dict{String,<:Any})
A list of documents attached to an index.
# Arguments
- `application_id`: The identifier of the application id the documents are attached to.
- `index_id`: The identifier of the index the documents are attached to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"dataSourceIds"`: The identifier of the data sources the documents are attached to.
- `"maxResults"`: The maximum number of documents to return.
- `"nextToken"`: If the maxResults response was incomplete because there is more data to
retrieve, Amazon Q Business returns a pagination token in the response. You can use this
pagination token to retrieve the next set of documents.
"""
function list_documents(
applicationId, indexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"GET",
"/applications/$(applicationId)/index/$(indexId)/documents";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_documents(
applicationId,
indexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"GET",
"/applications/$(applicationId)/index/$(indexId)/documents",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_groups(application_id, index_id, updated_earlier_than)
list_groups(application_id, index_id, updated_earlier_than, params::Dict{String,<:Any})
Provides a list of groups that are mapped to users.
# Arguments
- `application_id`: The identifier of the application for getting a list of groups mapped
to users.
- `index_id`: The identifier of the index for getting a list of groups mapped to users.
- `updated_earlier_than`: The timestamp identifier used for the latest PUT or DELETE action
for mapping users to their groups.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"dataSourceId"`: The identifier of the data source for getting a list of groups mapped
to users.
- `"maxResults"`: The maximum number of returned groups that are mapped to users.
- `"nextToken"`: If the previous response was incomplete (because there is more data to
retrieve), Amazon Q Business returns a pagination token in the response. You can use this
pagination token to retrieve the next set of groups that are mapped to users.
"""
function list_groups(
applicationId,
indexId,
updatedEarlierThan;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"GET",
"/applications/$(applicationId)/indices/$(indexId)/groups",
Dict{String,Any}("updatedEarlierThan" => updatedEarlierThan);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_groups(
applicationId,
indexId,
updatedEarlierThan,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"GET",
"/applications/$(applicationId)/indices/$(indexId)/groups",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("updatedEarlierThan" => updatedEarlierThan), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_indices(application_id)
list_indices(application_id, params::Dict{String,<:Any})
Lists the Amazon Q Business indices you have created.
# Arguments
- `application_id`: The identifier of the Amazon Q Business application connected to the
index.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of indices to return.
- `"nextToken"`: If the maxResults response was incomplete because there is more data to
retrieve, Amazon Q Business returns a pagination token in the response. You can use this
pagination token to retrieve the next set of Amazon Q Business indices.
"""
function list_indices(applicationId; aws_config::AbstractAWSConfig=global_aws_config())
return qbusiness(
"GET",
"/applications/$(applicationId)/indices";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_indices(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"GET",
"/applications/$(applicationId)/indices",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_messages(application_id, conversation_id)
list_messages(application_id, conversation_id, params::Dict{String,<:Any})
Gets a list of messages associated with an Amazon Q Business web experience.
# Arguments
- `application_id`: The identifier for the Amazon Q Business application.
- `conversation_id`: The identifier of the Amazon Q Business web experience conversation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of messages to return.
- `"nextToken"`: If the number of retrievers returned exceeds maxResults, Amazon Q Business
returns a next token as a pagination token to retrieve the next set of messages.
- `"userId"`: The identifier of the user involved in the Amazon Q Business web experience
conversation.
"""
function list_messages(
applicationId, conversationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"GET",
"/applications/$(applicationId)/conversations/$(conversationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_messages(
applicationId,
conversationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"GET",
"/applications/$(applicationId)/conversations/$(conversationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_plugins(application_id)
list_plugins(application_id, params::Dict{String,<:Any})
Lists configured Amazon Q Business plugins.
# Arguments
- `application_id`: The identifier of the application the plugin is attached to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of documents to return.
- `"nextToken"`: If the maxResults response was incomplete because there is more data to
retrieve, Amazon Q Business returns a pagination token in the response. You can use this
pagination token to retrieve the next set of plugins.
"""
function list_plugins(applicationId; aws_config::AbstractAWSConfig=global_aws_config())
return qbusiness(
"GET",
"/applications/$(applicationId)/plugins";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_plugins(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"GET",
"/applications/$(applicationId)/plugins",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_retrievers(application_id)
list_retrievers(application_id, params::Dict{String,<:Any})
Lists the retriever used by an Amazon Q Business application.
# Arguments
- `application_id`: The identifier of the Amazon Q Business application using the retriever.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of retrievers returned.
- `"nextToken"`: If the number of retrievers returned exceeds maxResults, Amazon Q Business
returns a next token as a pagination token to retrieve the next set of retrievers.
"""
function list_retrievers(applicationId; aws_config::AbstractAWSConfig=global_aws_config())
return qbusiness(
"GET",
"/applications/$(applicationId)/retrievers";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_retrievers(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"GET",
"/applications/$(applicationId)/retrievers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Gets a list of tags associated with a specified resource. Amazon Q Business applications
and data sources can have tags associated with them.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the Amazon Q Business application or
data source to get a list of tags for.
"""
function list_tags_for_resource(
resourceARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"GET",
"/v1/tags/$(resourceARN)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"GET",
"/v1/tags/$(resourceARN)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_web_experiences(application_id)
list_web_experiences(application_id, params::Dict{String,<:Any})
Lists one or more Amazon Q Business Web Experiences.
# Arguments
- `application_id`: The identifier of the Amazon Q Business application linked to the
listed web experiences.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of Amazon Q Business Web Experiences to return.
- `"nextToken"`: If the maxResults response was incomplete because there is more data to
retrieve, Amazon Q Business returns a pagination token in the response. You can use this
pagination token to retrieve the next set of Amazon Q Business conversations.
"""
function list_web_experiences(
applicationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"GET",
"/applications/$(applicationId)/experiences";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_web_experiences(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"GET",
"/applications/$(applicationId)/experiences",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_feedback(application_id, conversation_id, message_id)
put_feedback(application_id, conversation_id, message_id, params::Dict{String,<:Any})
Enables your end user to provide feedback on their Amazon Q Business generated chat
responses.
# Arguments
- `application_id`: The identifier of the application associated with the feedback.
- `conversation_id`: The identifier of the conversation the feedback is attached to.
- `message_id`: The identifier of the chat message that the feedback was given for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"messageCopiedAt"`: The timestamp for when the feedback was recorded.
- `"messageUsefulness"`: The feedback usefulness value given by the user to the chat
message.
- `"userId"`: The identifier of the user giving the feedback.
"""
function put_feedback(
applicationId,
conversationId,
messageId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"POST",
"/applications/$(applicationId)/conversations/$(conversationId)/messages/$(messageId)/feedback";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_feedback(
applicationId,
conversationId,
messageId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"POST",
"/applications/$(applicationId)/conversations/$(conversationId)/messages/$(messageId)/feedback",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_group(application_id, group_members, group_name, index_id, type)
put_group(application_id, group_members, group_name, index_id, type, params::Dict{String,<:Any})
Create, or updates, a mapping of users—who have access to a document—to groups. You can
also map sub groups to groups. For example, the group \"Company Intellectual Property
Teams\" includes sub groups \"Research\" and \"Engineering\". These sub groups include
their own list of users or people who work in these teams. Only users who work in research
and engineering, and therefore belong in the intellectual property group, can see
top-secret company documents in their Amazon Q Business chat results.
# Arguments
- `application_id`: The identifier of the application in which the user and group mapping
belongs.
- `group_members`:
- `group_name`: The list that contains your users or sub groups that belong the same group.
For example, the group \"Company\" includes the user \"CEO\" and the sub groups
\"Research\", \"Engineering\", and \"Sales and Marketing\". If you have more than 1000
users and/or sub groups for a single group, you need to provide the path to the S3 file
that lists your users and sub groups for a group. Your sub groups can contain more than
1000 users, but the list of sub groups that belong to a group (and/or users) must be no
more than 1000.
- `index_id`: The identifier of the index in which you want to map users to their groups.
- `type`: The type of the group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"dataSourceId"`: The identifier of the data source for which you want to map users to
their groups. This is useful if a group is tied to multiple data sources, but you only want
the group to access documents of a certain data source. For example, the groups
\"Research\", \"Engineering\", and \"Sales and Marketing\" are all tied to the company's
documents stored in the data sources Confluence and Salesforce. However, \"Sales and
Marketing\" team only needs access to customer-related documents stored in Salesforce.
"""
function put_group(
applicationId,
groupMembers,
groupName,
indexId,
type;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"PUT",
"/applications/$(applicationId)/indices/$(indexId)/groups",
Dict{String,Any}(
"groupMembers" => groupMembers, "groupName" => groupName, "type" => type
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_group(
applicationId,
groupMembers,
groupName,
indexId,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"PUT",
"/applications/$(applicationId)/indices/$(indexId)/groups",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"groupMembers" => groupMembers, "groupName" => groupName, "type" => type
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_data_source_sync_job(application_id, data_source_id, index_id)
start_data_source_sync_job(application_id, data_source_id, index_id, params::Dict{String,<:Any})
Starts a data source connector synchronization job. If a synchronization job is already in
progress, Amazon Q Business returns a ConflictException.
# Arguments
- `application_id`: The identifier of Amazon Q Business application the data source is
connected to.
- `data_source_id`: The identifier of the data source connector.
- `index_id`: The identifier of the index used with the data source connector.
"""
function start_data_source_sync_job(
applicationId, dataSourceId, indexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"POST",
"/applications/$(applicationId)/indices/$(indexId)/datasources/$(dataSourceId)/startsync";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_data_source_sync_job(
applicationId,
dataSourceId,
indexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"POST",
"/applications/$(applicationId)/indices/$(indexId)/datasources/$(dataSourceId)/startsync",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_data_source_sync_job(application_id, data_source_id, index_id)
stop_data_source_sync_job(application_id, data_source_id, index_id, params::Dict{String,<:Any})
Stops an Amazon Q Business data source connector synchronization job already in progress.
# Arguments
- `application_id`: The identifier of the Amazon Q Business application that the data
source is connected to.
- `data_source_id`: The identifier of the data source connector.
- `index_id`: The identifier of the index used with the Amazon Q Business data source
connector.
"""
function stop_data_source_sync_job(
applicationId, dataSourceId, indexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"POST",
"/applications/$(applicationId)/indices/$(indexId)/datasources/$(dataSourceId)/stopsync";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_data_source_sync_job(
applicationId,
dataSourceId,
indexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"POST",
"/applications/$(applicationId)/indices/$(indexId)/datasources/$(dataSourceId)/stopsync",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds the specified tag to the specified Amazon Q Business application or data source
resource. If the tag already exists, the existing value is replaced with the new value.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the Amazon Q Business application or
data source to tag.
- `tags`: A list of tag keys to add to the Amazon Q Business application or data source. If
a tag already exists, the existing value is replaced with the new value.
"""
function tag_resource(resourceARN, tags; aws_config::AbstractAWSConfig=global_aws_config())
return qbusiness(
"POST",
"/v1/tags/$(resourceARN)",
Dict{String,Any}("tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resourceARN,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"POST",
"/v1/tags/$(resourceARN)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tags" => tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes a tag from an Amazon Q Business application or a data source.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the Amazon Q Business application, or
data source to remove the tag from.
- `tag_keys`: A list of tag keys to remove from the Amazon Q Business application or data
source. If a tag key does not exist on the resource, it is ignored.
"""
function untag_resource(
resourceARN, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"DELETE",
"/v1/tags/$(resourceARN)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceARN,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"DELETE",
"/v1/tags/$(resourceARN)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_application(application_id)
update_application(application_id, params::Dict{String,<:Any})
Updates an existing Amazon Q Business application.
# Arguments
- `application_id`: The identifier of the Amazon Q Business application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"attachmentsConfiguration"`: An option to allow end users to upload files directly
during chat.
- `"description"`: A description for the Amazon Q Business application.
- `"displayName"`: A name for the Amazon Q Business application.
- `"identityCenterInstanceArn"`: The Amazon Resource Name (ARN) of the IAM Identity Center
instance you are either creating for—or connecting to—your Amazon Q Business
application.
- `"qAppsConfiguration"`: An option to allow end users to create and use Amazon Q Apps in
the web experience.
- `"roleArn"`: An Amazon Web Services Identity and Access Management (IAM) role that gives
Amazon Q Business permission to access Amazon CloudWatch logs and metrics.
"""
function update_application(
applicationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"PUT",
"/applications/$(applicationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_application(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"PUT",
"/applications/$(applicationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_chat_controls_configuration(application_id)
update_chat_controls_configuration(application_id, params::Dict{String,<:Any})
Updates an set of chat controls configured for an existing Amazon Q Business application.
# Arguments
- `application_id`: The identifier of the application for which the chat controls are
configured.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"blockedPhrasesConfigurationUpdate"`: The phrases blocked from chat by your chat control
configuration.
- `"clientToken"`: A token that you provide to identify the request to update a Amazon Q
Business application chat configuration.
- `"creatorModeConfiguration"`: The configuration details for CREATOR_MODE.
- `"responseScope"`: The response scope configured for your application. This determines
whether your application uses its retrieval augmented generation (RAG) system to generate
answers only from your enterprise data, or also uses the large language models (LLM)
knowledge to respons to end user questions in chat.
- `"topicConfigurationsToCreateOrUpdate"`: The configured topic specific chat controls you
want to update.
- `"topicConfigurationsToDelete"`: The configured topic specific chat controls you want to
delete.
"""
function update_chat_controls_configuration(
applicationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"PATCH",
"/applications/$(applicationId)/chatcontrols",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_chat_controls_configuration(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"PATCH",
"/applications/$(applicationId)/chatcontrols",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_data_source(application_id, data_source_id, index_id)
update_data_source(application_id, data_source_id, index_id, params::Dict{String,<:Any})
Updates an existing Amazon Q Business data source connector.
# Arguments
- `application_id`: The identifier of the Amazon Q Business application the data source is
attached to.
- `data_source_id`: The identifier of the data source connector.
- `index_id`: The identifier of the index attached to the data source connector.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"configuration"`:
- `"description"`: The description of the data source connector.
- `"displayName"`: A name of the data source connector.
- `"documentEnrichmentConfiguration"`:
- `"roleArn"`: The Amazon Resource Name (ARN) of an IAM role with permission to access the
data source and required resources.
- `"syncSchedule"`: The chosen update frequency for your data source.
- `"vpcConfiguration"`:
"""
function update_data_source(
applicationId, dataSourceId, indexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"PUT",
"/applications/$(applicationId)/indices/$(indexId)/datasources/$(dataSourceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_data_source(
applicationId,
dataSourceId,
indexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"PUT",
"/applications/$(applicationId)/indices/$(indexId)/datasources/$(dataSourceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_index(application_id, index_id)
update_index(application_id, index_id, params::Dict{String,<:Any})
Updates an Amazon Q Business index.
# Arguments
- `application_id`: The identifier of the Amazon Q Business application connected to the
index.
- `index_id`: The identifier of the Amazon Q Business index.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"capacityConfiguration"`: The storage capacity units you want to provision for your
Amazon Q Business index. You can add and remove capacity to fit your usage needs.
- `"description"`: The description of the Amazon Q Business index.
- `"displayName"`: The name of the Amazon Q Business index.
- `"documentAttributeConfigurations"`: Configuration information for document metadata or
fields. Document metadata are fields or attributes associated with your documents. For
example, the company department name associated with each document. For more information,
see Understanding document attributes.
"""
function update_index(
applicationId, indexId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"PUT",
"/applications/$(applicationId)/indices/$(indexId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_index(
applicationId,
indexId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"PUT",
"/applications/$(applicationId)/indices/$(indexId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_plugin(application_id, plugin_id)
update_plugin(application_id, plugin_id, params::Dict{String,<:Any})
Updates an Amazon Q Business plugin.
# Arguments
- `application_id`: The identifier of the application the plugin is attached to.
- `plugin_id`: The identifier of the plugin.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"authConfiguration"`: The authentication configuration the plugin is using.
- `"customPluginConfiguration"`: The configuration for a custom plugin.
- `"displayName"`: The name of the plugin.
- `"serverUrl"`: The source URL used for plugin configuration.
- `"state"`: The status of the plugin.
"""
function update_plugin(
applicationId, pluginId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"PUT",
"/applications/$(applicationId)/plugins/$(pluginId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_plugin(
applicationId,
pluginId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"PUT",
"/applications/$(applicationId)/plugins/$(pluginId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_retriever(application_id, retriever_id)
update_retriever(application_id, retriever_id, params::Dict{String,<:Any})
Updates the retriever used for your Amazon Q Business application.
# Arguments
- `application_id`: The identifier of your Amazon Q Business application.
- `retriever_id`: The identifier of your retriever.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"configuration"`:
- `"displayName"`: The name of your retriever.
- `"roleArn"`: The Amazon Resource Name (ARN) of an IAM role with permission to access the
retriever and required resources.
"""
function update_retriever(
applicationId, retrieverId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"PUT",
"/applications/$(applicationId)/retrievers/$(retrieverId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_retriever(
applicationId,
retrieverId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"PUT",
"/applications/$(applicationId)/retrievers/$(retrieverId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_user(application_id, user_id)
update_user(application_id, user_id, params::Dict{String,<:Any})
Updates a information associated with a user id.
# Arguments
- `application_id`: The identifier of the application the user is attached to.
- `user_id`: The email id attached to the user.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"userAliasesToDelete"`: The user aliases attached to the user id that are to be deleted.
- `"userAliasesToUpdate"`: The user aliases attached to the user id that are to be updated.
"""
function update_user(
applicationId, userId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"PUT",
"/applications/$(applicationId)/users/$(userId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_user(
applicationId,
userId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"PUT",
"/applications/$(applicationId)/users/$(userId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_web_experience(application_id, web_experience_id)
update_web_experience(application_id, web_experience_id, params::Dict{String,<:Any})
Updates an Amazon Q Business web experience.
# Arguments
- `application_id`: The identifier of the Amazon Q Business application attached to the web
experience.
- `web_experience_id`: The identifier of the Amazon Q Business web experience.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"authenticationConfiguration"`: The authentication configuration of the Amazon Q
Business web experience.
- `"roleArn"`: The Amazon Resource Name (ARN) of the role with permission to access the
Amazon Q Business web experience and required resources.
- `"samplePromptsControlMode"`: Determines whether sample prompts are enabled in the web
experience for an end user.
- `"subtitle"`: The subtitle of the Amazon Q Business web experience.
- `"title"`: The title of the Amazon Q Business web experience.
- `"welcomeMessage"`: A customized welcome message for an end user in an Amazon Q Business
web experience.
"""
function update_web_experience(
applicationId, webExperienceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qbusiness(
"PUT",
"/applications/$(applicationId)/experiences/$(webExperienceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_web_experience(
applicationId,
webExperienceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qbusiness(
"PUT",
"/applications/$(applicationId)/experiences/$(webExperienceId)",
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 | 66193 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: qconnect
using AWS.Compat
using AWS.UUIDs
"""
create_assistant(name, type)
create_assistant(name, type, params::Dict{String,<:Any})
Creates an Amazon Q in Connect assistant.
# Arguments
- `name`: The name of the assistant.
- `type`: The type of assistant.
# 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 assistant.
- `"serverSideEncryptionConfiguration"`: The configuration information for the customer
managed key used for encryption. The customer managed key must have a policy that allows
kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the
IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with
chat, the key policy must also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey
permissions to the connect.amazonaws.com service principal. For more information about
setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect
for your instance.
- `"tags"`: The tags used to organize, track, or control access for this resource.
"""
function create_assistant(name, type; aws_config::AbstractAWSConfig=global_aws_config())
return qconnect(
"POST",
"/assistants",
Dict{String,Any}("name" => name, "type" => type, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_assistant(
name,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"POST",
"/assistants",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name, "type" => type, "clientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_assistant_association(assistant_id, association, association_type)
create_assistant_association(assistant_id, association, association_type, params::Dict{String,<:Any})
Creates an association between an Amazon Q in Connect assistant and another resource.
Currently, the only supported association is with a knowledge base. An assistant can have
only a single association.
# Arguments
- `assistant_id`: The identifier of the Amazon Q in Connect assistant. Can be either the ID
or the ARN. URLs cannot contain the ARN.
- `association`: The identifier of the associated resource.
- `association_type`: The type of association.
# 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.
- `"tags"`: The tags used to organize, track, or control access for this resource.
"""
function create_assistant_association(
assistantId,
association,
associationType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"POST",
"/assistants/$(assistantId)/associations",
Dict{String,Any}(
"association" => association,
"associationType" => associationType,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_assistant_association(
assistantId,
association,
associationType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"POST",
"/assistants/$(assistantId)/associations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"association" => association,
"associationType" => associationType,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_content(knowledge_base_id, name, upload_id)
create_content(knowledge_base_id, name, upload_id, params::Dict{String,<:Any})
Creates Amazon Q in Connect content. Before to calling this API, use StartContentUpload to
upload an asset.
# Arguments
- `knowledge_base_id`: The identifier of the knowledge base. This should not be a
QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain
the ARN.
- `name`: The name of the content. Each piece of content in a knowledge base must have a
unique name. You can retrieve a piece of content using only its knowledge base and its name
with the SearchContent API.
- `upload_id`: A pointer to the uploaded asset. This value is returned by
StartContentUpload.
# 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.
- `"metadata"`: A key/value map to store attributes without affecting tagging or
recommendations. For example, when synchronizing data between an external system and Amazon
Q in Connect, you can store an external version identifier as metadata to utilize for
determining drift.
- `"overrideLinkOutUri"`: The URI you want to use for the article. If the knowledge base
has a templateUri, setting this argument overrides it for this piece of content.
- `"tags"`: The tags used to organize, track, or control access for this resource.
- `"title"`: The title of the content. If not set, the title is equal to the name.
"""
function create_content(
knowledgeBaseId, name, uploadId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qconnect(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/contents",
Dict{String,Any}(
"name" => name, "uploadId" => uploadId, "clientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_content(
knowledgeBaseId,
name,
uploadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/contents",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name, "uploadId" => uploadId, "clientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_knowledge_base(knowledge_base_type, name)
create_knowledge_base(knowledge_base_type, name, params::Dict{String,<:Any})
Creates a knowledge base. When using this API, you cannot reuse Amazon AppIntegrations
DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you
do, you'll get an InvalidRequestException error. For example, you're programmatically
managing your external knowledge base, and you want to add or remove one of the fields that
is being ingested from Salesforce. Do the following: Call DeleteKnowledgeBase. Call
DeleteDataIntegration. Call CreateDataIntegration to recreate the DataIntegration or a
create different one. Call CreateKnowledgeBase.
# Arguments
- `knowledge_base_type`: The type of knowledge base. Only CUSTOM knowledge bases allow you
to upload your own content. EXTERNAL knowledge bases support integrations with third-party
systems whose content is synchronized automatically.
- `name`: The name of the knowledge base.
# 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.
- `"renderingConfiguration"`: Information about how to render the content.
- `"serverSideEncryptionConfiguration"`: The configuration information for the customer
managed key used for encryption. This KMS key must have a policy that allows
kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the
IAM identity using the key to invoke Amazon Q in Connect. For more information about
setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect
for your instance.
- `"sourceConfiguration"`: The source of the knowledge base content. Only set this argument
for EXTERNAL knowledge bases.
- `"tags"`: The tags used to organize, track, or control access for this resource.
"""
function create_knowledge_base(
knowledgeBaseType, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return qconnect(
"POST",
"/knowledgeBases",
Dict{String,Any}(
"knowledgeBaseType" => knowledgeBaseType,
"name" => name,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_knowledge_base(
knowledgeBaseType,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"POST",
"/knowledgeBases",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"knowledgeBaseType" => knowledgeBaseType,
"name" => name,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_quick_response(content, knowledge_base_id, name)
create_quick_response(content, knowledge_base_id, name, params::Dict{String,<:Any})
Creates an Amazon Q in Connect quick response.
# Arguments
- `content`: The content of the quick response.
- `knowledge_base_id`: The identifier of the knowledge base. Can be either the ID or the
ARN. URLs cannot contain the ARN.
- `name`: The name of the quick response.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"channels"`: The Amazon Connect channels this quick response applies to.
- `"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.
- `"contentType"`: The media type of the quick response content. Use
application/x.quickresponse;format=plain for a quick response written in plain text. Use
application/x.quickresponse;format=markdown for a quick response written in richtext.
- `"description"`: The description of the quick response.
- `"groupingConfiguration"`: The configuration information of the user groups that the
quick response is accessible to.
- `"isActive"`: Whether the quick response is active.
- `"language"`: The language code value for the language in which the quick response is
written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT,
ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
- `"shortcutKey"`: The shortcut key of the quick response. The value should be unique
across the knowledge base.
- `"tags"`: The tags used to organize, track, or control access for this resource.
"""
function create_quick_response(
content, knowledgeBaseId, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return qconnect(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/quickResponses",
Dict{String,Any}(
"content" => content, "name" => name, "clientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_quick_response(
content,
knowledgeBaseId,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/quickResponses",
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_session(assistant_id, name)
create_session(assistant_id, name, params::Dict{String,<:Any})
Creates a session. A session is a contextual container used for generating recommendations.
Amazon Connect creates a new Amazon Q in Connect session for each contact on which Amazon Q
in Connect is enabled.
# Arguments
- `assistant_id`: The identifier of the Amazon Q in Connect assistant. Can be either the ID
or the ARN. URLs cannot contain the ARN.
- `name`: The name of the session.
# 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.
- `"tagFilter"`: An object that can be used to specify Tag conditions.
- `"tags"`: The tags used to organize, track, or control access for this resource.
"""
function create_session(
assistantId, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return qconnect(
"POST",
"/assistants/$(assistantId)/sessions",
Dict{String,Any}("name" => name, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_session(
assistantId,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"POST",
"/assistants/$(assistantId)/sessions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("name" => name, "clientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_assistant(assistant_id)
delete_assistant(assistant_id, params::Dict{String,<:Any})
Deletes an assistant.
# Arguments
- `assistant_id`: The identifier of the Amazon Q in Connect assistant. Can be either the ID
or the ARN. URLs cannot contain the ARN.
"""
function delete_assistant(assistantId; aws_config::AbstractAWSConfig=global_aws_config())
return qconnect(
"DELETE",
"/assistants/$(assistantId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_assistant(
assistantId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"DELETE",
"/assistants/$(assistantId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_assistant_association(assistant_association_id, assistant_id)
delete_assistant_association(assistant_association_id, assistant_id, params::Dict{String,<:Any})
Deletes an assistant association.
# Arguments
- `assistant_association_id`: The identifier of the assistant association. Can be either
the ID or the ARN. URLs cannot contain the ARN.
- `assistant_id`: The identifier of the Amazon Q in Connect assistant. Can be either the ID
or the ARN. URLs cannot contain the ARN.
"""
function delete_assistant_association(
assistantAssociationId, assistantId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qconnect(
"DELETE",
"/assistants/$(assistantId)/associations/$(assistantAssociationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_assistant_association(
assistantAssociationId,
assistantId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"DELETE",
"/assistants/$(assistantId)/associations/$(assistantAssociationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_content(content_id, knowledge_base_id)
delete_content(content_id, knowledge_base_id, params::Dict{String,<:Any})
Deletes the content.
# Arguments
- `content_id`: The identifier of the content. Can be either the ID or the ARN. URLs cannot
contain the ARN.
- `knowledge_base_id`: The identifier of the knowledge base. Can be either the ID or the
ARN. URLs cannot contain the ARN.
"""
function delete_content(
contentId, knowledgeBaseId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qconnect(
"DELETE",
"/knowledgeBases/$(knowledgeBaseId)/contents/$(contentId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_content(
contentId,
knowledgeBaseId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"DELETE",
"/knowledgeBases/$(knowledgeBaseId)/contents/$(contentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_import_job(import_job_id, knowledge_base_id)
delete_import_job(import_job_id, knowledge_base_id, params::Dict{String,<:Any})
Deletes the quick response import job.
# Arguments
- `import_job_id`: The identifier of the import job to be deleted.
- `knowledge_base_id`: The identifier of the knowledge base.
"""
function delete_import_job(
importJobId, knowledgeBaseId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qconnect(
"DELETE",
"/knowledgeBases/$(knowledgeBaseId)/importJobs/$(importJobId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_import_job(
importJobId,
knowledgeBaseId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"DELETE",
"/knowledgeBases/$(knowledgeBaseId)/importJobs/$(importJobId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_knowledge_base(knowledge_base_id)
delete_knowledge_base(knowledge_base_id, params::Dict{String,<:Any})
Deletes the knowledge base. When you use this API to delete an external knowledge base
such as Salesforce or ServiceNow, you must also delete the Amazon AppIntegrations
DataIntegration. This is because you can't reuse the DataIntegration after it's been
associated with an external knowledge base. However, you can delete and recreate it. See
DeleteDataIntegration and CreateDataIntegration in the Amazon AppIntegrations API
Reference.
# Arguments
- `knowledge_base_id`: The knowledge base to delete content from. Can be either the ID or
the ARN. URLs cannot contain the ARN.
"""
function delete_knowledge_base(
knowledgeBaseId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qconnect(
"DELETE",
"/knowledgeBases/$(knowledgeBaseId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_knowledge_base(
knowledgeBaseId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"DELETE",
"/knowledgeBases/$(knowledgeBaseId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_quick_response(knowledge_base_id, quick_response_id)
delete_quick_response(knowledge_base_id, quick_response_id, params::Dict{String,<:Any})
Deletes a quick response.
# Arguments
- `knowledge_base_id`: The knowledge base from which the quick response is deleted. The
identifier of the knowledge base.
- `quick_response_id`: The identifier of the quick response to delete.
"""
function delete_quick_response(
knowledgeBaseId, quickResponseId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qconnect(
"DELETE",
"/knowledgeBases/$(knowledgeBaseId)/quickResponses/$(quickResponseId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_quick_response(
knowledgeBaseId,
quickResponseId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"DELETE",
"/knowledgeBases/$(knowledgeBaseId)/quickResponses/$(quickResponseId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_assistant(assistant_id)
get_assistant(assistant_id, params::Dict{String,<:Any})
Retrieves information about an assistant.
# Arguments
- `assistant_id`: The identifier of the Amazon Q in Connect assistant. Can be either the ID
or the ARN. URLs cannot contain the ARN.
"""
function get_assistant(assistantId; aws_config::AbstractAWSConfig=global_aws_config())
return qconnect(
"GET",
"/assistants/$(assistantId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_assistant(
assistantId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"GET",
"/assistants/$(assistantId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_assistant_association(assistant_association_id, assistant_id)
get_assistant_association(assistant_association_id, assistant_id, params::Dict{String,<:Any})
Retrieves information about an assistant association.
# Arguments
- `assistant_association_id`: The identifier of the assistant association. Can be either
the ID or the ARN. URLs cannot contain the ARN.
- `assistant_id`: The identifier of the Amazon Q in Connect assistant. Can be either the ID
or the ARN. URLs cannot contain the ARN.
"""
function get_assistant_association(
assistantAssociationId, assistantId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qconnect(
"GET",
"/assistants/$(assistantId)/associations/$(assistantAssociationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_assistant_association(
assistantAssociationId,
assistantId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"GET",
"/assistants/$(assistantId)/associations/$(assistantAssociationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_content(content_id, knowledge_base_id)
get_content(content_id, knowledge_base_id, params::Dict{String,<:Any})
Retrieves content, including a pre-signed URL to download the content.
# Arguments
- `content_id`: The identifier of the content. Can be either the ID or the ARN. URLs cannot
contain the ARN.
- `knowledge_base_id`: The identifier of the knowledge base. This should not be a
QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain
the ARN.
"""
function get_content(
contentId, knowledgeBaseId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qconnect(
"GET",
"/knowledgeBases/$(knowledgeBaseId)/contents/$(contentId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_content(
contentId,
knowledgeBaseId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"GET",
"/knowledgeBases/$(knowledgeBaseId)/contents/$(contentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_content_summary(content_id, knowledge_base_id)
get_content_summary(content_id, knowledge_base_id, params::Dict{String,<:Any})
Retrieves summary information about the content.
# Arguments
- `content_id`: The identifier of the content. Can be either the ID or the ARN. URLs cannot
contain the ARN.
- `knowledge_base_id`: The identifier of the knowledge base. Can be either the ID or the
ARN. URLs cannot contain the ARN.
"""
function get_content_summary(
contentId, knowledgeBaseId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qconnect(
"GET",
"/knowledgeBases/$(knowledgeBaseId)/contents/$(contentId)/summary";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_content_summary(
contentId,
knowledgeBaseId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"GET",
"/knowledgeBases/$(knowledgeBaseId)/contents/$(contentId)/summary",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_import_job(import_job_id, knowledge_base_id)
get_import_job(import_job_id, knowledge_base_id, params::Dict{String,<:Any})
Retrieves the started import job.
# Arguments
- `import_job_id`: The identifier of the import job to retrieve.
- `knowledge_base_id`: The identifier of the knowledge base that the import job belongs to.
"""
function get_import_job(
importJobId, knowledgeBaseId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qconnect(
"GET",
"/knowledgeBases/$(knowledgeBaseId)/importJobs/$(importJobId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_import_job(
importJobId,
knowledgeBaseId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"GET",
"/knowledgeBases/$(knowledgeBaseId)/importJobs/$(importJobId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_knowledge_base(knowledge_base_id)
get_knowledge_base(knowledge_base_id, params::Dict{String,<:Any})
Retrieves information about the knowledge base.
# Arguments
- `knowledge_base_id`: The identifier of the knowledge base. Can be either the ID or the
ARN. URLs cannot contain the ARN.
"""
function get_knowledge_base(
knowledgeBaseId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qconnect(
"GET",
"/knowledgeBases/$(knowledgeBaseId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_knowledge_base(
knowledgeBaseId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"GET",
"/knowledgeBases/$(knowledgeBaseId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_quick_response(knowledge_base_id, quick_response_id)
get_quick_response(knowledge_base_id, quick_response_id, params::Dict{String,<:Any})
Retrieves the quick response.
# Arguments
- `knowledge_base_id`: The identifier of the knowledge base. This should be a
QUICK_RESPONSES type knowledge base.
- `quick_response_id`: The identifier of the quick response.
"""
function get_quick_response(
knowledgeBaseId, quickResponseId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qconnect(
"GET",
"/knowledgeBases/$(knowledgeBaseId)/quickResponses/$(quickResponseId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_quick_response(
knowledgeBaseId,
quickResponseId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"GET",
"/knowledgeBases/$(knowledgeBaseId)/quickResponses/$(quickResponseId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_recommendations(assistant_id, session_id)
get_recommendations(assistant_id, session_id, params::Dict{String,<:Any})
This API will be discontinued starting June 1, 2024. To receive generative responses after
March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and
integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your
applications. Retrieves recommendations for the specified session. To avoid retrieving the
same recommendations in subsequent calls, use NotifyRecommendationsReceived. This API
supports long-polling behavior with the waitTimeSeconds parameter. Short poll is the
default behavior and only returns recommendations already available. To perform a manual
query against an assistant, use QueryAssistant.
# Arguments
- `assistant_id`: The identifier of the Amazon Q in Connect assistant. Can be either the ID
or the ARN. URLs cannot contain the ARN.
- `session_id`: The identifier of the session. Can be either the ID or the ARN. URLs cannot
contain the ARN.
# 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.
- `"waitTimeSeconds"`: The duration (in seconds) for which the call waits for a
recommendation to be made available before returning. If a recommendation is available, the
call returns sooner than WaitTimeSeconds. If no messages are available and the wait time
expires, the call returns successfully with an empty list.
"""
function get_recommendations(
assistantId, sessionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qconnect(
"GET",
"/assistants/$(assistantId)/sessions/$(sessionId)/recommendations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_recommendations(
assistantId,
sessionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"GET",
"/assistants/$(assistantId)/sessions/$(sessionId)/recommendations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_session(assistant_id, session_id)
get_session(assistant_id, session_id, params::Dict{String,<:Any})
Retrieves information for a specified session.
# Arguments
- `assistant_id`: The identifier of the Amazon Q in Connect assistant. Can be either the ID
or the ARN. URLs cannot contain the ARN.
- `session_id`: The identifier of the session. Can be either the ID or the ARN. URLs cannot
contain the ARN.
"""
function get_session(
assistantId, sessionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qconnect(
"GET",
"/assistants/$(assistantId)/sessions/$(sessionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_session(
assistantId,
sessionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"GET",
"/assistants/$(assistantId)/sessions/$(sessionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_assistant_associations(assistant_id)
list_assistant_associations(assistant_id, params::Dict{String,<:Any})
Lists information about assistant associations.
# Arguments
- `assistant_id`: The identifier of the Amazon Q in Connect assistant. Can be either the ID
or the ARN. URLs cannot contain the ARN.
# 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_assistant_associations(
assistantId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qconnect(
"GET",
"/assistants/$(assistantId)/associations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_assistant_associations(
assistantId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"GET",
"/assistants/$(assistantId)/associations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_assistants()
list_assistants(params::Dict{String,<:Any})
Lists information about assistants.
# 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_assistants(; aws_config::AbstractAWSConfig=global_aws_config())
return qconnect(
"GET", "/assistants"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_assistants(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return qconnect(
"GET", "/assistants", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_contents(knowledge_base_id)
list_contents(knowledge_base_id, params::Dict{String,<:Any})
Lists the content.
# Arguments
- `knowledge_base_id`: The identifier of the knowledge base. This should not be a
QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain
the ARN.
# 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_contents(knowledgeBaseId; aws_config::AbstractAWSConfig=global_aws_config())
return qconnect(
"GET",
"/knowledgeBases/$(knowledgeBaseId)/contents";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_contents(
knowledgeBaseId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"GET",
"/knowledgeBases/$(knowledgeBaseId)/contents",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_import_jobs(knowledge_base_id)
list_import_jobs(knowledge_base_id, params::Dict{String,<:Any})
Lists information about import jobs.
# Arguments
- `knowledge_base_id`: The identifier of the knowledge base. Can be either the ID or the
ARN. URLs cannot contain the ARN.
# 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_import_jobs(
knowledgeBaseId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qconnect(
"GET",
"/knowledgeBases/$(knowledgeBaseId)/importJobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_import_jobs(
knowledgeBaseId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"GET",
"/knowledgeBases/$(knowledgeBaseId)/importJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_knowledge_bases()
list_knowledge_bases(params::Dict{String,<:Any})
Lists the knowledge bases.
# 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_knowledge_bases(; aws_config::AbstractAWSConfig=global_aws_config())
return qconnect(
"GET", "/knowledgeBases"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_knowledge_bases(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return qconnect(
"GET",
"/knowledgeBases",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_quick_responses(knowledge_base_id)
list_quick_responses(knowledge_base_id, params::Dict{String,<:Any})
Lists information about quick response.
# Arguments
- `knowledge_base_id`: The identifier of the knowledge base. Can be either the ID or the
ARN. URLs cannot contain the ARN.
# 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_quick_responses(
knowledgeBaseId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qconnect(
"GET",
"/knowledgeBases/$(knowledgeBaseId)/quickResponses";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_quick_responses(
knowledgeBaseId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"GET",
"/knowledgeBases/$(knowledgeBaseId)/quickResponses",
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 qconnect(
"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 qconnect(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
notify_recommendations_received(assistant_id, recommendation_ids, session_id)
notify_recommendations_received(assistant_id, recommendation_ids, session_id, params::Dict{String,<:Any})
Removes the specified recommendations from the specified assistant's queue of newly
available recommendations. You can use this API in conjunction with GetRecommendations and
a waitTimeSeconds input for long-polling behavior and avoiding duplicate recommendations.
# Arguments
- `assistant_id`: The identifier of the Amazon Q in Connect assistant. Can be either the ID
or the ARN. URLs cannot contain the ARN.
- `recommendation_ids`: The identifiers of the recommendations.
- `session_id`: The identifier of the session. Can be either the ID or the ARN. URLs cannot
contain the ARN.
"""
function notify_recommendations_received(
assistantId,
recommendationIds,
sessionId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"POST",
"/assistants/$(assistantId)/sessions/$(sessionId)/recommendations/notify",
Dict{String,Any}("recommendationIds" => recommendationIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function notify_recommendations_received(
assistantId,
recommendationIds,
sessionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"POST",
"/assistants/$(assistantId)/sessions/$(sessionId)/recommendations/notify",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("recommendationIds" => recommendationIds), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_feedback(assistant_id, content_feedback, target_id, target_type)
put_feedback(assistant_id, content_feedback, target_id, target_type, params::Dict{String,<:Any})
Provides feedback against the specified assistant for the specified target. This API only
supports generative targets.
# Arguments
- `assistant_id`: The identifier of the Amazon Q in Connect assistant.
- `content_feedback`: Information about the feedback provided.
- `target_id`: The identifier of the feedback target.
- `target_type`: The type of the feedback target.
"""
function put_feedback(
assistantId,
contentFeedback,
targetId,
targetType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"PUT",
"/assistants/$(assistantId)/feedback",
Dict{String,Any}(
"contentFeedback" => contentFeedback,
"targetId" => targetId,
"targetType" => targetType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_feedback(
assistantId,
contentFeedback,
targetId,
targetType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"PUT",
"/assistants/$(assistantId)/feedback",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"contentFeedback" => contentFeedback,
"targetId" => targetId,
"targetType" => targetType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
query_assistant(assistant_id, query_text)
query_assistant(assistant_id, query_text, params::Dict{String,<:Any})
This API will be discontinued starting June 1, 2024. To receive generative responses after
March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and
integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your
applications. Performs a manual search against the specified assistant. To retrieve
recommendations for an assistant, use GetRecommendations.
# Arguments
- `assistant_id`: The identifier of the Amazon Q in Connect assistant. Can be either the ID
or the ARN. URLs cannot contain the ARN.
- `query_text`: The text to search 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 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.
- `"queryCondition"`: Information about how to query content.
- `"sessionId"`: The identifier of the Amazon Q in Connect session. Can be either the ID or
the ARN. URLs cannot contain the ARN.
"""
function query_assistant(
assistantId, queryText; aws_config::AbstractAWSConfig=global_aws_config()
)
return qconnect(
"POST",
"/assistants/$(assistantId)/query",
Dict{String,Any}("queryText" => queryText);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function query_assistant(
assistantId,
queryText,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"POST",
"/assistants/$(assistantId)/query",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("queryText" => queryText), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_knowledge_base_template_uri(knowledge_base_id)
remove_knowledge_base_template_uri(knowledge_base_id, params::Dict{String,<:Any})
Removes a URI template from a knowledge base.
# Arguments
- `knowledge_base_id`: The identifier of the knowledge base. Can be either the ID or the
ARN. URLs cannot contain the ARN.
"""
function remove_knowledge_base_template_uri(
knowledgeBaseId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qconnect(
"DELETE",
"/knowledgeBases/$(knowledgeBaseId)/templateUri";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_knowledge_base_template_uri(
knowledgeBaseId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"DELETE",
"/knowledgeBases/$(knowledgeBaseId)/templateUri",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_content(knowledge_base_id, search_expression)
search_content(knowledge_base_id, search_expression, params::Dict{String,<:Any})
Searches for content in a specified knowledge base. Can be used to get a specific content
resource by its name.
# Arguments
- `knowledge_base_id`: The identifier of the knowledge base. This should not be a
QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain
the ARN.
- `search_expression`: The search expression to filter 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.
"""
function search_content(
knowledgeBaseId, searchExpression; aws_config::AbstractAWSConfig=global_aws_config()
)
return qconnect(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/search",
Dict{String,Any}("searchExpression" => searchExpression);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_content(
knowledgeBaseId,
searchExpression,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/search",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("searchExpression" => searchExpression), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_quick_responses(knowledge_base_id, search_expression)
search_quick_responses(knowledge_base_id, search_expression, params::Dict{String,<:Any})
Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge
base.
# Arguments
- `knowledge_base_id`: The identifier of the knowledge base. This should be a
QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain
the ARN.
- `search_expression`: The search expression for querying the quick response.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"attributes"`: The user-defined Amazon Connect contact attributes to be resolved when
search results are returned.
- `"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_quick_responses(
knowledgeBaseId, searchExpression; aws_config::AbstractAWSConfig=global_aws_config()
)
return qconnect(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/search/quickResponses",
Dict{String,Any}("searchExpression" => searchExpression);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_quick_responses(
knowledgeBaseId,
searchExpression,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/search/quickResponses",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("searchExpression" => searchExpression), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_sessions(assistant_id, search_expression)
search_sessions(assistant_id, search_expression, params::Dict{String,<:Any})
Searches for sessions.
# Arguments
- `assistant_id`: The identifier of the Amazon Q in Connect assistant. Can be either the ID
or the ARN. URLs cannot contain the ARN.
- `search_expression`: The search expression to filter 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.
"""
function search_sessions(
assistantId, searchExpression; aws_config::AbstractAWSConfig=global_aws_config()
)
return qconnect(
"POST",
"/assistants/$(assistantId)/searchSessions",
Dict{String,Any}("searchExpression" => searchExpression);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_sessions(
assistantId,
searchExpression,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"POST",
"/assistants/$(assistantId)/searchSessions",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("searchExpression" => searchExpression), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_content_upload(content_type, knowledge_base_id)
start_content_upload(content_type, knowledge_base_id, params::Dict{String,<:Any})
Get a URL to upload content to a knowledge base. To upload content, first make a PUT
request to the returned URL with your file, making sure to include the required headers.
Then use CreateContent to finalize the content creation process or UpdateContent to modify
an existing resource. You can only upload content to a knowledge base of type CUSTOM.
# Arguments
- `content_type`: The type of content to upload.
- `knowledge_base_id`: The identifier of the knowledge base. Can be either the ID or the
ARN. URLs cannot contain the ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"presignedUrlTimeToLive"`: The expected expiration time of the generated presigned URL,
specified in minutes.
"""
function start_content_upload(
contentType, knowledgeBaseId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qconnect(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/upload",
Dict{String,Any}("contentType" => contentType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_content_upload(
contentType,
knowledgeBaseId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/upload",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("contentType" => contentType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_import_job(import_job_type, knowledge_base_id, upload_id)
start_import_job(import_job_type, knowledge_base_id, upload_id, params::Dict{String,<:Any})
Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source
file. Before calling this API, use StartContentUpload to upload an asset that contains the
resource data. For importing Amazon Q in Connect quick responses, you need to upload a
csv file including the quick responses. For information about how to format the csv file
for importing quick responses, see Import quick responses.
# Arguments
- `import_job_type`: The type of the import job. For importing quick response resource,
set the value to QUICK_RESPONSES.
- `knowledge_base_id`: The identifier of the knowledge base. Can be either the ID or the
ARN. URLs cannot contain the ARN. For importing Amazon Q in Connect quick responses, this
should be a QUICK_RESPONSES type knowledge base.
- `upload_id`: A pointer to the uploaded asset. This value is returned by
StartContentUpload.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: The tags used to organize, track, or control access for this resource.
- `"externalSourceConfiguration"`: The configuration information of the external source
that the resource data are imported from.
- `"metadata"`: The metadata fields of the imported Amazon Q in Connect resources.
"""
function start_import_job(
importJobType,
knowledgeBaseId,
uploadId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/importJobs",
Dict{String,Any}(
"importJobType" => importJobType,
"uploadId" => uploadId,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_import_job(
importJobType,
knowledgeBaseId,
uploadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/importJobs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"importJobType" => importJobType,
"uploadId" => uploadId,
"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})
Adds the specified tags to the specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
- `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 qconnect(
"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 qconnect(
"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 qconnect(
"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 qconnect(
"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_content(content_id, knowledge_base_id)
update_content(content_id, knowledge_base_id, params::Dict{String,<:Any})
Updates information about the content.
# Arguments
- `content_id`: The identifier of the content. Can be either the ID or the ARN. URLs cannot
contain the ARN.
- `knowledge_base_id`: The identifier of the knowledge base. This should not be a
QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"metadata"`: A key/value map to store attributes without affecting tagging or
recommendations. For example, when synchronizing data between an external system and Amazon
Q in Connect, you can store an external version identifier as metadata to utilize for
determining drift.
- `"overrideLinkOutUri"`: The URI for the article. If the knowledge base has a templateUri,
setting this argument overrides it for this piece of content. To remove an existing
overrideLinkOurUri, exclude this argument and set removeOverrideLinkOutUri to true.
- `"removeOverrideLinkOutUri"`: Unset the existing overrideLinkOutUri if it exists.
- `"revisionId"`: The revisionId of the content resource to update, taken from an earlier
call to GetContent, GetContentSummary, SearchContent, or ListContents. If included, this
argument acts as an optimistic lock to ensure content was not modified since it was last
read. If it has been modified, this API throws a PreconditionFailedException.
- `"title"`: The title of the content.
- `"uploadId"`: A pointer to the uploaded asset. This value is returned by
StartContentUpload.
"""
function update_content(
contentId, knowledgeBaseId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qconnect(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/contents/$(contentId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_content(
contentId,
knowledgeBaseId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/contents/$(contentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_knowledge_base_template_uri(knowledge_base_id, template_uri)
update_knowledge_base_template_uri(knowledge_base_id, template_uri, params::Dict{String,<:Any})
Updates the template URI of a knowledge base. This is only supported for knowledge bases of
type EXTERNAL. Include a single variable in {variable} format; this interpolated by Amazon
Q in Connect using ingested content. For example, if you ingest a Salesforce article, it
has an Id value, and you can set the template URI to
https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*{Id}*/view.
# Arguments
- `knowledge_base_id`: The identifier of the knowledge base. This should not be a
QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain
the ARN.
- `template_uri`: The template URI to update.
"""
function update_knowledge_base_template_uri(
knowledgeBaseId, templateUri; aws_config::AbstractAWSConfig=global_aws_config()
)
return qconnect(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/templateUri",
Dict{String,Any}("templateUri" => templateUri);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_knowledge_base_template_uri(
knowledgeBaseId,
templateUri,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/templateUri",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("templateUri" => templateUri), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_quick_response(knowledge_base_id, quick_response_id)
update_quick_response(knowledge_base_id, quick_response_id, params::Dict{String,<:Any})
Updates an existing Amazon Q in Connect quick response.
# Arguments
- `knowledge_base_id`: The identifier of the knowledge base. Can be either the ID or the
ARN. URLs cannot contain the ARN.
- `quick_response_id`: The identifier of the quick response.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"channels"`: The Amazon Connect contact channels this quick response applies to. The
supported contact channel types include Chat.
- `"content"`: The updated content of the quick response.
- `"contentType"`: The media type of the quick response content. Use
application/x.quickresponse;format=plain for quick response written in plain text. Use
application/x.quickresponse;format=markdown for quick response written in richtext.
- `"description"`: The updated description of the quick response.
- `"groupingConfiguration"`: The updated grouping configuration of the quick response.
- `"isActive"`: Whether the quick response is active.
- `"language"`: The language code value for the language in which the quick response is
written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT,
ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
- `"name"`: The name of the quick response.
- `"removeDescription"`: Whether to remove the description from the quick response.
- `"removeGroupingConfiguration"`: Whether to remove the grouping configuration of the
quick response.
- `"removeShortcutKey"`: Whether to remove the shortcut key of the quick response.
- `"shortcutKey"`: The shortcut key of the quick response. The value should be unique
across the knowledge base.
"""
function update_quick_response(
knowledgeBaseId, quickResponseId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qconnect(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/quickResponses/$(quickResponseId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_quick_response(
knowledgeBaseId,
quickResponseId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/quickResponses/$(quickResponseId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_session(assistant_id, session_id)
update_session(assistant_id, session_id, params::Dict{String,<:Any})
Updates a session. A session is a contextual container used for generating recommendations.
Amazon Connect updates the existing Amazon Q in Connect session for each contact on which
Amazon Q in Connect is enabled.
# Arguments
- `assistant_id`: The identifier of the Amazon Q in Connect assistant. Can be either the ID
or the ARN. URLs cannot contain the ARN.
- `session_id`: The identifier of the session. Can be either the ID or the ARN. URLs cannot
contain the ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description.
- `"tagFilter"`: An object that can be used to specify Tag conditions.
"""
function update_session(
assistantId, sessionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qconnect(
"POST",
"/assistants/$(assistantId)/sessions/$(sessionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_session(
assistantId,
sessionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qconnect(
"POST",
"/assistants/$(assistantId)/sessions/$(sessionId)",
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 | 37629 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: qldb
using AWS.Compat
using AWS.UUIDs
"""
cancel_journal_kinesis_stream(name, stream_id)
cancel_journal_kinesis_stream(name, stream_id, params::Dict{String,<:Any})
Ends a given Amazon QLDB journal stream. Before a stream can be canceled, its current
status must be ACTIVE. You can't restart a stream after you cancel it. Canceled QLDB stream
resources are subject to a 7-day retention period, so they are automatically deleted after
this limit expires.
# Arguments
- `name`: The name of the ledger.
- `stream_id`: The UUID (represented in Base62-encoded text) of the QLDB journal stream to
be canceled.
"""
function cancel_journal_kinesis_stream(
name, streamId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qldb(
"DELETE",
"/ledgers/$(name)/journal-kinesis-streams/$(streamId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_journal_kinesis_stream(
name,
streamId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qldb(
"DELETE",
"/ledgers/$(name)/journal-kinesis-streams/$(streamId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_ledger(name, permissions_mode)
create_ledger(name, permissions_mode, params::Dict{String,<:Any})
Creates a new ledger in your Amazon Web Services account in the current Region.
# Arguments
- `name`: The name of the ledger that you want to create. The name must be unique among all
of the ledgers in your Amazon Web Services account in the current Region. Naming
constraints for ledger names are defined in Quotas in Amazon QLDB in the Amazon QLDB
Developer Guide.
- `permissions_mode`: The permissions mode to assign to the ledger that you want to create.
This parameter can have one of the following values: ALLOW_ALL: A legacy permissions
mode that enables access control with API-level granularity for ledgers. This mode allows
users who have the SendCommand API permission for this ledger to run all PartiQL commands
(hence, ALLOW_ALL) on any tables in the specified ledger. This mode disregards any
table-level or command-level IAM permissions policies that you create for the ledger.
STANDARD: (Recommended) A permissions mode that enables access control with finer
granularity for ledgers, tables, and PartiQL commands. By default, this mode denies all
user requests to run any PartiQL commands on any tables in this ledger. To allow PartiQL
commands to run, you must create IAM permissions policies for specific table resources and
PartiQL actions, in addition to the SendCommand API permission for the ledger. For
information, see Getting started with the standard permissions mode in the Amazon QLDB
Developer Guide. We strongly recommend using the STANDARD permissions mode to maximize
the security of your ledger data.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeletionProtection"`: Specifies whether the ledger is protected from being deleted by
any user. If not defined during ledger creation, this feature is enabled (true) by default.
If deletion protection is enabled, you must first disable it before you can delete the
ledger. You can disable it by calling the UpdateLedger operation to set this parameter to
false.
- `"KmsKey"`: The key in Key Management Service (KMS) to use for encryption of data at rest
in the ledger. For more information, see Encryption at rest in the Amazon QLDB Developer
Guide. Use one of the following options to specify this parameter: AWS_OWNED_KMS_KEY:
Use an KMS key that is owned and managed by Amazon Web Services on your behalf.
Undefined: By default, use an Amazon Web Services owned KMS key. A valid symmetric
customer managed KMS key: Use the specified symmetric encryption KMS key in your account
that you create, own, and manage. Amazon QLDB does not support asymmetric keys. For more
information, see Using symmetric and asymmetric keys in the Key Management Service
Developer Guide. To specify a customer managed KMS key, you can use its key ID, Amazon
Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with
\"alias/\". To specify a key in a different Amazon Web Services account, you must use the
key ARN or alias ARN. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key
ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias
name: alias/ExampleAlias Alias ARN:
arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias For more information, see Key
identifiers (KeyId) in the Key Management Service Developer Guide.
- `"Tags"`: The key-value pairs to add as tags to the ledger that you want to create. Tag
keys are case sensitive. Tag values are case sensitive and can be null.
"""
function create_ledger(
Name, PermissionsMode; aws_config::AbstractAWSConfig=global_aws_config()
)
return qldb(
"POST",
"/ledgers",
Dict{String,Any}("Name" => Name, "PermissionsMode" => PermissionsMode);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_ledger(
Name,
PermissionsMode,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qldb(
"POST",
"/ledgers",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Name" => Name, "PermissionsMode" => PermissionsMode),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_ledger(name)
delete_ledger(name, params::Dict{String,<:Any})
Deletes a ledger and all of its contents. This action is irreversible. If deletion
protection is enabled, you must first disable it before you can delete the ledger. You can
disable it by calling the UpdateLedger operation to set this parameter to false.
# Arguments
- `name`: The name of the ledger that you want to delete.
"""
function delete_ledger(name; aws_config::AbstractAWSConfig=global_aws_config())
return qldb(
"DELETE", "/ledgers/$(name)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_ledger(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return qldb(
"DELETE",
"/ledgers/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_journal_kinesis_stream(name, stream_id)
describe_journal_kinesis_stream(name, stream_id, params::Dict{String,<:Any})
Returns detailed information about a given Amazon QLDB journal stream. The output includes
the Amazon Resource Name (ARN), stream name, current status, creation time, and the
parameters of the original stream creation request. This action does not return any expired
journal streams. For more information, see Expiration for terminal streams in the Amazon
QLDB Developer Guide.
# Arguments
- `name`: The name of the ledger.
- `stream_id`: The UUID (represented in Base62-encoded text) of the QLDB journal stream to
describe.
"""
function describe_journal_kinesis_stream(
name, streamId; aws_config::AbstractAWSConfig=global_aws_config()
)
return qldb(
"GET",
"/ledgers/$(name)/journal-kinesis-streams/$(streamId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_journal_kinesis_stream(
name,
streamId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qldb(
"GET",
"/ledgers/$(name)/journal-kinesis-streams/$(streamId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_journal_s3_export(export_id, name)
describe_journal_s3_export(export_id, name, params::Dict{String,<:Any})
Returns information about a journal export job, including the ledger name, export ID,
creation time, current status, and the parameters of the original export creation request.
This action does not return any expired export jobs. For more information, see Export job
expiration in the Amazon QLDB Developer Guide. If the export job with the given ExportId
doesn't exist, then throws ResourceNotFoundException. If the ledger with the given Name
doesn't exist, then throws ResourceNotFoundException.
# Arguments
- `export_id`: The UUID (represented in Base62-encoded text) of the journal export job to
describe.
- `name`: The name of the ledger.
"""
function describe_journal_s3_export(
exportId, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return qldb(
"GET",
"/ledgers/$(name)/journal-s3-exports/$(exportId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_journal_s3_export(
exportId,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qldb(
"GET",
"/ledgers/$(name)/journal-s3-exports/$(exportId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_ledger(name)
describe_ledger(name, params::Dict{String,<:Any})
Returns information about a ledger, including its state, permissions mode, encryption at
rest settings, and when it was created.
# Arguments
- `name`: The name of the ledger that you want to describe.
"""
function describe_ledger(name; aws_config::AbstractAWSConfig=global_aws_config())
return qldb(
"GET", "/ledgers/$(name)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_ledger(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return qldb(
"GET",
"/ledgers/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
export_journal_to_s3(exclusive_end_time, inclusive_start_time, role_arn, s3_export_configuration, name)
export_journal_to_s3(exclusive_end_time, inclusive_start_time, role_arn, s3_export_configuration, name, params::Dict{String,<:Any})
Exports journal contents within a date and time range from a ledger into a specified Amazon
Simple Storage Service (Amazon S3) bucket. A journal export job can write the data objects
in either the text or binary representation of Amazon Ion format, or in JSON Lines text
format. If the ledger with the given Name doesn't exist, then throws
ResourceNotFoundException. If the ledger with the given Name is in CREATING status, then
throws ResourcePreconditionNotMetException. You can initiate up to two concurrent journal
export requests for each ledger. Beyond this limit, journal export requests throw
LimitExceededException.
# Arguments
- `exclusive_end_time`: The exclusive end date and time for the range of journal contents
to export. The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal
Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z. The ExclusiveEndTime must be
less than or equal to the current UTC date and time.
- `inclusive_start_time`: The inclusive start date and time for the range of journal
contents to export. The InclusiveStartTime must be in ISO 8601 date and time format and in
Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z. The InclusiveStartTime
must be before ExclusiveEndTime. If you provide an InclusiveStartTime that is before the
ledger's CreationDateTime, Amazon QLDB defaults it to the ledger's CreationDateTime.
- `role_arn`: The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions
for a journal export job to do the following: Write objects into your Amazon S3 bucket.
(Optional) Use your customer managed key in Key Management Service (KMS) for server-side
encryption of your exported data. To pass a role to QLDB when requesting a journal
export, you must have permissions to perform the iam:PassRole action on the IAM role
resource. This is required for all journal export requests.
- `s3_export_configuration`: The configuration settings of the Amazon S3 bucket destination
for your export request.
- `name`: The name of the ledger.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"OutputFormat"`: The output format of your exported journal data. A journal export job
can write the data objects in either the text or binary representation of Amazon Ion
format, or in JSON Lines text format. Default: ION_TEXT In JSON Lines format, each journal
block in an exported data object is a valid JSON object that is delimited by a newline. You
can use this format to directly integrate JSON exports with analytics tools such as Amazon
Athena and Glue because these services can parse newline-delimited JSON automatically.
"""
function export_journal_to_s3(
ExclusiveEndTime,
InclusiveStartTime,
RoleArn,
S3ExportConfiguration,
name;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qldb(
"POST",
"/ledgers/$(name)/journal-s3-exports",
Dict{String,Any}(
"ExclusiveEndTime" => ExclusiveEndTime,
"InclusiveStartTime" => InclusiveStartTime,
"RoleArn" => RoleArn,
"S3ExportConfiguration" => S3ExportConfiguration,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function export_journal_to_s3(
ExclusiveEndTime,
InclusiveStartTime,
RoleArn,
S3ExportConfiguration,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qldb(
"POST",
"/ledgers/$(name)/journal-s3-exports",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ExclusiveEndTime" => ExclusiveEndTime,
"InclusiveStartTime" => InclusiveStartTime,
"RoleArn" => RoleArn,
"S3ExportConfiguration" => S3ExportConfiguration,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_block(block_address, name)
get_block(block_address, name, params::Dict{String,<:Any})
Returns a block object at a specified address in a journal. Also returns a proof of the
specified block for verification if DigestTipAddress is provided. For information about the
data contents in a block, see Journal contents in the Amazon QLDB Developer Guide. If the
specified ledger doesn't exist or is in DELETING status, then throws
ResourceNotFoundException. If the specified ledger is in CREATING status, then throws
ResourcePreconditionNotMetException. If no block exists with the specified address, then
throws InvalidParameterException.
# Arguments
- `block_address`: The location of the block that you want to request. An address is an
Amazon Ion structure that has two fields: strandId and sequenceNo. For example:
{strandId:\"BlFTjlSXze9BIh1KOszcE3\",sequenceNo:14}.
- `name`: The name of the ledger.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DigestTipAddress"`: The latest block location covered by the digest for which to
request a proof. An address is an Amazon Ion structure that has two fields: strandId and
sequenceNo. For example: {strandId:\"BlFTjlSXze9BIh1KOszcE3\",sequenceNo:49}.
"""
function get_block(BlockAddress, name; aws_config::AbstractAWSConfig=global_aws_config())
return qldb(
"POST",
"/ledgers/$(name)/block",
Dict{String,Any}("BlockAddress" => BlockAddress);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_block(
BlockAddress,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qldb(
"POST",
"/ledgers/$(name)/block",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("BlockAddress" => BlockAddress), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_digest(name)
get_digest(name, params::Dict{String,<:Any})
Returns the digest of a ledger at the latest committed block in the journal. The response
includes a 256-bit hash value and a block address.
# Arguments
- `name`: The name of the ledger.
"""
function get_digest(name; aws_config::AbstractAWSConfig=global_aws_config())
return qldb(
"POST",
"/ledgers/$(name)/digest";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_digest(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return qldb(
"POST",
"/ledgers/$(name)/digest",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_revision(block_address, document_id, name)
get_revision(block_address, document_id, name, params::Dict{String,<:Any})
Returns a revision data object for a specified document ID and block address. Also returns
a proof of the specified revision for verification if DigestTipAddress is provided.
# Arguments
- `block_address`: The block location of the document revision to be verified. An address
is an Amazon Ion structure that has two fields: strandId and sequenceNo. For example:
{strandId:\"BlFTjlSXze9BIh1KOszcE3\",sequenceNo:14}.
- `document_id`: The UUID (represented in Base62-encoded text) of the document to be
verified.
- `name`: The name of the ledger.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DigestTipAddress"`: The latest block location covered by the digest for which to
request a proof. An address is an Amazon Ion structure that has two fields: strandId and
sequenceNo. For example: {strandId:\"BlFTjlSXze9BIh1KOszcE3\",sequenceNo:49}.
"""
function get_revision(
BlockAddress, DocumentId, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return qldb(
"POST",
"/ledgers/$(name)/revision",
Dict{String,Any}("BlockAddress" => BlockAddress, "DocumentId" => DocumentId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_revision(
BlockAddress,
DocumentId,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qldb(
"POST",
"/ledgers/$(name)/revision",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"BlockAddress" => BlockAddress, "DocumentId" => DocumentId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_journal_kinesis_streams_for_ledger(name)
list_journal_kinesis_streams_for_ledger(name, params::Dict{String,<:Any})
Returns all Amazon QLDB journal streams for a given ledger. This action does not return any
expired journal streams. For more information, see Expiration for terminal streams in the
Amazon QLDB Developer Guide. This action returns a maximum of MaxResults items. It is
paginated so that you can retrieve all the items by calling
ListJournalKinesisStreamsForLedger multiple times.
# Arguments
- `name`: The name of the ledger.
# 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 in a single
ListJournalKinesisStreamsForLedger request. (The actual number of results returned might be
fewer.)
- `"next_token"`: A pagination token, indicating that you want to retrieve the next page of
results. If you received a value for NextToken in the response from a previous
ListJournalKinesisStreamsForLedger call, you should use that value as input here.
"""
function list_journal_kinesis_streams_for_ledger(
name; aws_config::AbstractAWSConfig=global_aws_config()
)
return qldb(
"GET",
"/ledgers/$(name)/journal-kinesis-streams";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_journal_kinesis_streams_for_ledger(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return qldb(
"GET",
"/ledgers/$(name)/journal-kinesis-streams",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_journal_s3_exports()
list_journal_s3_exports(params::Dict{String,<:Any})
Returns all journal export jobs for all ledgers that are associated with the current Amazon
Web Services account and Region. This action returns a maximum of MaxResults items, and is
paginated so that you can retrieve all the items by calling ListJournalS3Exports multiple
times. This action does not return any expired export jobs. For more information, see
Export job expiration in the Amazon QLDB Developer Guide.
# 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 in a single ListJournalS3Exports
request. (The actual number of results returned might be fewer.)
- `"next_token"`: A pagination token, indicating that you want to retrieve the next page of
results. If you received a value for NextToken in the response from a previous
ListJournalS3Exports call, then you should use that value as input here.
"""
function list_journal_s3_exports(; aws_config::AbstractAWSConfig=global_aws_config())
return qldb(
"GET", "/journal-s3-exports"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_journal_s3_exports(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return qldb(
"GET",
"/journal-s3-exports",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_journal_s3_exports_for_ledger(name)
list_journal_s3_exports_for_ledger(name, params::Dict{String,<:Any})
Returns all journal export jobs for a specified ledger. This action returns a maximum of
MaxResults items, and is paginated so that you can retrieve all the items by calling
ListJournalS3ExportsForLedger multiple times. This action does not return any expired
export jobs. For more information, see Export job expiration in the Amazon QLDB Developer
Guide.
# Arguments
- `name`: The name of the ledger.
# 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 in a single
ListJournalS3ExportsForLedger request. (The actual number of results returned might be
fewer.)
- `"next_token"`: A pagination token, indicating that you want to retrieve the next page of
results. If you received a value for NextToken in the response from a previous
ListJournalS3ExportsForLedger call, then you should use that value as input here.
"""
function list_journal_s3_exports_for_ledger(
name; aws_config::AbstractAWSConfig=global_aws_config()
)
return qldb(
"GET",
"/ledgers/$(name)/journal-s3-exports";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_journal_s3_exports_for_ledger(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return qldb(
"GET",
"/ledgers/$(name)/journal-s3-exports",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_ledgers()
list_ledgers(params::Dict{String,<:Any})
Returns all ledgers that are associated with the current Amazon Web Services account and
Region. This action returns a maximum of MaxResults items and is paginated so that you can
retrieve all the items by calling ListLedgers multiple times.
# 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 in a single ListLedgers request.
(The actual number of results returned might be fewer.)
- `"next_token"`: A pagination token, indicating that you want to retrieve the next page of
results. If you received a value for NextToken in the response from a previous ListLedgers
call, then you should use that value as input here.
"""
function list_ledgers(; aws_config::AbstractAWSConfig=global_aws_config())
return qldb("GET", "/ledgers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_ledgers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return qldb(
"GET", "/ledgers", 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 for a specified Amazon QLDB resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) for which to list the tags. For example:
arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return qldb(
"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 qldb(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stream_journal_to_kinesis(inclusive_start_time, kinesis_configuration, role_arn, stream_name, name)
stream_journal_to_kinesis(inclusive_start_time, kinesis_configuration, role_arn, stream_name, name, params::Dict{String,<:Any})
Creates a journal stream for a given Amazon QLDB ledger. The stream captures every document
revision that is committed to the ledger's journal and delivers the data to a specified
Amazon Kinesis Data Streams resource.
# Arguments
- `inclusive_start_time`: The inclusive start date and time from which to start streaming
journal data. This parameter must be in ISO 8601 date and time format and in Universal
Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z. The InclusiveStartTime cannot be
in the future and must be before ExclusiveEndTime. If you provide an InclusiveStartTime
that is before the ledger's CreationDateTime, QLDB effectively defaults it to the ledger's
CreationDateTime.
- `kinesis_configuration`: The configuration settings of the Kinesis Data Streams
destination for your stream request.
- `role_arn`: The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions
for a journal stream to write data records to a Kinesis Data Streams resource. To pass a
role to QLDB when requesting a journal stream, you must have permissions to perform the
iam:PassRole action on the IAM role resource. This is required for all journal stream
requests.
- `stream_name`: The name that you want to assign to the QLDB journal stream. User-defined
names can help identify and indicate the purpose of a stream. Your stream name must be
unique among other active streams for a given ledger. Stream names have the same naming
constraints as ledger names, as defined in Quotas in Amazon QLDB in the Amazon QLDB
Developer Guide.
- `name`: The name of the ledger.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExclusiveEndTime"`: The exclusive date and time that specifies when the stream ends. If
you don't define this parameter, the stream runs indefinitely until you cancel it. The
ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time
(UTC). For example: 2019-06-13T21:36:34Z.
- `"Tags"`: The key-value pairs to add as tags to the stream that you want to create. Tag
keys are case sensitive. Tag values are case sensitive and can be null.
"""
function stream_journal_to_kinesis(
InclusiveStartTime,
KinesisConfiguration,
RoleArn,
StreamName,
name;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qldb(
"POST",
"/ledgers/$(name)/journal-kinesis-streams",
Dict{String,Any}(
"InclusiveStartTime" => InclusiveStartTime,
"KinesisConfiguration" => KinesisConfiguration,
"RoleArn" => RoleArn,
"StreamName" => StreamName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stream_journal_to_kinesis(
InclusiveStartTime,
KinesisConfiguration,
RoleArn,
StreamName,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qldb(
"POST",
"/ledgers/$(name)/journal-kinesis-streams",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InclusiveStartTime" => InclusiveStartTime,
"KinesisConfiguration" => KinesisConfiguration,
"RoleArn" => RoleArn,
"StreamName" => StreamName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(tags, resource_arn)
tag_resource(tags, resource_arn, params::Dict{String,<:Any})
Adds one or more tags to a specified Amazon QLDB resource. A resource can have up to 50
tags. If you try to create more than 50 tags for a resource, your request fails and returns
an error.
# Arguments
- `tags`: The key-value pairs to add as tags to the specified QLDB resource. Tag keys are
case sensitive. If you specify a key that already exists for the resource, your request
fails and returns an error. Tag values are case sensitive and can be null.
- `resource_arn`: The Amazon Resource Name (ARN) to which you want to add the tags. For
example: arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger
"""
function tag_resource(Tags, resourceArn; aws_config::AbstractAWSConfig=global_aws_config())
return qldb(
"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 qldb(
"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 a specified Amazon QLDB resource. You can specify up to 50
tag keys to remove.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) from which to remove the tags. For
example: arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger
- `tag_keys`: The list of tag keys to remove.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return qldb(
"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 qldb(
"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_ledger(name)
update_ledger(name, params::Dict{String,<:Any})
Updates properties on a ledger.
# Arguments
- `name`: The name of the ledger.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeletionProtection"`: Specifies whether the ledger is protected from being deleted by
any user. If not defined during ledger creation, this feature is enabled (true) by default.
If deletion protection is enabled, you must first disable it before you can delete the
ledger. You can disable it by calling the UpdateLedger operation to set this parameter to
false.
- `"KmsKey"`: The key in Key Management Service (KMS) to use for encryption of data at rest
in the ledger. For more information, see Encryption at rest in the Amazon QLDB Developer
Guide. Use one of the following options to specify this parameter: AWS_OWNED_KMS_KEY:
Use an KMS key that is owned and managed by Amazon Web Services on your behalf.
Undefined: Make no changes to the KMS key of the ledger. A valid symmetric customer
managed KMS key: Use the specified symmetric encryption KMS key in your account that you
create, own, and manage. Amazon QLDB does not support asymmetric keys. For more
information, see Using symmetric and asymmetric keys in the Key Management Service
Developer Guide. To specify a customer managed KMS key, you can use its key ID, Amazon
Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with
\"alias/\". To specify a key in a different Amazon Web Services account, you must use the
key ARN or alias ARN. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key
ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias
name: alias/ExampleAlias Alias ARN:
arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias For more information, see Key
identifiers (KeyId) in the Key Management Service Developer Guide.
"""
function update_ledger(name; aws_config::AbstractAWSConfig=global_aws_config())
return qldb(
"PATCH", "/ledgers/$(name)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function update_ledger(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return qldb(
"PATCH",
"/ledgers/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_ledger_permissions_mode(permissions_mode, name)
update_ledger_permissions_mode(permissions_mode, name, params::Dict{String,<:Any})
Updates the permissions mode of a ledger. Before you switch to the STANDARD permissions
mode, you must first create all required IAM policies and table tags to avoid disruption to
your users. To learn more, see Migrating to the standard permissions mode in the Amazon
QLDB Developer Guide.
# Arguments
- `permissions_mode`: The permissions mode to assign to the ledger. This parameter can have
one of the following values: ALLOW_ALL: A legacy permissions mode that enables access
control with API-level granularity for ledgers. This mode allows users who have the
SendCommand API permission for this ledger to run all PartiQL commands (hence, ALLOW_ALL)
on any tables in the specified ledger. This mode disregards any table-level or
command-level IAM permissions policies that you create for the ledger. STANDARD:
(Recommended) A permissions mode that enables access control with finer granularity for
ledgers, tables, and PartiQL commands. By default, this mode denies all user requests to
run any PartiQL commands on any tables in this ledger. To allow PartiQL commands to run,
you must create IAM permissions policies for specific table resources and PartiQL actions,
in addition to the SendCommand API permission for the ledger. For information, see Getting
started with the standard permissions mode in the Amazon QLDB Developer Guide. We
strongly recommend using the STANDARD permissions mode to maximize the security of your
ledger data.
- `name`: The name of the ledger.
"""
function update_ledger_permissions_mode(
PermissionsMode, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return qldb(
"PATCH",
"/ledgers/$(name)/permissions-mode",
Dict{String,Any}("PermissionsMode" => PermissionsMode);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_ledger_permissions_mode(
PermissionsMode,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return qldb(
"PATCH",
"/ledgers/$(name)/permissions-mode",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("PermissionsMode" => PermissionsMode), 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 | 2265 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: qldb_session
using AWS.Compat
using AWS.UUIDs
"""
send_command()
send_command(params::Dict{String,<:Any})
Sends a command to an Amazon QLDB ledger. Instead of interacting directly with this API,
we recommend using the QLDB driver or the QLDB shell to execute data transactions on a
ledger. If you are working with an AWS SDK, use the QLDB driver. The driver provides a
high-level abstraction layer above this QLDB Session data plane and manages SendCommand API
calls for you. For information and a list of supported programming languages, see Getting
started with the driver in the Amazon QLDB Developer Guide. If you are working with the
AWS Command Line Interface (AWS CLI), use the QLDB shell. The shell is a command line
interface that uses the QLDB driver to interact with a ledger. For information, see
Accessing Amazon QLDB using the QLDB shell.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AbortTransaction"`: Command to abort the current transaction.
- `"CommitTransaction"`: Command to commit the specified transaction.
- `"EndSession"`: Command to end the current session.
- `"ExecuteStatement"`: Command to execute a statement in the specified transaction.
- `"FetchPage"`: Command to fetch a page.
- `"SessionToken"`: Specifies the session token for the current command. A session token is
constant throughout the life of the session. To obtain a session token, run the
StartSession command. This SessionToken is required for every subsequent command that is
issued during the current session.
- `"StartSession"`: Command to start a new session. A session token is obtained as part of
the response.
- `"StartTransaction"`: Command to start a new transaction.
"""
function send_command(; aws_config::AbstractAWSConfig=global_aws_config())
return qldb_session(
"SendCommand"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function send_command(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return qldb_session(
"SendCommand", 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 | 306455 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: quicksight
using AWS.Compat
using AWS.UUIDs
"""
cancel_ingestion(aws_account_id, data_set_id, ingestion_id)
cancel_ingestion(aws_account_id, data_set_id, ingestion_id, params::Dict{String,<:Any})
Cancels an ongoing ingestion of data into SPICE.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID.
- `data_set_id`: The ID of the dataset used in the ingestion.
- `ingestion_id`: An ID for the ingestion.
"""
function cancel_ingestion(
AwsAccountId, DataSetId, IngestionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/data-sets/$(DataSetId)/ingestions/$(IngestionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_ingestion(
AwsAccountId,
DataSetId,
IngestionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/data-sets/$(DataSetId)/ingestions/$(IngestionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_account_customization(account_customization, aws_account_id)
create_account_customization(account_customization, aws_account_id, params::Dict{String,<:Any})
Creates Amazon QuickSight customizations for the current Amazon Web Services Region.
Currently, you can add a custom default theme by using the CreateAccountCustomization or
UpdateAccountCustomization API operation. To further customize Amazon QuickSight by
removing Amazon QuickSight sample assets and videos for all new users, see Customizing
Amazon QuickSight in the Amazon QuickSight User Guide. You can create customizations for
your Amazon Web Services account or, if you specify a namespace, for a QuickSight namespace
instead. Customizations that apply to a namespace always override customizations that apply
to an Amazon Web Services account. To find out which customizations apply, use the
DescribeAccountCustomization API operation. Before you use the CreateAccountCustomization
API operation to add a theme as the namespace default, make sure that you first share the
theme with the namespace. If you don't share it with the namespace, the theme isn't visible
to your users even if you make it the default theme. To check if the theme is shared, view
the current permissions by using the DescribeThemePermissions API operation. To share the
theme, grant permissions by using the UpdateThemePermissions API operation.
# Arguments
- `account_customization`: The Amazon QuickSight customizations you're adding in the
current Amazon Web Services Region. You can add these to an Amazon Web Services account and
a QuickSight namespace. For example, you can add a default theme by setting
AccountCustomization to the midnight theme: \"AccountCustomization\": { \"DefaultTheme\":
\"arn:aws:quicksight::aws:theme/MIDNIGHT\" }. Or, you can add a custom theme by specifying
\"AccountCustomization\": { \"DefaultTheme\":
\"arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639\" }.
- `aws_account_id`: The ID for the Amazon Web Services account that you want to customize
Amazon QuickSight for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: A list of the tags that you want to attach to this resource.
- `"namespace"`: The Amazon QuickSight namespace that you want to add customizations to.
"""
function create_account_customization(
AccountCustomization, AwsAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/customizations",
Dict{String,Any}("AccountCustomization" => AccountCustomization);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_account_customization(
AccountCustomization,
AwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/customizations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AccountCustomization" => AccountCustomization),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_account_subscription(account_name, authentication_method, aws_account_id, notification_email)
create_account_subscription(account_name, authentication_method, aws_account_id, notification_email, params::Dict{String,<:Any})
Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q. The Amazon Web
Services Region for the account is derived from what is configured in the CLI or SDK.
Before you use this operation, make sure that you can connect to an existing Amazon Web
Services account. If you don't have an Amazon Web Services account, see Sign up for Amazon
Web Services in the Amazon QuickSight User Guide. The person who signs up for Amazon
QuickSight needs to have the correct Identity and Access Management (IAM) permissions. For
more information, see IAM Policy Examples for Amazon QuickSight in the Amazon QuickSight
User Guide. If your IAM policy includes both the Subscribe and CreateAccountSubscription
actions, make sure that both actions are set to Allow. If either action is set to Deny, the
Deny action prevails and your API call fails. You can't pass an existing IAM role to access
other Amazon Web Services services using this API operation. To pass your existing IAM role
to Amazon QuickSight, see Passing IAM roles to Amazon QuickSight in the Amazon QuickSight
User Guide. You can't set default resource access on the new account from the Amazon
QuickSight API. Instead, add default resource access from the Amazon QuickSight console.
For more information about setting default resource access to Amazon Web Services services,
see Setting default resource access to Amazon Web Services services in the Amazon
QuickSight User Guide.
# Arguments
- `account_name`: The name of your Amazon QuickSight account. This name is unique over all
of Amazon Web Services, and it appears only when users sign in. You can't change
AccountName value after the Amazon QuickSight account is created.
- `authentication_method`: The method that you want to use to authenticate your Amazon
QuickSight account. If you choose ACTIVE_DIRECTORY, provide an ActiveDirectoryName and an
AdminGroup associated with your Active Directory. If you choose IAM_IDENTITY_CENTER,
provide an AdminGroup associated with your IAM Identity Center account.
- `aws_account_id`: The Amazon Web Services account ID of the account that you're using to
create your Amazon QuickSight account.
- `notification_email`: The email address that you want Amazon QuickSight to send
notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ActiveDirectoryName"`: The name of your Active Directory. This field is required if
ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.
- `"AdminGroup"`: The admin group associated with your Active Directory or IAM Identity
Center account. Either this field or the AdminProGroup field is required if
ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new
Amazon QuickSight account. For more information about using IAM Identity Center in Amazon
QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the
Amazon QuickSight User Guide. For more information about using Active Directory in Amazon
QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the
Amazon QuickSight User Guide.
- `"AdminProGroup"`: The admin pro group associated with your Active Directory or IAM
Identity Center account. Either this field or the AdminGroup field is required if
ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new
Amazon QuickSight account. For more information about using IAM Identity Center in Amazon
QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the
Amazon QuickSight User Guide. For more information about using Active Directory in Amazon
QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the
Amazon QuickSight User Guide.
- `"AuthorGroup"`: The author group associated with your Active Directory or IAM Identity
Center account. For more information about using IAM Identity Center in Amazon QuickSight,
see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon
QuickSight User Guide. For more information about using Active Directory in Amazon
QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the
Amazon QuickSight User Guide.
- `"AuthorProGroup"`: The author pro group associated with your Active Directory or IAM
Identity Center account. For more information about using IAM Identity Center in Amazon
QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the
Amazon QuickSight User Guide. For more information about using Active Directory in Amazon
QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the
Amazon QuickSight User Guide.
- `"ContactNumber"`: A 10-digit phone number for the author of the Amazon QuickSight
account to use for future communications. This field is required if ENTERPPRISE_AND_Q is
the selected edition of the new Amazon QuickSight account.
- `"DirectoryId"`: The ID of the Active Directory that is associated with your Amazon
QuickSight account.
- `"Edition"`: The edition of Amazon QuickSight that you want your account to have.
Currently, you can choose from ENTERPRISE or ENTERPRISE_AND_Q. If you choose
ENTERPRISE_AND_Q, the following parameters are required: FirstName LastName
EmailAddress ContactNumber
- `"EmailAddress"`: The email address of the author of the Amazon QuickSight account to use
for future communications. This field is required if ENTERPPRISE_AND_Q is the selected
edition of the new Amazon QuickSight account.
- `"FirstName"`: The first name of the author of the Amazon QuickSight account to use for
future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition
of the new Amazon QuickSight account.
- `"IAMIdentityCenterInstanceArn"`: The Amazon Resource Name (ARN) for the IAM Identity
Center instance.
- `"LastName"`: The last name of the author of the Amazon QuickSight account to use for
future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition
of the new Amazon QuickSight account.
- `"ReaderGroup"`: The reader group associated with your Active Directory or IAM Identity
Center account. For more information about using IAM Identity Center in Amazon QuickSight,
see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon
QuickSight User Guide. For more information about using Active Directory in Amazon
QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the
Amazon QuickSight User Guide.
- `"ReaderProGroup"`: The reader pro group associated with your Active Directory or IAM
Identity Center account. For more information about using IAM Identity Center in Amazon
QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the
Amazon QuickSight User Guide. For more information about using Active Directory in Amazon
QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the
Amazon QuickSight User Guide.
- `"Realm"`: The realm of the Active Directory that is associated with your Amazon
QuickSight account. This field is required if ACTIVE_DIRECTORY is the selected
authentication method of the new Amazon QuickSight account.
"""
function create_account_subscription(
AccountName,
AuthenticationMethod,
AwsAccountId,
NotificationEmail;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/account/$(AwsAccountId)",
Dict{String,Any}(
"AccountName" => AccountName,
"AuthenticationMethod" => AuthenticationMethod,
"NotificationEmail" => NotificationEmail,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_account_subscription(
AccountName,
AuthenticationMethod,
AwsAccountId,
NotificationEmail,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/account/$(AwsAccountId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AccountName" => AccountName,
"AuthenticationMethod" => AuthenticationMethod,
"NotificationEmail" => NotificationEmail,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_analysis(analysis_id, aws_account_id, name)
create_analysis(analysis_id, aws_account_id, name, params::Dict{String,<:Any})
Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or
from an AnalysisDefinition.
# Arguments
- `analysis_id`: The ID for the analysis that you're creating. This ID displays in the URL
of the analysis.
- `aws_account_id`: The ID of the Amazon Web Services account where you are creating an
analysis.
- `name`: A descriptive name for the analysis that you're creating. This name displays for
the analysis in the Amazon QuickSight console.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Definition"`: The definition of an analysis. A definition is the data model of all
features in a Dashboard, Template, or Analysis. Either a SourceEntity or a Definition must
be provided in order for the request to be valid.
- `"FolderArns"`: When you create the analysis, Amazon QuickSight adds the analysis to
these folders.
- `"Parameters"`: The parameter names and override values that you want to use. An analysis
can have any parameter type, and some parameters might accept multiple values.
- `"Permissions"`: A structure that describes the principals and the resource-level
permissions on an analysis. You can use the Permissions structure to grant permissions by
providing a list of Identity and Access Management (IAM) action information for each
principal listed by Amazon Resource Name (ARN). To specify no permissions, omit
Permissions.
- `"SourceEntity"`: A source entity to use for the analysis that you're creating. This
metadata structure contains details that describe a source template and one or more
datasets. Either a SourceEntity or a Definition must be provided in order for the request
to be valid.
- `"Tags"`: Contains a map of the key-value pairs for the resource tag or tags assigned to
the analysis.
- `"ThemeArn"`: The ARN for the theme to apply to the analysis that you're creating. To see
the theme in the Amazon QuickSight console, make sure that you have access to it.
- `"ValidationStrategy"`: The option to relax the validation needed to create an analysis
with definition objects. This skips the validation step for specific errors.
"""
function create_analysis(
AnalysisId, AwsAccountId, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/analyses/$(AnalysisId)",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_analysis(
AnalysisId,
AwsAccountId,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/analyses/$(AnalysisId)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dashboard(aws_account_id, dashboard_id, name)
create_dashboard(aws_account_id, dashboard_id, name, params::Dict{String,<:Any})
Creates a dashboard from either a template or directly with a DashboardDefinition. To first
create a template, see the CreateTemplate API operation. A dashboard is an entity in
Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can
share Amazon QuickSight dashboards. With the right permissions, you can create scheduled
email reports from them. If you have the correct permissions, you can create a dashboard
from a template that exists in a different Amazon Web Services account.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account where you want to create the
dashboard.
- `dashboard_id`: The ID for the dashboard, also added to the IAM policy.
- `name`: The display name of the dashboard.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DashboardPublishOptions"`: Options for publishing the dashboard when you create it:
AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or
DISABLED. When this is set to DISABLED, Amazon QuickSight disables the left filter pane on
the published dashboard, which can be used for ad hoc (one-time) filtering. This option is
ENABLED by default. AvailabilityStatus for ExportToCSVOption - This status can be
either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled
when this is set to DISABLED. This option is ENABLED by default. VisibilityState for
SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This
option is COLLAPSED by default.
- `"Definition"`: The definition of a dashboard. A definition is the data model of all
features in a Dashboard, Template, or Analysis. Either a SourceEntity or a Definition must
be provided in order for the request to be valid.
- `"FolderArns"`: When you create the dashboard, Amazon QuickSight adds the dashboard to
these folders.
- `"LinkEntities"`: A list of analysis Amazon Resource Names (ARNs) to be linked to the
dashboard.
- `"LinkSharingConfiguration"`: A structure that contains the permissions of a shareable
link to the dashboard.
- `"Parameters"`: The parameters for the creation of the dashboard, which you want to use
to override the default settings. A dashboard can have any type of parameters, and some
parameters might accept multiple values.
- `"Permissions"`: A structure that contains the permissions of the dashboard. You can use
this structure for granting permissions by providing a list of IAM action information for
each principal ARN. To specify no permissions, omit the permissions list.
- `"SourceEntity"`: The entity that you are using as a source when you create the
dashboard. In SourceEntity, you specify the type of object you're using as source. You can
only create a dashboard from a template, so you use a SourceTemplate entity. If you need to
create a dashboard from an analysis, first convert the analysis to a template by using the
CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN)
of the source template. The SourceTemplateARN can contain any Amazon Web Services account
and any Amazon QuickSight-supported Amazon Web Services Region. Use the DataSetReferences
entity within SourceTemplate to list the replacement datasets for the placeholders listed
in the original. The schema in each dataset must match its placeholder. Either a
SourceEntity or a Definition must be provided in order for the request to be valid.
- `"Tags"`: Contains a map of the key-value pairs for the resource tag or tags assigned to
the dashboard.
- `"ThemeArn"`: The Amazon Resource Name (ARN) of the theme that is being used for this
dashboard. If you add a value for this field, it overrides the value that is used in the
source entity. The theme ARN must exist in the same Amazon Web Services account where you
create the dashboard.
- `"ValidationStrategy"`: The option to relax the validation needed to create a dashboard
with definition objects. This option skips the validation step for specific errors.
- `"VersionDescription"`: A description for the first version of the dashboard being
created.
"""
function create_dashboard(
AwsAccountId, DashboardId, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/dashboards/$(DashboardId)",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dashboard(
AwsAccountId,
DashboardId,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/dashboards/$(DashboardId)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_data_set(aws_account_id, data_set_id, import_mode, name, physical_table_map)
create_data_set(aws_account_id, data_set_id, import_mode, name, physical_table_map, params::Dict{String,<:Any})
Creates a dataset. This operation doesn't support datasets that include uploaded files as a
source.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID.
- `data_set_id`: An ID for the dataset that you want to create. This ID is unique per
Amazon Web Services Region for each Amazon Web Services account.
- `import_mode`: Indicates whether you want to import the data into SPICE.
- `name`: The display name for the dataset.
- `physical_table_map`: Declares the physical tables that are available in the underlying
data sources.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ColumnGroups"`: Groupings of columns that work together in certain Amazon QuickSight
features. Currently, only geospatial hierarchy is supported.
- `"ColumnLevelPermissionRules"`: A set of one or more definitions of a
ColumnLevelPermissionRule .
- `"DataSetUsageConfiguration"`:
- `"DatasetParameters"`: The parameter declarations of the dataset.
- `"FieldFolders"`: The folder that contains fields and nested subfolders for your dataset.
- `"FolderArns"`: When you create the dataset, Amazon QuickSight adds the dataset to these
folders.
- `"LogicalTableMap"`: Configures the combination and transformation of the data from the
physical tables.
- `"Permissions"`: A list of resource permissions on the dataset.
- `"RowLevelPermissionDataSet"`: The row-level security configuration for the data that you
want to create.
- `"RowLevelPermissionTagConfiguration"`: The configuration of tags on a dataset to set
row-level security. Row-level security tags are currently supported for anonymous embedding
only.
- `"Tags"`: Contains a map of the key-value pairs for the resource tag or tags assigned to
the dataset.
"""
function create_data_set(
AwsAccountId,
DataSetId,
ImportMode,
Name,
PhysicalTableMap;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/data-sets",
Dict{String,Any}(
"DataSetId" => DataSetId,
"ImportMode" => ImportMode,
"Name" => Name,
"PhysicalTableMap" => PhysicalTableMap,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_data_set(
AwsAccountId,
DataSetId,
ImportMode,
Name,
PhysicalTableMap,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/data-sets",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DataSetId" => DataSetId,
"ImportMode" => ImportMode,
"Name" => Name,
"PhysicalTableMap" => PhysicalTableMap,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_data_source(aws_account_id, data_source_id, name, type)
create_data_source(aws_account_id, data_source_id, name, type, params::Dict{String,<:Any})
Creates a data source.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID.
- `data_source_id`: An ID for the data source. This ID is unique per Amazon Web Services
Region for each Amazon Web Services account.
- `name`: A display name for the data source.
- `type`: The type of the data source. To return a list of all data sources, use
ListDataSources. Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Credentials"`: The credentials Amazon QuickSight that uses to connect to your
underlying source. Currently, only credentials based on user name and password are
supported.
- `"DataSourceParameters"`: The parameters that Amazon QuickSight uses to connect to your
underlying source.
- `"FolderArns"`: When you create the data source, Amazon QuickSight adds the data source
to these folders.
- `"Permissions"`: A list of resource permissions on the data source.
- `"SslProperties"`: Secure Socket Layer (SSL) properties that apply when Amazon QuickSight
connects to your underlying source.
- `"Tags"`: Contains a map of the key-value pairs for the resource tag or tags assigned to
the data source.
- `"VpcConnectionProperties"`: Use this parameter only when you want Amazon QuickSight to
use a VPC connection when connecting to your underlying source.
"""
function create_data_source(
AwsAccountId,
DataSourceId,
Name,
Type;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/data-sources",
Dict{String,Any}("DataSourceId" => DataSourceId, "Name" => Name, "Type" => Type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_data_source(
AwsAccountId,
DataSourceId,
Name,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/data-sources",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DataSourceId" => DataSourceId, "Name" => Name, "Type" => Type
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_folder(aws_account_id, folder_id)
create_folder(aws_account_id, folder_id, params::Dict{String,<:Any})
Creates an empty shared folder.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account where you want to create the
folder.
- `folder_id`: The ID of the folder.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FolderType"`: The type of folder. By default, folderType is SHARED.
- `"Name"`: The name of the folder.
- `"ParentFolderArn"`: The Amazon Resource Name (ARN) for the parent folder.
ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.
- `"Permissions"`: A structure that describes the principals and the resource-level
permissions of a folder. To specify no permissions, omit Permissions.
- `"SharingModel"`: An optional parameter that determines the sharing scope of the folder.
The default value for this parameter is ACCOUNT.
- `"Tags"`: Tags for the folder.
"""
function create_folder(
AwsAccountId, FolderId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/folders/$(FolderId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_folder(
AwsAccountId,
FolderId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/folders/$(FolderId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_folder_membership(aws_account_id, folder_id, member_id, member_type)
create_folder_membership(aws_account_id, folder_id, member_id, member_type, params::Dict{String,<:Any})
Adds an asset, such as a dashboard, analysis, or dataset into a folder.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that contains the folder.
- `folder_id`: The ID of the folder.
- `member_id`: The ID of the asset that you want to add to the folder.
- `member_type`: The member type of the asset that you want to add to a folder.
"""
function create_folder_membership(
AwsAccountId,
FolderId,
MemberId,
MemberType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/folders/$(FolderId)/members/$(MemberType)/$(MemberId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_folder_membership(
AwsAccountId,
FolderId,
MemberId,
MemberType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/folders/$(FolderId)/members/$(MemberType)/$(MemberId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_group(aws_account_id, group_name, namespace)
create_group(aws_account_id, group_name, namespace, params::Dict{String,<:Any})
Use the CreateGroup operation to create a group in Amazon QuickSight. You can create up to
10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace,
contact Amazon Web Services Support. The permissions resource is
arn:aws:quicksight:<your-region>:<relevant-aws-account-id>:group/default/<gro
up-name> . The response is a group object.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that the group is in.
Currently, you use the ID for the Amazon Web Services account that contains your Amazon
QuickSight account.
- `group_name`: A name for the group that you want to create.
- `namespace`: The namespace that you want the group to be a part of.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description for the group that you want to create.
"""
function create_group(
AwsAccountId, GroupName, Namespace; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/groups",
Dict{String,Any}("GroupName" => GroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_group(
AwsAccountId,
GroupName,
Namespace,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/groups",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GroupName" => GroupName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_group_membership(aws_account_id, group_name, member_name, namespace)
create_group_membership(aws_account_id, group_name, member_name, namespace, params::Dict{String,<:Any})
Adds an Amazon QuickSight user to an Amazon QuickSight group.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that the group is in.
Currently, you use the ID for the Amazon Web Services account that contains your Amazon
QuickSight account.
- `group_name`: The name of the group that you want to add the user to.
- `member_name`: The name of the user that you want to add to the group membership.
- `namespace`: The namespace that you want the user to be a part of.
"""
function create_group_membership(
AwsAccountId,
GroupName,
MemberName,
Namespace;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/groups/$(GroupName)/members/$(MemberName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_group_membership(
AwsAccountId,
GroupName,
MemberName,
Namespace,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/groups/$(GroupName)/members/$(MemberName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_iampolicy_assignment(assignment_name, assignment_status, aws_account_id, namespace)
create_iampolicy_assignment(assignment_name, assignment_status, aws_account_id, namespace, params::Dict{String,<:Any})
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name
(ARN). This policy assignment is attached to the specified groups or users of Amazon
QuickSight. Assignment names are unique per Amazon Web Services account. To avoid
overwriting rules in other namespaces, use assignment names that are unique.
# Arguments
- `assignment_name`: The name of the assignment, also called a rule. The name must be
unique within the Amazon Web Services account.
- `assignment_status`: The status of the assignment. Possible values are as follows:
ENABLED - Anything specified in this assignment is used when creating the data source.
DISABLED - This assignment isn't used when creating the data source. DRAFT - This
assignment is an unfinished draft and isn't used when creating the data source.
- `aws_account_id`: The ID of the Amazon Web Services account where you want to assign an
IAM policy to Amazon QuickSight users or groups.
- `namespace`: The namespace that contains the assignment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Identities"`: The Amazon QuickSight users, groups, or both that you want to assign the
policy to.
- `"PolicyArn"`: The ARN for the IAM policy to apply to the Amazon QuickSight users and
groups specified in this assignment.
"""
function create_iampolicy_assignment(
AssignmentName,
AssignmentStatus,
AwsAccountId,
Namespace;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/iam-policy-assignments/",
Dict{String,Any}(
"AssignmentName" => AssignmentName, "AssignmentStatus" => AssignmentStatus
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_iampolicy_assignment(
AssignmentName,
AssignmentStatus,
AwsAccountId,
Namespace,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/iam-policy-assignments/",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AssignmentName" => AssignmentName,
"AssignmentStatus" => AssignmentStatus,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_ingestion(aws_account_id, data_set_id, ingestion_id)
create_ingestion(aws_account_id, data_set_id, ingestion_id, params::Dict{String,<:Any})
Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets
in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh
datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is
measured starting 24 hours before the current date and time. Any ingestions operating on
tagged datasets inherit the same tags automatically for use in access control. For an
example, see How do I create an IAM policy to control access to Amazon EC2 resources using
tags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset,
but not on the ingestion resource.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID.
- `data_set_id`: The ID of the dataset used in the ingestion.
- `ingestion_id`: An ID for the ingestion.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IngestionType"`: The type of ingestion that you want to create.
"""
function create_ingestion(
AwsAccountId, DataSetId, IngestionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/data-sets/$(DataSetId)/ingestions/$(IngestionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_ingestion(
AwsAccountId,
DataSetId,
IngestionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/data-sets/$(DataSetId)/ingestions/$(IngestionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_namespace(aws_account_id, identity_store, namespace)
create_namespace(aws_account_id, identity_store, namespace, params::Dict{String,<:Any})
(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight. A
namespace allows you to isolate the Amazon QuickSight users and groups that are registered
for that namespace. Users that access the namespace can share assets only with other users
or groups in the same namespace. They can't see users and groups in other namespaces. You
can create a namespace after your Amazon Web Services account is subscribed to Amazon
QuickSight. The namespace must be unique within the Amazon Web Services account. By
default, there is a limit of 100 namespaces per Amazon Web Services account. To increase
your limit, create a ticket with Amazon Web Services Support.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that you want to create the
Amazon QuickSight namespace in.
- `identity_store`: Specifies the type of your user identity directory. Currently, this
supports users with an identity type of QUICKSIGHT.
- `namespace`: The name that you want to use to describe the new namespace.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: The tags that you want to associate with the namespace that you're creating.
"""
function create_namespace(
AwsAccountId,
IdentityStore,
Namespace;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)",
Dict{String,Any}("IdentityStore" => IdentityStore, "Namespace" => Namespace);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_namespace(
AwsAccountId,
IdentityStore,
Namespace,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IdentityStore" => IdentityStore, "Namespace" => Namespace
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_refresh_schedule(aws_account_id, data_set_id, schedule)
create_refresh_schedule(aws_account_id, data_set_id, schedule, params::Dict{String,<:Any})
Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a
single dataset.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID.
- `data_set_id`: The ID of the dataset.
- `schedule`: The refresh schedule.
"""
function create_refresh_schedule(
AwsAccountId, DataSetId, Schedule; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/data-sets/$(DataSetId)/refresh-schedules",
Dict{String,Any}("Schedule" => Schedule);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_refresh_schedule(
AwsAccountId,
DataSetId,
Schedule,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/data-sets/$(DataSetId)/refresh-schedules",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Schedule" => Schedule), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_role_membership(aws_account_id, member_name, namespace, role)
create_role_membership(aws_account_id, member_name, namespace, role, params::Dict{String,<:Any})
Use CreateRoleMembership to add an existing Amazon QuickSight group to an existing role.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that you want to create a
group in. The Amazon Web Services account ID that you provide must be the same Amazon Web
Services account that contains your Amazon QuickSight account.
- `member_name`: The name of the group that you want to add to the role.
- `namespace`: The namespace that the role belongs to.
- `role`: The role that you want to add a group to.
"""
function create_role_membership(
AwsAccountId,
MemberName,
Namespace,
Role;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/roles/$(Role)/members/$(MemberName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_role_membership(
AwsAccountId,
MemberName,
Namespace,
Role,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/roles/$(Role)/members/$(MemberName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_template(aws_account_id, template_id)
create_template(aws_account_id, template_id, params::Dict{String,<:Any})
Creates a template either from a TemplateDefinition or from an existing Amazon QuickSight
analysis or template. You can use the resulting template to create additional dashboards,
templates, or analyses. A template is an entity in Amazon QuickSight that encapsulates the
metadata required to create an analysis and that you can use to create s dashboard. A
template adds a layer of abstraction by using placeholders to replace the dataset
associated with the analysis. You can use templates to create dashboards by replacing
dataset placeholders with datasets that follow the same schema that was used to create the
source analysis and template.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that the group is in. You
use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
- `template_id`: An ID for the template that you want to create. This template is unique
per Amazon Web Services Region; in each Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Definition"`: The definition of a template. A definition is the data model of all
features in a Dashboard, Template, or Analysis. Either a SourceEntity or a Definition must
be provided in order for the request to be valid.
- `"Name"`: A display name for the template.
- `"Permissions"`: A list of resource permissions to be set on the template.
- `"SourceEntity"`: The entity that you are using as a source when you create the template.
In SourceEntity, you specify the type of object you're using as source: SourceTemplate for
a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name
(ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis,
specify the ARN of the source analysis. The SourceTemplate ARN can contain any Amazon Web
Services account and any Amazon QuickSight-supported Amazon Web Services Region. Use the
DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement
datasets for the placeholders listed in the original. The schema in each dataset must match
its placeholder. Either a SourceEntity or a Definition must be provided in order for the
request to be valid.
- `"Tags"`: Contains a map of the key-value pairs for the resource tag or tags assigned to
the resource.
- `"ValidationStrategy"`: TThe option to relax the validation needed to create a template
with definition objects. This skips the validation step for specific errors.
- `"VersionDescription"`: A description of the current template version being created. This
API operation creates the first version of the template. Every time UpdateTemplate is
called, a new version is created. Each version of the template maintains a description of
the version in the VersionDescription field.
"""
function create_template(
AwsAccountId, TemplateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/templates/$(TemplateId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_template(
AwsAccountId,
TemplateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/templates/$(TemplateId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_template_alias(alias_name, aws_account_id, template_id, template_version_number)
create_template_alias(alias_name, aws_account_id, template_id, template_version_number, params::Dict{String,<:Any})
Creates a template alias for a template.
# Arguments
- `alias_name`: The name that you want to give to the template alias that you're creating.
Don't start the alias name with the character. Alias names that start with are reserved
by Amazon QuickSight.
- `aws_account_id`: The ID of the Amazon Web Services account that contains the template
that you creating an alias for.
- `template_id`: An ID for the template.
- `template_version_number`: The version number of the template.
"""
function create_template_alias(
AliasName,
AwsAccountId,
TemplateId,
TemplateVersionNumber;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/templates/$(TemplateId)/aliases/$(AliasName)",
Dict{String,Any}("TemplateVersionNumber" => TemplateVersionNumber);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_template_alias(
AliasName,
AwsAccountId,
TemplateId,
TemplateVersionNumber,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/templates/$(TemplateId)/aliases/$(AliasName)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("TemplateVersionNumber" => TemplateVersionNumber),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_theme(aws_account_id, base_theme_id, configuration, name, theme_id)
create_theme(aws_account_id, base_theme_id, configuration, name, theme_id, params::Dict{String,<:Any})
Creates a theme. A theme is set of configuration options for color and layout. Themes apply
to analyses and dashboards. For more information, see Using Themes in Amazon QuickSight in
the Amazon QuickSight User Guide.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account where you want to store the
new theme.
- `base_theme_id`: The ID of the theme that a custom theme will inherit from. All themes
inherit from one of the starting themes defined by Amazon QuickSight. For a list of the
starting themes, use ListThemes or choose Themes from within an analysis.
- `configuration`: The theme configuration, which contains the theme display properties.
- `name`: A display name for the theme.
- `theme_id`: An ID for the theme that you want to create. The theme ID is unique per
Amazon Web Services Region in each Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Permissions"`: A valid grouping of resource permissions to apply to the new theme.
- `"Tags"`: A map of the key-value pairs for the resource tag or tags that you want to add
to the resource.
- `"VersionDescription"`: A description of the first version of the theme that you're
creating. Every time UpdateTheme is called, a new version is created. Each version of the
theme has a description of the version in the VersionDescription field.
"""
function create_theme(
AwsAccountId,
BaseThemeId,
Configuration,
Name,
ThemeId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/themes/$(ThemeId)",
Dict{String,Any}(
"BaseThemeId" => BaseThemeId, "Configuration" => Configuration, "Name" => Name
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_theme(
AwsAccountId,
BaseThemeId,
Configuration,
Name,
ThemeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/themes/$(ThemeId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"BaseThemeId" => BaseThemeId,
"Configuration" => Configuration,
"Name" => Name,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_theme_alias(alias_name, aws_account_id, theme_id, theme_version_number)
create_theme_alias(alias_name, aws_account_id, theme_id, theme_version_number, params::Dict{String,<:Any})
Creates a theme alias for a theme.
# Arguments
- `alias_name`: The name that you want to give to the theme alias that you are creating.
The alias name can't begin with a . Alias names that start with are reserved by Amazon
QuickSight.
- `aws_account_id`: The ID of the Amazon Web Services account that contains the theme for
the new theme alias.
- `theme_id`: An ID for the theme alias.
- `theme_version_number`: The version number of the theme.
"""
function create_theme_alias(
AliasName,
AwsAccountId,
ThemeId,
ThemeVersionNumber;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/themes/$(ThemeId)/aliases/$(AliasName)",
Dict{String,Any}("ThemeVersionNumber" => ThemeVersionNumber);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_theme_alias(
AliasName,
AwsAccountId,
ThemeId,
ThemeVersionNumber,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/themes/$(ThemeId)/aliases/$(AliasName)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ThemeVersionNumber" => ThemeVersionNumber), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_topic(aws_account_id, topic, topic_id)
create_topic(aws_account_id, topic, topic_id, params::Dict{String,<:Any})
Creates a new Q topic.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that you want to create a
topic in.
- `topic`: The definition of a topic to create.
- `topic_id`: The ID for the topic that you want to create. This ID is unique per Amazon
Web Services Region for each Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: Contains a map of the key-value pairs for the resource tag or tags that are
assigned to the dataset.
"""
function create_topic(
AwsAccountId, Topic, TopicId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/topics",
Dict{String,Any}("Topic" => Topic, "TopicId" => TopicId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_topic(
AwsAccountId,
Topic,
TopicId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/topics",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Topic" => Topic, "TopicId" => TopicId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_topic_refresh_schedule(aws_account_id, dataset_arn, refresh_schedule, topic_id)
create_topic_refresh_schedule(aws_account_id, dataset_arn, refresh_schedule, topic_id, params::Dict{String,<:Any})
Creates a topic refresh schedule.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the topic
you're creating a refresh schedule for.
- `dataset_arn`: The Amazon Resource Name (ARN) of the dataset.
- `refresh_schedule`: The definition of a refresh schedule.
- `topic_id`: The ID of the topic that you want to modify. This ID is unique per Amazon Web
Services Region for each Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DatasetName"`: The name of the dataset.
"""
function create_topic_refresh_schedule(
AwsAccountId,
DatasetArn,
RefreshSchedule,
TopicId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/topics/$(TopicId)/schedules",
Dict{String,Any}("DatasetArn" => DatasetArn, "RefreshSchedule" => RefreshSchedule);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_topic_refresh_schedule(
AwsAccountId,
DatasetArn,
RefreshSchedule,
TopicId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/topics/$(TopicId)/schedules",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatasetArn" => DatasetArn, "RefreshSchedule" => RefreshSchedule
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_vpcconnection(aws_account_id, name, role_arn, security_group_ids, subnet_ids, vpcconnection_id)
create_vpcconnection(aws_account_id, name, role_arn, security_group_ids, subnet_ids, vpcconnection_id, params::Dict{String,<:Any})
Creates a new VPC connection.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID of the account where you want to
create a new VPC connection.
- `name`: The display name for the VPC connection.
- `role_arn`: The IAM role to associate with the VPC connection.
- `security_group_ids`: A list of security group IDs for the VPC connection.
- `subnet_ids`: A list of subnet IDs for the VPC connection.
- `vpcconnection_id`: The ID of the VPC connection that you're creating. This ID is a
unique identifier for each Amazon Web Services Region in an Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DnsResolvers"`: A list of IP addresses of DNS resolver endpoints for the VPC connection.
- `"Tags"`: A map of the key-value pairs for the resource tag or tags assigned to the VPC
connection.
"""
function create_vpcconnection(
AwsAccountId,
Name,
RoleArn,
SecurityGroupIds,
SubnetIds,
VPCConnectionId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/vpc-connections",
Dict{String,Any}(
"Name" => Name,
"RoleArn" => RoleArn,
"SecurityGroupIds" => SecurityGroupIds,
"SubnetIds" => SubnetIds,
"VPCConnectionId" => VPCConnectionId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_vpcconnection(
AwsAccountId,
Name,
RoleArn,
SecurityGroupIds,
SubnetIds,
VPCConnectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/vpc-connections",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Name" => Name,
"RoleArn" => RoleArn,
"SecurityGroupIds" => SecurityGroupIds,
"SubnetIds" => SubnetIds,
"VPCConnectionId" => VPCConnectionId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_account_customization(aws_account_id)
delete_account_customization(aws_account_id, params::Dict{String,<:Any})
Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the
specified Amazon Web Services account and Amazon QuickSight namespace.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that you want to delete
Amazon QuickSight customizations from in this Amazon Web Services Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"namespace"`: The Amazon QuickSight namespace that you're deleting the customizations
from.
"""
function delete_account_customization(
AwsAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/customizations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_account_customization(
AwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/customizations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_account_subscription(aws_account_id)
delete_account_subscription(aws_account_id, params::Dict{String,<:Any})
Use the DeleteAccountSubscription operation to delete an Amazon QuickSight account. This
operation will result in an error message if you have configured your account termination
protection settings to True. To change this setting and delete your account, call the
UpdateAccountSettings API and set the value of the TerminationProtectionEnabled parameter
to False, then make another call to the DeleteAccountSubscription API.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID of the account that you want to
delete.
"""
function delete_account_subscription(
AwsAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"DELETE",
"/account/$(AwsAccountId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_account_subscription(
AwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"DELETE",
"/account/$(AwsAccountId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_analysis(analysis_id, aws_account_id)
delete_analysis(analysis_id, aws_account_id, params::Dict{String,<:Any})
Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window
during which you can restore the analysis. If you don't specify a recovery window value,
the operation defaults to 30 days. Amazon QuickSight attaches a DeletionTime stamp to the
response that specifies the end of the recovery window. At the end of the recovery window,
Amazon QuickSight deletes the analysis permanently. At any time before recovery window
ends, you can use the RestoreAnalysis API operation to remove the DeletionTime stamp and
cancel the deletion of the analysis. The analysis remains visible in the API until it's
deleted, so you can describe it but you can't make a template from it. An analysis that's
scheduled for deletion isn't accessible in the Amazon QuickSight console. To access it in
the console, restore it. Deleting an analysis doesn't delete the dashboards that you
publish from it.
# Arguments
- `analysis_id`: The ID of the analysis that you're deleting.
- `aws_account_id`: The ID of the Amazon Web Services account where you want to delete an
analysis.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"force-delete-without-recovery"`: This option defaults to the value
NoForceDeleteWithoutRecovery. To immediately delete the analysis, add the
ForceDeleteWithoutRecovery option. You can't restore an analysis after it's deleted.
- `"recovery-window-in-days"`: A value that specifies the number of days that Amazon
QuickSight waits before it deletes the analysis. You can't use this parameter with the
ForceDeleteWithoutRecovery option in the same API call. The default value is 30.
"""
function delete_analysis(
AnalysisId, AwsAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/analyses/$(AnalysisId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_analysis(
AnalysisId,
AwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/analyses/$(AnalysisId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dashboard(aws_account_id, dashboard_id)
delete_dashboard(aws_account_id, dashboard_id, params::Dict{String,<:Any})
Deletes a dashboard.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the dashboard
that you're deleting.
- `dashboard_id`: The ID for the dashboard.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"version-number"`: The version number of the dashboard. If the version number property
is provided, only the specified version of the dashboard is deleted.
"""
function delete_dashboard(
AwsAccountId, DashboardId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/dashboards/$(DashboardId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_dashboard(
AwsAccountId,
DashboardId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/dashboards/$(DashboardId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_data_set(aws_account_id, data_set_id)
delete_data_set(aws_account_id, data_set_id, params::Dict{String,<:Any})
Deletes a dataset.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID.
- `data_set_id`: The ID for the dataset that you want to create. This ID is unique per
Amazon Web Services Region for each Amazon Web Services account.
"""
function delete_data_set(
AwsAccountId, DataSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/data-sets/$(DataSetId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_data_set(
AwsAccountId,
DataSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/data-sets/$(DataSetId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_data_set_refresh_properties(aws_account_id, data_set_id)
delete_data_set_refresh_properties(aws_account_id, data_set_id, params::Dict{String,<:Any})
Deletes the dataset refresh properties of the dataset.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID.
- `data_set_id`: The ID of the dataset.
"""
function delete_data_set_refresh_properties(
AwsAccountId, DataSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/data-sets/$(DataSetId)/refresh-properties";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_data_set_refresh_properties(
AwsAccountId,
DataSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/data-sets/$(DataSetId)/refresh-properties",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_data_source(aws_account_id, data_source_id)
delete_data_source(aws_account_id, data_source_id, params::Dict{String,<:Any})
Deletes the data source permanently. This operation breaks all the datasets that reference
the deleted data source.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID.
- `data_source_id`: The ID of the data source. This ID is unique per Amazon Web Services
Region for each Amazon Web Services account.
"""
function delete_data_source(
AwsAccountId, DataSourceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/data-sources/$(DataSourceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_data_source(
AwsAccountId,
DataSourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/data-sources/$(DataSourceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_folder(aws_account_id, folder_id)
delete_folder(aws_account_id, folder_id, params::Dict{String,<:Any})
Deletes an empty folder.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that contains the folder.
- `folder_id`: The ID of the folder.
"""
function delete_folder(
AwsAccountId, FolderId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/folders/$(FolderId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_folder(
AwsAccountId,
FolderId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/folders/$(FolderId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_folder_membership(aws_account_id, folder_id, member_id, member_type)
delete_folder_membership(aws_account_id, folder_id, member_id, member_type, params::Dict{String,<:Any})
Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that contains the folder.
- `folder_id`: The Folder ID.
- `member_id`: The ID of the asset that you want to delete.
- `member_type`: The member type of the asset that you want to delete from a folder.
"""
function delete_folder_membership(
AwsAccountId,
FolderId,
MemberId,
MemberType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/folders/$(FolderId)/members/$(MemberType)/$(MemberId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_folder_membership(
AwsAccountId,
FolderId,
MemberId,
MemberType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/folders/$(FolderId)/members/$(MemberType)/$(MemberId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_group(aws_account_id, group_name, namespace)
delete_group(aws_account_id, group_name, namespace, params::Dict{String,<:Any})
Removes a user group from Amazon QuickSight.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that the group is in.
Currently, you use the ID for the Amazon Web Services account that contains your Amazon
QuickSight account.
- `group_name`: The name of the group that you want to delete.
- `namespace`: The namespace of the group that you want to delete.
"""
function delete_group(
AwsAccountId, GroupName, Namespace; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/groups/$(GroupName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_group(
AwsAccountId,
GroupName,
Namespace,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/groups/$(GroupName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_group_membership(aws_account_id, group_name, member_name, namespace)
delete_group_membership(aws_account_id, group_name, member_name, namespace, params::Dict{String,<:Any})
Removes a user from a group so that the user is no longer a member of the group.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that the group is in.
Currently, you use the ID for the Amazon Web Services account that contains your Amazon
QuickSight account.
- `group_name`: The name of the group that you want to delete the user from.
- `member_name`: The name of the user that you want to delete from the group membership.
- `namespace`: The namespace of the group that you want to remove a user from.
"""
function delete_group_membership(
AwsAccountId,
GroupName,
MemberName,
Namespace;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/groups/$(GroupName)/members/$(MemberName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_group_membership(
AwsAccountId,
GroupName,
MemberName,
Namespace,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/groups/$(GroupName)/members/$(MemberName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_iampolicy_assignment(assignment_name, aws_account_id, namespace)
delete_iampolicy_assignment(assignment_name, aws_account_id, namespace, params::Dict{String,<:Any})
Deletes an existing IAM policy assignment.
# Arguments
- `assignment_name`: The name of the assignment.
- `aws_account_id`: The Amazon Web Services account ID where you want to delete the IAM
policy assignment.
- `namespace`: The namespace that contains the assignment.
"""
function delete_iampolicy_assignment(
AssignmentName,
AwsAccountId,
Namespace;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/namespace/$(Namespace)/iam-policy-assignments/$(AssignmentName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_iampolicy_assignment(
AssignmentName,
AwsAccountId,
Namespace,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/namespace/$(Namespace)/iam-policy-assignments/$(AssignmentName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_identity_propagation_config(aws_account_id, service)
delete_identity_propagation_config(aws_account_id, service, params::Dict{String,<:Any})
Deletes all access scopes and authorized targets that are associated with a service from
the Amazon QuickSight IAM Identity Center application. This operation is only supported for
Amazon QuickSight accounts that use IAM Identity Center.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that you want to delete an
identity propagation configuration from.
- `service`: The name of the Amazon Web Services service that you want to delete the
associated access scopes and authorized targets from.
"""
function delete_identity_propagation_config(
AwsAccountId, Service; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/identity-propagation-config/$(Service)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_identity_propagation_config(
AwsAccountId,
Service,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/identity-propagation-config/$(Service)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_namespace(aws_account_id, namespace)
delete_namespace(aws_account_id, namespace, params::Dict{String,<:Any})
Deletes a namespace and the users and groups that are associated with the namespace. This
is an asynchronous process. Assets including dashboards, analyses, datasets and data
sources are not deleted. To delete these assets, you use the API operations for the
relevant asset.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that you want to delete the
Amazon QuickSight namespace from.
- `namespace`: The namespace that you want to delete.
"""
function delete_namespace(
AwsAccountId, Namespace; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_namespace(
AwsAccountId,
Namespace,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_refresh_schedule(aws_account_id, data_set_id, schedule_id)
delete_refresh_schedule(aws_account_id, data_set_id, schedule_id, params::Dict{String,<:Any})
Deletes a refresh schedule from a dataset.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID.
- `data_set_id`: The ID of the dataset.
- `schedule_id`: The ID of the refresh schedule.
"""
function delete_refresh_schedule(
AwsAccountId, DataSetId, ScheduleId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/data-sets/$(DataSetId)/refresh-schedules/$(ScheduleId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_refresh_schedule(
AwsAccountId,
DataSetId,
ScheduleId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/data-sets/$(DataSetId)/refresh-schedules/$(ScheduleId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_role_custom_permission(aws_account_id, namespace, role)
delete_role_custom_permission(aws_account_id, namespace, role, params::Dict{String,<:Any})
Removes custom permissions from the role.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that the group is in.
Currently, you use the ID for the Amazon Web Services account that contains your Amazon
QuickSight account.
- `namespace`: The namespace that includes the role.
- `role`: The role that you want to remove permissions from.
"""
function delete_role_custom_permission(
AwsAccountId, Namespace, Role; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/roles/$(Role)/custom-permission";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_role_custom_permission(
AwsAccountId,
Namespace,
Role,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/roles/$(Role)/custom-permission",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_role_membership(aws_account_id, member_name, namespace, role)
delete_role_membership(aws_account_id, member_name, namespace, role, params::Dict{String,<:Any})
Removes a group from a role.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that you want to create a
group in. The Amazon Web Services account ID that you provide must be the same Amazon Web
Services account that contains your Amazon QuickSight account.
- `member_name`: The name of the group.
- `namespace`: The namespace that contains the role.
- `role`: The role that you want to remove permissions from.
"""
function delete_role_membership(
AwsAccountId,
MemberName,
Namespace,
Role;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/roles/$(Role)/members/$(MemberName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_role_membership(
AwsAccountId,
MemberName,
Namespace,
Role,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/roles/$(Role)/members/$(MemberName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_template(aws_account_id, template_id)
delete_template(aws_account_id, template_id, params::Dict{String,<:Any})
Deletes a template.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the template
that you're deleting.
- `template_id`: An ID for the template you want to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"version-number"`: Specifies the version of the template that you want to delete. If you
don't provide a version number, DeleteTemplate deletes all versions of the template.
"""
function delete_template(
AwsAccountId, TemplateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/templates/$(TemplateId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_template(
AwsAccountId,
TemplateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/templates/$(TemplateId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_template_alias(alias_name, aws_account_id, template_id)
delete_template_alias(alias_name, aws_account_id, template_id, params::Dict{String,<:Any})
Deletes the item that the specified template alias points to. If you provide a specific
alias, you delete the version of the template that the alias points to.
# Arguments
- `alias_name`: The name for the template alias. To delete a specific alias, you delete the
version that the alias points to. You can specify the alias name, or specify the latest
version of the template by providing the keyword LATEST in the AliasName parameter.
- `aws_account_id`: The ID of the Amazon Web Services account that contains the item to
delete.
- `template_id`: The ID for the template that the specified alias is for.
"""
function delete_template_alias(
AliasName, AwsAccountId, TemplateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/templates/$(TemplateId)/aliases/$(AliasName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_template_alias(
AliasName,
AwsAccountId,
TemplateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/templates/$(TemplateId)/aliases/$(AliasName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_theme(aws_account_id, theme_id)
delete_theme(aws_account_id, theme_id, params::Dict{String,<:Any})
Deletes a theme.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the theme that
you're deleting.
- `theme_id`: An ID for the theme that you want to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"version-number"`: The version of the theme that you want to delete. Note: If you
don't provide a version number, you're using this call to DeleteTheme to delete all
versions of the theme.
"""
function delete_theme(
AwsAccountId, ThemeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/themes/$(ThemeId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_theme(
AwsAccountId,
ThemeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/themes/$(ThemeId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_theme_alias(alias_name, aws_account_id, theme_id)
delete_theme_alias(alias_name, aws_account_id, theme_id, params::Dict{String,<:Any})
Deletes the version of the theme that the specified theme alias points to. If you provide a
specific alias, you delete the version of the theme that the alias points to.
# Arguments
- `alias_name`: The unique name for the theme alias to delete.
- `aws_account_id`: The ID of the Amazon Web Services account that contains the theme alias
to delete.
- `theme_id`: The ID for the theme that the specified alias is for.
"""
function delete_theme_alias(
AliasName, AwsAccountId, ThemeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/themes/$(ThemeId)/aliases/$(AliasName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_theme_alias(
AliasName,
AwsAccountId,
ThemeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/themes/$(ThemeId)/aliases/$(AliasName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_topic(aws_account_id, topic_id)
delete_topic(aws_account_id, topic_id, params::Dict{String,<:Any})
Deletes a topic.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the topic that
you want to delete.
- `topic_id`: The ID of the topic that you want to delete. This ID is unique per Amazon Web
Services Region for each Amazon Web Services account.
"""
function delete_topic(
AwsAccountId, TopicId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/topics/$(TopicId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_topic(
AwsAccountId,
TopicId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/topics/$(TopicId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_topic_refresh_schedule(aws_account_id, dataset_id, topic_id)
delete_topic_refresh_schedule(aws_account_id, dataset_id, topic_id, params::Dict{String,<:Any})
Deletes a topic refresh schedule.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID.
- `dataset_id`: The ID of the dataset.
- `topic_id`: The ID of the topic that you want to modify. This ID is unique per Amazon Web
Services Region for each Amazon Web Services account.
"""
function delete_topic_refresh_schedule(
AwsAccountId, DatasetId, TopicId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/topics/$(TopicId)/schedules/$(DatasetId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_topic_refresh_schedule(
AwsAccountId,
DatasetId,
TopicId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/topics/$(TopicId)/schedules/$(DatasetId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_user(aws_account_id, namespace, user_name)
delete_user(aws_account_id, namespace, user_name, params::Dict{String,<:Any})
Deletes the Amazon QuickSight user that is associated with the identity of the IAM user or
role that's making the call. The IAM user isn't deleted as a result of this call.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that the user is in.
Currently, you use the ID for the Amazon Web Services account that contains your Amazon
QuickSight account.
- `namespace`: The namespace. Currently, you should set this to default.
- `user_name`: The name of the user that you want to delete.
"""
function delete_user(
AwsAccountId, Namespace, UserName; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/users/$(UserName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_user(
AwsAccountId,
Namespace,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/users/$(UserName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_user_by_principal_id(aws_account_id, namespace, principal_id)
delete_user_by_principal_id(aws_account_id, namespace, principal_id, params::Dict{String,<:Any})
Deletes a user identified by its principal ID.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that the user is in.
Currently, you use the ID for the Amazon Web Services account that contains your Amazon
QuickSight account.
- `namespace`: The namespace. Currently, you should set this to default.
- `principal_id`: The principal ID of the user.
"""
function delete_user_by_principal_id(
AwsAccountId, Namespace, PrincipalId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/user-principals/$(PrincipalId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_user_by_principal_id(
AwsAccountId,
Namespace,
PrincipalId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/user-principals/$(PrincipalId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_vpcconnection(aws_account_id, vpcconnection_id)
delete_vpcconnection(aws_account_id, vpcconnection_id, params::Dict{String,<:Any})
Deletes a VPC connection.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID of the account where you want to
delete a VPC connection.
- `vpcconnection_id`: The ID of the VPC connection that you're creating. This ID is a
unique identifier for each Amazon Web Services Region in an Amazon Web Services account.
"""
function delete_vpcconnection(
AwsAccountId, VPCConnectionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/vpc-connections/$(VPCConnectionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_vpcconnection(
AwsAccountId,
VPCConnectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"DELETE",
"/accounts/$(AwsAccountId)/vpc-connections/$(VPCConnectionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_account_customization(aws_account_id)
describe_account_customization(aws_account_id, params::Dict{String,<:Any})
Describes the customizations associated with the provided Amazon Web Services account and
Amazon Amazon QuickSight namespace in an Amazon Web Services Region. The Amazon QuickSight
console evaluates which customizations to apply by running this API operation with the
Resolved flag included. To determine what customizations display when you run this
command, it can help to visualize the relationship of the entities involved. Amazon Web
Services account - The Amazon Web Services account exists at the top of the hierarchy. It
has the potential to use all of the Amazon Web Services Regions and Amazon Web Services
Services. When you subscribe to Amazon QuickSight, you choose one Amazon Web Services
Region to use as your home Region. That's where your free SPICE capacity is located. You
can use Amazon QuickSight in any supported Amazon Web Services Region. Amazon Web
Services Region - In each Amazon Web Services Region where you sign in to Amazon QuickSight
at least once, Amazon QuickSight acts as a separate instance of the same service. If you
have a user directory, it resides in us-east-1, which is the US East (N. Virginia).
Generally speaking, these users have access to Amazon QuickSight in any Amazon Web Services
Region, unless they are constrained to a namespace. To run the command in a different
Amazon Web Services Region, you change your Region settings. If you're using the CLI, you
can use one of the following options: Use command line options. Use named profiles.
Run aws configure to change your default Amazon Web Services Region. Use Enter to key the
same settings for your keys. For more information, see Configuring the CLI. Namespace
- A QuickSight namespace is a partition that contains users and assets (data sources,
datasets, dashboards, and so on). To access assets that are in a specific namespace, users
and groups must also be part of the same namespace. People who share a namespace are
completely isolated from users and assets in other namespaces, even if they are in the same
Amazon Web Services account and Amazon Web Services Region. Applied customizations -
Within an Amazon Web Services Region, a set of Amazon QuickSight customizations can apply
to an Amazon Web Services account or to a namespace. Settings that you apply to a namespace
override settings that you apply to an Amazon Web Services account. All settings are
isolated to a single Amazon Web Services Region. To apply them in other Amazon Web Services
Regions, run the CreateAccountCustomization command in each Amazon Web Services Region
where you want to apply the same customizations.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that you want to describe
Amazon QuickSight customizations for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"namespace"`: The Amazon QuickSight namespace that you want to describe Amazon
QuickSight customizations for.
- `"resolved"`: The Resolved flag works with the other parameters to determine which view
of Amazon QuickSight customizations is returned. You can add this flag to your command to
use the same view that Amazon QuickSight uses to identify which customizations to apply to
the console. Omit this flag, or set it to no-resolved, to reveal customizations that are
configured at different levels.
"""
function describe_account_customization(
AwsAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/customizations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_account_customization(
AwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/customizations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_account_settings(aws_account_id)
describe_account_settings(aws_account_id, params::Dict{String,<:Any})
Describes the settings that were used when your Amazon QuickSight subscription was first
created in this Amazon Web Services account.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that contains the settings
that you want to list.
"""
function describe_account_settings(
AwsAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/settings";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_account_settings(
AwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/settings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_account_subscription(aws_account_id)
describe_account_subscription(aws_account_id, params::Dict{String,<:Any})
Use the DescribeAccountSubscription operation to receive a description of an Amazon
QuickSight account's subscription. A successful API call returns an AccountInfo object that
includes an account's name, subscription status, authentication type, edition, and
notification email address.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID associated with your Amazon
QuickSight account.
"""
function describe_account_subscription(
AwsAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/account/$(AwsAccountId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_account_subscription(
AwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/account/$(AwsAccountId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_analysis(analysis_id, aws_account_id)
describe_analysis(analysis_id, aws_account_id, params::Dict{String,<:Any})
Provides a summary of the metadata for an analysis.
# Arguments
- `analysis_id`: The ID of the analysis that you're describing. The ID is part of the URL
of the analysis.
- `aws_account_id`: The ID of the Amazon Web Services account that contains the analysis.
You must be using the Amazon Web Services account that the analysis is in.
"""
function describe_analysis(
AnalysisId, AwsAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/analyses/$(AnalysisId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_analysis(
AnalysisId,
AwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/analyses/$(AnalysisId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_analysis_definition(analysis_id, aws_account_id)
describe_analysis_definition(analysis_id, aws_account_id, params::Dict{String,<:Any})
Provides a detailed description of the definition of an analysis. If you do not need to
know details about the content of an Analysis, for instance if you are trying to check the
status of a recently created or updated Analysis, use the DescribeAnalysis instead.
# Arguments
- `analysis_id`: The ID of the analysis that you're describing. The ID is part of the URL
of the analysis.
- `aws_account_id`: The ID of the Amazon Web Services account that contains the analysis.
You must be using the Amazon Web Services account that the analysis is in.
"""
function describe_analysis_definition(
AnalysisId, AwsAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/analyses/$(AnalysisId)/definition";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_analysis_definition(
AnalysisId,
AwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/analyses/$(AnalysisId)/definition",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_analysis_permissions(analysis_id, aws_account_id)
describe_analysis_permissions(analysis_id, aws_account_id, params::Dict{String,<:Any})
Provides the read and write permissions for an analysis.
# Arguments
- `analysis_id`: The ID of the analysis whose permissions you're describing. The ID is part
of the analysis URL.
- `aws_account_id`: The ID of the Amazon Web Services account that contains the analysis
whose permissions you're describing. You must be using the Amazon Web Services account that
the analysis is in.
"""
function describe_analysis_permissions(
AnalysisId, AwsAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/analyses/$(AnalysisId)/permissions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_analysis_permissions(
AnalysisId,
AwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/analyses/$(AnalysisId)/permissions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_asset_bundle_export_job(asset_bundle_export_job_id, aws_account_id)
describe_asset_bundle_export_job(asset_bundle_export_job_id, aws_account_id, params::Dict{String,<:Any})
Describes an existing export job. Poll job descriptions after a job starts to know the
status of the job. When a job succeeds, a URL is provided to download the exported assets'
data from. Download URLs are valid for five minutes after they are generated. You can call
the DescribeAssetBundleExportJob API for a new download URL as needed. Job descriptions are
available for 14 days after the job starts.
# Arguments
- `asset_bundle_export_job_id`: The ID of the job that you want described. The job ID is
set when you start a new job with a StartAssetBundleExportJob API call.
- `aws_account_id`: The ID of the Amazon Web Services account the export job is executed
in.
"""
function describe_asset_bundle_export_job(
AssetBundleExportJobId, AwsAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/asset-bundle-export-jobs/$(AssetBundleExportJobId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_asset_bundle_export_job(
AssetBundleExportJobId,
AwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/asset-bundle-export-jobs/$(AssetBundleExportJobId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_asset_bundle_import_job(asset_bundle_import_job_id, aws_account_id)
describe_asset_bundle_import_job(asset_bundle_import_job_id, aws_account_id, params::Dict{String,<:Any})
Describes an existing import job. Poll job descriptions after starting a job to know when
it has succeeded or failed. Job descriptions are available for 14 days after job starts.
# Arguments
- `asset_bundle_import_job_id`: The ID of the job. The job ID is set when you start a new
job with a StartAssetBundleImportJob API call.
- `aws_account_id`: The ID of the Amazon Web Services account the import job was executed
in.
"""
function describe_asset_bundle_import_job(
AssetBundleImportJobId, AwsAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/asset-bundle-import-jobs/$(AssetBundleImportJobId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_asset_bundle_import_job(
AssetBundleImportJobId,
AwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/asset-bundle-import-jobs/$(AssetBundleImportJobId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dashboard(aws_account_id, dashboard_id)
describe_dashboard(aws_account_id, dashboard_id, params::Dict{String,<:Any})
Provides a summary for a dashboard.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the dashboard
that you're describing.
- `dashboard_id`: The ID for the dashboard.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"alias-name"`: The alias name.
- `"version-number"`: The version number for the dashboard. If a version number isn't
passed, the latest published dashboard version is described.
"""
function describe_dashboard(
AwsAccountId, DashboardId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/dashboards/$(DashboardId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_dashboard(
AwsAccountId,
DashboardId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/dashboards/$(DashboardId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dashboard_definition(aws_account_id, dashboard_id)
describe_dashboard_definition(aws_account_id, dashboard_id, params::Dict{String,<:Any})
Provides a detailed description of the definition of a dashboard. If you do not need to
know details about the content of a dashboard, for instance if you are trying to check the
status of a recently created or updated dashboard, use the DescribeDashboard instead.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the dashboard
that you're describing.
- `dashboard_id`: The ID for the dashboard.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"alias-name"`: The alias name.
- `"version-number"`: The version number for the dashboard. If a version number isn't
passed, the latest published dashboard version is described.
"""
function describe_dashboard_definition(
AwsAccountId, DashboardId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/dashboards/$(DashboardId)/definition";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_dashboard_definition(
AwsAccountId,
DashboardId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/dashboards/$(DashboardId)/definition",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dashboard_permissions(aws_account_id, dashboard_id)
describe_dashboard_permissions(aws_account_id, dashboard_id, params::Dict{String,<:Any})
Describes read and write permissions for a dashboard.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the dashboard
that you're describing permissions for.
- `dashboard_id`: The ID for the dashboard, also added to the IAM policy.
"""
function describe_dashboard_permissions(
AwsAccountId, DashboardId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/dashboards/$(DashboardId)/permissions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_dashboard_permissions(
AwsAccountId,
DashboardId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/dashboards/$(DashboardId)/permissions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dashboard_snapshot_job(aws_account_id, dashboard_id, snapshot_job_id)
describe_dashboard_snapshot_job(aws_account_id, dashboard_id, snapshot_job_id, params::Dict{String,<:Any})
Describes an existing snapshot job. Poll job descriptions after a job starts to know the
status of the job. For information on available status codes, see JobStatus.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that the dashboard snapshot
job is executed in.
- `dashboard_id`: The ID of the dashboard that you have started a snapshot job for.
- `snapshot_job_id`: The ID of the job to be described. The job ID is set when you start a
new job with a StartDashboardSnapshotJob API call.
"""
function describe_dashboard_snapshot_job(
AwsAccountId,
DashboardId,
SnapshotJobId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/dashboards/$(DashboardId)/snapshot-jobs/$(SnapshotJobId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_dashboard_snapshot_job(
AwsAccountId,
DashboardId,
SnapshotJobId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/dashboards/$(DashboardId)/snapshot-jobs/$(SnapshotJobId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dashboard_snapshot_job_result(aws_account_id, dashboard_id, snapshot_job_id)
describe_dashboard_snapshot_job_result(aws_account_id, dashboard_id, snapshot_job_id, params::Dict{String,<:Any})
Describes the result of an existing snapshot job that has finished running. A finished
snapshot job will return a COMPLETED or FAILED status when you poll the job with a
DescribeDashboardSnapshotJob API call. If the job has not finished running, this operation
returns a message that says Dashboard Snapshot Job with id <SnapshotjobId> has not
reached a terminal state..
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that the dashboard snapshot
job is executed in.
- `dashboard_id`: The ID of the dashboard that you have started a snapshot job for.
- `snapshot_job_id`: The ID of the job to be described. The job ID is set when you start a
new job with a StartDashboardSnapshotJob API call.
"""
function describe_dashboard_snapshot_job_result(
AwsAccountId,
DashboardId,
SnapshotJobId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/dashboards/$(DashboardId)/snapshot-jobs/$(SnapshotJobId)/result";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_dashboard_snapshot_job_result(
AwsAccountId,
DashboardId,
SnapshotJobId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/dashboards/$(DashboardId)/snapshot-jobs/$(SnapshotJobId)/result",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_data_set(aws_account_id, data_set_id)
describe_data_set(aws_account_id, data_set_id, params::Dict{String,<:Any})
Describes a dataset. This operation doesn't support datasets that include uploaded files as
a source.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID.
- `data_set_id`: The ID for the dataset that you want to create. This ID is unique per
Amazon Web Services Region for each Amazon Web Services account.
"""
function describe_data_set(
AwsAccountId, DataSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/data-sets/$(DataSetId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_data_set(
AwsAccountId,
DataSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/data-sets/$(DataSetId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_data_set_permissions(aws_account_id, data_set_id)
describe_data_set_permissions(aws_account_id, data_set_id, params::Dict{String,<:Any})
Describes the permissions on a dataset. The permissions resource is
arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID.
- `data_set_id`: The ID for the dataset that you want to create. This ID is unique per
Amazon Web Services Region for each Amazon Web Services account.
"""
function describe_data_set_permissions(
AwsAccountId, DataSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/data-sets/$(DataSetId)/permissions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_data_set_permissions(
AwsAccountId,
DataSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/data-sets/$(DataSetId)/permissions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_data_set_refresh_properties(aws_account_id, data_set_id)
describe_data_set_refresh_properties(aws_account_id, data_set_id, params::Dict{String,<:Any})
Describes the refresh properties of a dataset.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID.
- `data_set_id`: The ID of the dataset.
"""
function describe_data_set_refresh_properties(
AwsAccountId, DataSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/data-sets/$(DataSetId)/refresh-properties";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_data_set_refresh_properties(
AwsAccountId,
DataSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/data-sets/$(DataSetId)/refresh-properties",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_data_source(aws_account_id, data_source_id)
describe_data_source(aws_account_id, data_source_id, params::Dict{String,<:Any})
Describes a data source.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID.
- `data_source_id`: The ID of the data source. This ID is unique per Amazon Web Services
Region for each Amazon Web Services account.
"""
function describe_data_source(
AwsAccountId, DataSourceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/data-sources/$(DataSourceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_data_source(
AwsAccountId,
DataSourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/data-sources/$(DataSourceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_data_source_permissions(aws_account_id, data_source_id)
describe_data_source_permissions(aws_account_id, data_source_id, params::Dict{String,<:Any})
Describes the resource permissions for a data source.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID.
- `data_source_id`: The ID of the data source. This ID is unique per Amazon Web Services
Region for each Amazon Web Services account.
"""
function describe_data_source_permissions(
AwsAccountId, DataSourceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/data-sources/$(DataSourceId)/permissions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_data_source_permissions(
AwsAccountId,
DataSourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/data-sources/$(DataSourceId)/permissions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_folder(aws_account_id, folder_id)
describe_folder(aws_account_id, folder_id, params::Dict{String,<:Any})
Describes a folder.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that contains the folder.
- `folder_id`: The ID of the folder.
"""
function describe_folder(
AwsAccountId, FolderId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/folders/$(FolderId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_folder(
AwsAccountId,
FolderId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/folders/$(FolderId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_folder_permissions(aws_account_id, folder_id)
describe_folder_permissions(aws_account_id, folder_id, params::Dict{String,<:Any})
Describes permissions for a folder.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that contains the folder.
- `folder_id`: The ID of the folder.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max-results"`: The maximum number of results to be returned per request.
- `"namespace"`: The namespace of the folder whose permissions you want described.
- `"next-token"`: A pagination token for the next set of results.
"""
function describe_folder_permissions(
AwsAccountId, FolderId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/folders/$(FolderId)/permissions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_folder_permissions(
AwsAccountId,
FolderId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/folders/$(FolderId)/permissions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_folder_resolved_permissions(aws_account_id, folder_id)
describe_folder_resolved_permissions(aws_account_id, folder_id, params::Dict{String,<:Any})
Describes the folder resolved permissions. Permissions consists of both folder direct
permissions and the inherited permissions from the ancestor folders.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that contains the folder.
- `folder_id`: The ID of the folder.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max-results"`: The maximum number of results to be returned per request.
- `"namespace"`: The namespace of the folder whose permissions you want described.
- `"next-token"`: A pagination token for the next set of results.
"""
function describe_folder_resolved_permissions(
AwsAccountId, FolderId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/folders/$(FolderId)/resolved-permissions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_folder_resolved_permissions(
AwsAccountId,
FolderId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/folders/$(FolderId)/resolved-permissions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_group(aws_account_id, group_name, namespace)
describe_group(aws_account_id, group_name, namespace, params::Dict{String,<:Any})
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that the group is in.
Currently, you use the ID for the Amazon Web Services account that contains your Amazon
QuickSight account.
- `group_name`: The name of the group that you want to describe.
- `namespace`: The namespace of the group that you want described.
"""
function describe_group(
AwsAccountId, GroupName, Namespace; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/groups/$(GroupName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_group(
AwsAccountId,
GroupName,
Namespace,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/groups/$(GroupName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_group_membership(aws_account_id, group_name, member_name, namespace)
describe_group_membership(aws_account_id, group_name, member_name, namespace, params::Dict{String,<:Any})
Use the DescribeGroupMembership operation to determine if a user is a member of the
specified group. If the user exists and is a member of the specified group, an associated
GroupMember object is returned.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that the group is in.
Currently, you use the ID for the Amazon Web Services account that contains your Amazon
QuickSight account.
- `group_name`: The name of the group that you want to search.
- `member_name`: The user name of the user that you want to search for.
- `namespace`: The namespace that includes the group you are searching within.
"""
function describe_group_membership(
AwsAccountId,
GroupName,
MemberName,
Namespace;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/groups/$(GroupName)/members/$(MemberName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_group_membership(
AwsAccountId,
GroupName,
MemberName,
Namespace,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/groups/$(GroupName)/members/$(MemberName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_iampolicy_assignment(assignment_name, aws_account_id, namespace)
describe_iampolicy_assignment(assignment_name, aws_account_id, namespace, params::Dict{String,<:Any})
Describes an existing IAM policy assignment, as specified by the assignment name.
# Arguments
- `assignment_name`: The name of the assignment, also called a rule.
- `aws_account_id`: The ID of the Amazon Web Services account that contains the assignment
that you want to describe.
- `namespace`: The namespace that contains the assignment.
"""
function describe_iampolicy_assignment(
AssignmentName,
AwsAccountId,
Namespace;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/iam-policy-assignments/$(AssignmentName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_iampolicy_assignment(
AssignmentName,
AwsAccountId,
Namespace,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/iam-policy-assignments/$(AssignmentName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_ingestion(aws_account_id, data_set_id, ingestion_id)
describe_ingestion(aws_account_id, data_set_id, ingestion_id, params::Dict{String,<:Any})
Describes a SPICE ingestion.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID.
- `data_set_id`: The ID of the dataset used in the ingestion.
- `ingestion_id`: An ID for the ingestion.
"""
function describe_ingestion(
AwsAccountId, DataSetId, IngestionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/data-sets/$(DataSetId)/ingestions/$(IngestionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_ingestion(
AwsAccountId,
DataSetId,
IngestionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/data-sets/$(DataSetId)/ingestions/$(IngestionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_ip_restriction(aws_account_id)
describe_ip_restriction(aws_account_id, params::Dict{String,<:Any})
Provides a summary and status of IP rules.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the IP rules.
"""
function describe_ip_restriction(
AwsAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/ip-restriction";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_ip_restriction(
AwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/ip-restriction",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_key_registration(aws_account_id)
describe_key_registration(aws_account_id, params::Dict{String,<:Any})
Describes all customer managed key registrations in a Amazon QuickSight account.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the customer
managed key registration that you want to describe.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"default-key-only"`: Determines whether the request returns the default key only.
"""
function describe_key_registration(
AwsAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/key-registration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_key_registration(
AwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/key-registration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_namespace(aws_account_id, namespace)
describe_namespace(aws_account_id, namespace, params::Dict{String,<:Any})
Describes the current namespace.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that contains the Amazon
QuickSight namespace that you want to describe.
- `namespace`: The namespace that you want to describe.
"""
function describe_namespace(
AwsAccountId, Namespace; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_namespace(
AwsAccountId,
Namespace,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_refresh_schedule(aws_account_id, data_set_id, schedule_id)
describe_refresh_schedule(aws_account_id, data_set_id, schedule_id, params::Dict{String,<:Any})
Provides a summary of a refresh schedule.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID.
- `data_set_id`: The ID of the dataset.
- `schedule_id`: The ID of the refresh schedule.
"""
function describe_refresh_schedule(
AwsAccountId, DataSetId, ScheduleId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/data-sets/$(DataSetId)/refresh-schedules/$(ScheduleId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_refresh_schedule(
AwsAccountId,
DataSetId,
ScheduleId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/data-sets/$(DataSetId)/refresh-schedules/$(ScheduleId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_role_custom_permission(aws_account_id, namespace, role)
describe_role_custom_permission(aws_account_id, namespace, role, params::Dict{String,<:Any})
Describes all custom permissions that are mapped to a role.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that you want to create a
group in. The Amazon Web Services account ID that you provide must be the same Amazon Web
Services account that contains your Amazon QuickSight account.
- `namespace`: The namespace that contains the role.
- `role`: The name of the role whose permissions you want described.
"""
function describe_role_custom_permission(
AwsAccountId, Namespace, Role; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/roles/$(Role)/custom-permission";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_role_custom_permission(
AwsAccountId,
Namespace,
Role,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/roles/$(Role)/custom-permission",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_template(aws_account_id, template_id)
describe_template(aws_account_id, template_id, params::Dict{String,<:Any})
Describes a template's metadata.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the template
that you're describing.
- `template_id`: The ID for the template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"alias-name"`: The alias of the template that you want to describe. If you name a
specific alias, you describe the version that the alias points to. You can specify the
latest version of the template by providing the keyword LATEST in the AliasName parameter.
The keyword PUBLISHED doesn't apply to templates.
- `"version-number"`: (Optional) The number for the version to describe. If a VersionNumber
parameter value isn't provided, the latest version of the template is described.
"""
function describe_template(
AwsAccountId, TemplateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/templates/$(TemplateId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_template(
AwsAccountId,
TemplateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/templates/$(TemplateId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_template_alias(alias_name, aws_account_id, template_id)
describe_template_alias(alias_name, aws_account_id, template_id, params::Dict{String,<:Any})
Describes the template alias for a template.
# Arguments
- `alias_name`: The name of the template alias that you want to describe. If you name a
specific alias, you describe the version that the alias points to. You can specify the
latest version of the template by providing the keyword LATEST in the AliasName parameter.
The keyword PUBLISHED doesn't apply to templates.
- `aws_account_id`: The ID of the Amazon Web Services account that contains the template
alias that you're describing.
- `template_id`: The ID for the template.
"""
function describe_template_alias(
AliasName, AwsAccountId, TemplateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/templates/$(TemplateId)/aliases/$(AliasName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_template_alias(
AliasName,
AwsAccountId,
TemplateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/templates/$(TemplateId)/aliases/$(AliasName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_template_definition(aws_account_id, template_id)
describe_template_definition(aws_account_id, template_id, params::Dict{String,<:Any})
Provides a detailed description of the definition of a template. If you do not need to
know details about the content of a template, for instance if you are trying to check the
status of a recently created or updated template, use the DescribeTemplate instead.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the template.
You must be using the Amazon Web Services account that the template is in.
- `template_id`: The ID of the template that you're describing.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"alias-name"`: The alias of the template that you want to describe. If you name a
specific alias, you describe the version that the alias points to. You can specify the
latest version of the template by providing the keyword LATEST in the AliasName parameter.
The keyword PUBLISHED doesn't apply to templates.
- `"version-number"`: The version number of the template.
"""
function describe_template_definition(
AwsAccountId, TemplateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/templates/$(TemplateId)/definition";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_template_definition(
AwsAccountId,
TemplateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/templates/$(TemplateId)/definition",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_template_permissions(aws_account_id, template_id)
describe_template_permissions(aws_account_id, template_id, params::Dict{String,<:Any})
Describes read and write permissions on a template.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the template
that you're describing.
- `template_id`: The ID for the template.
"""
function describe_template_permissions(
AwsAccountId, TemplateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/templates/$(TemplateId)/permissions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_template_permissions(
AwsAccountId,
TemplateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/templates/$(TemplateId)/permissions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_theme(aws_account_id, theme_id)
describe_theme(aws_account_id, theme_id, params::Dict{String,<:Any})
Describes a theme.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the theme that
you're describing.
- `theme_id`: The ID for the theme.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"alias-name"`: The alias of the theme that you want to describe. If you name a specific
alias, you describe the version that the alias points to. You can specify the latest
version of the theme by providing the keyword LATEST in the AliasName parameter. The
keyword PUBLISHED doesn't apply to themes.
- `"version-number"`: The version number for the version to describe. If a VersionNumber
parameter value isn't provided, the latest version of the theme is described.
"""
function describe_theme(
AwsAccountId, ThemeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/themes/$(ThemeId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_theme(
AwsAccountId,
ThemeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/themes/$(ThemeId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_theme_alias(alias_name, aws_account_id, theme_id)
describe_theme_alias(alias_name, aws_account_id, theme_id, params::Dict{String,<:Any})
Describes the alias for a theme.
# Arguments
- `alias_name`: The name of the theme alias that you want to describe.
- `aws_account_id`: The ID of the Amazon Web Services account that contains the theme alias
that you're describing.
- `theme_id`: The ID for the theme.
"""
function describe_theme_alias(
AliasName, AwsAccountId, ThemeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/themes/$(ThemeId)/aliases/$(AliasName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_theme_alias(
AliasName,
AwsAccountId,
ThemeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/themes/$(ThemeId)/aliases/$(AliasName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_theme_permissions(aws_account_id, theme_id)
describe_theme_permissions(aws_account_id, theme_id, params::Dict{String,<:Any})
Describes the read and write permissions for a theme.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the theme that
you're describing.
- `theme_id`: The ID for the theme that you want to describe permissions for.
"""
function describe_theme_permissions(
AwsAccountId, ThemeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/themes/$(ThemeId)/permissions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_theme_permissions(
AwsAccountId,
ThemeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/themes/$(ThemeId)/permissions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_topic(aws_account_id, topic_id)
describe_topic(aws_account_id, topic_id, params::Dict{String,<:Any})
Describes a topic.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID.
- `topic_id`: The ID of the topic that you want to describe. This ID is unique per Amazon
Web Services Region for each Amazon Web Services account.
"""
function describe_topic(
AwsAccountId, TopicId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/topics/$(TopicId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_topic(
AwsAccountId,
TopicId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/topics/$(TopicId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_topic_permissions(aws_account_id, topic_id)
describe_topic_permissions(aws_account_id, topic_id, params::Dict{String,<:Any})
Describes the permissions of a topic.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the topic that
you want described.
- `topic_id`: The ID of the topic that you want to describe. This ID is unique per Amazon
Web Services Region for each Amazon Web Services account.
"""
function describe_topic_permissions(
AwsAccountId, TopicId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/topics/$(TopicId)/permissions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_topic_permissions(
AwsAccountId,
TopicId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/topics/$(TopicId)/permissions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_topic_refresh(aws_account_id, refresh_id, topic_id)
describe_topic_refresh(aws_account_id, refresh_id, topic_id, params::Dict{String,<:Any})
Describes the status of a topic refresh.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the topic whose
refresh you want to describe.
- `refresh_id`: The ID of the refresh, which is performed when the topic is created or
updated.
- `topic_id`: The ID of the topic that you want to describe. This ID is unique per Amazon
Web Services Region for each Amazon Web Services account.
"""
function describe_topic_refresh(
AwsAccountId, RefreshId, TopicId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/topics/$(TopicId)/refresh/$(RefreshId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_topic_refresh(
AwsAccountId,
RefreshId,
TopicId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/topics/$(TopicId)/refresh/$(RefreshId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_topic_refresh_schedule(aws_account_id, dataset_id, topic_id)
describe_topic_refresh_schedule(aws_account_id, dataset_id, topic_id, params::Dict{String,<:Any})
Deletes a topic refresh schedule.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID.
- `dataset_id`: The ID of the dataset.
- `topic_id`: The ID of the topic that contains the refresh schedule that you want to
describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services
account.
"""
function describe_topic_refresh_schedule(
AwsAccountId, DatasetId, TopicId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/topics/$(TopicId)/schedules/$(DatasetId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_topic_refresh_schedule(
AwsAccountId,
DatasetId,
TopicId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/topics/$(TopicId)/schedules/$(DatasetId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_user(aws_account_id, namespace, user_name)
describe_user(aws_account_id, namespace, user_name, params::Dict{String,<:Any})
Returns information about a user, given the user name.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that the user is in.
Currently, you use the ID for the Amazon Web Services account that contains your Amazon
QuickSight account.
- `namespace`: The namespace. Currently, you should set this to default.
- `user_name`: The name of the user that you want to describe.
"""
function describe_user(
AwsAccountId, Namespace, UserName; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/users/$(UserName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_user(
AwsAccountId,
Namespace,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/users/$(UserName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_vpcconnection(aws_account_id, vpcconnection_id)
describe_vpcconnection(aws_account_id, vpcconnection_id, params::Dict{String,<:Any})
Describes a VPC connection.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID of the account that contains the VPC
connection that you want described.
- `vpcconnection_id`: The ID of the VPC connection that you're creating. This ID is a
unique identifier for each Amazon Web Services Region in an Amazon Web Services account.
"""
function describe_vpcconnection(
AwsAccountId, VPCConnectionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/vpc-connections/$(VPCConnectionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_vpcconnection(
AwsAccountId,
VPCConnectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/vpc-connections/$(VPCConnectionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
generate_embed_url_for_anonymous_user(authorized_resource_arns, aws_account_id, experience_configuration, namespace)
generate_embed_url_for_anonymous_user(authorized_resource_arns, aws_account_id, experience_configuration, namespace, params::Dict{String,<:Any})
Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual
in your website, without having to register any reader users. Before you use this action,
make sure that you have configured the dashboards and permissions. The following rules
apply to the generated URL: It contains a temporary bearer token. It is valid for 5
minutes after it is generated. Once redeemed within this period, it cannot be re-used
again. The URL validity period should not be confused with the actual session lifetime
that can be customized using the SessionLifetimeInMinutes parameter. The resulting user
session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session
duration is 10 hours. You are charged only when the URL is used or there is interaction
with Amazon QuickSight. For more information, see Embedded Analytics in the Amazon
QuickSight User Guide. For more information about the high-level steps for embedding and
for an interactive demo of the ways you can customize embedding, visit the Amazon
QuickSight Developer Portal.
# Arguments
- `authorized_resource_arns`: The Amazon Resource Names (ARNs) for the Amazon QuickSight
resources that the user is authorized to access during the lifetime of the session. If you
choose Dashboard embedding experience, pass the list of dashboard ARNs in the account that
you want the user to be able to view. If you want to make changes to the theme of your
embedded content, pass a list of theme ARNs that the anonymous users need access to.
Currently, you can pass up to 25 theme ARNs in each API call.
- `aws_account_id`: The ID for the Amazon Web Services account that contains the dashboard
that you're embedding.
- `experience_configuration`: The configuration of the experience that you are embedding.
- `namespace`: The Amazon QuickSight namespace that the anonymous user virtually belongs
to. If you are not using an Amazon QuickSight custom namespace, set this to default.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllowedDomains"`: The domains that you want to add to the allow list for access to the
generated URL that is then embedded. This optional parameter overrides the static domains
that are configured in the Manage QuickSight menu in the Amazon QuickSight console.
Instead, it allows only the domains that you include in this parameter. You can list up to
three domains or subdomains in each API call. To include all subdomains under a specific
domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all
subdomains under https://sapp.amazon.com.
- `"SessionLifetimeInMinutes"`: How many minutes the session is valid. The session lifetime
must be in [15-600] minutes range.
- `"SessionTags"`: The session tags used for row-level security. Before you use this
parameter, make sure that you have configured the relevant datasets using the
DataSetRowLevelPermissionTagConfiguration parameter so that session tags can be used to
provide row-level security. These are not the tags used for the Amazon Web Services
resource tagging feature. For more information, see Using Row-Level Security (RLS) with
Tagsin the Amazon QuickSight User Guide.
"""
function generate_embed_url_for_anonymous_user(
AuthorizedResourceArns,
AwsAccountId,
ExperienceConfiguration,
Namespace;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/embed-url/anonymous-user",
Dict{String,Any}(
"AuthorizedResourceArns" => AuthorizedResourceArns,
"ExperienceConfiguration" => ExperienceConfiguration,
"Namespace" => Namespace,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function generate_embed_url_for_anonymous_user(
AuthorizedResourceArns,
AwsAccountId,
ExperienceConfiguration,
Namespace,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/embed-url/anonymous-user",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AuthorizedResourceArns" => AuthorizedResourceArns,
"ExperienceConfiguration" => ExperienceConfiguration,
"Namespace" => Namespace,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
generate_embed_url_for_registered_user(aws_account_id, experience_configuration, user_arn)
generate_embed_url_for_registered_user(aws_account_id, experience_configuration, user_arn, params::Dict{String,<:Any})
Generates an embed URL that you can use to embed an Amazon QuickSight experience in your
website. This action can be used for any type of user registered in an Amazon QuickSight
account. Before you use this action, make sure that you have configured the relevant Amazon
QuickSight resource and permissions. The following rules apply to the generated URL: It
contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once
redeemed within this period, it cannot be re-used again. The URL validity period should
not be confused with the actual session lifetime that can be customized using the
SessionLifetimeInMinutes parameter. The resulting user session is valid for 15 minutes
(minimum) to 10 hours (maximum). The default session duration is 10 hours. You are
charged only when the URL is used or there is interaction with Amazon QuickSight. For
more information, see Embedded Analytics in the Amazon QuickSight User Guide. For more
information about the high-level steps for embedding and for an interactive demo of the
ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that contains the dashboard
that you're embedding.
- `experience_configuration`: The experience that you want to embed. For registered users,
you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon
QuickSight Q search bar, the Amazon QuickSight Generative Q&A experience, or the entire
Amazon QuickSight console.
- `user_arn`: The Amazon Resource Name for the registered user.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllowedDomains"`: The domains that you want to add to the allow list for access to the
generated URL that is then embedded. This optional parameter overrides the static domains
that are configured in the Manage QuickSight menu in the Amazon QuickSight console.
Instead, it allows only the domains that you include in this parameter. You can list up to
three domains or subdomains in each API call. To include all subdomains under a specific
domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all
subdomains under https://sapp.amazon.com.
- `"SessionLifetimeInMinutes"`: How many minutes the session is valid. The session lifetime
must be in [15-600] minutes range.
"""
function generate_embed_url_for_registered_user(
AwsAccountId,
ExperienceConfiguration,
UserArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/embed-url/registered-user",
Dict{String,Any}(
"ExperienceConfiguration" => ExperienceConfiguration, "UserArn" => UserArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function generate_embed_url_for_registered_user(
AwsAccountId,
ExperienceConfiguration,
UserArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/embed-url/registered-user",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ExperienceConfiguration" => ExperienceConfiguration,
"UserArn" => UserArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_dashboard_embed_url(aws_account_id, dashboard_id, creds-type)
get_dashboard_embed_url(aws_account_id, dashboard_id, creds-type, params::Dict{String,<:Any})
Generates a temporary session URL and authorization code(bearer token) that you can use to
embed an Amazon QuickSight read-only dashboard in your website or application. Before you
use this command, make sure that you have configured the dashboards and permissions.
Currently, you can use GetDashboardEmbedURL only from the server, not from the user's
browser. The following rules apply to the generated URL: They must be used together.
They can be used one time only. They are valid for 5 minutes after you run this command.
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You
can use the optional SessionLifetimeInMinutes parameter to customize session duration.
For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon
QuickSight User Guide. For more information about the high-level steps for embedding and
for an interactive demo of the ways you can customize embedding, visit the Amazon
QuickSight Developer Portal.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that contains the dashboard
that you're embedding.
- `dashboard_id`: The ID for the dashboard, also added to the Identity and Access
Management (IAM) policy.
- `creds-type`: The authentication method that the user uses to sign in.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"additional-dashboard-ids"`: A list of one or more dashboard IDs that you want anonymous
users to have tempporary access to. Currently, the IdentityType parameter must be set to
ANONYMOUS because other identity types authenticate as Amazon QuickSight or IAM users. For
example, if you set \"--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3
identity-type ANONYMOUS\", the session can access all three dashboards.
- `"namespace"`: The Amazon QuickSight namespace that contains the dashboard IDs in this
request. If you're not using a custom namespace, set Namespace = default.
- `"reset-disabled"`: Remove the reset button on the embedded dashboard. The default is
FALSE, which enables the reset button.
- `"session-lifetime"`: How many minutes the session is valid. The session lifetime must be
15-600 minutes.
- `"state-persistence-enabled"`: Adds persistence of state for the user session in an
embedded dashboard. Persistence applies to the sheet and the parameter settings. These are
control settings that the dashboard subscriber (Amazon QuickSight reader) chooses while
viewing the dashboard. If this is set to TRUE, the settings are the same when the
subscriber reopens the same dashboard URL. The state is stored in Amazon QuickSight, not in
a browser cookie. If this is set to FALSE, the state of the user session is not persisted.
The default is FALSE.
- `"undo-redo-disabled"`: Remove the undo/redo button on the embedded dashboard. The
default is FALSE, which enables the undo/redo button.
- `"user-arn"`: The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
QUICKSIGHT identity type. You can use this for any Amazon QuickSight users in your account
(readers, authors, or admins) authenticated as one of the following: Active Directory
(AD) users or group members Invited nonfederated users IAM users and IAM role-based
sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM
federation. Omit this parameter for users in the third group – IAM users and IAM
role-based sessions.
"""
function get_dashboard_embed_url(
AwsAccountId, DashboardId, creds_type; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/dashboards/$(DashboardId)/embed-url",
Dict{String,Any}("creds-type" => creds_type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_dashboard_embed_url(
AwsAccountId,
DashboardId,
creds_type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/dashboards/$(DashboardId)/embed-url",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("creds-type" => creds_type), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_session_embed_url(aws_account_id)
get_session_embed_url(aws_account_id, params::Dict{String,<:Any})
Generates a session URL and authorization code that you can use to embed the Amazon Amazon
QuickSight console in your web server code. Use GetSessionEmbedUrl where you want to
provide an authoring portal that allows users to create data sources, datasets, analyses,
and dashboards. The users who access an embedded Amazon QuickSight console need belong to
the author or admin security cohort. If you want to restrict permissions to some of these
features, add a custom permissions profile to the user with the UpdateUser API operation.
Use RegisterUser API operation to add a new user with a custom permission profile
attached. For more information, see the following sections in the Amazon QuickSight User
Guide: Embedding Analytics Customizing Access to the Amazon QuickSight Console
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account associated with your Amazon
QuickSight subscription.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"entry-point"`: The URL you use to access the embedded session. The entry point URL is
constrained to the following paths: /start /start/analyses /start/dashboards
/start/favorites /dashboards/DashboardId - where DashboardId is the actual ID key from
the Amazon QuickSight console URL of the dashboard /analyses/AnalysisId - where
AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis
- `"session-lifetime"`: How many minutes the session is valid. The session lifetime must be
15-600 minutes.
- `"user-arn"`: The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
QUICKSIGHT identity type. You can use this for any type of Amazon QuickSight users in your
account (readers, authors, or admins). They need to be authenticated as one of the
following: Active Directory (AD) users or group members Invited nonfederated users
IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using
SAML, OpenID Connect, or IAM federation Omit this parameter for users in the third group,
IAM users and IAM role-based sessions.
"""
function get_session_embed_url(
AwsAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/session-embed-url";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_session_embed_url(
AwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/session-embed-url",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_analyses(aws_account_id)
list_analyses(aws_account_id, params::Dict{String,<:Any})
Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the analyses.
# 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.
- `"next-token"`: A pagination token that can be used in a subsequent request.
"""
function list_analyses(AwsAccountId; aws_config::AbstractAWSConfig=global_aws_config())
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/analyses";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_analyses(
AwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/analyses",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_asset_bundle_export_jobs(aws_account_id)
list_asset_bundle_export_jobs(aws_account_id, params::Dict{String,<:Any})
Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs
created more than 14 days ago are deleted forever and are not returned. If you are using
the same job ID for multiple jobs, ListAssetBundleExportJobs only returns the most recent
job that uses the repeated job ID.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that the export jobs were
executed in.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max-results"`: The maximum number of results to be returned per request.
- `"next-token"`: The token for the next set of results, or null if there are no more
results.
"""
function list_asset_bundle_export_jobs(
AwsAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/asset-bundle-export-jobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_asset_bundle_export_jobs(
AwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/asset-bundle-export-jobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_asset_bundle_import_jobs(aws_account_id)
list_asset_bundle_import_jobs(aws_account_id, params::Dict{String,<:Any})
Lists all asset bundle import jobs that have taken place in the last 14 days. Jobs created
more than 14 days ago are deleted forever and are not returned. If you are using the same
job ID for multiple jobs, ListAssetBundleImportJobs only returns the most recent job that
uses the repeated job ID.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that the import jobs were
executed in.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max-results"`: The maximum number of results to be returned per request.
- `"next-token"`: The token for the next set of results, or null if there are no more
results.
"""
function list_asset_bundle_import_jobs(
AwsAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/asset-bundle-import-jobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_asset_bundle_import_jobs(
AwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/asset-bundle-import-jobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_dashboard_versions(aws_account_id, dashboard_id)
list_dashboard_versions(aws_account_id, dashboard_id, params::Dict{String,<:Any})
Lists all the versions of the dashboards in the Amazon QuickSight subscription.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the dashboard
that you're listing versions for.
- `dashboard_id`: The ID for the dashboard.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max-results"`: The maximum number of results to be returned per request.
- `"next-token"`: The token for the next set of results, or null if there are no more
results.
"""
function list_dashboard_versions(
AwsAccountId, DashboardId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/dashboards/$(DashboardId)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_dashboard_versions(
AwsAccountId,
DashboardId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/dashboards/$(DashboardId)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_dashboards(aws_account_id)
list_dashboards(aws_account_id, params::Dict{String,<:Any})
Lists dashboards in an Amazon Web Services account.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the dashboards
that you're listing.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max-results"`: The maximum number of results to be returned per request.
- `"next-token"`: The token for the next set of results, or null if there are no more
results.
"""
function list_dashboards(AwsAccountId; aws_config::AbstractAWSConfig=global_aws_config())
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/dashboards";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_dashboards(
AwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/dashboards",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_data_sets(aws_account_id)
list_data_sets(aws_account_id, params::Dict{String,<:Any})
Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon
Web Services Region. The permissions resource is
arn:aws:quicksight:region:aws-account-id:dataset/*.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max-results"`: The maximum number of results to be returned per request.
- `"next-token"`: The token for the next set of results, or null if there are no more
results.
"""
function list_data_sets(AwsAccountId; aws_config::AbstractAWSConfig=global_aws_config())
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/data-sets";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_data_sets(
AwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/data-sets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_data_sources(aws_account_id)
list_data_sources(aws_account_id, params::Dict{String,<:Any})
Lists data sources in current Amazon Web Services Region that belong to this Amazon Web
Services account.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max-results"`: The maximum number of results to be returned per request.
- `"next-token"`: The token for the next set of results, or null if there are no more
results.
"""
function list_data_sources(AwsAccountId; aws_config::AbstractAWSConfig=global_aws_config())
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/data-sources";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_data_sources(
AwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/data-sources",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_folder_members(aws_account_id, folder_id)
list_folder_members(aws_account_id, folder_id, params::Dict{String,<:Any})
List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that contains the folder.
- `folder_id`: The ID of the folder.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max-results"`: The maximum number of results to be returned per request.
- `"next-token"`: The token for the next set of results, or null if there are no more
results.
"""
function list_folder_members(
AwsAccountId, FolderId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/folders/$(FolderId)/members";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_folder_members(
AwsAccountId,
FolderId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/folders/$(FolderId)/members",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_folders(aws_account_id)
list_folders(aws_account_id, params::Dict{String,<:Any})
Lists all folders in an account.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that contains the folder.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max-results"`: The maximum number of results to be returned per request.
- `"next-token"`: The token for the next set of results, or null if there are no more
results.
"""
function list_folders(AwsAccountId; aws_config::AbstractAWSConfig=global_aws_config())
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/folders";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_folders(
AwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/folders",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_group_memberships(aws_account_id, group_name, namespace)
list_group_memberships(aws_account_id, group_name, namespace, params::Dict{String,<:Any})
Lists member users in a group.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that the group is in.
Currently, you use the ID for the Amazon Web Services account that contains your Amazon
QuickSight account.
- `group_name`: The name of the group that you want to see a membership list of.
- `namespace`: The namespace of the group that you want a list of users from.
# 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 from this request.
- `"next-token"`: A pagination token that can be used in a subsequent request.
"""
function list_group_memberships(
AwsAccountId, GroupName, Namespace; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/groups/$(GroupName)/members";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_group_memberships(
AwsAccountId,
GroupName,
Namespace,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/groups/$(GroupName)/members",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_groups(aws_account_id, namespace)
list_groups(aws_account_id, namespace, params::Dict{String,<:Any})
Lists all user groups in Amazon QuickSight.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that the group is in.
Currently, you use the ID for the Amazon Web Services account that contains your Amazon
QuickSight account.
- `namespace`: The namespace that you want a list of groups from.
# 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.
- `"next-token"`: A pagination token that can be used in a subsequent request.
"""
function list_groups(
AwsAccountId, Namespace; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/groups";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_groups(
AwsAccountId,
Namespace,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/groups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_iampolicy_assignments(aws_account_id, namespace)
list_iampolicy_assignments(aws_account_id, namespace, params::Dict{String,<:Any})
Lists the IAM policy assignments in the current Amazon QuickSight account.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains these IAM
policy assignments.
- `namespace`: The namespace for the assignments.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"assignment-status"`: The status of the assignments.
- `"max-results"`: The maximum number of results to be returned per request.
- `"next-token"`: The token for the next set of results, or null if there are no more
results.
"""
function list_iampolicy_assignments(
AwsAccountId, Namespace; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/v2/iam-policy-assignments";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_iampolicy_assignments(
AwsAccountId,
Namespace,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/v2/iam-policy-assignments",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_iampolicy_assignments_for_user(aws_account_id, namespace, user_name)
list_iampolicy_assignments_for_user(aws_account_id, namespace, user_name, params::Dict{String,<:Any})
Lists all of the IAM policy assignments, including the Amazon Resource Names (ARNs), for
the IAM policies assigned to the specified user and group, or groups that the user belongs
to.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the assignments.
- `namespace`: The namespace of the assignment.
- `user_name`: The name of the user.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max-results"`: The maximum number of results to be returned per request.
- `"next-token"`: The token for the next set of results, or null if there are no more
results.
"""
function list_iampolicy_assignments_for_user(
AwsAccountId, Namespace, UserName; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/users/$(UserName)/iam-policy-assignments";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_iampolicy_assignments_for_user(
AwsAccountId,
Namespace,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/users/$(UserName)/iam-policy-assignments",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_identity_propagation_configs(aws_account_id)
list_identity_propagation_configs(aws_account_id, params::Dict{String,<:Any})
Lists all services and authorized targets that the Amazon QuickSight IAM Identity Center
application can access. This operation is only supported for Amazon QuickSight accounts
that use IAM Identity Center.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contain the identity
propagation configurations of.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max-results"`: The maximum number of results to be returned.
- `"next-token"`: The token for the next set of results, or null if there are no more
results.
"""
function list_identity_propagation_configs(
AwsAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/identity-propagation-config";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_identity_propagation_configs(
AwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/identity-propagation-config",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_ingestions(aws_account_id, data_set_id)
list_ingestions(aws_account_id, data_set_id, params::Dict{String,<:Any})
Lists the history of SPICE ingestions for a dataset.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID.
- `data_set_id`: The ID of the dataset used in the ingestion.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max-results"`: The maximum number of results to be returned per request.
- `"next-token"`: The token for the next set of results, or null if there are no more
results.
"""
function list_ingestions(
AwsAccountId, DataSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/data-sets/$(DataSetId)/ingestions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_ingestions(
AwsAccountId,
DataSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/data-sets/$(DataSetId)/ingestions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_namespaces(aws_account_id)
list_namespaces(aws_account_id, params::Dict{String,<:Any})
Lists the namespaces for the specified Amazon Web Services account. This operation doesn't
list deleted namespaces.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that contains the Amazon
QuickSight namespaces that you want to list.
# 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.
- `"next-token"`: A unique pagination token that can be used in a subsequent request. You
will receive a pagination token in the response body of a previous ListNameSpaces API call
if there is more data that can be returned. To receive the data, make another
ListNamespaces API call with the returned token to retrieve the next page of data. Each
token is valid for 24 hours. If you try to make a ListNamespaces API call with an expired
token, you will receive a HTTP 400 InvalidNextTokenException error.
"""
function list_namespaces(AwsAccountId; aws_config::AbstractAWSConfig=global_aws_config())
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/namespaces";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_namespaces(
AwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/namespaces",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_refresh_schedules(aws_account_id, data_set_id)
list_refresh_schedules(aws_account_id, data_set_id, params::Dict{String,<:Any})
Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID.
- `data_set_id`: The ID of the dataset.
"""
function list_refresh_schedules(
AwsAccountId, DataSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/data-sets/$(DataSetId)/refresh-schedules";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_refresh_schedules(
AwsAccountId,
DataSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/data-sets/$(DataSetId)/refresh-schedules",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_role_memberships(aws_account_id, namespace, role)
list_role_memberships(aws_account_id, namespace, role, params::Dict{String,<:Any})
Lists all groups that are associated with a role.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that you want to create a
group in. The Amazon Web Services account ID that you provide must be the same Amazon Web
Services account that contains your Amazon QuickSight account.
- `namespace`: The namespace that includes the role.
- `role`: The name of the role.
# 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.
- `"next-token"`: A pagination token that can be used in a subsequent request.
"""
function list_role_memberships(
AwsAccountId, Namespace, Role; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/roles/$(Role)/members";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_role_memberships(
AwsAccountId,
Namespace,
Role,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/roles/$(Role)/members",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Lists the tags assigned to a resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource that you want a list of
tags for.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/resources/$(ResourceArn)/tags";
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 quicksight(
"GET",
"/resources/$(ResourceArn)/tags",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_template_aliases(aws_account_id, template_id)
list_template_aliases(aws_account_id, template_id, params::Dict{String,<:Any})
Lists all the aliases of a template.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the template
aliases that you're listing.
- `template_id`: The ID for the template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max-result"`: The maximum number of results to be returned per request.
- `"next-token"`: The token for the next set of results, or null if there are no more
results.
"""
function list_template_aliases(
AwsAccountId, TemplateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/templates/$(TemplateId)/aliases";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_template_aliases(
AwsAccountId,
TemplateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/templates/$(TemplateId)/aliases",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_template_versions(aws_account_id, template_id)
list_template_versions(aws_account_id, template_id, params::Dict{String,<:Any})
Lists all the versions of the templates in the current Amazon QuickSight account.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the templates
that you're listing.
- `template_id`: The ID for the template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max-results"`: The maximum number of results to be returned per request.
- `"next-token"`: The token for the next set of results, or null if there are no more
results.
"""
function list_template_versions(
AwsAccountId, TemplateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/templates/$(TemplateId)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_template_versions(
AwsAccountId,
TemplateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/templates/$(TemplateId)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_templates(aws_account_id)
list_templates(aws_account_id, params::Dict{String,<:Any})
Lists all the templates in the current Amazon QuickSight account.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the templates
that you're listing.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max-result"`: The maximum number of results to be returned per request.
- `"next-token"`: The token for the next set of results, or null if there are no more
results.
"""
function list_templates(AwsAccountId; aws_config::AbstractAWSConfig=global_aws_config())
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/templates";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_templates(
AwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/templates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_theme_aliases(aws_account_id, theme_id)
list_theme_aliases(aws_account_id, theme_id, params::Dict{String,<:Any})
Lists all the aliases of a theme.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the theme
aliases that you're listing.
- `theme_id`: The ID for the theme.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max-result"`: The maximum number of results to be returned per request.
- `"next-token"`: The token for the next set of results, or null if there are no more
results.
"""
function list_theme_aliases(
AwsAccountId, ThemeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/themes/$(ThemeId)/aliases";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_theme_aliases(
AwsAccountId,
ThemeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/themes/$(ThemeId)/aliases",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_theme_versions(aws_account_id, theme_id)
list_theme_versions(aws_account_id, theme_id, params::Dict{String,<:Any})
Lists all the versions of the themes in the current Amazon Web Services account.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the themes that
you're listing.
- `theme_id`: The ID for the theme.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max-results"`: The maximum number of results to be returned per request.
- `"next-token"`: The token for the next set of results, or null if there are no more
results.
"""
function list_theme_versions(
AwsAccountId, ThemeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/themes/$(ThemeId)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_theme_versions(
AwsAccountId,
ThemeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/themes/$(ThemeId)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_themes(aws_account_id)
list_themes(aws_account_id, params::Dict{String,<:Any})
Lists all the themes in the current Amazon Web Services account.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the themes that
you're listing.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max-results"`: The maximum number of results to be returned per request.
- `"next-token"`: The token for the next set of results, or null if there are no more
results.
- `"type"`: The type of themes that you want to list. Valid options include the following:
ALL (default)- Display all existing themes. CUSTOM - Display only the themes created
by people using Amazon QuickSight. QUICKSIGHT - Display only the starting themes defined
by Amazon QuickSight.
"""
function list_themes(AwsAccountId; aws_config::AbstractAWSConfig=global_aws_config())
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/themes";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_themes(
AwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/themes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_topic_refresh_schedules(aws_account_id, topic_id)
list_topic_refresh_schedules(aws_account_id, topic_id, params::Dict{String,<:Any})
Lists all of the refresh schedules for a topic.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the topic whose
refresh schedule you want described.
- `topic_id`: The ID for the topic that you want to describe. This ID is unique per Amazon
Web Services Region for each Amazon Web Services account.
"""
function list_topic_refresh_schedules(
AwsAccountId, TopicId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/topics/$(TopicId)/schedules";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_topic_refresh_schedules(
AwsAccountId,
TopicId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/topics/$(TopicId)/schedules",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_topics(aws_account_id)
list_topics(aws_account_id, params::Dict{String,<:Any})
Lists all of the topics within an account.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the topics that
you want to list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max-results"`: The maximum number of results to be returned per request.
- `"next-token"`: The token for the next set of results, or null if there are no more
results.
"""
function list_topics(AwsAccountId; aws_config::AbstractAWSConfig=global_aws_config())
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/topics";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_topics(
AwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/topics",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_user_groups(aws_account_id, namespace, user_name)
list_user_groups(aws_account_id, namespace, user_name, params::Dict{String,<:Any})
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID that the user is in. Currently, you
use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
- `namespace`: The namespace. Currently, you should set this to default.
- `user_name`: The Amazon QuickSight user name that you want to list group memberships for.
# 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 from this request.
- `"next-token"`: A pagination token that can be used in a subsequent request.
"""
function list_user_groups(
AwsAccountId, Namespace, UserName; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/users/$(UserName)/groups";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_user_groups(
AwsAccountId,
Namespace,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/users/$(UserName)/groups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_users(aws_account_id, namespace)
list_users(aws_account_id, namespace, params::Dict{String,<:Any})
Returns a list of all of the Amazon QuickSight users belonging to this account.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that the user is in.
Currently, you use the ID for the Amazon Web Services account that contains your Amazon
QuickSight account.
- `namespace`: The namespace. Currently, you should set this to default.
# 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 from this request.
- `"next-token"`: A pagination token that can be used in a subsequent request.
"""
function list_users(
AwsAccountId, Namespace; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/users";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_users(
AwsAccountId,
Namespace,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/users",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_vpcconnections(aws_account_id)
list_vpcconnections(aws_account_id, params::Dict{String,<:Any})
Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon
Web Services account.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID of the account that contains the VPC
connections that you want to list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max-results"`: The maximum number of results to be returned per request.
- `"next-token"`: The token for the next set of results, or null if there are no more
results.
"""
function list_vpcconnections(
AwsAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/vpc-connections";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_vpcconnections(
AwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"GET",
"/accounts/$(AwsAccountId)/vpc-connections",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_data_set_refresh_properties(aws_account_id, data_set_id, data_set_refresh_properties)
put_data_set_refresh_properties(aws_account_id, data_set_id, data_set_refresh_properties, params::Dict{String,<:Any})
Creates or updates the dataset refresh properties for the dataset.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID.
- `data_set_id`: The ID of the dataset.
- `data_set_refresh_properties`: The dataset refresh properties.
"""
function put_data_set_refresh_properties(
AwsAccountId,
DataSetId,
DataSetRefreshProperties;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/data-sets/$(DataSetId)/refresh-properties",
Dict{String,Any}("DataSetRefreshProperties" => DataSetRefreshProperties);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_data_set_refresh_properties(
AwsAccountId,
DataSetId,
DataSetRefreshProperties,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/data-sets/$(DataSetId)/refresh-properties",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DataSetRefreshProperties" => DataSetRefreshProperties),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_user(aws_account_id, email, identity_type, namespace, user_role)
register_user(aws_account_id, email, identity_type, namespace, user_role, params::Dict{String,<:Any})
Creates an Amazon QuickSight user whose identity is associated with the Identity and Access
Management (IAM) identity or role specified in the request. When you register a new user
from the Amazon QuickSight API, Amazon QuickSight generates a registration URL. The user
accesses this registration URL to create their account. Amazon QuickSight doesn't send a
registration email to users who are registered from the Amazon QuickSight API. If you want
new users to receive a registration email, then add those users in the Amazon QuickSight
console. For more information on registering a new user in the Amazon QuickSight console,
see Inviting users to access Amazon QuickSight.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that the user is in.
Currently, you use the ID for the Amazon Web Services account that contains your Amazon
QuickSight account.
- `email`: The email address of the user that you want to register.
- `identity_type`: The identity type that your Amazon QuickSight account uses to manage the
identity of users.
- `namespace`: The namespace. Currently, you should set this to default.
- `user_role`: The Amazon QuickSight role for the user. The user role can be one of the
following: READER: A user who has read-only access to dashboards. AUTHOR: A user who
can create data sources, datasets, analyses, and dashboards. ADMIN: A user who is an
author, who can also manage Amazon QuickSight settings. READER_PRO: Reader Pro adds
Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in
Amazon QuickSight, can build stories with Amazon Q, and can generate executive summaries
from dashboards. AUTHOR_PRO: Author Pro adds Generative BI capabilities to the Author
role. Author Pros can author dashboards with natural language with Amazon Q, build stories
with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.
ADMIN_PRO: Admin Pros are Author Pros who can also manage Amazon QuickSight
administrative settings. Admin Pro users are billed at Author Pro pricing.
RESTRICTED_READER: This role isn't currently available for use. RESTRICTED_AUTHOR: This
role isn't currently available for use.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CustomFederationProviderUrl"`: The URL of the custom OpenID Connect (OIDC) provider
that provides identity to let a user federate into Amazon QuickSight with an associated
Identity and Access Management(IAM) role. This parameter should only be used when
ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.
- `"CustomPermissionsName"`: (Enterprise edition only) The name of the custom permissions
profile that you want to assign to this user. Customized permissions allows you to control
a user's access by restricting access the following operations: Create and update data
sources Create and update datasets Create and update email reports Subscribe to email
reports To add custom permissions to an existing user, use UpdateUser instead. A set of
custom permissions includes any combination of these restrictions. Currently, you need to
create the profile names for custom permission sets by using the Amazon QuickSight console.
Then, you use the RegisterUser API operation to assign the named set of permissions to a
Amazon QuickSight user. Amazon QuickSight custom permissions are applied through IAM
policies. Therefore, they override the permissions typically granted by assigning Amazon
QuickSight users to one of the default security cohorts in Amazon QuickSight (admin,
author, reader, admin pro, author pro, reader pro). This feature is available only to
Amazon QuickSight Enterprise edition subscriptions.
- `"ExternalLoginFederationProviderType"`: The type of supported external login provider
that provides identity to let a user federate into Amazon QuickSight with an associated
Identity and Access Management(IAM) role. The type of supported external login provider can
be one of the following. COGNITO: Amazon Cognito. The provider URL is
cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the
\"CustomFederationProviderUrl\" parameter which is only needed when the external provider
is custom. CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC
type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider
URL.
- `"ExternalLoginId"`: The identity ID for a user in the external login provider.
- `"IamArn"`: The ARN of the IAM user or role that you are registering with Amazon
QuickSight.
- `"SessionName"`: You need to use this parameter only when you register one or more users
using an assumed IAM role. You don't need to provide the session name for other scenarios,
for example when you are registering an IAM user or an Amazon QuickSight user. You can
register multiple users using the same IAM role if each user has a different session name.
For more information on assuming IAM roles, see assume-role in the CLI Reference.
- `"Tags"`: The tags to associate with the user.
- `"UserName"`: The Amazon QuickSight user name that you want to create for the user you
are registering.
"""
function register_user(
AwsAccountId,
Email,
IdentityType,
Namespace,
UserRole;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/users",
Dict{String,Any}(
"Email" => Email, "IdentityType" => IdentityType, "UserRole" => UserRole
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_user(
AwsAccountId,
Email,
IdentityType,
Namespace,
UserRole,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/users",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Email" => Email, "IdentityType" => IdentityType, "UserRole" => UserRole
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restore_analysis(analysis_id, aws_account_id)
restore_analysis(analysis_id, aws_account_id, params::Dict{String,<:Any})
Restores an analysis.
# Arguments
- `analysis_id`: The ID of the analysis that you're restoring.
- `aws_account_id`: The ID of the Amazon Web Services account that contains the analysis.
"""
function restore_analysis(
AnalysisId, AwsAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/restore/analyses/$(AnalysisId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function restore_analysis(
AnalysisId,
AwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/restore/analyses/$(AnalysisId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_analyses(aws_account_id, filters)
search_analyses(aws_account_id, filters, params::Dict{String,<:Any})
Searches for analyses that belong to the user specified in the filter. This operation is
eventually consistent. The results are best effort and may not reflect very recent updates
and changes.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the analyses
that you're searching for.
- `filters`: The structure for the search filters that you want to apply to your 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.
- `"NextToken"`: A pagination token that can be used in a subsequent request.
"""
function search_analyses(
AwsAccountId, Filters; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/search/analyses",
Dict{String,Any}("Filters" => Filters);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_analyses(
AwsAccountId,
Filters,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/search/analyses",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Filters" => Filters), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_dashboards(aws_account_id, filters)
search_dashboards(aws_account_id, filters, params::Dict{String,<:Any})
Searches for dashboards that belong to a user. This operation is eventually consistent.
The results are best effort and may not reflect very recent updates and changes.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the user whose
dashboards you're searching for.
- `filters`: The filters to apply to the search. Currently, you can search only by user
name, for example, \"Filters\": [ { \"Name\": \"QUICKSIGHT_USER\", \"Operator\":
\"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\" } ]
# 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 more
results.
"""
function search_dashboards(
AwsAccountId, Filters; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/search/dashboards",
Dict{String,Any}("Filters" => Filters);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_dashboards(
AwsAccountId,
Filters,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/search/dashboards",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Filters" => Filters), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_data_sets(aws_account_id, filters)
search_data_sets(aws_account_id, filters, params::Dict{String,<:Any})
Use the SearchDataSets operation to search for datasets that belong to an account.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID.
- `filters`: The filters to apply to the search.
# 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"`: A pagination token that can be used in a subsequent request.
"""
function search_data_sets(
AwsAccountId, Filters; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/search/data-sets",
Dict{String,Any}("Filters" => Filters);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_data_sets(
AwsAccountId,
Filters,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/search/data-sets",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Filters" => Filters), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_data_sources(aws_account_id, filters)
search_data_sources(aws_account_id, filters, params::Dict{String,<:Any})
Use the SearchDataSources operation to search for data sources that belong to an account.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID.
- `filters`: The filters to apply to the search.
# 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"`: A pagination token that can be used in a subsequent request.
"""
function search_data_sources(
AwsAccountId, Filters; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/search/data-sources",
Dict{String,Any}("Filters" => Filters);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_data_sources(
AwsAccountId,
Filters,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/search/data-sources",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Filters" => Filters), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_folders(aws_account_id, filters)
search_folders(aws_account_id, filters, params::Dict{String,<:Any})
Searches the subfolders in a folder.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that contains the folder.
- `filters`: The filters to apply to the search. Currently, you can search only by the
parent folder ARN. For example, \"Filters\": [ { \"Name\": \"PARENT_FOLDER_ARN\",
\"Operator\": \"StringEquals\", \"Value\":
\"arn:aws:quicksight:us-east-1:1:folder/folderId\" } ].
# 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 more
results.
"""
function search_folders(
AwsAccountId, Filters; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/search/folders",
Dict{String,Any}("Filters" => Filters);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_folders(
AwsAccountId,
Filters,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/search/folders",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Filters" => Filters), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_groups(aws_account_id, filters, namespace)
search_groups(aws_account_id, filters, namespace, params::Dict{String,<:Any})
Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace
using the supplied filters.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that the group is in.
Currently, you use the ID for the Amazon Web Services account that contains your Amazon
QuickSight account.
- `filters`: The structure for the search filters that you want to apply to your search.
- `namespace`: The namespace that you want to search.
# 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 from this request.
- `"next-token"`: A pagination token that can be used in a subsequent request.
"""
function search_groups(
AwsAccountId, Filters, Namespace; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/groups-search",
Dict{String,Any}("Filters" => Filters);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_groups(
AwsAccountId,
Filters,
Namespace,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/groups-search",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Filters" => Filters), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_asset_bundle_export_job(asset_bundle_export_job_id, aws_account_id, export_format, resource_arns)
start_asset_bundle_export_job(asset_bundle_export_job_id, aws_account_id, export_format, resource_arns, params::Dict{String,<:Any})
Starts an Asset Bundle export job. An Asset Bundle export job exports specified Amazon
QuickSight assets. You can also choose to export any asset dependencies in the same job.
Export jobs run asynchronously and can be polled with a DescribeAssetBundleExportJob API
call. When a job is successfully completed, a download URL that contains the exported
assets is returned. The URL is valid for 5 minutes and can be refreshed with a
DescribeAssetBundleExportJob API call. Each Amazon QuickSight account can run up to 5
export jobs concurrently. The API caller must have the necessary permissions in their IAM
role to access each resource before the resources can be exported.
# Arguments
- `asset_bundle_export_job_id`: The ID of the job. This ID is unique while the job is
running. After the job is completed, you can reuse this ID for another job.
- `aws_account_id`: The ID of the Amazon Web Services account to export assets from.
- `export_format`: The export data format.
- `resource_arns`: An array of resource ARNs to export. The following resources are
supported. Analysis Dashboard DataSet DataSource RefreshSchedule
Theme VPCConnection The API caller must have the necessary permissions in their IAM
role to access each resource before the resources can be exported.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CloudFormationOverridePropertyConfiguration"`: An optional collection of structures
that generate CloudFormation parameters to override the existing resource property values
when the resource is exported to a new CloudFormation template. Use this field if the
ExportFormat field of a StartAssetBundleExportJobRequest API call is set to
CLOUDFORMATION_JSON.
- `"IncludeAllDependencies"`: A Boolean that determines whether all dependencies of each
resource ARN are recursively exported with the job. For example, say you provided a
Dashboard ARN to the ResourceArns parameter. If you set IncludeAllDependencies to TRUE, any
theme, dataset, and data source resource that is a dependency of the dashboard is also
exported.
- `"IncludePermissions"`: A Boolean that determines whether all permissions for each
resource ARN are exported with the job. If you set IncludePermissions to TRUE, any
permissions associated with each resource are exported.
- `"IncludeTags"`: A Boolean that determines whether all tags for each resource ARN are
exported with the job. If you set IncludeTags to TRUE, any tags associated with each
resource are exported.
- `"ValidationStrategy"`: An optional parameter that determines which validation strategy
to use for the export job. If StrictModeForAllResources is set to TRUE, strict validation
for every error is enforced. If it is set to FALSE, validation is skipped for specific UI
errors that are shown as warnings. The default value for StrictModeForAllResources is FALSE.
"""
function start_asset_bundle_export_job(
AssetBundleExportJobId,
AwsAccountId,
ExportFormat,
ResourceArns;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/asset-bundle-export-jobs/export",
Dict{String,Any}(
"AssetBundleExportJobId" => AssetBundleExportJobId,
"ExportFormat" => ExportFormat,
"ResourceArns" => ResourceArns,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_asset_bundle_export_job(
AssetBundleExportJobId,
AwsAccountId,
ExportFormat,
ResourceArns,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/asset-bundle-export-jobs/export",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AssetBundleExportJobId" => AssetBundleExportJobId,
"ExportFormat" => ExportFormat,
"ResourceArns" => ResourceArns,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_asset_bundle_import_job(asset_bundle_import_job_id, asset_bundle_import_source, aws_account_id)
start_asset_bundle_import_job(asset_bundle_import_job_id, asset_bundle_import_source, aws_account_id, params::Dict{String,<:Any})
Starts an Asset Bundle import job. An Asset Bundle import job imports specified Amazon
QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming
prefix and specified configuration overrides. The assets that are contained in the bundle
file that you provide are used to create or update a new or existing asset in your Amazon
QuickSight account. Each Amazon QuickSight account can run up to 5 import jobs
concurrently. The API caller must have the necessary \"create\", \"describe\", and
\"update\" permissions in their IAM role to access each resource type that is contained in
the bundle file before the resources can be imported.
# Arguments
- `asset_bundle_import_job_id`: The ID of the job. This ID is unique while the job is
running. After the job is completed, you can reuse this ID for another job.
- `asset_bundle_import_source`: The source of the asset bundle zip file that contains the
data that you want to import. The file must be in QUICKSIGHT_JSON format.
- `aws_account_id`: The ID of the Amazon Web Services account to import assets into.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FailureAction"`: The failure action for the import job. If you choose ROLLBACK, failed
import jobs will attempt to undo any asset changes caused by the failed job. If you choose
DO_NOTHING, failed import jobs will not attempt to roll back any asset changes caused by
the failed job, possibly keeping the Amazon QuickSight account in an inconsistent state.
- `"OverrideParameters"`: Optional overrides that are applied to the resource configuration
before import.
- `"OverridePermissions"`: Optional permission overrides that are applied to the resource
configuration before import.
- `"OverrideTags"`: Optional tag overrides that are applied to the resource configuration
before import.
- `"OverrideValidationStrategy"`: An optional validation strategy override for all analyses
and dashboards that is applied to the resource configuration before import.
"""
function start_asset_bundle_import_job(
AssetBundleImportJobId,
AssetBundleImportSource,
AwsAccountId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/asset-bundle-import-jobs/import",
Dict{String,Any}(
"AssetBundleImportJobId" => AssetBundleImportJobId,
"AssetBundleImportSource" => AssetBundleImportSource,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_asset_bundle_import_job(
AssetBundleImportJobId,
AssetBundleImportSource,
AwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/asset-bundle-import-jobs/import",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AssetBundleImportJobId" => AssetBundleImportJobId,
"AssetBundleImportSource" => AssetBundleImportSource,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_dashboard_snapshot_job(aws_account_id, dashboard_id, snapshot_configuration, snapshot_job_id, user_configuration)
start_dashboard_snapshot_job(aws_account_id, dashboard_id, snapshot_configuration, snapshot_job_id, user_configuration, params::Dict{String,<:Any})
Starts an asynchronous job that generates a snapshot of a dashboard's output. You can
request one or several of the following format configurations in each API call. 1
Paginated PDF 1 Excel workbook that includes up to 5 table or pivot table visuals 5
CSVs from table or pivot table visuals The status of a submitted job can be polled with
the DescribeDashboardSnapshotJob API. When you call the DescribeDashboardSnapshotJob API,
check the JobStatus field in the response. Once the job reaches a COMPLETED or FAILED
status, use the DescribeDashboardSnapshotJobResult API to obtain the URLs for the generated
files. If the job fails, the DescribeDashboardSnapshotJobResult API returns detailed
information about the error that occurred. StartDashboardSnapshotJob API throttling
Amazon QuickSight utilizes API throttling to create a more consistent user experience
within a time span for customers when they call the StartDashboardSnapshotJob. By default,
12 jobs can run simlutaneously in one Amazon Web Services account and users can submit up
10 API requests per second before an account is throttled. If an overwhelming number of API
requests are made by the same user in a short period of time, Amazon QuickSight throttles
the API calls to maintin an optimal experience and reliability for all Amazon QuickSight
users. Common throttling scenarios The following list provides information about the most
commin throttling scenarios that can occur. A large number of SnapshotExport API jobs
are running simultaneously on an Amazon Web Services account. When a new
StartDashboardSnapshotJob is created and there are already 12 jobs with the RUNNING status,
the new job request fails and returns a LimitExceededException error. Wait for a current
job to comlpete before you resubmit the new job. A large number of API requests are
submitted on an Amazon Web Services account. When a user makes more than 10 API calls to
the Amazon QuickSight API in one second, a ThrottlingException is returned. If your use
case requires a higher throttling limit, contact your account admin or Amazon Web
ServicesSupport to explore options to tailor a more optimal expereince for your account.
Best practices to handle throttling If your use case projects high levels of API traffic,
try to reduce the degree of frequency and parallelism of API calls as much as you can to
avoid throttling. You can also perform a timing test to calculate an estimate for the total
processing time of your projected load that stays within the throttling limits of the
Amazon QuickSight APIs. For example, if your projected traffic is 100 snapshot jobs before
12:00 PM per day, start 12 jobs in parallel and measure the amount of time it takes to
proccess all 12 jobs. Once you obtain the result, multiply the duration by 9, for example
(12 minutes * 9 = 108 minutes). Use the new result to determine the latest time at which
the jobs need to be started to meet your target deadline. The time that it takes to process
a job can be impacted by the following factors: The dataset type (Direct Query or SPICE).
The size of the dataset. The complexity of the calculated fields that are used in the
dashboard. The number of visuals that are on a sheet. The types of visuals that are on
the sheet. The number of formats and snapshots that are requested in the job
configuration. The size of the generated snapshots.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that the dashboard snapshot
job is executed in.
- `dashboard_id`: The ID of the dashboard that you want to start a snapshot job for.
- `snapshot_configuration`: A structure that describes the configuration of the dashboard
snapshot.
- `snapshot_job_id`: An ID for the dashboard snapshot job. This ID is unique to the
dashboard while the job is running. This ID can be used to poll the status of a job with a
DescribeDashboardSnapshotJob while the job runs. You can reuse this ID for another job 24
hours after the current job is completed.
- `user_configuration`: A structure that contains information about the anonymous users
that the generated snapshot is for. This API will not return information about registered
Amazon QuickSight.
"""
function start_dashboard_snapshot_job(
AwsAccountId,
DashboardId,
SnapshotConfiguration,
SnapshotJobId,
UserConfiguration;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/dashboards/$(DashboardId)/snapshot-jobs",
Dict{String,Any}(
"SnapshotConfiguration" => SnapshotConfiguration,
"SnapshotJobId" => SnapshotJobId,
"UserConfiguration" => UserConfiguration,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_dashboard_snapshot_job(
AwsAccountId,
DashboardId,
SnapshotConfiguration,
SnapshotJobId,
UserConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/dashboards/$(DashboardId)/snapshot-jobs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SnapshotConfiguration" => SnapshotConfiguration,
"SnapshotJobId" => SnapshotJobId,
"UserConfiguration" => UserConfiguration,
),
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 QuickSight resource.
Tags can help you organize and categorize your resources. You can also use them to scope
user permissions, by granting a user permission to access or change only resources with
certain tag values. You can use the TagResource operation with a resource that already has
tags. If you specify a new tag key for the resource, this tag is appended to the list of
tags associated with the resource. If you specify a tag key that is already associated with
the resource, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on
data set, data source, dashboard, template, topic, and user. Tagging for Amazon QuickSight
works in a similar way to tagging for other Amazon Web Services services, except for the
following: Tags are used to track costs for users in Amazon QuickSight. You can't tag
other resources that Amazon QuickSight costs are based on, such as storage capacoty
(SPICE), session usage, alert consumption, or reporting units. Amazon QuickSight doesn't
currently support the tag editor for Resource Groups.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource that you want to tag.
- `tags`: Contains a map of the key-value pairs for the resource tag or tags assigned to
the resource.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return quicksight(
"POST",
"/resources/$(ResourceArn)/tags",
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 quicksight(
"POST",
"/resources/$(ResourceArn)/tags",
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, keys)
untag_resource(resource_arn, keys, params::Dict{String,<:Any})
Removes a tag or tags from a resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource that you want to untag.
- `keys`: The keys of the key-value pairs for the resource tag or tags assigned to the
resource.
"""
function untag_resource(
ResourceArn, keys; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"DELETE",
"/resources/$(ResourceArn)/tags",
Dict{String,Any}("keys" => keys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ResourceArn,
keys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"DELETE",
"/resources/$(ResourceArn)/tags",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("keys" => keys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_account_customization(account_customization, aws_account_id)
update_account_customization(account_customization, aws_account_id, params::Dict{String,<:Any})
Updates Amazon QuickSight customizations for the current Amazon Web Services Region.
Currently, the only customization that you can use is a theme. You can use customizations
for your Amazon Web Services account or, if you specify a namespace, for a Amazon
QuickSight namespace instead. Customizations that apply to a namespace override
customizations that apply to an Amazon Web Services account. To find out which
customizations apply, use the DescribeAccountCustomization API operation.
# Arguments
- `account_customization`: The Amazon QuickSight customizations you're updating in the
current Amazon Web Services Region.
- `aws_account_id`: The ID for the Amazon Web Services account that you want to update
Amazon QuickSight customizations for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"namespace"`: The namespace that you want to update Amazon QuickSight customizations for.
"""
function update_account_customization(
AccountCustomization, AwsAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/customizations",
Dict{String,Any}("AccountCustomization" => AccountCustomization);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_account_customization(
AccountCustomization,
AwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/customizations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AccountCustomization" => AccountCustomization),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_account_settings(aws_account_id, default_namespace)
update_account_settings(aws_account_id, default_namespace, params::Dict{String,<:Any})
Updates the Amazon QuickSight settings in your Amazon Web Services account.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that contains the Amazon
QuickSight settings that you want to list.
- `default_namespace`: The default namespace for this Amazon Web Services account.
Currently, the default is default. IAM users that register for the first time with Amazon
QuickSight provide an email address that becomes associated with the default namespace.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NotificationEmail"`: The email address that you want Amazon QuickSight to send
notifications to regarding your Amazon Web Services account or Amazon QuickSight
subscription.
- `"TerminationProtectionEnabled"`: A boolean value that determines whether or not an
Amazon QuickSight account can be deleted. A True value doesn't allow the account to be
deleted and results in an error message if a user tries to make a DeleteAccountSubscription
request. A False value will allow the account to be deleted.
"""
function update_account_settings(
AwsAccountId, DefaultNamespace; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/settings",
Dict{String,Any}("DefaultNamespace" => DefaultNamespace);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_account_settings(
AwsAccountId,
DefaultNamespace,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/settings",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("DefaultNamespace" => DefaultNamespace), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_analysis(analysis_id, aws_account_id, name)
update_analysis(analysis_id, aws_account_id, name, params::Dict{String,<:Any})
Updates an analysis in Amazon QuickSight
# Arguments
- `analysis_id`: The ID for the analysis that you're updating. This ID displays in the URL
of the analysis.
- `aws_account_id`: The ID of the Amazon Web Services account that contains the analysis
that you're updating.
- `name`: A descriptive name for the analysis that you're updating. This name displays for
the analysis in the Amazon QuickSight console.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Definition"`: The definition of an analysis. A definition is the data model of all
features in a Dashboard, Template, or Analysis.
- `"Parameters"`: The parameter names and override values that you want to use. An analysis
can have any parameter type, and some parameters might accept multiple values.
- `"SourceEntity"`: A source entity to use for the analysis that you're updating. This
metadata structure contains details that describe a source template and one or more
datasets.
- `"ThemeArn"`: The Amazon Resource Name (ARN) for the theme to apply to the analysis that
you're creating. To see the theme in the Amazon QuickSight console, make sure that you have
access to it.
- `"ValidationStrategy"`: The option to relax the validation needed to update an analysis
with definition objects. This skips the validation step for specific errors.
"""
function update_analysis(
AnalysisId, AwsAccountId, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/analyses/$(AnalysisId)",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_analysis(
AnalysisId,
AwsAccountId,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/analyses/$(AnalysisId)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_analysis_permissions(analysis_id, aws_account_id)
update_analysis_permissions(analysis_id, aws_account_id, params::Dict{String,<:Any})
Updates the read and write permissions for an analysis.
# Arguments
- `analysis_id`: The ID of the analysis whose permissions you're updating. The ID is part
of the analysis URL.
- `aws_account_id`: The ID of the Amazon Web Services account that contains the analysis
whose permissions you're updating. You must be using the Amazon Web Services account that
the analysis is in.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GrantPermissions"`: A structure that describes the permissions to add and the principal
to add them to.
- `"RevokePermissions"`: A structure that describes the permissions to remove and the
principal to remove them from.
"""
function update_analysis_permissions(
AnalysisId, AwsAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/analyses/$(AnalysisId)/permissions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_analysis_permissions(
AnalysisId,
AwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/analyses/$(AnalysisId)/permissions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_dashboard(aws_account_id, dashboard_id, name)
update_dashboard(aws_account_id, dashboard_id, name, params::Dict{String,<:Any})
Updates a dashboard in an Amazon Web Services account. Updating a Dashboard creates a new
dashboard version but does not immediately publish the new version. You can update the
published version of a dashboard by using the UpdateDashboardPublishedVersion API
operation.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the dashboard
that you're updating.
- `dashboard_id`: The ID for the dashboard.
- `name`: The display name of the dashboard.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DashboardPublishOptions"`: Options for publishing the dashboard when you create it:
AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or
DISABLED. When this is set to DISABLED, Amazon QuickSight disables the left filter pane on
the published dashboard, which can be used for ad hoc (one-time) filtering. This option is
ENABLED by default. AvailabilityStatus for ExportToCSVOption - This status can be
either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled
when this is set to DISABLED. This option is ENABLED by default. VisibilityState for
SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This
option is COLLAPSED by default.
- `"Definition"`: The definition of a dashboard. A definition is the data model of all
features in a Dashboard, Template, or Analysis.
- `"Parameters"`: A structure that contains the parameters of the dashboard. These are
parameter overrides for a dashboard. A dashboard can have any type of parameters, and some
parameters might accept multiple values.
- `"SourceEntity"`: The entity that you are using as a source when you update the
dashboard. In SourceEntity, you specify the type of object you're using as source. You can
only update a dashboard from a template, so you use a SourceTemplate entity. If you need to
update a dashboard from an analysis, first convert the analysis to a template by using the
CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN)
of the source template. The SourceTemplate ARN can contain any Amazon Web Services account
and any Amazon QuickSight-supported Amazon Web Services Region. Use the DataSetReferences
entity within SourceTemplate to list the replacement datasets for the placeholders listed
in the original. The schema in each dataset must match its placeholder.
- `"ThemeArn"`: The Amazon Resource Name (ARN) of the theme that is being used for this
dashboard. If you add a value for this field, it overrides the value that was originally
associated with the entity. The theme ARN must exist in the same Amazon Web Services
account where you create the dashboard.
- `"ValidationStrategy"`: The option to relax the validation needed to update a dashboard
with definition objects. This skips the validation step for specific errors.
- `"VersionDescription"`: A description for the first version of the dashboard being
created.
"""
function update_dashboard(
AwsAccountId, DashboardId, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/dashboards/$(DashboardId)",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_dashboard(
AwsAccountId,
DashboardId,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/dashboards/$(DashboardId)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_dashboard_links(aws_account_id, dashboard_id, link_entities)
update_dashboard_links(aws_account_id, dashboard_id, link_entities, params::Dict{String,<:Any})
Updates the linked analyses on a dashboard.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the dashboard
whose links you want to update.
- `dashboard_id`: The ID for the dashboard.
- `link_entities`: list of analysis Amazon Resource Names (ARNs) to be linked to the
dashboard.
"""
function update_dashboard_links(
AwsAccountId,
DashboardId,
LinkEntities;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/dashboards/$(DashboardId)/linked-entities",
Dict{String,Any}("LinkEntities" => LinkEntities);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_dashboard_links(
AwsAccountId,
DashboardId,
LinkEntities,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/dashboards/$(DashboardId)/linked-entities",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("LinkEntities" => LinkEntities), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_dashboard_permissions(aws_account_id, dashboard_id)
update_dashboard_permissions(aws_account_id, dashboard_id, params::Dict{String,<:Any})
Updates read and write permissions on a dashboard.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the dashboard
whose permissions you're updating.
- `dashboard_id`: The ID for the dashboard.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GrantLinkPermissions"`: Grants link permissions to all users in a defined namespace.
- `"GrantPermissions"`: The permissions that you want to grant on this resource.
- `"RevokeLinkPermissions"`: Revokes link permissions from all users in a defined namespace.
- `"RevokePermissions"`: The permissions that you want to revoke from this resource.
"""
function update_dashboard_permissions(
AwsAccountId, DashboardId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/dashboards/$(DashboardId)/permissions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_dashboard_permissions(
AwsAccountId,
DashboardId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/dashboards/$(DashboardId)/permissions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_dashboard_published_version(aws_account_id, dashboard_id, version_number)
update_dashboard_published_version(aws_account_id, dashboard_id, version_number, params::Dict{String,<:Any})
Updates the published version of a dashboard.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the dashboard
that you're updating.
- `dashboard_id`: The ID for the dashboard.
- `version_number`: The version number of the dashboard.
"""
function update_dashboard_published_version(
AwsAccountId,
DashboardId,
VersionNumber;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/dashboards/$(DashboardId)/versions/$(VersionNumber)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_dashboard_published_version(
AwsAccountId,
DashboardId,
VersionNumber,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/dashboards/$(DashboardId)/versions/$(VersionNumber)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_data_set(aws_account_id, data_set_id, import_mode, name, physical_table_map)
update_data_set(aws_account_id, data_set_id, import_mode, name, physical_table_map, params::Dict{String,<:Any})
Updates a dataset. This operation doesn't support datasets that include uploaded files as a
source. Partial updates are not supported by this operation.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID.
- `data_set_id`: The ID for the dataset that you want to update. This ID is unique per
Amazon Web Services Region for each Amazon Web Services account.
- `import_mode`: Indicates whether you want to import the data into SPICE.
- `name`: The display name for the dataset.
- `physical_table_map`: Declares the physical tables that are available in the underlying
data sources.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ColumnGroups"`: Groupings of columns that work together in certain Amazon QuickSight
features. Currently, only geospatial hierarchy is supported.
- `"ColumnLevelPermissionRules"`: A set of one or more definitions of a
ColumnLevelPermissionRule .
- `"DataSetUsageConfiguration"`:
- `"DatasetParameters"`: The parameter declarations of the dataset.
- `"FieldFolders"`: The folder that contains fields and nested subfolders for your dataset.
- `"LogicalTableMap"`: Configures the combination and transformation of the data from the
physical tables.
- `"RowLevelPermissionDataSet"`: The row-level security configuration for the data you want
to create.
- `"RowLevelPermissionTagConfiguration"`: The configuration of tags on a dataset to set
row-level security. Row-level security tags are currently supported for anonymous embedding
only.
"""
function update_data_set(
AwsAccountId,
DataSetId,
ImportMode,
Name,
PhysicalTableMap;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/data-sets/$(DataSetId)",
Dict{String,Any}(
"ImportMode" => ImportMode,
"Name" => Name,
"PhysicalTableMap" => PhysicalTableMap,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_data_set(
AwsAccountId,
DataSetId,
ImportMode,
Name,
PhysicalTableMap,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/data-sets/$(DataSetId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ImportMode" => ImportMode,
"Name" => Name,
"PhysicalTableMap" => PhysicalTableMap,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_data_set_permissions(aws_account_id, data_set_id)
update_data_set_permissions(aws_account_id, data_set_id, params::Dict{String,<:Any})
Updates the permissions on a dataset. The permissions resource is
arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID.
- `data_set_id`: The ID for the dataset whose permissions you want to update. This ID is
unique per Amazon Web Services Region for each Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GrantPermissions"`: The resource permissions that you want to grant to the dataset.
- `"RevokePermissions"`: The resource permissions that you want to revoke from the dataset.
"""
function update_data_set_permissions(
AwsAccountId, DataSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/data-sets/$(DataSetId)/permissions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_data_set_permissions(
AwsAccountId,
DataSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/data-sets/$(DataSetId)/permissions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_data_source(aws_account_id, data_source_id, name)
update_data_source(aws_account_id, data_source_id, name, params::Dict{String,<:Any})
Updates a data source.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID.
- `data_source_id`: The ID of the data source. This ID is unique per Amazon Web Services
Region for each Amazon Web Services account.
- `name`: A display name for the data source.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Credentials"`: The credentials that Amazon QuickSight that uses to connect to your
underlying source. Currently, only credentials based on user name and password are
supported.
- `"DataSourceParameters"`: The parameters that Amazon QuickSight uses to connect to your
underlying source.
- `"SslProperties"`: Secure Socket Layer (SSL) properties that apply when Amazon QuickSight
connects to your underlying source.
- `"VpcConnectionProperties"`: Use this parameter only when you want Amazon QuickSight to
use a VPC connection when connecting to your underlying source.
"""
function update_data_source(
AwsAccountId, DataSourceId, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/data-sources/$(DataSourceId)",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_data_source(
AwsAccountId,
DataSourceId,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/data-sources/$(DataSourceId)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_data_source_permissions(aws_account_id, data_source_id)
update_data_source_permissions(aws_account_id, data_source_id, params::Dict{String,<:Any})
Updates the permissions to a data source.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID.
- `data_source_id`: The ID of the data source. This ID is unique per Amazon Web Services
Region for each Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GrantPermissions"`: A list of resource permissions that you want to grant on the data
source.
- `"RevokePermissions"`: A list of resource permissions that you want to revoke on the data
source.
"""
function update_data_source_permissions(
AwsAccountId, DataSourceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/data-sources/$(DataSourceId)/permissions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_data_source_permissions(
AwsAccountId,
DataSourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/data-sources/$(DataSourceId)/permissions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_folder(aws_account_id, folder_id, name)
update_folder(aws_account_id, folder_id, name, params::Dict{String,<:Any})
Updates the name of a folder.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that contains the folder to
update.
- `folder_id`: The ID of the folder.
- `name`: The name of the folder.
"""
function update_folder(
AwsAccountId, FolderId, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/folders/$(FolderId)",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_folder(
AwsAccountId,
FolderId,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/folders/$(FolderId)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_folder_permissions(aws_account_id, folder_id)
update_folder_permissions(aws_account_id, folder_id, params::Dict{String,<:Any})
Updates permissions of a folder.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that contains the folder to
update.
- `folder_id`: The ID of the folder.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GrantPermissions"`: The permissions that you want to grant on a resource. Namespace
ARNs are not supported Principal values for folder permissions.
- `"RevokePermissions"`: The permissions that you want to revoke from a resource. Namespace
ARNs are not supported Principal values for folder permissions.
"""
function update_folder_permissions(
AwsAccountId, FolderId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/folders/$(FolderId)/permissions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_folder_permissions(
AwsAccountId,
FolderId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/folders/$(FolderId)/permissions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_group(aws_account_id, group_name, namespace)
update_group(aws_account_id, group_name, namespace, params::Dict{String,<:Any})
Changes a group description.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that the group is in.
Currently, you use the ID for the Amazon Web Services account that contains your Amazon
QuickSight account.
- `group_name`: The name of the group that you want to update.
- `namespace`: The namespace of the group that you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description for the group that you want to update.
"""
function update_group(
AwsAccountId, GroupName, Namespace; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/groups/$(GroupName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_group(
AwsAccountId,
GroupName,
Namespace,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/groups/$(GroupName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_iampolicy_assignment(assignment_name, aws_account_id, namespace)
update_iampolicy_assignment(assignment_name, aws_account_id, namespace, params::Dict{String,<:Any})
Updates an existing IAM policy assignment. This operation updates only the optional
parameter or parameters that are specified in the request. This overwrites all of the users
included in Identities.
# Arguments
- `assignment_name`: The name of the assignment, also called a rule. The name must be
unique within the Amazon Web Services account.
- `aws_account_id`: The ID of the Amazon Web Services account that contains the IAM policy
assignment.
- `namespace`: The namespace of the assignment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AssignmentStatus"`: The status of the assignment. Possible values are as follows:
ENABLED - Anything specified in this assignment is used when creating the data source.
DISABLED - This assignment isn't used when creating the data source. DRAFT - This
assignment is an unfinished draft and isn't used when creating the data source.
- `"Identities"`: The Amazon QuickSight users, groups, or both that you want to assign the
policy to.
- `"PolicyArn"`: The ARN for the IAM policy to apply to the Amazon QuickSight users and
groups specified in this assignment.
"""
function update_iampolicy_assignment(
AssignmentName,
AwsAccountId,
Namespace;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/iam-policy-assignments/$(AssignmentName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_iampolicy_assignment(
AssignmentName,
AwsAccountId,
Namespace,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/iam-policy-assignments/$(AssignmentName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_identity_propagation_config(aws_account_id, service)
update_identity_propagation_config(aws_account_id, service, params::Dict{String,<:Any})
Adds or updates services and authorized targets to configure what the Amazon QuickSight IAM
Identity Center application can access. This operation is only supported for Amazon
QuickSight accounts using IAM Identity Center
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the identity
propagation configuration that you want to update.
- `service`: The name of the Amazon Web Services service that contains the authorized
targets that you want to add or update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AuthorizedTargets"`: Specifies a list of application ARNs that represent the authorized
targets for a service.
"""
function update_identity_propagation_config(
AwsAccountId, Service; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/identity-propagation-config/$(Service)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_identity_propagation_config(
AwsAccountId,
Service,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/identity-propagation-config/$(Service)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_ip_restriction(aws_account_id)
update_ip_restriction(aws_account_id, params::Dict{String,<:Any})
Updates the content and status of IP rules. Traffic from a source is allowed when the
source satisfies either the IpRestrictionRule, VpcIdRestrictionRule, or
VpcEndpointIdRestrictionRule. To use this operation, you must provide the entire map of
rules. You can use the DescribeIpRestriction operation to get the current rule map.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the IP rules.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Enabled"`: A value that specifies whether IP rules are turned on.
- `"IpRestrictionRuleMap"`: A map that describes the updated IP rules with CIDR ranges and
descriptions.
- `"VpcEndpointIdRestrictionRuleMap"`: A map of allowed VPC endpoint IDs and their
corresponding rule descriptions.
- `"VpcIdRestrictionRuleMap"`: A map of VPC IDs and their corresponding rules. When you
configure this parameter, traffic from all VPC endpoints that are present in the specified
VPC is allowed.
"""
function update_ip_restriction(
AwsAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/ip-restriction";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_ip_restriction(
AwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/ip-restriction",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_key_registration(aws_account_id, key_registration)
update_key_registration(aws_account_id, key_registration, params::Dict{String,<:Any})
Updates a customer managed key in a Amazon QuickSight account.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the customer
managed key registration that you want to update.
- `key_registration`: A list of RegisteredCustomerManagedKey objects to be updated to the
Amazon QuickSight account.
"""
function update_key_registration(
AwsAccountId, KeyRegistration; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/key-registration",
Dict{String,Any}("KeyRegistration" => KeyRegistration);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_key_registration(
AwsAccountId,
KeyRegistration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/key-registration",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("KeyRegistration" => KeyRegistration), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_public_sharing_settings(aws_account_id)
update_public_sharing_settings(aws_account_id, params::Dict{String,<:Any})
Use the UpdatePublicSharingSettings operation to turn on or turn off the public sharing
settings of an Amazon QuickSight dashboard. To use this operation, turn on session capacity
pricing for your Amazon QuickSight account. Before you can turn on public sharing on your
account, make sure to give public sharing permissions to an administrative user in the
Identity and Access Management (IAM) console. For more information on using IAM with Amazon
QuickSight, see Using Amazon QuickSight with IAM in the Amazon QuickSight User Guide.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID associated with your Amazon
QuickSight subscription.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PublicSharingEnabled"`: A Boolean value that indicates whether public sharing is turned
on for an Amazon QuickSight account.
"""
function update_public_sharing_settings(
AwsAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/public-sharing-settings";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_public_sharing_settings(
AwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/public-sharing-settings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_refresh_schedule(aws_account_id, data_set_id, schedule)
update_refresh_schedule(aws_account_id, data_set_id, schedule, params::Dict{String,<:Any})
Updates a refresh schedule for a dataset.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID.
- `data_set_id`: The ID of the dataset.
- `schedule`: The refresh schedule.
"""
function update_refresh_schedule(
AwsAccountId, DataSetId, Schedule; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/data-sets/$(DataSetId)/refresh-schedules",
Dict{String,Any}("Schedule" => Schedule);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_refresh_schedule(
AwsAccountId,
DataSetId,
Schedule,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/data-sets/$(DataSetId)/refresh-schedules",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Schedule" => Schedule), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_role_custom_permission(aws_account_id, custom_permissions_name, namespace, role)
update_role_custom_permission(aws_account_id, custom_permissions_name, namespace, role, params::Dict{String,<:Any})
Updates the custom permissions that are associated with a role.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that you want to create a
group in. The Amazon Web Services account ID that you provide must be the same Amazon Web
Services account that contains your Amazon QuickSight account.
- `custom_permissions_name`: The name of the custom permission that you want to update the
role with.
- `namespace`: The namespace that contains the role that you want to update.
- `role`: The name of role tht you want to update.
"""
function update_role_custom_permission(
AwsAccountId,
CustomPermissionsName,
Namespace,
Role;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/roles/$(Role)/custom-permission",
Dict{String,Any}("CustomPermissionsName" => CustomPermissionsName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_role_custom_permission(
AwsAccountId,
CustomPermissionsName,
Namespace,
Role,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/roles/$(Role)/custom-permission",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CustomPermissionsName" => CustomPermissionsName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_spicecapacity_configuration(aws_account_id, purchase_mode)
update_spicecapacity_configuration(aws_account_id, purchase_mode, params::Dict{String,<:Any})
Updates the SPICE capacity configuration for a Amazon QuickSight account.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the SPICE
configuration that you want to update.
- `purchase_mode`: Determines how SPICE capacity can be purchased. The following options
are available. MANUAL: SPICE capacity can only be purchased manually. AUTO_PURCHASE:
Extra SPICE capacity is automatically purchased on your behalf as needed. SPICE capacity
can also be purchased manually with this option.
"""
function update_spicecapacity_configuration(
AwsAccountId, PurchaseMode; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/spice-capacity-configuration",
Dict{String,Any}("PurchaseMode" => PurchaseMode);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_spicecapacity_configuration(
AwsAccountId,
PurchaseMode,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"POST",
"/accounts/$(AwsAccountId)/spice-capacity-configuration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PurchaseMode" => PurchaseMode), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_template(aws_account_id, template_id)
update_template(aws_account_id, template_id, params::Dict{String,<:Any})
Updates a template from an existing Amazon QuickSight analysis or another template.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the template
that you're updating.
- `template_id`: The ID for the template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Definition"`: The definition of a template. A definition is the data model of all
features in a Dashboard, Template, or Analysis.
- `"Name"`: The name for the template.
- `"SourceEntity"`: The entity that you are using as a source when you update the template.
In SourceEntity, you specify the type of object you're using as source: SourceTemplate for
a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name
(ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis,
specify the ARN of the source analysis. The SourceTemplate ARN can contain any Amazon Web
Services account and any Amazon QuickSight-supported Amazon Web Services Region;. Use the
DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement
datasets for the placeholders listed in the original. The schema in each dataset must match
its placeholder.
- `"ValidationStrategy"`: The option to relax the validation needed to update a template
with definition objects. This skips the validation step for specific errors.
- `"VersionDescription"`: A description of the current template version that is being
updated. Every time you call UpdateTemplate, you create a new version of the template. Each
version of the template maintains a description of the version in the VersionDescription
field.
"""
function update_template(
AwsAccountId, TemplateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/templates/$(TemplateId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_template(
AwsAccountId,
TemplateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/templates/$(TemplateId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_template_alias(alias_name, aws_account_id, template_id, template_version_number)
update_template_alias(alias_name, aws_account_id, template_id, template_version_number, params::Dict{String,<:Any})
Updates the template alias of a template.
# Arguments
- `alias_name`: The alias of the template that you want to update. If you name a specific
alias, you update the version that the alias points to. You can specify the latest version
of the template by providing the keyword LATEST in the AliasName parameter. The keyword
PUBLISHED doesn't apply to templates.
- `aws_account_id`: The ID of the Amazon Web Services account that contains the template
alias that you're updating.
- `template_id`: The ID for the template.
- `template_version_number`: The version number of the template.
"""
function update_template_alias(
AliasName,
AwsAccountId,
TemplateId,
TemplateVersionNumber;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/templates/$(TemplateId)/aliases/$(AliasName)",
Dict{String,Any}("TemplateVersionNumber" => TemplateVersionNumber);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_template_alias(
AliasName,
AwsAccountId,
TemplateId,
TemplateVersionNumber,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/templates/$(TemplateId)/aliases/$(AliasName)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("TemplateVersionNumber" => TemplateVersionNumber),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_template_permissions(aws_account_id, template_id)
update_template_permissions(aws_account_id, template_id, params::Dict{String,<:Any})
Updates the resource permissions for a template.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the template.
- `template_id`: The ID for the template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GrantPermissions"`: A list of resource permissions to be granted on the template.
- `"RevokePermissions"`: A list of resource permissions to be revoked from the template.
"""
function update_template_permissions(
AwsAccountId, TemplateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/templates/$(TemplateId)/permissions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_template_permissions(
AwsAccountId,
TemplateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/templates/$(TemplateId)/permissions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_theme(aws_account_id, base_theme_id, theme_id)
update_theme(aws_account_id, base_theme_id, theme_id, params::Dict{String,<:Any})
Updates a theme.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the theme that
you're updating.
- `base_theme_id`: The theme ID, defined by Amazon QuickSight, that a custom theme inherits
from. All themes initially inherit from a default Amazon QuickSight theme.
- `theme_id`: The ID for the theme.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Configuration"`: The theme configuration, which contains the theme display properties.
- `"Name"`: The name for the theme.
- `"VersionDescription"`: A description of the theme version that you're updating Every
time that you call UpdateTheme, you create a new version of the theme. Each version of the
theme maintains a description of the version in VersionDescription.
"""
function update_theme(
AwsAccountId, BaseThemeId, ThemeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/themes/$(ThemeId)",
Dict{String,Any}("BaseThemeId" => BaseThemeId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_theme(
AwsAccountId,
BaseThemeId,
ThemeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/themes/$(ThemeId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("BaseThemeId" => BaseThemeId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_theme_alias(alias_name, aws_account_id, theme_id, theme_version_number)
update_theme_alias(alias_name, aws_account_id, theme_id, theme_version_number, params::Dict{String,<:Any})
Updates an alias of a theme.
# Arguments
- `alias_name`: The name of the theme alias that you want to update.
- `aws_account_id`: The ID of the Amazon Web Services account that contains the theme alias
that you're updating.
- `theme_id`: The ID for the theme.
- `theme_version_number`: The version number of the theme that the alias should reference.
"""
function update_theme_alias(
AliasName,
AwsAccountId,
ThemeId,
ThemeVersionNumber;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/themes/$(ThemeId)/aliases/$(AliasName)",
Dict{String,Any}("ThemeVersionNumber" => ThemeVersionNumber);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_theme_alias(
AliasName,
AwsAccountId,
ThemeId,
ThemeVersionNumber,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/themes/$(ThemeId)/aliases/$(AliasName)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ThemeVersionNumber" => ThemeVersionNumber), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_theme_permissions(aws_account_id, theme_id)
update_theme_permissions(aws_account_id, theme_id, params::Dict{String,<:Any})
Updates the resource permissions for a theme. Permissions apply to the action to grant or
revoke permissions on, for example \"quicksight:DescribeTheme\". Theme permissions apply in
groupings. Valid groupings include the following for the three levels of permissions, which
are user, owner, or no permissions: User \"quicksight:DescribeTheme\"
\"quicksight:DescribeThemeAlias\" \"quicksight:ListThemeAliases\"
\"quicksight:ListThemeVersions\" Owner \"quicksight:DescribeTheme\"
\"quicksight:DescribeThemeAlias\" \"quicksight:ListThemeAliases\"
\"quicksight:ListThemeVersions\" \"quicksight:DeleteTheme\"
\"quicksight:UpdateTheme\" \"quicksight:CreateThemeAlias\"
\"quicksight:DeleteThemeAlias\" \"quicksight:UpdateThemeAlias\"
\"quicksight:UpdateThemePermissions\" \"quicksight:DescribeThemePermissions\" To
specify no permissions, omit the permissions list.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the theme.
- `theme_id`: The ID for the theme.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GrantPermissions"`: A list of resource permissions to be granted for the theme.
- `"RevokePermissions"`: A list of resource permissions to be revoked from the theme.
"""
function update_theme_permissions(
AwsAccountId, ThemeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/themes/$(ThemeId)/permissions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_theme_permissions(
AwsAccountId,
ThemeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/themes/$(ThemeId)/permissions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_topic(aws_account_id, topic, topic_id)
update_topic(aws_account_id, topic, topic_id, params::Dict{String,<:Any})
Updates a topic.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the topic that
you want to update.
- `topic`: The definition of the topic that you want to update.
- `topic_id`: The ID of the topic that you want to modify. This ID is unique per Amazon Web
Services Region for each Amazon Web Services account.
"""
function update_topic(
AwsAccountId, Topic, TopicId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/topics/$(TopicId)",
Dict{String,Any}("Topic" => Topic);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_topic(
AwsAccountId,
Topic,
TopicId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/topics/$(TopicId)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Topic" => Topic), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_topic_permissions(aws_account_id, topic_id)
update_topic_permissions(aws_account_id, topic_id, params::Dict{String,<:Any})
Updates the permissions of a topic.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the topic that
you want to update the permissions for.
- `topic_id`: The ID of the topic that you want to modify. This ID is unique per Amazon Web
Services Region for each Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GrantPermissions"`: The resource permissions that you want to grant to the topic.
- `"RevokePermissions"`: The resource permissions that you want to revoke from the topic.
"""
function update_topic_permissions(
AwsAccountId, TopicId; aws_config::AbstractAWSConfig=global_aws_config()
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/topics/$(TopicId)/permissions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_topic_permissions(
AwsAccountId,
TopicId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/topics/$(TopicId)/permissions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_topic_refresh_schedule(aws_account_id, dataset_id, refresh_schedule, topic_id)
update_topic_refresh_schedule(aws_account_id, dataset_id, refresh_schedule, topic_id, params::Dict{String,<:Any})
Updates a topic refresh schedule.
# Arguments
- `aws_account_id`: The ID of the Amazon Web Services account that contains the topic whose
refresh schedule you want to update.
- `dataset_id`: The ID of the dataset.
- `refresh_schedule`: The definition of a refresh schedule.
- `topic_id`: The ID of the topic that you want to modify. This ID is unique per Amazon Web
Services Region for each Amazon Web Services account.
"""
function update_topic_refresh_schedule(
AwsAccountId,
DatasetId,
RefreshSchedule,
TopicId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/topics/$(TopicId)/schedules/$(DatasetId)",
Dict{String,Any}("RefreshSchedule" => RefreshSchedule);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_topic_refresh_schedule(
AwsAccountId,
DatasetId,
RefreshSchedule,
TopicId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/topics/$(TopicId)/schedules/$(DatasetId)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("RefreshSchedule" => RefreshSchedule), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_user(aws_account_id, email, namespace, role, user_name)
update_user(aws_account_id, email, namespace, role, user_name, params::Dict{String,<:Any})
Updates an Amazon QuickSight user.
# Arguments
- `aws_account_id`: The ID for the Amazon Web Services account that the user is in.
Currently, you use the ID for the Amazon Web Services account that contains your Amazon
QuickSight account.
- `email`: The email address of the user that you want to update.
- `namespace`: The namespace. Currently, you should set this to default.
- `role`: The Amazon QuickSight role of the user. The role can be one of the following
default security cohorts: READER: A user who has read-only access to dashboards.
AUTHOR: A user who can create data sources, datasets, analyses, and dashboards. ADMIN: A
user who is an author, who can also manage Amazon QuickSight settings. READER_PRO:
Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to
Amazon Q in Amazon QuickSight, can build stories with Amazon Q, and can generate executive
summaries from dashboards. AUTHOR_PRO: Author Pro adds Generative BI capabilities to the
Author role. Author Pros can author dashboards with natural language with Amazon Q, build
stories with Amazon Q, create Topics for Q&A, and generate executive summaries from
dashboards. ADMIN_PRO: Admin Pros are Author Pros who can also manage Amazon QuickSight
administrative settings. Admin Pro users are billed at Author Pro pricing. The name of
the Amazon QuickSight role is invisible to the user except for the console screens dealing
with permissions.
- `user_name`: The Amazon QuickSight user name that you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CustomFederationProviderUrl"`: The URL of the custom OpenID Connect (OIDC) provider
that provides identity to let a user federate into Amazon QuickSight with an associated
Identity and Access Management(IAM) role. This parameter should only be used when
ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.
- `"CustomPermissionsName"`: (Enterprise edition only) The name of the custom permissions
profile that you want to assign to this user. Customized permissions allows you to control
a user's access by restricting access the following operations: Create and update data
sources Create and update datasets Create and update email reports Subscribe to email
reports A set of custom permissions includes any combination of these restrictions.
Currently, you need to create the profile names for custom permission sets by using the
Amazon QuickSight console. Then, you use the RegisterUser API operation to assign the named
set of permissions to a Amazon QuickSight user. Amazon QuickSight custom permissions are
applied through IAM policies. Therefore, they override the permissions typically granted by
assigning Amazon QuickSight users to one of the default security cohorts in Amazon
QuickSight (admin, author, reader). This feature is available only to Amazon QuickSight
Enterprise edition subscriptions.
- `"ExternalLoginFederationProviderType"`: The type of supported external login provider
that provides identity to let a user federate into Amazon QuickSight with an associated
Identity and Access Management(IAM) role. The type of supported external login provider can
be one of the following. COGNITO: Amazon Cognito. The provider URL is
cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the
\"CustomFederationProviderUrl\" parameter which is only needed when the external provider
is custom. CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC
type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider
URL. NONE: This clears all the previously saved external login information for a user.
Use the DescribeUser API operation to check the external login information.
- `"ExternalLoginId"`: The identity ID for a user in the external login provider.
- `"UnapplyCustomPermissions"`: A flag that you use to indicate that you want to remove all
custom permissions from this user. Using this parameter resets the user to the state it was
in before a custom permissions profile was applied. This parameter defaults to NULL and it
doesn't accept any other value.
"""
function update_user(
AwsAccountId,
Email,
Namespace,
Role,
UserName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/users/$(UserName)",
Dict{String,Any}("Email" => Email, "Role" => Role);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_user(
AwsAccountId,
Email,
Namespace,
Role,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/namespaces/$(Namespace)/users/$(UserName)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Email" => Email, "Role" => Role), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_vpcconnection(aws_account_id, name, role_arn, security_group_ids, subnet_ids, vpcconnection_id)
update_vpcconnection(aws_account_id, name, role_arn, security_group_ids, subnet_ids, vpcconnection_id, params::Dict{String,<:Any})
Updates a VPC connection.
# Arguments
- `aws_account_id`: The Amazon Web Services account ID of the account that contains the VPC
connection that you want to update.
- `name`: The display name for the VPC connection.
- `role_arn`: An IAM role associated with the VPC connection.
- `security_group_ids`: A list of security group IDs for the VPC connection.
- `subnet_ids`: A list of subnet IDs for the VPC connection.
- `vpcconnection_id`: The ID of the VPC connection that you're updating. This ID is a
unique identifier for each Amazon Web Services Region in an Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DnsResolvers"`: A list of IP addresses of DNS resolver endpoints for the VPC connection.
"""
function update_vpcconnection(
AwsAccountId,
Name,
RoleArn,
SecurityGroupIds,
SubnetIds,
VPCConnectionId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/vpc-connections/$(VPCConnectionId)",
Dict{String,Any}(
"Name" => Name,
"RoleArn" => RoleArn,
"SecurityGroupIds" => SecurityGroupIds,
"SubnetIds" => SubnetIds,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_vpcconnection(
AwsAccountId,
Name,
RoleArn,
SecurityGroupIds,
SubnetIds,
VPCConnectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return quicksight(
"PUT",
"/accounts/$(AwsAccountId)/vpc-connections/$(VPCConnectionId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Name" => Name,
"RoleArn" => RoleArn,
"SecurityGroupIds" => SecurityGroupIds,
"SubnetIds" => SubnetIds,
),
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 | 92078 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: ram
using AWS.Compat
using AWS.UUIDs
"""
accept_resource_share_invitation(resource_share_invitation_arn)
accept_resource_share_invitation(resource_share_invitation_arn, params::Dict{String,<:Any})
Accepts an invitation to a resource share from another Amazon Web Services account. After
you accept the invitation, the resources included in the resource share are available to
interact with in the relevant Amazon Web Services Management Consoles and tools.
# Arguments
- `resource_share_invitation_arn`: The Amazon Resource Name (ARN) of the invitation that
you want to accept.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Specifies a unique, case-sensitive identifier that you provide to ensure
the idempotency of the request. This lets you safely retry the request without accidentally
performing the same operation a second time. Passing the same value to a later call to an
operation requires that you also pass the same value for all other parameters. We recommend
that you use a UUID type of value.. If you don't provide this value, then Amazon Web
Services generates a random one for you. If you retry the operation with the same
ClientToken, but with different parameters, the retry fails with an
IdempotentParameterMismatch error.
"""
function accept_resource_share_invitation(
resourceShareInvitationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ram(
"POST",
"/acceptresourceshareinvitation",
Dict{String,Any}("resourceShareInvitationArn" => resourceShareInvitationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function accept_resource_share_invitation(
resourceShareInvitationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ram(
"POST",
"/acceptresourceshareinvitation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"resourceShareInvitationArn" => resourceShareInvitationArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_resource_share(resource_share_arn)
associate_resource_share(resource_share_arn, params::Dict{String,<:Any})
Adds the specified list of principals and list of resources to a resource share. Principals
that already have access to this resource share immediately receive access to the added
resources. Newly added principals immediately receive access to the resources shared in
this resource share.
# Arguments
- `resource_share_arn`: Specifies the Amazon Resource Name (ARN) of the resource share that
you want to add principals or resources to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Specifies a unique, case-sensitive identifier that you provide to ensure
the idempotency of the request. This lets you safely retry the request without accidentally
performing the same operation a second time. Passing the same value to a later call to an
operation requires that you also pass the same value for all other parameters. We recommend
that you use a UUID type of value.. If you don't provide this value, then Amazon Web
Services generates a random one for you. If you retry the operation with the same
ClientToken, but with different parameters, the retry fails with an
IdempotentParameterMismatch error.
- `"principals"`: Specifies a list of principals to whom you want to the resource share.
This can be null if you want to add only resources. What the principals can do with the
resources in the share is determined by the RAM permissions that you associate with the
resource share. See AssociateResourceSharePermission. You can include the following values:
An Amazon Web Services account ID, for example: 123456789012 An Amazon Resource Name
(ARN) of an organization in Organizations, for example:
organizations::123456789012:organization/o-exampleorgid An ARN of an organizational unit
(OU) in Organizations, for example:
organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123 An ARN of
an IAM role, for example: iam::123456789012:role/rolename An ARN of an IAM user, for
example: iam::123456789012user/username Not all resource types can be shared with IAM
roles and users. For more information, see Sharing with IAM roles and users in the Resource
Access Manager User Guide.
- `"resourceArns"`: Specifies a list of Amazon Resource Names (ARNs) of the resources that
you want to share. This can be null if you want to add only principals.
- `"sources"`: Specifies from which source accounts the service principal has access to the
resources in this resource share.
"""
function associate_resource_share(
resourceShareArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ram(
"POST",
"/associateresourceshare",
Dict{String,Any}("resourceShareArn" => resourceShareArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_resource_share(
resourceShareArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ram(
"POST",
"/associateresourceshare",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("resourceShareArn" => resourceShareArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_resource_share_permission(permission_arn, resource_share_arn)
associate_resource_share_permission(permission_arn, resource_share_arn, params::Dict{String,<:Any})
Adds or replaces the RAM permission for a resource type included in a resource share. You
can have exactly one permission associated with each resource type in the resource share.
You can add a new RAM permission only if there are currently no resources of that resource
type currently in the resource share.
# Arguments
- `permission_arn`: Specifies the Amazon Resource Name (ARN) of the RAM permission to
associate with the resource share. To find the ARN for a permission, use either the
ListPermissions operation or go to the Permissions library page in the RAM console and then
choose the name of the permission. The ARN is displayed on the detail page.
- `resource_share_arn`: Specifies the Amazon Resource Name (ARN) of the resource share to
which you want to add or replace permissions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Specifies a unique, case-sensitive identifier that you provide to ensure
the idempotency of the request. This lets you safely retry the request without accidentally
performing the same operation a second time. Passing the same value to a later call to an
operation requires that you also pass the same value for all other parameters. We recommend
that you use a UUID type of value.. If you don't provide this value, then Amazon Web
Services generates a random one for you. If you retry the operation with the same
ClientToken, but with different parameters, the retry fails with an
IdempotentParameterMismatch error.
- `"permissionVersion"`: Specifies the version of the RAM permission to associate with the
resource share. You can specify only the version that is currently set as the default
version for the permission. If you also set the replace pararameter to true, then this
operation updates an outdated version of the permission to the current default version.
You don't need to specify this parameter because the default behavior is to use the version
that is currently set as the default version for the permission. This parameter is
supported for backwards compatibility.
- `"replace"`: Specifies whether the specified permission should replace the existing
permission associated with the resource share. Use true to replace the current permissions.
Use false to add the permission to a resource share that currently doesn't have a
permission. The default value is false. A resource share can have only one permission per
resource type. If a resource share already has a permission for the specified resource type
and you don't set replace to true then the operation returns an error. This helps prevent
accidental overwriting of a permission.
"""
function associate_resource_share_permission(
permissionArn, resourceShareArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ram(
"POST",
"/associateresourcesharepermission",
Dict{String,Any}(
"permissionArn" => permissionArn, "resourceShareArn" => resourceShareArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_resource_share_permission(
permissionArn,
resourceShareArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ram(
"POST",
"/associateresourcesharepermission",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"permissionArn" => permissionArn, "resourceShareArn" => resourceShareArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_permission(name, policy_template, resource_type)
create_permission(name, policy_template, resource_type, params::Dict{String,<:Any})
Creates a customer managed permission for a specified resource type that you can attach to
resource shares. It is created in the Amazon Web Services Region in which you call the
operation.
# Arguments
- `name`: Specifies the name of the customer managed permission. The name must be unique
within the Amazon Web Services Region.
- `policy_template`: A string in JSON format string that contains the following elements of
a resource-based policy: Effect: must be set to ALLOW. Action: specifies the actions
that are allowed by this customer managed permission. The list must contain only actions
that are supported by the specified resource type. For a list of all actions supported by
each resource type, see Actions, resources, and condition keys for Amazon Web Services
services in the Identity and Access Management User Guide. Condition: (optional)
specifies conditional parameters that must evaluate to true when a user attempts an action
for that action to be allowed. For more information about the Condition element, see IAM
policies: Condition element in the Identity and Access Management User Guide. This
template can't include either the Resource or Principal elements. Those are both filled in
by RAM when it instantiates the resource-based policy on each resource shared using this
managed permission. The Resource comes from the ARN of the specific resource that you are
sharing. The Principal comes from the list of identities added to the resource share.
- `resource_type`: Specifies the name of the resource type that this customer managed
permission applies to. The format is <service-code>:<resource-type> and is
not case sensitive. For example, to specify an Amazon EC2 Subnet, you can use the string
ec2:subnet. To see the list of valid values for this parameter, query the ListResourceTypes
operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Specifies a unique, case-sensitive identifier that you provide to ensure
the idempotency of the request. This lets you safely retry the request without accidentally
performing the same operation a second time. Passing the same value to a later call to an
operation requires that you also pass the same value for all other parameters. We recommend
that you use a UUID type of value.. If you don't provide this value, then Amazon Web
Services generates a random one for you. If you retry the operation with the same
ClientToken, but with different parameters, the retry fails with an
IdempotentParameterMismatch error.
- `"tags"`: Specifies a list of one or more tag key and value pairs to attach to the
permission.
"""
function create_permission(
name, policyTemplate, resourceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return ram(
"POST",
"/createpermission",
Dict{String,Any}(
"name" => name,
"policyTemplate" => policyTemplate,
"resourceType" => resourceType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_permission(
name,
policyTemplate,
resourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ram(
"POST",
"/createpermission",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name,
"policyTemplate" => policyTemplate,
"resourceType" => resourceType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_permission_version(permission_arn, policy_template)
create_permission_version(permission_arn, policy_template, params::Dict{String,<:Any})
Creates a new version of the specified customer managed permission. The new version is
automatically set as the default version of the customer managed permission. New resource
shares automatically use the default permission. Existing resource shares continue to use
their original permission versions, but you can use ReplacePermissionAssociations to update
them. If the specified customer managed permission already has the maximum of 5 versions,
then you must delete one of the existing versions before you can create a new one.
# Arguments
- `permission_arn`: Specifies the Amazon Resource Name (ARN) of the customer managed
permission you're creating a new version for.
- `policy_template`: A string in JSON format string that contains the following elements of
a resource-based policy: Effect: must be set to ALLOW. Action: specifies the actions
that are allowed by this customer managed permission. The list must contain only actions
that are supported by the specified resource type. For a list of all actions supported by
each resource type, see Actions, resources, and condition keys for Amazon Web Services
services in the Identity and Access Management User Guide. Condition: (optional)
specifies conditional parameters that must evaluate to true when a user attempts an action
for that action to be allowed. For more information about the Condition element, see IAM
policies: Condition element in the Identity and Access Management User Guide. This
template can't include either the Resource or Principal elements. Those are both filled in
by RAM when it instantiates the resource-based policy on each resource shared using this
managed permission. The Resource comes from the ARN of the specific resource that you are
sharing. The Principal comes from the list of identities added to the resource share.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Specifies a unique, case-sensitive identifier that you provide to ensure
the idempotency of the request. This lets you safely retry the request without accidentally
performing the same operation a second time. Passing the same value to a later call to an
operation requires that you also pass the same value for all other parameters. We recommend
that you use a UUID type of value.. If you don't provide this value, then Amazon Web
Services generates a random one for you. If you retry the operation with the same
ClientToken, but with different parameters, the retry fails with an
IdempotentParameterMismatch error.
"""
function create_permission_version(
permissionArn, policyTemplate; aws_config::AbstractAWSConfig=global_aws_config()
)
return ram(
"POST",
"/createpermissionversion",
Dict{String,Any}(
"permissionArn" => permissionArn, "policyTemplate" => policyTemplate
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_permission_version(
permissionArn,
policyTemplate,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ram(
"POST",
"/createpermissionversion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"permissionArn" => permissionArn, "policyTemplate" => policyTemplate
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_resource_share(name)
create_resource_share(name, params::Dict{String,<:Any})
Creates a resource share. You can provide a list of the Amazon Resource Names (ARNs) for
the resources that you want to share, a list of principals you want to share the resources
with, and the permissions to grant those principals. Sharing a resource makes it available
for use by principals outside of the Amazon Web Services account that created the resource.
Sharing doesn't change any permissions or quotas that apply to the resource in the account
that created it.
# Arguments
- `name`: Specifies the name of the resource share.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"allowExternalPrincipals"`: Specifies whether principals outside your organization in
Organizations can be associated with a resource share. A value of true lets you share with
individual Amazon Web Services accounts that are not in your organization. A value of false
only has meaning if your account is a member of an Amazon Web Services Organization. The
default value is true.
- `"clientToken"`: Specifies a unique, case-sensitive identifier that you provide to ensure
the idempotency of the request. This lets you safely retry the request without accidentally
performing the same operation a second time. Passing the same value to a later call to an
operation requires that you also pass the same value for all other parameters. We recommend
that you use a UUID type of value.. If you don't provide this value, then Amazon Web
Services generates a random one for you. If you retry the operation with the same
ClientToken, but with different parameters, the retry fails with an
IdempotentParameterMismatch error.
- `"permissionArns"`: Specifies the Amazon Resource Names (ARNs) of the RAM permission to
associate with the resource share. If you do not specify an ARN for the permission, RAM
automatically attaches the default version of the permission for each resource type. You
can associate only one permission with each resource type included in the resource share.
- `"principals"`: Specifies a list of one or more principals to associate with the resource
share. You can include the following values: An Amazon Web Services account ID, for
example: 123456789012 An Amazon Resource Name (ARN) of an organization in Organizations,
for example: organizations::123456789012:organization/o-exampleorgid An ARN of an
organizational unit (OU) in Organizations, for example:
organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123 An ARN of
an IAM role, for example: iam::123456789012:role/rolename An ARN of an IAM user, for
example: iam::123456789012user/username Not all resource types can be shared with IAM
roles and users. For more information, see Sharing with IAM roles and users in the Resource
Access Manager User Guide.
- `"resourceArns"`: Specifies a list of one or more ARNs of the resources to associate with
the resource share.
- `"sources"`: Specifies from which source accounts the service principal has access to the
resources in this resource share.
- `"tags"`: Specifies one or more tags to attach to the resource share itself. It doesn't
attach the tags to the resources associated with the resource share.
"""
function create_resource_share(name; aws_config::AbstractAWSConfig=global_aws_config())
return ram(
"POST",
"/createresourceshare",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_resource_share(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ram(
"POST",
"/createresourceshare",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_permission(permission_arn)
delete_permission(permission_arn, params::Dict{String,<:Any})
Deletes the specified customer managed permission in the Amazon Web Services Region in
which you call this operation. You can delete a customer managed permission only if it
isn't attached to any resource share. The operation deletes all versions associated with
the customer managed permission.
# Arguments
- `permission_arn`: Specifies the Amazon Resource Name (ARN) of the customer managed
permission that you want to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Specifies a unique, case-sensitive identifier that you provide to ensure
the idempotency of the request. This lets you safely retry the request without accidentally
performing the same operation a second time. Passing the same value to a later call to an
operation requires that you also pass the same value for all other parameters. We recommend
that you use a UUID type of value.. If you don't provide this value, then Amazon Web
Services generates a random one for you. If you retry the operation with the same
ClientToken, but with different parameters, the retry fails with an
IdempotentParameterMismatch error.
"""
function delete_permission(permissionArn; aws_config::AbstractAWSConfig=global_aws_config())
return ram(
"DELETE",
"/deletepermission",
Dict{String,Any}("permissionArn" => permissionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_permission(
permissionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ram(
"DELETE",
"/deletepermission",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("permissionArn" => permissionArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_permission_version(permission_arn, permission_version)
delete_permission_version(permission_arn, permission_version, params::Dict{String,<:Any})
Deletes one version of a customer managed permission. The version you specify must not be
attached to any resource share and must not be the default version for the permission. If a
customer managed permission has the maximum of 5 versions, then you must delete at least
one version before you can create another.
# Arguments
- `permission_arn`: Specifies the Amazon Resource Name (ARN) of the permission with the
version you want to delete.
- `permission_version`: Specifies the version number to delete. You can't delete the
default version for a customer managed permission. You can't delete a version if it's the
only version of the permission. You must either first create another version, or delete the
permission completely. You can't delete a version if it is attached to any resource shares.
If the version is the default, you must first use SetDefaultPermissionVersion to set a
different version as the default for the customer managed permission, and then use
AssociateResourceSharePermission to update your resource shares to use the new default
version.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Specifies a unique, case-sensitive identifier that you provide to ensure
the idempotency of the request. This lets you safely retry the request without accidentally
performing the same operation a second time. Passing the same value to a later call to an
operation requires that you also pass the same value for all other parameters. We recommend
that you use a UUID type of value.. If you don't provide this value, then Amazon Web
Services generates a random one for you. If you retry the operation with the same
ClientToken, but with different parameters, the retry fails with an
IdempotentParameterMismatch error.
"""
function delete_permission_version(
permissionArn, permissionVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return ram(
"DELETE",
"/deletepermissionversion",
Dict{String,Any}(
"permissionArn" => permissionArn, "permissionVersion" => permissionVersion
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_permission_version(
permissionArn,
permissionVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ram(
"DELETE",
"/deletepermissionversion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"permissionArn" => permissionArn,
"permissionVersion" => permissionVersion,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_resource_share(resource_share_arn)
delete_resource_share(resource_share_arn, params::Dict{String,<:Any})
Deletes the specified resource share. This doesn't delete any of the resources that were
associated with the resource share; it only stops the sharing of those resources through
this resource share.
# Arguments
- `resource_share_arn`: Specifies the Amazon Resource Name (ARN) of the resource share to
delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Specifies a unique, case-sensitive identifier that you provide to ensure
the idempotency of the request. This lets you safely retry the request without accidentally
performing the same operation a second time. Passing the same value to a later call to an
operation requires that you also pass the same value for all other parameters. We recommend
that you use a UUID type of value.. If you don't provide this value, then Amazon Web
Services generates a random one for you. If you retry the operation with the same
ClientToken, but with different parameters, the retry fails with an
IdempotentParameterMismatch error.
"""
function delete_resource_share(
resourceShareArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ram(
"DELETE",
"/deleteresourceshare",
Dict{String,Any}("resourceShareArn" => resourceShareArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_resource_share(
resourceShareArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ram(
"DELETE",
"/deleteresourceshare",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("resourceShareArn" => resourceShareArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_resource_share(resource_share_arn)
disassociate_resource_share(resource_share_arn, params::Dict{String,<:Any})
Removes the specified principals or resources from participating in the specified resource
share.
# Arguments
- `resource_share_arn`: Specifies Amazon Resource Name (ARN) of the resource share that you
want to remove resources or principals from.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Specifies a unique, case-sensitive identifier that you provide to ensure
the idempotency of the request. This lets you safely retry the request without accidentally
performing the same operation a second time. Passing the same value to a later call to an
operation requires that you also pass the same value for all other parameters. We recommend
that you use a UUID type of value.. If you don't provide this value, then Amazon Web
Services generates a random one for you. If you retry the operation with the same
ClientToken, but with different parameters, the retry fails with an
IdempotentParameterMismatch error.
- `"principals"`: Specifies a list of one or more principals that no longer are to have
access to the resources in this resource share. You can include the following values: An
Amazon Web Services account ID, for example: 123456789012 An Amazon Resource Name (ARN)
of an organization in Organizations, for example:
organizations::123456789012:organization/o-exampleorgid An ARN of an organizational unit
(OU) in Organizations, for example:
organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123 An ARN of
an IAM role, for example: iam::123456789012:role/rolename An ARN of an IAM user, for
example: iam::123456789012user/username Not all resource types can be shared with IAM
roles and users. For more information, see Sharing with IAM roles and users in the Resource
Access Manager User Guide.
- `"resourceArns"`: Specifies a list of Amazon Resource Names (ARNs) for one or more
resources that you want to remove from the resource share. After the operation runs, these
resources are no longer shared with principals associated with the resource share.
- `"sources"`: Specifies from which source accounts the service principal no longer has
access to the resources in this resource share.
"""
function disassociate_resource_share(
resourceShareArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ram(
"POST",
"/disassociateresourceshare",
Dict{String,Any}("resourceShareArn" => resourceShareArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_resource_share(
resourceShareArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ram(
"POST",
"/disassociateresourceshare",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("resourceShareArn" => resourceShareArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_resource_share_permission(permission_arn, resource_share_arn)
disassociate_resource_share_permission(permission_arn, resource_share_arn, params::Dict{String,<:Any})
Removes a managed permission from a resource share. Permission changes take effect
immediately. You can remove a managed permission from a resource share only if there are
currently no resources of the relevant resource type currently attached to the resource
share.
# Arguments
- `permission_arn`: The Amazon Resource Name (ARN) of the managed permission to
disassociate from the resource share. Changes to permissions take effect immediately.
- `resource_share_arn`: The Amazon Resource Name (ARN) of the resource share that you want
to remove the managed permission from.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Specifies a unique, case-sensitive identifier that you provide to ensure
the idempotency of the request. This lets you safely retry the request without accidentally
performing the same operation a second time. Passing the same value to a later call to an
operation requires that you also pass the same value for all other parameters. We recommend
that you use a UUID type of value.. If you don't provide this value, then Amazon Web
Services generates a random one for you. If you retry the operation with the same
ClientToken, but with different parameters, the retry fails with an
IdempotentParameterMismatch error.
"""
function disassociate_resource_share_permission(
permissionArn, resourceShareArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ram(
"POST",
"/disassociateresourcesharepermission",
Dict{String,Any}(
"permissionArn" => permissionArn, "resourceShareArn" => resourceShareArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_resource_share_permission(
permissionArn,
resourceShareArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ram(
"POST",
"/disassociateresourcesharepermission",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"permissionArn" => permissionArn, "resourceShareArn" => resourceShareArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_sharing_with_aws_organization()
enable_sharing_with_aws_organization(params::Dict{String,<:Any})
Enables resource sharing within your organization in Organizations. This operation creates
a service-linked role called AWSServiceRoleForResourceAccessManager that has the IAM
managed policy named AWSResourceAccessManagerServiceRolePolicy attached. This role permits
RAM to retrieve information about the organization and its structure. This lets you share
resources with all of the accounts in the calling account's organization by specifying the
organization ID, or all of the accounts in an organizational unit (OU) by specifying the OU
ID. Until you enable sharing within the organization, you can specify only individual
Amazon Web Services accounts, or for supported resource types, IAM roles and users. You
must call this operation from an IAM role or user in the organization's management account.
"""
function enable_sharing_with_aws_organization(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ram(
"POST",
"/enablesharingwithawsorganization";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_sharing_with_aws_organization(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ram(
"POST",
"/enablesharingwithawsorganization",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_permission(permission_arn)
get_permission(permission_arn, params::Dict{String,<:Any})
Retrieves the contents of a managed permission in JSON format.
# Arguments
- `permission_arn`: Specifies the Amazon Resource Name (ARN) of the permission whose
contents you want to retrieve. To find the ARN for a permission, use either the
ListPermissions operation or go to the Permissions library page in the RAM console and then
choose the name of the permission. The ARN is displayed on the detail page.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"permissionVersion"`: Specifies the version number of the RAM permission to retrieve. If
you don't specify this parameter, the operation retrieves the default version. To see the
list of available versions, use ListPermissionVersions.
"""
function get_permission(permissionArn; aws_config::AbstractAWSConfig=global_aws_config())
return ram(
"POST",
"/getpermission",
Dict{String,Any}("permissionArn" => permissionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_permission(
permissionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ram(
"POST",
"/getpermission",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("permissionArn" => permissionArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resource_policies(resource_arns)
get_resource_policies(resource_arns, params::Dict{String,<:Any})
Retrieves the resource policies for the specified resources that you own and have shared.
# Arguments
- `resource_arns`: Specifies the Amazon Resource Names (ARNs) of the resources whose
policies you want to retrieve.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Specifies the total number of results that you want included on each page
of the response. If you do not include this parameter, it defaults to a value that is
specific to the operation. If additional items exist beyond the number you specify, the
NextToken response element is returned with a value (not null). Include the specified value
as the NextToken request parameter in the next call to the operation to get the next part
of the results. Note that the service might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to
ensure that you receive all of the results.
- `"nextToken"`: Specifies that you want to receive the next page of results. Valid only if
you received a NextToken response in the previous request. If you did, it indicates that
more output is available. Set this parameter to the value provided by the previous call's
NextToken response to request the next page of results.
- `"principal"`: Specifies the principal.
"""
function get_resource_policies(
resourceArns; aws_config::AbstractAWSConfig=global_aws_config()
)
return ram(
"POST",
"/getresourcepolicies",
Dict{String,Any}("resourceArns" => resourceArns);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resource_policies(
resourceArns,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ram(
"POST",
"/getresourcepolicies",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArns" => resourceArns), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resource_share_associations(association_type)
get_resource_share_associations(association_type, params::Dict{String,<:Any})
Retrieves the lists of resources and principals that associated for resource shares that
you own.
# Arguments
- `association_type`: Specifies whether you want to retrieve the associations that involve
a specified resource or principal. PRINCIPAL – list the principals whose associations
you want to see. RESOURCE – list the resources whose associations you want to see.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"associationStatus"`: Specifies that you want to retrieve only associations that have
this status.
- `"maxResults"`: Specifies the total number of results that you want included on each page
of the response. If you do not include this parameter, it defaults to a value that is
specific to the operation. If additional items exist beyond the number you specify, the
NextToken response element is returned with a value (not null). Include the specified value
as the NextToken request parameter in the next call to the operation to get the next part
of the results. Note that the service might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to
ensure that you receive all of the results.
- `"nextToken"`: Specifies that you want to receive the next page of results. Valid only if
you received a NextToken response in the previous request. If you did, it indicates that
more output is available. Set this parameter to the value provided by the previous call's
NextToken response to request the next page of results.
- `"principal"`: Specifies the ID of the principal whose resource shares you want to
retrieve. This can be an Amazon Web Services account ID, an organization ID, an
organizational unit ID, or the Amazon Resource Name (ARN) of an individual IAM role or
user. You cannot specify this parameter if the association type is RESOURCE.
- `"resourceArn"`: Specifies the Amazon Resource Name (ARN) of a resource whose resource
shares you want to retrieve. You cannot specify this parameter if the association type is
PRINCIPAL.
- `"resourceShareArns"`: Specifies a list of Amazon Resource Names (ARNs) of the resource
share whose associations you want to retrieve.
"""
function get_resource_share_associations(
associationType; aws_config::AbstractAWSConfig=global_aws_config()
)
return ram(
"POST",
"/getresourceshareassociations",
Dict{String,Any}("associationType" => associationType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resource_share_associations(
associationType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ram(
"POST",
"/getresourceshareassociations",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("associationType" => associationType), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resource_share_invitations()
get_resource_share_invitations(params::Dict{String,<:Any})
Retrieves details about invitations that you have received for resource shares.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Specifies the total number of results that you want included on each page
of the response. If you do not include this parameter, it defaults to a value that is
specific to the operation. If additional items exist beyond the number you specify, the
NextToken response element is returned with a value (not null). Include the specified value
as the NextToken request parameter in the next call to the operation to get the next part
of the results. Note that the service might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to
ensure that you receive all of the results.
- `"nextToken"`: Specifies that you want to receive the next page of results. Valid only if
you received a NextToken response in the previous request. If you did, it indicates that
more output is available. Set this parameter to the value provided by the previous call's
NextToken response to request the next page of results.
- `"resourceShareArns"`: Specifies that you want details about invitations only for the
resource shares described by this list of Amazon Resource Names (ARNs)
- `"resourceShareInvitationArns"`: Specifies the Amazon Resource Names (ARNs) of the
resource share invitations you want information about.
"""
function get_resource_share_invitations(; aws_config::AbstractAWSConfig=global_aws_config())
return ram(
"POST",
"/getresourceshareinvitations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resource_share_invitations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ram(
"POST",
"/getresourceshareinvitations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resource_shares(resource_owner)
get_resource_shares(resource_owner, params::Dict{String,<:Any})
Retrieves details about the resource shares that you own or that are shared with you.
# Arguments
- `resource_owner`: Specifies that you want to retrieve details of only those resource
shares that match the following: SELF – resource shares that your account shares
with other accounts OTHER-ACCOUNTS – resource shares that other accounts share with
your account
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Specifies the total number of results that you want included on each page
of the response. If you do not include this parameter, it defaults to a value that is
specific to the operation. If additional items exist beyond the number you specify, the
NextToken response element is returned with a value (not null). Include the specified value
as the NextToken request parameter in the next call to the operation to get the next part
of the results. Note that the service might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to
ensure that you receive all of the results.
- `"name"`: Specifies the name of an individual resource share that you want to retrieve
details about.
- `"nextToken"`: Specifies that you want to receive the next page of results. Valid only if
you received a NextToken response in the previous request. If you did, it indicates that
more output is available. Set this parameter to the value provided by the previous call's
NextToken response to request the next page of results.
- `"permissionArn"`: Specifies that you want to retrieve details of only those resource
shares that use the managed permission with this Amazon Resource Name (ARN).
- `"permissionVersion"`: Specifies that you want to retrieve details for only those
resource shares that use the specified version of the managed permission.
- `"resourceShareArns"`: Specifies the Amazon Resource Names (ARNs) of individual resource
shares that you want information about.
- `"resourceShareStatus"`: Specifies that you want to retrieve details of only those
resource shares that have this status.
- `"tagFilters"`: Specifies that you want to retrieve details of only those resource shares
that match the specified tag keys and values.
"""
function get_resource_shares(
resourceOwner; aws_config::AbstractAWSConfig=global_aws_config()
)
return ram(
"POST",
"/getresourceshares",
Dict{String,Any}("resourceOwner" => resourceOwner);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resource_shares(
resourceOwner,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ram(
"POST",
"/getresourceshares",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceOwner" => resourceOwner), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_pending_invitation_resources(resource_share_invitation_arn)
list_pending_invitation_resources(resource_share_invitation_arn, params::Dict{String,<:Any})
Lists the resources in a resource share that is shared with you but for which the
invitation is still PENDING. That means that you haven't accepted or rejected the
invitation and the invitation hasn't expired.
# Arguments
- `resource_share_invitation_arn`: Specifies the Amazon Resource Name (ARN) of the
invitation. You can use GetResourceShareInvitations to find the ARN of the invitation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Specifies the total number of results that you want included on each page
of the response. If you do not include this parameter, it defaults to a value that is
specific to the operation. If additional items exist beyond the number you specify, the
NextToken response element is returned with a value (not null). Include the specified value
as the NextToken request parameter in the next call to the operation to get the next part
of the results. Note that the service might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to
ensure that you receive all of the results.
- `"nextToken"`: Specifies that you want to receive the next page of results. Valid only if
you received a NextToken response in the previous request. If you did, it indicates that
more output is available. Set this parameter to the value provided by the previous call's
NextToken response to request the next page of results.
- `"resourceRegionScope"`: Specifies that you want the results to include only resources
that have the specified scope. ALL – the results include both global and regional
resources or resource types. GLOBAL – the results include only global resources or
resource types. REGIONAL – the results include only regional resources or resource
types. The default value is ALL.
"""
function list_pending_invitation_resources(
resourceShareInvitationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ram(
"POST",
"/listpendinginvitationresources",
Dict{String,Any}("resourceShareInvitationArn" => resourceShareInvitationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_pending_invitation_resources(
resourceShareInvitationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ram(
"POST",
"/listpendinginvitationresources",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"resourceShareInvitationArn" => resourceShareInvitationArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_permission_associations()
list_permission_associations(params::Dict{String,<:Any})
Lists information about the managed permission and its associations to any resource shares
that use this managed permission. This lets you see which resource shares use which
versions of the specified managed permission.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"associationStatus"`: Specifies that you want to list only those associations with
resource shares that match this status.
- `"defaultVersion"`: When true, specifies that you want to list only those associations
with resource shares that use the default version of the specified managed permission. When
false (the default value), lists associations with resource shares that use any version of
the specified managed permission.
- `"featureSet"`: Specifies that you want to list only those associations with resource
shares that have a featureSet with this value.
- `"maxResults"`: Specifies the total number of results that you want included on each page
of the response. If you do not include this parameter, it defaults to a value that is
specific to the operation. If additional items exist beyond the number you specify, the
NextToken response element is returned with a value (not null). Include the specified value
as the NextToken request parameter in the next call to the operation to get the next part
of the results. Note that the service might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to
ensure that you receive all of the results.
- `"nextToken"`: Specifies that you want to receive the next page of results. Valid only if
you received a NextToken response in the previous request. If you did, it indicates that
more output is available. Set this parameter to the value provided by the previous call's
NextToken response to request the next page of results.
- `"permissionArn"`: Specifies the Amazon Resource Name (ARN) of the managed permission.
- `"permissionVersion"`: Specifies that you want to list only those associations with
resource shares that use this version of the managed permission. If you don't provide a
value for this parameter, then the operation returns information about associations with
resource shares that use any version of the managed permission.
- `"resourceType"`: Specifies that you want to list only those associations with resource
shares that include at least one resource of this resource type.
"""
function list_permission_associations(; aws_config::AbstractAWSConfig=global_aws_config())
return ram(
"POST",
"/listpermissionassociations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_permission_associations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ram(
"POST",
"/listpermissionassociations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_permission_versions(permission_arn)
list_permission_versions(permission_arn, params::Dict{String,<:Any})
Lists the available versions of the specified RAM permission.
# Arguments
- `permission_arn`: Specifies the Amazon Resource Name (ARN) of the RAM permission whose
versions you want to list. You can use the permissionVersion parameter on the
AssociateResourceSharePermission operation to specify a non-default version to attach.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Specifies the total number of results that you want included on each page
of the response. If you do not include this parameter, it defaults to a value that is
specific to the operation. If additional items exist beyond the number you specify, the
NextToken response element is returned with a value (not null). Include the specified value
as the NextToken request parameter in the next call to the operation to get the next part
of the results. Note that the service might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to
ensure that you receive all of the results.
- `"nextToken"`: Specifies that you want to receive the next page of results. Valid only if
you received a NextToken response in the previous request. If you did, it indicates that
more output is available. Set this parameter to the value provided by the previous call's
NextToken response to request the next page of results.
"""
function list_permission_versions(
permissionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ram(
"POST",
"/listpermissionversions",
Dict{String,Any}("permissionArn" => permissionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_permission_versions(
permissionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ram(
"POST",
"/listpermissionversions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("permissionArn" => permissionArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_permissions()
list_permissions(params::Dict{String,<:Any})
Retrieves a list of available RAM permissions that you can use for the supported resource
types.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Specifies the total number of results that you want included on each page
of the response. If you do not include this parameter, it defaults to a value that is
specific to the operation. If additional items exist beyond the number you specify, the
NextToken response element is returned with a value (not null). Include the specified value
as the NextToken request parameter in the next call to the operation to get the next part
of the results. Note that the service might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to
ensure that you receive all of the results.
- `"nextToken"`: Specifies that you want to receive the next page of results. Valid only if
you received a NextToken response in the previous request. If you did, it indicates that
more output is available. Set this parameter to the value provided by the previous call's
NextToken response to request the next page of results.
- `"permissionType"`: Specifies that you want to list only permissions of this type: AWS
– returns only Amazon Web Services managed permissions. LOCAL – returns only
customer managed permissions ALL – returns both Amazon Web Services managed
permissions and customer managed permissions. If you don't specify this parameter, the
default is All.
- `"resourceType"`: Specifies that you want to list only those permissions that apply to
the specified resource type. This parameter is not case sensitive. For example, to list
only permissions that apply to Amazon EC2 subnets, specify ec2:subnet. You can use the
ListResourceTypes operation to get the specific string required.
"""
function list_permissions(; aws_config::AbstractAWSConfig=global_aws_config())
return ram(
"POST", "/listpermissions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_permissions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ram(
"POST",
"/listpermissions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_principals(resource_owner)
list_principals(resource_owner, params::Dict{String,<:Any})
Lists the principals that you are sharing resources with or that are sharing resources with
you.
# Arguments
- `resource_owner`: Specifies that you want to list information for only resource shares
that match the following: SELF – principals that your account is sharing resources
with OTHER-ACCOUNTS – principals that are sharing resources with your account
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Specifies the total number of results that you want included on each page
of the response. If you do not include this parameter, it defaults to a value that is
specific to the operation. If additional items exist beyond the number you specify, the
NextToken response element is returned with a value (not null). Include the specified value
as the NextToken request parameter in the next call to the operation to get the next part
of the results. Note that the service might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to
ensure that you receive all of the results.
- `"nextToken"`: Specifies that you want to receive the next page of results. Valid only if
you received a NextToken response in the previous request. If you did, it indicates that
more output is available. Set this parameter to the value provided by the previous call's
NextToken response to request the next page of results.
- `"principals"`: Specifies that you want to list information for only the listed
principals. You can include the following values: An Amazon Web Services account ID, for
example: 123456789012 An Amazon Resource Name (ARN) of an organization in Organizations,
for example: organizations::123456789012:organization/o-exampleorgid An ARN of an
organizational unit (OU) in Organizations, for example:
organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123 An ARN of
an IAM role, for example: iam::123456789012:role/rolename An ARN of an IAM user, for
example: iam::123456789012user/username Not all resource types can be shared with IAM
roles and users. For more information, see Sharing with IAM roles and users in the Resource
Access Manager User Guide.
- `"resourceArn"`: Specifies that you want to list principal information for the resource
share with the specified Amazon Resource Name (ARN).
- `"resourceShareArns"`: Specifies that you want to list information for only principals
associated with the resource shares specified by a list the Amazon Resource Names (ARNs).
- `"resourceType"`: Specifies that you want to list information for only principals
associated with resource shares that include the specified resource type. For a list of
valid values, query the ListResourceTypes operation.
"""
function list_principals(resourceOwner; aws_config::AbstractAWSConfig=global_aws_config())
return ram(
"POST",
"/listprincipals",
Dict{String,Any}("resourceOwner" => resourceOwner);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_principals(
resourceOwner,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ram(
"POST",
"/listprincipals",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceOwner" => resourceOwner), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_replace_permission_associations_work()
list_replace_permission_associations_work(params::Dict{String,<:Any})
Retrieves the current status of the asynchronous tasks performed by RAM when you perform
the ReplacePermissionAssociationsWork operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Specifies the total number of results that you want included on each page
of the response. If you do not include this parameter, it defaults to a value that is
specific to the operation. If additional items exist beyond the number you specify, the
NextToken response element is returned with a value (not null). Include the specified value
as the NextToken request parameter in the next call to the operation to get the next part
of the results. Note that the service might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to
ensure that you receive all of the results.
- `"nextToken"`: Specifies that you want to receive the next page of results. Valid only if
you received a NextToken response in the previous request. If you did, it indicates that
more output is available. Set this parameter to the value provided by the previous call's
NextToken response to request the next page of results.
- `"status"`: Specifies that you want to see only the details about requests with a status
that matches this value.
- `"workIds"`: A list of IDs. These values come from the idfield of the
replacePermissionAssociationsWorkstructure returned by the ReplacePermissionAssociations
operation.
"""
function list_replace_permission_associations_work(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ram(
"POST",
"/listreplacepermissionassociationswork";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_replace_permission_associations_work(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ram(
"POST",
"/listreplacepermissionassociationswork",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_resource_share_permissions(resource_share_arn)
list_resource_share_permissions(resource_share_arn, params::Dict{String,<:Any})
Lists the RAM permissions that are associated with a resource share.
# Arguments
- `resource_share_arn`: Specifies the Amazon Resource Name (ARN) of the resource share for
which you want to retrieve the associated permissions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Specifies the total number of results that you want included on each page
of the response. If you do not include this parameter, it defaults to a value that is
specific to the operation. If additional items exist beyond the number you specify, the
NextToken response element is returned with a value (not null). Include the specified value
as the NextToken request parameter in the next call to the operation to get the next part
of the results. Note that the service might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to
ensure that you receive all of the results.
- `"nextToken"`: Specifies that you want to receive the next page of results. Valid only if
you received a NextToken response in the previous request. If you did, it indicates that
more output is available. Set this parameter to the value provided by the previous call's
NextToken response to request the next page of results.
"""
function list_resource_share_permissions(
resourceShareArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ram(
"POST",
"/listresourcesharepermissions",
Dict{String,Any}("resourceShareArn" => resourceShareArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_resource_share_permissions(
resourceShareArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ram(
"POST",
"/listresourcesharepermissions",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("resourceShareArn" => resourceShareArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_resource_types()
list_resource_types(params::Dict{String,<:Any})
Lists the resource types that can be shared by RAM.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Specifies the total number of results that you want included on each page
of the response. If you do not include this parameter, it defaults to a value that is
specific to the operation. If additional items exist beyond the number you specify, the
NextToken response element is returned with a value (not null). Include the specified value
as the NextToken request parameter in the next call to the operation to get the next part
of the results. Note that the service might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to
ensure that you receive all of the results.
- `"nextToken"`: Specifies that you want to receive the next page of results. Valid only if
you received a NextToken response in the previous request. If you did, it indicates that
more output is available. Set this parameter to the value provided by the previous call's
NextToken response to request the next page of results.
- `"resourceRegionScope"`: Specifies that you want the results to include only resources
that have the specified scope. ALL – the results include both global and regional
resources or resource types. GLOBAL – the results include only global resources or
resource types. REGIONAL – the results include only regional resources or resource
types. The default value is ALL.
"""
function list_resource_types(; aws_config::AbstractAWSConfig=global_aws_config())
return ram(
"POST", "/listresourcetypes"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_resource_types(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ram(
"POST",
"/listresourcetypes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_resources(resource_owner)
list_resources(resource_owner, params::Dict{String,<:Any})
Lists the resources that you added to a resource share or the resources that are shared
with you.
# Arguments
- `resource_owner`: Specifies that you want to list only the resource shares that match the
following: SELF – resources that your account shares with other accounts
OTHER-ACCOUNTS – resources that other accounts share with your account
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Specifies the total number of results that you want included on each page
of the response. If you do not include this parameter, it defaults to a value that is
specific to the operation. If additional items exist beyond the number you specify, the
NextToken response element is returned with a value (not null). Include the specified value
as the NextToken request parameter in the next call to the operation to get the next part
of the results. Note that the service might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to
ensure that you receive all of the results.
- `"nextToken"`: Specifies that you want to receive the next page of results. Valid only if
you received a NextToken response in the previous request. If you did, it indicates that
more output is available. Set this parameter to the value provided by the previous call's
NextToken response to request the next page of results.
- `"principal"`: Specifies that you want to list only the resource shares that are
associated with the specified principal.
- `"resourceArns"`: Specifies that you want to list only the resource shares that include
resources with the specified Amazon Resource Names (ARNs).
- `"resourceRegionScope"`: Specifies that you want the results to include only resources
that have the specified scope. ALL – the results include both global and regional
resources or resource types. GLOBAL – the results include only global resources or
resource types. REGIONAL – the results include only regional resources or resource
types. The default value is ALL.
- `"resourceShareArns"`: Specifies that you want to list only resources in the resource
shares identified by the specified Amazon Resource Names (ARNs).
- `"resourceType"`: Specifies that you want to list only the resource shares that include
resources of the specified resource type. For valid values, query the ListResourceTypes
operation.
"""
function list_resources(resourceOwner; aws_config::AbstractAWSConfig=global_aws_config())
return ram(
"POST",
"/listresources",
Dict{String,Any}("resourceOwner" => resourceOwner);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_resources(
resourceOwner,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ram(
"POST",
"/listresources",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceOwner" => resourceOwner), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
promote_permission_created_from_policy(name, permission_arn)
promote_permission_created_from_policy(name, permission_arn, params::Dict{String,<:Any})
When you attach a resource-based policy to a resource, RAM automatically creates a resource
share of featureSet=CREATED_FROM_POLICY with a managed permission that has the same IAM
permissions as the original resource-based policy. However, this type of managed permission
is visible to only the resource share owner, and the associated resource share can't be
modified by using RAM. This operation creates a separate, fully manageable customer managed
permission that has the same IAM permissions as the original resource-based policy. You can
associate this customer managed permission to any resource shares. Before you use
PromoteResourceShareCreatedFromPolicy, you should first run this operation to ensure that
you have an appropriate customer managed permission that can be associated with the
promoted resource share. The original CREATED_FROM_POLICY policy isn't deleted, and
resource shares using that original policy aren't automatically updated. You can't modify
a CREATED_FROM_POLICY resource share so you can't associate the new customer managed
permission by using ReplacePermsissionAssociations. However, if you use
PromoteResourceShareCreatedFromPolicy, that operation automatically associates the fully
manageable customer managed permission to the newly promoted STANDARD resource share.
After you promote a resource share, if the original CREATED_FROM_POLICY managed permission
has no other associations to A resource share, then RAM automatically deletes it.
# Arguments
- `name`: Specifies a name for the promoted customer managed permission.
- `permission_arn`: Specifies the Amazon Resource Name (ARN) of the CREATED_FROM_POLICY
permission that you want to promote. You can get this Amazon Resource Name (ARN) by calling
the ListResourceSharePermissions operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Specifies a unique, case-sensitive identifier that you provide to ensure
the idempotency of the request. This lets you safely retry the request without accidentally
performing the same operation a second time. Passing the same value to a later call to an
operation requires that you also pass the same value for all other parameters. We recommend
that you use a UUID type of value.. If you don't provide this value, then Amazon Web
Services generates a random one for you. If you retry the operation with the same
ClientToken, but with different parameters, the retry fails with an
IdempotentParameterMismatch error.
"""
function promote_permission_created_from_policy(
name, permissionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ram(
"POST",
"/promotepermissioncreatedfrompolicy",
Dict{String,Any}("name" => name, "permissionArn" => permissionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function promote_permission_created_from_policy(
name,
permissionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ram(
"POST",
"/promotepermissioncreatedfrompolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("name" => name, "permissionArn" => permissionArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
promote_resource_share_created_from_policy(resource_share_arn)
promote_resource_share_created_from_policy(resource_share_arn, params::Dict{String,<:Any})
When you attach a resource-based policy to a resource, RAM automatically creates a resource
share of featureSet=CREATED_FROM_POLICY with a managed permission that has the same IAM
permissions as the original resource-based policy. However, this type of managed permission
is visible to only the resource share owner, and the associated resource share can't be
modified by using RAM. This operation promotes the resource share to a STANDARD resource
share that is fully manageable in RAM. When you promote a resource share, you can then
manage the resource share in RAM and it becomes visible to all of the principals you shared
it with. Before you perform this operation, you should first run
PromotePermissionCreatedFromPolicyto ensure that you have an appropriate customer managed
permission that can be associated with this resource share after its is promoted. If this
operation can't find a managed permission that exactly matches the existing
CREATED_FROM_POLICY permission, then this operation fails.
# Arguments
- `resource_share_arn`: Specifies the Amazon Resource Name (ARN) of the resource share to
promote.
"""
function promote_resource_share_created_from_policy(
resourceShareArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ram(
"POST",
"/promoteresourcesharecreatedfrompolicy",
Dict{String,Any}("resourceShareArn" => resourceShareArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function promote_resource_share_created_from_policy(
resourceShareArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ram(
"POST",
"/promoteresourcesharecreatedfrompolicy",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("resourceShareArn" => resourceShareArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reject_resource_share_invitation(resource_share_invitation_arn)
reject_resource_share_invitation(resource_share_invitation_arn, params::Dict{String,<:Any})
Rejects an invitation to a resource share from another Amazon Web Services account.
# Arguments
- `resource_share_invitation_arn`: Specifies the Amazon Resource Name (ARN) of the
invitation that you want to reject.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Specifies a unique, case-sensitive identifier that you provide to ensure
the idempotency of the request. This lets you safely retry the request without accidentally
performing the same operation a second time. Passing the same value to a later call to an
operation requires that you also pass the same value for all other parameters. We recommend
that you use a UUID type of value.. If you don't provide this value, then Amazon Web
Services generates a random one for you. If you retry the operation with the same
ClientToken, but with different parameters, the retry fails with an
IdempotentParameterMismatch error.
"""
function reject_resource_share_invitation(
resourceShareInvitationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ram(
"POST",
"/rejectresourceshareinvitation",
Dict{String,Any}("resourceShareInvitationArn" => resourceShareInvitationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reject_resource_share_invitation(
resourceShareInvitationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ram(
"POST",
"/rejectresourceshareinvitation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"resourceShareInvitationArn" => resourceShareInvitationArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
replace_permission_associations(from_permission_arn, to_permission_arn)
replace_permission_associations(from_permission_arn, to_permission_arn, params::Dict{String,<:Any})
Updates all resource shares that use a managed permission to a different managed
permission. This operation always applies the default version of the target managed
permission. You can optionally specify that the update applies to only resource shares that
currently use a specified version. This enables you to update to the latest version,
without changing the which managed permission is used. You can use this operation to update
all of your resource shares to use the current default version of the permission by
specifying the same value for the fromPermissionArn and toPermissionArn parameters. You can
use the optional fromPermissionVersion parameter to update only those resources that use a
specified version of the managed permission to the new managed permission. To successfully
perform this operation, you must have permission to update the resource-based policy on all
affected resource types.
# Arguments
- `from_permission_arn`: Specifies the Amazon Resource Name (ARN) of the managed permission
that you want to replace.
- `to_permission_arn`: Specifies the ARN of the managed permission that you want to
associate with resource shares in place of the one specified by fromPerssionArn and
fromPermissionVersion. The operation always associates the version that is currently the
default for the specified managed permission.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Specifies a unique, case-sensitive identifier that you provide to ensure
the idempotency of the request. This lets you safely retry the request without accidentally
performing the same operation a second time. Passing the same value to a later call to an
operation requires that you also pass the same value for all other parameters. We recommend
that you use a UUID type of value.. If you don't provide this value, then Amazon Web
Services generates a random one for you. If you retry the operation with the same
ClientToken, but with different parameters, the retry fails with an
IdempotentParameterMismatch error.
- `"fromPermissionVersion"`: Specifies that you want to updated the permissions for only
those resource shares that use the specified version of the managed permission.
"""
function replace_permission_associations(
fromPermissionArn, toPermissionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ram(
"POST",
"/replacepermissionassociations",
Dict{String,Any}(
"fromPermissionArn" => fromPermissionArn, "toPermissionArn" => toPermissionArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function replace_permission_associations(
fromPermissionArn,
toPermissionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ram(
"POST",
"/replacepermissionassociations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"fromPermissionArn" => fromPermissionArn,
"toPermissionArn" => toPermissionArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_default_permission_version(permission_arn, permission_version)
set_default_permission_version(permission_arn, permission_version, params::Dict{String,<:Any})
Designates the specified version number as the default version for the specified customer
managed permission. New resource shares automatically use this new default permission.
Existing resource shares continue to use their original permission version, but you can use
ReplacePermissionAssociations to update them.
# Arguments
- `permission_arn`: Specifies the Amazon Resource Name (ARN) of the customer managed
permission whose default version you want to change.
- `permission_version`: Specifies the version number that you want to designate as the
default for customer managed permission. To see a list of all available version numbers,
use ListPermissionVersions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Specifies a unique, case-sensitive identifier that you provide to ensure
the idempotency of the request. This lets you safely retry the request without accidentally
performing the same operation a second time. Passing the same value to a later call to an
operation requires that you also pass the same value for all other parameters. We recommend
that you use a UUID type of value.. If you don't provide this value, then Amazon Web
Services generates a random one for you. If you retry the operation with the same
ClientToken, but with different parameters, the retry fails with an
IdempotentParameterMismatch error.
"""
function set_default_permission_version(
permissionArn, permissionVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return ram(
"POST",
"/setdefaultpermissionversion",
Dict{String,Any}(
"permissionArn" => permissionArn, "permissionVersion" => permissionVersion
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_default_permission_version(
permissionArn,
permissionVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ram(
"POST",
"/setdefaultpermissionversion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"permissionArn" => permissionArn,
"permissionVersion" => permissionVersion,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(tags)
tag_resource(tags, params::Dict{String,<:Any})
Adds the specified tag keys and values to a resource share or managed permission. If you
choose a resource share, the tags are attached to only the resource share, not to the
resources that are in the resource share. The tags on a managed permission are the same for
all versions of the managed permission.
# Arguments
- `tags`: A list of one or more tag key and value pairs. The tag key must be present and
not be an empty string. The tag value must be present but can be an empty string.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"resourceArn"`: Specifies the Amazon Resource Name (ARN) of the managed permission that
you want to add tags to. You must specify either resourceArn, or resourceShareArn, but not
both.
- `"resourceShareArn"`: Specifies the Amazon Resource Name (ARN) of the resource share that
you want to add tags to. You must specify either resourceShareArn, or resourceArn, but not
both.
"""
function tag_resource(tags; aws_config::AbstractAWSConfig=global_aws_config())
return ram(
"POST",
"/tagresource",
Dict{String,Any}("tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
tags, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ram(
"POST",
"/tagresource",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tags" => tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(tag_keys)
untag_resource(tag_keys, params::Dict{String,<:Any})
Removes the specified tag key and value pairs from the specified resource share or managed
permission.
# Arguments
- `tag_keys`: Specifies a list of one or more tag keys that you want to remove.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"resourceArn"`: Specifies the Amazon Resource Name (ARN) of the managed permission that
you want to remove tags from. You must specify either resourceArn, or resourceShareArn, but
not both.
- `"resourceShareArn"`: Specifies the Amazon Resource Name (ARN) of the resource share that
you want to remove tags from. The tags are removed from the resource share, not the
resources in the resource share. You must specify either resourceShareArn, or resourceArn,
but not both.
"""
function untag_resource(tagKeys; aws_config::AbstractAWSConfig=global_aws_config())
return ram(
"POST",
"/untagresource",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
tagKeys, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ram(
"POST",
"/untagresource",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_resource_share(resource_share_arn)
update_resource_share(resource_share_arn, params::Dict{String,<:Any})
Modifies some of the properties of the specified resource share.
# Arguments
- `resource_share_arn`: Specifies the Amazon Resource Name (ARN) of the resource share that
you want to modify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"allowExternalPrincipals"`: Specifies whether principals outside your organization in
Organizations can be associated with a resource share.
- `"clientToken"`: Specifies a unique, case-sensitive identifier that you provide to ensure
the idempotency of the request. This lets you safely retry the request without accidentally
performing the same operation a second time. Passing the same value to a later call to an
operation requires that you also pass the same value for all other parameters. We recommend
that you use a UUID type of value.. If you don't provide this value, then Amazon Web
Services generates a random one for you. If you retry the operation with the same
ClientToken, but with different parameters, the retry fails with an
IdempotentParameterMismatch error.
- `"name"`: If specified, the new name that you want to attach to the resource share.
"""
function update_resource_share(
resourceShareArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ram(
"POST",
"/updateresourceshare",
Dict{String,Any}("resourceShareArn" => resourceShareArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_resource_share(
resourceShareArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ram(
"POST",
"/updateresourceshare",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("resourceShareArn" => resourceShareArn), 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 | 13264 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: rbin
using AWS.Compat
using AWS.UUIDs
"""
create_rule(resource_type, retention_period)
create_rule(resource_type, retention_period, params::Dict{String,<:Any})
Creates a Recycle Bin retention rule. For more information, see Create Recycle Bin
retention rules in the Amazon Elastic Compute Cloud User Guide.
# Arguments
- `resource_type`: The resource type to be retained by the retention rule. Currently, only
Amazon EBS snapshots and EBS-backed AMIs are supported. To retain snapshots, specify
EBS_SNAPSHOT. To retain EBS-backed AMIs, specify EC2_IMAGE.
- `retention_period`: Information about the retention period for which the retention rule
is to retain resources.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The retention rule description.
- `"LockConfiguration"`: Information about the retention rule lock configuration.
- `"ResourceTags"`: Specifies the resource tags to use to identify resources that are to be
retained by a tag-level retention rule. For tag-level retention rules, only deleted
resources, of the specified resource type, that have one or more of the specified tag key
and value pairs are retained. If a resource is deleted, but it does not have any of the
specified tag key and value pairs, it is immediately deleted without being retained by the
retention rule. You can add the same tag key and value pair to a maximum or five retention
rules. To create a Region-level retention rule, omit this parameter. A Region-level
retention rule does not have any resource tags specified. It retains all deleted resources
of the specified resource type in the Region in which the rule is created, even if the
resources are not tagged.
- `"Tags"`: Information about the tags to assign to the retention rule.
"""
function create_rule(
ResourceType, RetentionPeriod; aws_config::AbstractAWSConfig=global_aws_config()
)
return rbin(
"POST",
"/rules",
Dict{String,Any}(
"ResourceType" => ResourceType, "RetentionPeriod" => RetentionPeriod
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_rule(
ResourceType,
RetentionPeriod,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rbin(
"POST",
"/rules",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ResourceType" => ResourceType, "RetentionPeriod" => RetentionPeriod
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_rule(identifier)
delete_rule(identifier, params::Dict{String,<:Any})
Deletes a Recycle Bin retention rule. For more information, see Delete Recycle Bin
retention rules in the Amazon Elastic Compute Cloud User Guide.
# Arguments
- `identifier`: The unique ID of the retention rule.
"""
function delete_rule(identifier; aws_config::AbstractAWSConfig=global_aws_config())
return rbin(
"DELETE",
"/rules/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_rule(
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rbin(
"DELETE",
"/rules/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_rule(identifier)
get_rule(identifier, params::Dict{String,<:Any})
Gets information about a Recycle Bin retention rule.
# Arguments
- `identifier`: The unique ID of the retention rule.
"""
function get_rule(identifier; aws_config::AbstractAWSConfig=global_aws_config())
return rbin(
"GET",
"/rules/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_rule(
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rbin(
"GET",
"/rules/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_rules(resource_type)
list_rules(resource_type, params::Dict{String,<:Any})
Lists the Recycle Bin retention rules in the Region.
# Arguments
- `resource_type`: The resource type retained by the retention rule. Only retention rules
that retain the specified resource type are listed. Currently, only Amazon EBS snapshots
and EBS-backed AMIs are supported. To list retention rules that retain snapshots, specify
EBS_SNAPSHOT. To list retention rules that retain EBS-backed AMIs, specify EC2_IMAGE.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LockState"`: The lock state of the retention rules to list. Only retention rules with
the specified lock state are returned.
- `"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.
- `"ResourceTags"`: Information about the resource tags used to identify resources that are
retained by the retention rule.
"""
function list_rules(ResourceType; aws_config::AbstractAWSConfig=global_aws_config())
return rbin(
"POST",
"/list-rules",
Dict{String,Any}("ResourceType" => ResourceType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_rules(
ResourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rbin(
"POST",
"/list-rules",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceType" => ResourceType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Lists the tags assigned to a retention rule.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the retention rule.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return rbin(
"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 rbin(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
lock_rule(lock_configuration, identifier)
lock_rule(lock_configuration, identifier, params::Dict{String,<:Any})
Locks a retention rule. A locked retention rule can't be modified or deleted.
# Arguments
- `lock_configuration`: Information about the retention rule lock configuration.
- `identifier`: The unique ID of the retention rule.
"""
function lock_rule(
LockConfiguration, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rbin(
"PATCH",
"/rules/$(identifier)/lock",
Dict{String,Any}("LockConfiguration" => LockConfiguration);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function lock_rule(
LockConfiguration,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rbin(
"PATCH",
"/rules/$(identifier)/lock",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("LockConfiguration" => LockConfiguration), 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})
Assigns tags to the specified retention rule.
# Arguments
- `tags`: Information about the tags to assign to the retention rule.
- `resource_arn`: The Amazon Resource Name (ARN) of the retention rule.
"""
function tag_resource(Tags, resourceArn; aws_config::AbstractAWSConfig=global_aws_config())
return rbin(
"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 rbin(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Tags" => Tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
unlock_rule(identifier)
unlock_rule(identifier, params::Dict{String,<:Any})
Unlocks a retention rule. After a retention rule is unlocked, it can be modified or deleted
only after the unlock delay period expires.
# Arguments
- `identifier`: The unique ID of the retention rule.
"""
function unlock_rule(identifier; aws_config::AbstractAWSConfig=global_aws_config())
return rbin(
"PATCH",
"/rules/$(identifier)/unlock";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function unlock_rule(
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rbin(
"PATCH",
"/rules/$(identifier)/unlock",
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})
Unassigns a tag from a retention rule.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the retention rule.
- `tag_keys`: The tag keys of the tags to unassign. All tags that have the specified tag
key are unassigned.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return rbin(
"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 rbin(
"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_rule(identifier)
update_rule(identifier, params::Dict{String,<:Any})
Updates an existing Recycle Bin retention rule. You can update a retention rule's
description, resource tags, and retention period at any time after creation. You can't
update a retention rule's resource type after creation. For more information, see Update
Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.
# Arguments
- `identifier`: The unique ID of the retention rule.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The retention rule description.
- `"ResourceTags"`: Specifies the resource tags to use to identify resources that are to be
retained by a tag-level retention rule. For tag-level retention rules, only deleted
resources, of the specified resource type, that have one or more of the specified tag key
and value pairs are retained. If a resource is deleted, but it does not have any of the
specified tag key and value pairs, it is immediately deleted without being retained by the
retention rule. You can add the same tag key and value pair to a maximum or five retention
rules. To create a Region-level retention rule, omit this parameter. A Region-level
retention rule does not have any resource tags specified. It retains all deleted resources
of the specified resource type in the Region in which the rule is created, even if the
resources are not tagged.
- `"ResourceType"`: This parameter is currently not supported. You can't update a
retention rule's resource type after creation.
- `"RetentionPeriod"`: Information about the retention period for which the retention rule
is to retain resources.
"""
function update_rule(identifier; aws_config::AbstractAWSConfig=global_aws_config())
return rbin(
"PATCH",
"/rules/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_rule(
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rbin(
"PATCH",
"/rules/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 602576 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: rds
using AWS.Compat
using AWS.UUIDs
"""
add_role_to_dbcluster(dbcluster_identifier, role_arn)
add_role_to_dbcluster(dbcluster_identifier, role_arn, params::Dict{String,<:Any})
Associates an Identity and Access Management (IAM) role with a DB cluster.
# Arguments
- `dbcluster_identifier`: The name of the DB cluster to associate the IAM role with.
- `role_arn`: The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora
DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FeatureName"`: The name of the feature for the DB cluster that the IAM role is to be
associated with. For information about supported feature names, see DBEngineVersion.
"""
function add_role_to_dbcluster(
DBClusterIdentifier, RoleArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"AddRoleToDBCluster",
Dict{String,Any}(
"DBClusterIdentifier" => DBClusterIdentifier, "RoleArn" => RoleArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_role_to_dbcluster(
DBClusterIdentifier,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"AddRoleToDBCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBClusterIdentifier" => DBClusterIdentifier, "RoleArn" => RoleArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_role_to_dbinstance(dbinstance_identifier, feature_name, role_arn)
add_role_to_dbinstance(dbinstance_identifier, feature_name, role_arn, params::Dict{String,<:Any})
Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB
instance. To add a role to a DB instance, the status of the DB instance must be available.
This command doesn't apply to RDS Custom.
# Arguments
- `dbinstance_identifier`: The name of the DB instance to associate the IAM role with.
- `feature_name`: The name of the feature for the DB instance that the IAM role is to be
associated with. For information about supported feature names, see DBEngineVersion.
- `role_arn`: The Amazon Resource Name (ARN) of the IAM role to associate with the DB
instance, for example arn:aws:iam::123456789012:role/AccessRole.
"""
function add_role_to_dbinstance(
DBInstanceIdentifier,
FeatureName,
RoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"AddRoleToDBInstance",
Dict{String,Any}(
"DBInstanceIdentifier" => DBInstanceIdentifier,
"FeatureName" => FeatureName,
"RoleArn" => RoleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_role_to_dbinstance(
DBInstanceIdentifier,
FeatureName,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"AddRoleToDBInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBInstanceIdentifier" => DBInstanceIdentifier,
"FeatureName" => FeatureName,
"RoleArn" => RoleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_source_identifier_to_subscription(source_identifier, subscription_name)
add_source_identifier_to_subscription(source_identifier, subscription_name, params::Dict{String,<:Any})
Adds a source identifier to an existing RDS event notification subscription.
# Arguments
- `source_identifier`: The identifier of the event source to be added. Constraints: If
the source type is a DB instance, a DBInstanceIdentifier value must be supplied. If the
source type is a DB cluster, a DBClusterIdentifier value must be supplied. If the source
type is a DB parameter group, a DBParameterGroupName value must be supplied. If the
source type is a DB security group, a DBSecurityGroupName value must be supplied. If the
source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied. If the
source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
If the source type is an RDS Proxy, a DBProxyName value must be supplied.
- `subscription_name`: The name of the RDS event notification subscription you want to add
a source identifier to.
"""
function add_source_identifier_to_subscription(
SourceIdentifier, SubscriptionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"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 rds(
"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 RDS resource. These tags can also be used with cost
allocation reporting to track cost associated with Amazon RDS resources, or used in a
Condition statement in an IAM policy for Amazon RDS. For an overview on tagging your
relational database resources, see Tagging Amazon RDS Resources or Tagging Amazon Aurora
and Amazon RDS Resources.
# Arguments
- `resource_name`: The Amazon RDS resource that the tags are added to. This value is an
Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS
Amazon Resource Name (ARN).
- `tag`: The tags to be assigned to the Amazon RDS 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 RDS resource.
"""
function add_tags_to_resource(
ResourceName, Tag; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"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 rds(
"AddTagsToResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceName" => ResourceName, "Tag" => Tag),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
apply_pending_maintenance_action(apply_action, opt_in_type, resource_identifier)
apply_pending_maintenance_action(apply_action, opt_in_type, resource_identifier, params::Dict{String,<:Any})
Applies a pending maintenance action to a resource (for example, to a DB instance).
# Arguments
- `apply_action`: The pending maintenance action to apply to this resource. Valid Values:
system-update, db-upgrade, hardware-maintenance, ca-certificate-rotation
- `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 RDS Amazon Resource Name (ARN) of the resource that the
pending maintenance action applies to. For information about creating an ARN, see
Constructing an RDS Amazon Resource Name (ARN).
"""
function apply_pending_maintenance_action(
ApplyAction,
OptInType,
ResourceIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"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 rds(
"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
"""
authorize_dbsecurity_group_ingress(dbsecurity_group_name)
authorize_dbsecurity_group_ingress(dbsecurity_group_name, params::Dict{String,<:Any})
Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or
VPC security groups can be added to the DBSecurityGroup if the application using the
database is running on EC2 or VPC instances. Second, IP ranges are available if the
application accessing your database is running on the internet. Required parameters for
this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and
either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC). You can't authorize ingress
from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance
in another. You can't authorize ingress from a VPC security group in one VPC to an Amazon
RDS DB instance in another. For an overview of CIDR ranges, go to the Wikipedia Tutorial.
EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a
VPC, we recommend that you migrate as soon as possible. For more information, see Migrate
from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is
Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in
the Amazon RDS User Guide.
# Arguments
- `dbsecurity_group_name`: The name of the DB security group to add authorization to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CIDRIP"`: The IP range to authorize.
- `"EC2SecurityGroupId"`: Id of the EC2 security group to authorize. For VPC DB security
groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either
EC2SecurityGroupName or EC2SecurityGroupId must be provided.
- `"EC2SecurityGroupName"`: Name of the EC2 security group to authorize. For VPC DB
security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId
and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
- `"EC2SecurityGroupOwnerId"`: Amazon Web Services account number of the owner of the EC2
security group specified in the EC2SecurityGroupName parameter. The Amazon Web Services
access key ID isn't an acceptable value. For VPC DB security groups, EC2SecurityGroupId
must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or
EC2SecurityGroupId must be provided.
"""
function authorize_dbsecurity_group_ingress(
DBSecurityGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"AuthorizeDBSecurityGroupIngress",
Dict{String,Any}("DBSecurityGroupName" => DBSecurityGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function authorize_dbsecurity_group_ingress(
DBSecurityGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"AuthorizeDBSecurityGroupIngress",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBSecurityGroupName" => DBSecurityGroupName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
backtrack_dbcluster(backtrack_to, dbcluster_identifier)
backtrack_dbcluster(backtrack_to, dbcluster_identifier, params::Dict{String,<:Any})
Backtracks a DB cluster to a specific time, without creating a new DB cluster. For more
information on backtracking, see Backtracking an Aurora DB Cluster in the Amazon Aurora
User Guide. This action applies only to Aurora MySQL DB clusters.
# Arguments
- `backtrack_to`: The timestamp of the time to backtrack the DB cluster to, specified in
ISO 8601 format. For more information about ISO 8601, see the ISO8601 Wikipedia page. If
the specified time isn't a consistent time for the DB cluster, Aurora automatically chooses
the nearest possible consistent time for the DB cluster. Constraints: Must contain a
valid ISO 8601 timestamp. Can't contain a timestamp set in the future. Example:
2017-07-08T18:00Z
- `dbcluster_identifier`: The DB cluster identifier of the DB cluster to be backtracked.
This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63
alphanumeric characters or hyphens. First character must be a letter. Can't end with a
hyphen or contain two consecutive hyphens. Example: my-cluster1
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Force"`: Specifies whether to force the DB cluster to backtrack when binary logging is
enabled. Otherwise, an error occurs when binary logging is enabled.
- `"UseEarliestTimeOnPointInTimeUnavailable"`: Specifies whether to backtrack the DB
cluster to the earliest possible backtrack time when BacktrackTo is set to a timestamp
earlier than the earliest backtrack time. When this parameter is disabled and BacktrackTo
is set to a timestamp earlier than the earliest backtrack time, an error occurs.
"""
function backtrack_dbcluster(
BacktrackTo, DBClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"BacktrackDBCluster",
Dict{String,Any}(
"BacktrackTo" => BacktrackTo, "DBClusterIdentifier" => DBClusterIdentifier
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function backtrack_dbcluster(
BacktrackTo,
DBClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"BacktrackDBCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"BacktrackTo" => BacktrackTo,
"DBClusterIdentifier" => DBClusterIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_export_task(export_task_identifier)
cancel_export_task(export_task_identifier, params::Dict{String,<:Any})
Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3.
Any data that has already been written to the S3 bucket isn't removed.
# Arguments
- `export_task_identifier`: The identifier of the snapshot or cluster export task to cancel.
"""
function cancel_export_task(
ExportTaskIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"CancelExportTask",
Dict{String,Any}("ExportTaskIdentifier" => ExportTaskIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_export_task(
ExportTaskIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"CancelExportTask",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ExportTaskIdentifier" => ExportTaskIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
copy_dbcluster_parameter_group(source_dbcluster_parameter_group_identifier, target_dbcluster_parameter_group_description, target_dbcluster_parameter_group_identifier)
copy_dbcluster_parameter_group(source_dbcluster_parameter_group_identifier, target_dbcluster_parameter_group_description, target_dbcluster_parameter_group_identifier, params::Dict{String,<:Any})
Copies the specified DB cluster parameter group. You can't copy a default DB cluster
parameter group. Instead, create a new custom DB cluster parameter group, which copies the
default parameters and values for the specified DB cluster parameter group family.
# Arguments
- `source_dbcluster_parameter_group_identifier`: The identifier or Amazon Resource Name
(ARN) for the source DB cluster parameter group. For information about creating an ARN, see
Constructing an ARN for Amazon RDS in the Amazon Aurora User Guide. Constraints: Must
specify a valid DB cluster parameter group.
- `target_dbcluster_parameter_group_description`: A description for the copied DB cluster
parameter group.
- `target_dbcluster_parameter_group_identifier`: The identifier for the copied DB cluster
parameter group. Constraints: Can't be null, empty, or blank Must contain from 1 to 255
letters, numbers, or hyphens First character must be a letter Can't 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"`:
"""
function copy_dbcluster_parameter_group(
SourceDBClusterParameterGroupIdentifier,
TargetDBClusterParameterGroupDescription,
TargetDBClusterParameterGroupIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"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 rds(
"CopyDBClusterParameterGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SourceDBClusterParameterGroupIdentifier" =>
SourceDBClusterParameterGroupIdentifier,
"TargetDBClusterParameterGroupDescription" =>
TargetDBClusterParameterGroupDescription,
"TargetDBClusterParameterGroupIdentifier" =>
TargetDBClusterParameterGroupIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
copy_dbcluster_snapshot(source_dbcluster_snapshot_identifier, target_dbcluster_snapshot_identifier)
copy_dbcluster_snapshot(source_dbcluster_snapshot_identifier, target_dbcluster_snapshot_identifier, params::Dict{String,<:Any})
Copies a snapshot of a DB cluster. To copy a DB cluster snapshot from a shared manual DB
cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN)
of the shared DB cluster snapshot. You can copy an encrypted DB cluster snapshot from
another Amazon Web Services Region. In that case, the Amazon Web Services Region where you
call the CopyDBClusterSnapshot operation is the destination Amazon Web Services Region for
the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot
from another Amazon Web Services Region, you must provide the following values: KmsKeyId
- The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier
for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon
Web Services Region. TargetDBClusterSnapshotIdentifier - The identifier for the new copy
of the DB cluster snapshot in the destination Amazon Web Services Region.
SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB
cluster snapshot to be copied. This identifier must be in the ARN format for the source
Amazon Web Services Region and is the same value as the SourceDBClusterSnapshotIdentifier
in the presigned URL. To cancel the copy operation once it is in progress, delete the
target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB
cluster snapshot is in \"copying\" status. For more information on copying encrypted Amazon
Aurora DB cluster snapshots from one Amazon Web Services Region to another, see Copying a
Snapshot in the Amazon Aurora User Guide. For more information on Amazon Aurora DB
clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information
on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
# Arguments
- `source_dbcluster_snapshot_identifier`: The identifier of the DB cluster snapshot to
copy. This parameter isn't case-sensitive. You can't copy an encrypted, shared DB cluster
snapshot from one Amazon Web Services Region to another. 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 DB snapshot identifier. If the
source snapshot is in a different Amazon Web Services Region than the copy, specify a valid
DB cluster snapshot ARN. For more information, go to Copying Snapshots Across Amazon Web
Services Regions in the Amazon Aurora User Guide. Example: my-cluster-snapshot1
- `target_dbcluster_snapshot_identifier`: The identifier of the new DB cluster snapshot to
create from the source DB cluster snapshot. This parameter isn't case-sensitive.
Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. First character
must be a letter. Can't 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"`: Specifies whether to copy all tags from the source DB cluster snapshot to
the target DB cluster snapshot. By default, tags are not copied.
- `"KmsKeyId"`: The Amazon Web Services KMS key identifier for an encrypted DB cluster
snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or
alias name for the Amazon Web Services KMS key. If you copy an encrypted DB cluster
snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to
encrypt the copy with a new KMS key. If you don't specify a value for KmsKeyId, then the
copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster
snapshot. If you copy an encrypted DB cluster snapshot that is shared from another Amazon
Web Services account, then you must specify a value for KmsKeyId. To copy an encrypted DB
cluster snapshot to another Amazon Web Services Region, you must set KmsKeyId to the Amazon
Web Services KMS key identifier you want to use to encrypt the copy of the DB cluster
snapshot in the destination Amazon Web Services Region. KMS keys are specific to the Amazon
Web Services Region that they are created in, and you can't use KMS keys from one Amazon
Web Services Region in another Amazon Web Services Region. If you copy an unencrypted DB
cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.
- `"PreSignedUrl"`: When you are copying a DB cluster snapshot from one Amazon Web Services
GovCloud (US) Region to another, the URL that contains a Signature Version 4 signed request
for the CopyDBClusterSnapshot API operation in the Amazon Web Services Region that contains
the source DB cluster snapshot to copy. Use the PreSignedUrl parameter when copying an
encrypted DB cluster snapshot from another Amazon Web Services Region. Don't specify
PreSignedUrl when copying an encrypted DB cluster snapshot in the same Amazon Web Services
Region. This setting applies only to Amazon Web Services GovCloud (US) Regions. It's
ignored in other Amazon Web Services Regions. The presigned URL must be a valid request for
the CopyDBClusterSnapshot API operation that can run in the source Amazon Web Services
Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request
must contain the following parameter values: KmsKeyId - The KMS key identifier for the
KMS key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web
Services Region. This is the same identifier for both the CopyDBClusterSnapshot operation
that is called in the destination Amazon Web Services Region, and the operation contained
in the presigned URL. DestinationRegion - The name of the Amazon Web Services Region
that the DB cluster snapshot is to be created in. SourceDBClusterSnapshotIdentifier -
The DB cluster snapshot identifier for the encrypted DB 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 DB cluster snapshot from the
us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier looks
like the following example:
arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115. To
learn how to generate a Signature Version 4 signed request, see Authenticating Requests:
Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4
Signing Process. 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 presigned URL that is a valid request for
the operation that can run in the source Amazon Web Services Region. If you supply a value
for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your
behalf.
- `"SourceRegion"`: The ID of the region that contains the snapshot to be copied.
- `"Tags"`:
"""
function copy_dbcluster_snapshot(
SourceDBClusterSnapshotIdentifier,
TargetDBClusterSnapshotIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"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 rds(
"CopyDBClusterSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SourceDBClusterSnapshotIdentifier" =>
SourceDBClusterSnapshotIdentifier,
"TargetDBClusterSnapshotIdentifier" =>
TargetDBClusterSnapshotIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
copy_dbparameter_group(source_dbparameter_group_identifier, target_dbparameter_group_description, target_dbparameter_group_identifier)
copy_dbparameter_group(source_dbparameter_group_identifier, target_dbparameter_group_description, target_dbparameter_group_identifier, params::Dict{String,<:Any})
Copies the specified DB parameter group. You can't copy a default DB parameter group.
Instead, create a new custom DB parameter group, which copies the default parameters and
values for the specified DB parameter group family.
# Arguments
- `source_dbparameter_group_identifier`: The identifier or ARN for the source DB parameter
group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in
the Amazon RDS User Guide. Constraints: Must specify a valid DB parameter group.
- `target_dbparameter_group_description`: A description for the copied DB parameter group.
- `target_dbparameter_group_identifier`: The identifier for the copied DB parameter group.
Constraints: Can't be null, empty, or blank Must contain from 1 to 255 letters,
numbers, or hyphens First character must be a letter Can't end with a hyphen or contain
two consecutive hyphens Example: my-db-parameter-group
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`:
"""
function copy_dbparameter_group(
SourceDBParameterGroupIdentifier,
TargetDBParameterGroupDescription,
TargetDBParameterGroupIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"CopyDBParameterGroup",
Dict{String,Any}(
"SourceDBParameterGroupIdentifier" => SourceDBParameterGroupIdentifier,
"TargetDBParameterGroupDescription" => TargetDBParameterGroupDescription,
"TargetDBParameterGroupIdentifier" => TargetDBParameterGroupIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function copy_dbparameter_group(
SourceDBParameterGroupIdentifier,
TargetDBParameterGroupDescription,
TargetDBParameterGroupIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"CopyDBParameterGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SourceDBParameterGroupIdentifier" => SourceDBParameterGroupIdentifier,
"TargetDBParameterGroupDescription" =>
TargetDBParameterGroupDescription,
"TargetDBParameterGroupIdentifier" => TargetDBParameterGroupIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
copy_dbsnapshot(source_dbsnapshot_identifier, target_dbsnapshot_identifier)
copy_dbsnapshot(source_dbsnapshot_identifier, target_dbsnapshot_identifier, params::Dict{String,<:Any})
Copies the specified DB snapshot. The source DB snapshot must be in the available state.
You can copy a snapshot from one Amazon Web Services Region to another. In that case, the
Amazon Web Services Region where you call the CopyDBSnapshot operation is the destination
Amazon Web Services Region for the DB snapshot copy. This command doesn't apply to RDS
Custom. For more information about copying snapshots, see Copying a DB Snapshot in the
Amazon RDS User Guide.
# Arguments
- `source_dbsnapshot_identifier`: The identifier for the source DB snapshot. If the source
snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot
identifier. For example, you might specify rds:mysql-instance1-snapshot-20130805. If the
source snapshot is in a different Amazon Web Services Region than the copy, specify a valid
DB snapshot ARN. For example, you might specify
arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805. If you are
copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name
(ARN) of the shared DB snapshot. If you are copying an encrypted snapshot this parameter
must be in the ARN format for the source Amazon Web Services Region. Constraints: Must
specify a valid system snapshot in the \"available\" state. Example:
rds:mydb-2012-04-02-00-01 Example:
arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805
- `target_dbsnapshot_identifier`: The identifier for the copy of the snapshot. Constraints:
Can't be null, empty, or blank Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter Can't end with a hyphen or contain two consecutive
hyphens Example: my-db-snapshot
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CopyOptionGroup"`: Specifies whether to copy the DB option group associated with the
source DB snapshot to the target Amazon Web Services account and associate with the target
DB snapshot. The associated option group can be copied only with cross-account snapshot
copy calls.
- `"CopyTags"`: Specifies whether to copy all tags from the source DB snapshot to the
target DB snapshot. By default, tags aren't copied.
- `"KmsKeyId"`: The Amazon Web Services KMS key identifier for an encrypted DB snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name
for the KMS key. If you copy an encrypted DB snapshot from your Amazon Web Services
account, you can specify a value for this parameter to encrypt the copy with a new KMS key.
If you don't specify a value for this parameter, then the copy of the DB snapshot is
encrypted with the same Amazon Web Services KMS key as the source DB snapshot. If you copy
an encrypted DB snapshot that is shared from another Amazon Web Services account, then you
must specify a value for this parameter. If you specify this parameter when you copy an
unencrypted snapshot, the copy is encrypted. If you copy an encrypted snapshot to a
different Amazon Web Services Region, then you must specify an Amazon Web Services KMS key
identifier for the destination Amazon Web Services Region. KMS keys are specific to the
Amazon Web Services Region that they are created in, and you can't use KMS keys from one
Amazon Web Services Region in another Amazon Web Services Region.
- `"OptionGroupName"`: The name of an option group to associate with the copy of the
snapshot. Specify this option if you are copying a snapshot from one Amazon Web Services
Region to another, and your DB instance uses a nondefault option group. If your source DB
instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must
specify this option when copying across Amazon Web Services Regions. For more information,
see Option group considerations in the Amazon RDS User Guide.
- `"PreSignedUrl"`: When you are copying a snapshot from one Amazon Web Services GovCloud
(US) Region to another, the URL that contains a Signature Version 4 signed request for the
CopyDBSnapshot API operation in the source Amazon Web Services Region that contains the
source DB snapshot to copy. This setting applies only to Amazon Web Services GovCloud (US)
Regions. It's ignored in other Amazon Web Services Regions. You must specify this parameter
when you copy an encrypted DB snapshot from another Amazon Web Services Region by using the
Amazon RDS API. Don't specify PreSignedUrl when you are copying an encrypted DB snapshot in
the same Amazon Web Services Region. The presigned URL must be a valid request for the
CopyDBClusterSnapshot API operation that can run in the source Amazon Web Services Region
that contains the encrypted DB cluster snapshot to copy. The presigned URL request must
contain the following parameter values: DestinationRegion - The Amazon Web Services
Region that the encrypted DB snapshot is copied to. This Amazon Web Services Region is the
same one where the CopyDBSnapshot operation is called that contains this presigned URL. For
example, if you copy an encrypted DB snapshot from the us-west-2 Amazon Web Services Region
to the us-east-1 Amazon Web Services Region, then you call the CopyDBSnapshot operation in
the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call
to the CopyDBSnapshot operation in the us-west-2 Amazon Web Services Region. For this
example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web
Services Region. KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the
copy of the DB snapshot in the destination Amazon Web Services Region. This is the same
identifier for both the CopyDBSnapshot operation that is called in the destination Amazon
Web Services Region, and the operation contained in the presigned URL.
SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted 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 DB snapshot from
the us-west-2 Amazon Web Services Region, then your SourceDBSnapshotIdentifier looks like
the following example:
arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115. To learn
how to generate a Signature Version 4 signed request, see Authenticating Requests: Using
Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing
Process. 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 presigned URL that is a valid request for the
operation that can run in the source Amazon Web Services Region. If you supply a value for
this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
- `"SourceRegion"`: The ID of the region that contains the snapshot to be copied.
- `"Tags"`:
- `"TargetCustomAvailabilityZone"`: The external custom Availability Zone (CAZ) identifier
for the target CAZ. Example: rds-caz-aiqhTgQv.
"""
function copy_dbsnapshot(
SourceDBSnapshotIdentifier,
TargetDBSnapshotIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"CopyDBSnapshot",
Dict{String,Any}(
"SourceDBSnapshotIdentifier" => SourceDBSnapshotIdentifier,
"TargetDBSnapshotIdentifier" => TargetDBSnapshotIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function copy_dbsnapshot(
SourceDBSnapshotIdentifier,
TargetDBSnapshotIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"CopyDBSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SourceDBSnapshotIdentifier" => SourceDBSnapshotIdentifier,
"TargetDBSnapshotIdentifier" => TargetDBSnapshotIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
copy_option_group(source_option_group_identifier, target_option_group_description, target_option_group_identifier)
copy_option_group(source_option_group_identifier, target_option_group_description, target_option_group_identifier, params::Dict{String,<:Any})
Copies the specified option group.
# Arguments
- `source_option_group_identifier`: The identifier for the source option group.
Constraints: Must specify a valid option group.
- `target_option_group_description`: The description for the copied option group.
- `target_option_group_identifier`: The identifier for the copied option group.
Constraints: Can't be null, empty, or blank Must contain from 1 to 255 letters,
numbers, or hyphens First character must be a letter Can't end with a hyphen or contain
two consecutive hyphens Example: my-option-group
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`:
"""
function copy_option_group(
SourceOptionGroupIdentifier,
TargetOptionGroupDescription,
TargetOptionGroupIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"CopyOptionGroup",
Dict{String,Any}(
"SourceOptionGroupIdentifier" => SourceOptionGroupIdentifier,
"TargetOptionGroupDescription" => TargetOptionGroupDescription,
"TargetOptionGroupIdentifier" => TargetOptionGroupIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function copy_option_group(
SourceOptionGroupIdentifier,
TargetOptionGroupDescription,
TargetOptionGroupIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"CopyOptionGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SourceOptionGroupIdentifier" => SourceOptionGroupIdentifier,
"TargetOptionGroupDescription" => TargetOptionGroupDescription,
"TargetOptionGroupIdentifier" => TargetOptionGroupIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_blue_green_deployment(blue_green_deployment_name, source)
create_blue_green_deployment(blue_green_deployment_name, source, params::Dict{String,<:Any})
Creates a blue/green deployment. A blue/green deployment creates a staging environment that
copies the production environment. In a blue/green deployment, the blue environment is the
current production environment. The green environment is the staging environment. The
staging environment stays in sync with the current production environment using logical
replication. You can make changes to the databases in the green environment without
affecting production workloads. For example, you can upgrade the major or minor DB engine
version, change database parameters, or make schema changes in the staging environment. You
can thoroughly test changes in the green environment. When ready, you can switch over the
environments to promote the green environment to be the new production environment. The
switchover typically takes under a minute. For more information, see Using Amazon RDS
Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon
RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
# Arguments
- `blue_green_deployment_name`: The name of the blue/green deployment. Constraints: Can't
be the same as an existing blue/green deployment name in the same account and Amazon Web
Services Region.
- `source`: The Amazon Resource Name (ARN) of the source production database. Specify the
database that you want to clone. The blue/green deployment creates this database in the
green environment. You can make updates to the database in the green environment, such as
an engine version upgrade. When you are ready, you can switch the database in the green
environment to be the production database.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: Tags to assign to the blue/green deployment.
- `"TargetDBClusterParameterGroupName"`: The DB cluster parameter group associated with the
Aurora DB cluster in the green environment. To test parameter changes, specify a DB cluster
parameter group that is different from the one associated with the source DB cluster.
- `"TargetDBInstanceClass"`: Specify the DB instance class for the databases in the green
environment. This parameter only applies to RDS DB instances, because DB instances within
an Aurora DB cluster can have multiple different instance classes. If you're creating a
blue/green deployment from an Aurora DB cluster, don't specify this parameter. After the
green environment is created, you can individually modify the instance classes of the DB
instances within the green DB cluster.
- `"TargetDBParameterGroupName"`: The DB parameter group associated with the DB instance in
the green environment. To test parameter changes, specify a DB parameter group that is
different from the one associated with the source DB instance.
- `"TargetEngineVersion"`: The engine version of the database in the green environment.
Specify the engine version to upgrade to in the green environment.
- `"UpgradeTargetStorageConfig"`: Whether to upgrade the storage file system configuration
on the green database. This option migrates the green DB instance from the older 32-bit
file system to the preferred configuration. For more information, see Upgrading the storage
file system for a DB instance.
"""
function create_blue_green_deployment(
BlueGreenDeploymentName, Source; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"CreateBlueGreenDeployment",
Dict{String,Any}(
"BlueGreenDeploymentName" => BlueGreenDeploymentName, "Source" => Source
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_blue_green_deployment(
BlueGreenDeploymentName,
Source,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"CreateBlueGreenDeployment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"BlueGreenDeploymentName" => BlueGreenDeploymentName, "Source" => Source
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_custom_dbengine_version(engine, engine_version)
create_custom_dbengine_version(engine, engine_version, params::Dict{String,<:Any})
Creates a custom DB engine version (CEV).
# Arguments
- `engine`: The database engine. RDS Custom for Oracle supports the following values:
custom-oracle-ee custom-oracle-ee-cdb custom-oracle-se2 custom-oracle-se2-cdb
- `engine_version`: The name of your CEV. The name format is 19.customized_string. For
example, a valid CEV name is 19.my_cev1. This setting is required for RDS Custom for
Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique
per customer per Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DatabaseInstallationFilesS3BucketName"`: The name of an Amazon S3 bucket that contains
database installation files for your CEV. For example, a valid bucket name is
my-custom-installation-files.
- `"DatabaseInstallationFilesS3Prefix"`: The Amazon S3 directory that contains the database
installation files for your CEV. For example, a valid bucket name is 123456789012/cev1. If
this setting isn't specified, no prefix is assumed.
- `"Description"`: An optional description of your CEV.
- `"ImageId"`: The ID of the Amazon Machine Image (AMI). For RDS Custom for SQL Server, an
AMI ID is required to create a CEV. For RDS Custom for Oracle, the default is the most
recent AMI available, but you can specify an AMI ID that was used in a different Oracle
CEV. Find the AMIs used by your CEVs by calling the DescribeDBEngineVersions operation.
- `"KMSKeyId"`: The Amazon Web Services KMS key identifier for an encrypted CEV. A
symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS. If
you have an existing symmetric encryption KMS key in your account, you can use it with RDS
Custom. No further action is necessary. If you don't already have a symmetric encryption
KMS key in your account, follow the instructions in Creating a symmetric encryption KMS
key in the Amazon Web Services Key Management Service Developer Guide. You can choose the
same symmetric encryption key when you create a CEV and a DB instance, or choose different
keys.
- `"Manifest"`: The CEV manifest, which is a JSON document that describes the installation
.zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string.
RDS Custom applies the patches in the order in which they are listed. The following JSON
fields are valid: MediaImportTemplateVersion Version of the CEV manifest. The date is in
the format YYYY-MM-DD. databaseInstallationFileNames Ordered list of installation files
for the CEV. opatchFileNames Ordered list of OPatch installers used for the Oracle DB
engine. psuRuPatchFileNames The PSU and RU patches for this CEV. OtherPatchFileNames
The patches that are not in the list of PSU and RU patches. Amazon RDS applies these
patches after applying the PSU and RU patches. For more information, see Creating the
CEV manifest in the Amazon RDS User Guide.
- `"SourceCustomDbEngineVersionIdentifier"`: The ARN of a CEV to use as a source for
creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using
either Source or UseAwsProvidedLatestImage. You can't specify a different JSON manifest
when you specify SourceCustomDbEngineVersionIdentifier.
- `"Tags"`:
- `"UseAwsProvidedLatestImage"`: Specifies whether to use the latest service-provided
Amazon Machine Image (AMI) for the CEV. If you specify UseAwsProvidedLatestImage, you can't
also specify ImageId.
"""
function create_custom_dbengine_version(
Engine, EngineVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"CreateCustomDBEngineVersion",
Dict{String,Any}("Engine" => Engine, "EngineVersion" => EngineVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_custom_dbengine_version(
Engine,
EngineVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"CreateCustomDBEngineVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Engine" => Engine, "EngineVersion" => EngineVersion),
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 Aurora DB cluster or Multi-AZ DB cluster. If you create an Aurora DB
cluster, the request creates an empty cluster. You must explicitly create the writer
instance for your DB cluster using the CreateDBInstance operation. If you create a Multi-AZ
DB cluster, the request creates a writer and two reader DB instances for you, each in a
different Availability Zone. You can use the ReplicationSourceIdentifier parameter to
create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS
for MySQL or PostgreSQL DB instance. For more information about Amazon Aurora, see What is
Amazon Aurora? in the Amazon Aurora User Guide. You can also use the
ReplicationSourceIdentifier parameter to create a Multi-AZ DB cluster read replica with an
RDS for MySQL or PostgreSQL DB instance as the source. For more information about Multi-AZ
DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
# Arguments
- `dbcluster_identifier`: The identifier for this DB cluster. This parameter is stored as a
lowercase string. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints: Must contain from 1 to 63 (for Aurora DB clusters) or 1 to 52 (for Multi-AZ
DB clusters) letters, numbers, or hyphens. First character must be a letter. Can't end
with a hyphen or contain two consecutive hyphens. Example: my-cluster1
- `engine`: The database engine to use for this DB cluster. Valid for Cluster Type: Aurora
DB clusters and Multi-AZ DB clusters Valid Values: aurora-mysql aurora-postgresql
mysql postgres neptune - For information about using Amazon Neptune, see the
Amazon Neptune User Guide .
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllocatedStorage"`: The amount of storage in gibibytes (GiB) to allocate to each DB
instance in the Multi-AZ DB cluster. Valid for Cluster Type: Multi-AZ DB clusters only This
setting is required to create a Multi-AZ DB cluster.
- `"AutoMinorVersionUpgrade"`: Specifies whether minor engine upgrades are applied
automatically to the DB cluster during the maintenance window. By default, minor engine
upgrades are applied automatically. Valid for Cluster Type: Multi-AZ DB clusters only
- `"AvailabilityZones"`: A list of Availability Zones (AZs) where you specifically want to
create DB instances in the DB cluster. For information on AZs, see Availability Zones in
the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only Constraints:
Can't specify more than three AZs.
- `"BacktrackWindow"`: The target backtrack window, in seconds. To disable backtracking,
set this value to 0. Valid for Cluster Type: Aurora MySQL DB clusters only Default: 0
Constraints: If specified, this value must be set to a number from 0 to 259,200 (72
hours).
- `"BackupRetentionPeriod"`: The number of days for which automated backups are retained.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Default: 1
Constraints: Must be a value from 1 to 35.
- `"CACertificateIdentifier"`: The CA certificate identifier to use for the DB cluster's
server certificate. For more information, see Using SSL/TLS to encrypt a connection to a DB
instance in the Amazon RDS User Guide. Valid for Cluster Type: Multi-AZ DB clusters
- `"CharacterSetName"`: The name of the character set (CharacterSet) to associate the DB
cluster with. Valid for Cluster Type: Aurora DB clusters only
- `"CopyTagsToSnapshot"`: Specifies whether to copy all tags from the DB cluster to
snapshots of the DB cluster. The default is not to copy them. Valid for Cluster Type:
Aurora DB clusters and Multi-AZ DB clusters
- `"DBClusterInstanceClass"`: The compute and memory capacity of each DB instance in the
Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available
in all Amazon Web Services Regions, or for all database engines. For the full list of DB
instance classes and availability for your engine, see DB instance class in the Amazon RDS
User Guide. This setting is required to create a Multi-AZ DB cluster. Valid for Cluster
Type: Multi-AZ DB clusters only
- `"DBClusterParameterGroupName"`: The name of the DB cluster parameter group to associate
with this DB cluster. If you don't specify a value, then the default DB cluster parameter
group for the specified DB engine and version is used. Valid for Cluster Type: Aurora DB
clusters and Multi-AZ DB clusters Constraints: If supplied, must match the name of an
existing DB cluster parameter group.
- `"DBSubnetGroupName"`: A DB subnet group to associate with this DB cluster. This setting
is required to create a Multi-AZ DB cluster. Valid for Cluster Type: Aurora DB clusters and
Multi-AZ DB clusters Constraints: Must match the name of an existing DB subnet group.
Must not be default. Example: mydbsubnetgroup
- `"DBSystemId"`: Reserved for future use.
- `"DatabaseName"`: The name for your database of up to 64 alphanumeric characters. A
database named postgres is always created. If this parameter is specified, an additional
database with this name is created. Valid for Cluster Type: Aurora DB clusters and Multi-AZ
DB clusters
- `"DeletionProtection"`: Specifies whether the DB cluster has deletion protection enabled.
The database can't be deleted when deletion protection is enabled. By default, deletion
protection isn't enabled. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB
clusters
- `"Domain"`: The Active Directory directory ID to create the DB cluster in. For Amazon
Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that
connect to the DB cluster. For more information, see Kerberos authentication in the Amazon
Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only
- `"DomainIAMRoleName"`: The name of the IAM role to use when making API calls to the
Directory Service. Valid for Cluster Type: Aurora DB clusters only
- `"EnableCloudwatchLogsExports"`: The list of log types that need to be enabled for
exporting to CloudWatch Logs. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB
clusters The following values are valid for each DB engine: Aurora MySQL - audit | error
| general | slowquery Aurora PostgreSQL - postgresql RDS for MySQL - error | general
| slowquery RDS for PostgreSQL - postgresql | upgrade For more information about
exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch
Logs in the Amazon RDS User Guide. For more information about exporting CloudWatch Logs for
Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora
User Guide.
- `"EnableGlobalWriteForwarding"`: Specifies whether to enable this DB cluster to forward
write operations to the primary cluster of a global cluster (Aurora global database). By
default, write operations are not allowed on Aurora DB clusters that are secondary clusters
in an Aurora global database. You can set this value only on Aurora DB clusters that are
members of an Aurora global database. With this parameter enabled, a secondary cluster can
forward writes to the current primary cluster, and the resulting changes are replicated
back to this cluster. For the primary DB cluster of an Aurora global database, this value
is used immediately if the primary is demoted by a global cluster API operation, but it
does nothing until then. Valid for Cluster Type: Aurora DB clusters only
- `"EnableHttpEndpoint"`: Specifies whether to enable the HTTP endpoint for the DB cluster.
By default, the HTTP endpoint isn't enabled. When enabled, the HTTP endpoint provides a
connectionless web service API (RDS Data API) for running SQL queries on the DB cluster.
You can also query your database from inside the RDS console with the RDS query editor. RDS
Data API is supported with the following DB clusters: Aurora PostgreSQL Serverless v2 and
provisioned Aurora PostgreSQL and Aurora MySQL Serverless v1 For more information, see
Using RDS Data API in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB
clusters only
- `"EnableIAMDatabaseAuthentication"`: Specifies whether to enable mapping of Amazon Web
Services Identity and Access Management (IAM) accounts to database accounts. By default,
mapping isn't enabled. For more information, see IAM Database Authentication in the Amazon
Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only
- `"EnableLimitlessDatabase"`: Specifies whether to enable Aurora Limitless Database. You
must enable Aurora Limitless Database to create a DB shard group. Valid for: Aurora DB
clusters only
- `"EnableLocalWriteForwarding"`: Specifies whether read replicas can forward write
operations to the writer DB instance in the DB cluster. By default, write operations aren't
allowed on reader DB instances. Valid for: Aurora DB clusters only
- `"EnablePerformanceInsights"`: Specifies whether to turn on Performance Insights for the
DB cluster. For more information, see Using Amazon Performance Insights in the Amazon RDS
User Guide. Valid for Cluster Type: Multi-AZ DB clusters only
- `"EngineLifecycleSupport"`: The life cycle type for this DB cluster. By default, this
value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon
RDS Extended Support. At the end of standard support, you can avoid charges for Extended
Support by setting the value to open-source-rds-extended-support-disabled. In this case,
creating the DB cluster will fail if the DB major version is past its end of standard
support date. You can use this setting to enroll your DB cluster into Amazon RDS Extended
Support. With RDS Extended Support, you can run the selected major engine version on your
DB cluster past the end of standard support for that engine version. For more information,
see the following sections: Amazon Aurora (PostgreSQL only) - Using Amazon RDS Extended
Support in the Amazon Aurora User Guide Amazon RDS - Using Amazon RDS Extended Support
in the Amazon RDS User Guide Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB
clusters Valid Values: open-source-rds-extended-support |
open-source-rds-extended-support-disabled Default: open-source-rds-extended-support
- `"EngineMode"`: The DB engine mode of the DB cluster, either provisioned or serverless.
The serverless engine mode only applies for Aurora Serverless v1 DB clusters. Aurora
Serverless v2 DB clusters use the provisioned engine mode. For information about
limitations and requirements for Serverless DB clusters, see the following sections in the
Amazon Aurora User Guide: Limitations of Aurora Serverless v1 Requirements for
Aurora Serverless v2 Valid for Cluster Type: Aurora DB clusters only
- `"EngineVersion"`: The version number of the database engine to use. To list all of the
available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (MySQL
8.0-compatible), use the following command: aws rds describe-db-engine-versions --engine
aurora-mysql --query \"DBEngineVersions[].EngineVersion\" You can supply either 5.7 or 8.0
to use the default engine version for Aurora MySQL version 2 or version 3, respectively. To
list all of the available engine versions for Aurora PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query
\"DBEngineVersions[].EngineVersion\" To list all of the available engine versions for RDS
for MySQL, use the following command: aws rds describe-db-engine-versions --engine mysql
--query \"DBEngineVersions[].EngineVersion\" To list all of the available engine versions
for RDS for PostgreSQL, use the following command: aws rds describe-db-engine-versions
--engine postgres --query \"DBEngineVersions[].EngineVersion\" For information about a
specific engine, see the following topics: Aurora MySQL - see Database engine updates for
Amazon Aurora MySQL in the Amazon Aurora User Guide. Aurora PostgreSQL - see Amazon
Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide. RDS for
MySQL - see Amazon RDS for MySQL in the Amazon RDS User Guide. RDS for PostgreSQL - see
Amazon RDS for PostgreSQL in the Amazon RDS User Guide. Valid for Cluster Type: Aurora DB
clusters and Multi-AZ DB clusters
- `"GlobalClusterIdentifier"`: The global cluster ID of an Aurora cluster that becomes the
primary cluster in the new global database cluster. Valid for Cluster Type: Aurora DB
clusters only
- `"Iops"`: The amount of Provisioned IOPS (input/output operations per second) to be
initially allocated for each DB instance in the Multi-AZ DB cluster. For information about
valid IOPS values, see Provisioned IOPS storage in the Amazon RDS User Guide. This setting
is required to create a Multi-AZ DB cluster. Valid for Cluster Type: Multi-AZ DB clusters
only Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB
cluster.
- `"KmsKeyId"`: The Amazon Web Services KMS key identifier for an encrypted DB cluster. The
Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for
the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key
ARN or alias ARN. When a KMS key isn't specified in KmsKeyId: If
ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS uses the KMS
key used to encrypt the source. Otherwise, Amazon RDS uses your default KMS key. If the
StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn't specified, then
Amazon RDS 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. If you create a read replica of an encrypted DB cluster in
another Amazon Web Services Region, make sure to set KmsKeyId to a KMS key identifier that
is valid in the destination Amazon Web Services Region. This KMS key is used to encrypt the
read replica in that Amazon Web Services Region. Valid for Cluster Type: Aurora DB clusters
and Multi-AZ DB clusters
- `"ManageMasterUserPassword"`: Specifies whether to manage the master user password with
Amazon Web Services Secrets Manager. For more information, see Password management with
Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management
with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide. Valid for
Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Constraints: Can't manage the
master user password with Amazon Web Services Secrets Manager if MasterUserPassword is
specified.
- `"MasterUserPassword"`: The password for the master database user. Valid for Cluster
Type: Aurora DB clusters and Multi-AZ DB clusters Constraints: Must contain from 8 to 41
characters. Can contain any printable ASCII character except \"/\", \"\"\", or \"@\".
Can't be specified if ManageMasterUserPassword is turned on.
- `"MasterUserSecretKmsKeyId"`: The Amazon Web Services KMS key identifier to encrypt a
secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web
Services Secrets Manager for the DB cluster. The Amazon Web Services KMS key identifier is
the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a
different Amazon Web Services account, specify the key ARN or alias ARN. If you don't
specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt
the secret. If the secret is in a different Amazon Web Services account, then you can't use
the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed
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. Valid
for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
- `"MasterUsername"`: The name of the master user for the DB cluster. Valid for Cluster
Type: Aurora DB clusters and Multi-AZ DB clusters Constraints: Must be 1 to 16 letters or
numbers. First character must be a letter. Can't be a reserved word for the chosen
database engine.
- `"MonitoringInterval"`: The interval, in seconds, between points when Enhanced Monitoring
metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring
metrics, specify 0. If MonitoringRoleArn is specified, also set MonitoringInterval to a
value other than 0. Valid for Cluster Type: Multi-AZ DB clusters only Valid Values: 0 | 1 |
5 | 10 | 15 | 30 | 60 Default: 0
- `"MonitoringRoleArn"`: The Amazon Resource Name (ARN) for the IAM role that permits RDS
to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is
arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see
Setting up and enabling Enhanced Monitoring in the Amazon RDS User Guide. If
MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value. Valid
for Cluster Type: Multi-AZ DB clusters only
- `"NetworkType"`: The network type of the DB cluster. The network type is determined by
the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4
protocol or the IPv4 and the IPv6 protocols (DUAL). For more information, see Working with
a DB instance in a VPC in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB
clusters only Valid Values: IPV4 | DUAL
- `"OptionGroupName"`: The option group to associate the DB cluster with. DB clusters are
associated with a default option group that can't be modified.
- `"PerformanceInsightsKMSKeyId"`: The Amazon Web Services KMS key identifier for
encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the
key ARN, key ID, alias ARN, or alias name for the KMS key. If you don't specify a value for
PerformanceInsightsKMSKeyId, then Amazon RDS 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. Valid for Cluster Type:
Multi-AZ DB clusters only
- `"PerformanceInsightsRetentionPeriod"`: The number of days to retain Performance Insights
data. Valid for Cluster Type: Multi-AZ DB clusters only Valid Values: 7 month * 31,
where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months *
31), 589 (19 months * 31) 731 Default: 7 days If you specify a retention period that
isn't valid, such as 94, Amazon RDS issues an error.
- `"Port"`: The port number on which the instances in the DB cluster accept connections.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values:
1150-65535 Default: RDS for MySQL and Aurora MySQL - 3306 RDS for PostgreSQL and
Aurora PostgreSQL - 5432
- `"PreSignedUrl"`: When you are replicating a DB cluster from one Amazon Web Services
GovCloud (US) Region to another, an URL that contains a Signature Version 4 signed request
for the CreateDBCluster operation to be called in the source Amazon Web Services Region
where the DB cluster is replicated from. Specify PreSignedUrl only when you are performing
cross-Region replication from an encrypted DB cluster. The presigned URL must be a valid
request for the CreateDBCluster API operation that can run in the source Amazon Web
Services Region that contains the encrypted DB cluster to copy. The presigned URL request
must contain the following parameter values: KmsKeyId - The KMS key identifier for the
KMS key to use to encrypt the copy of the DB cluster in the destination Amazon Web Services
Region. This should refer to the same KMS key for both the CreateDBCluster operation that
is called in the destination Amazon Web Services Region, and the operation contained in the
presigned URL. DestinationRegion - The name of the Amazon Web Services Region that
Aurora read replica will be created in. ReplicationSourceIdentifier - The DB cluster
identifier for the encrypted DB cluster 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 DB cluster from the us-west-2 Amazon Web Services Region, then
your ReplicationSourceIdentifier would look like Example:
arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1. To learn how to generate a
Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters
(Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process. 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 presigned URL that is a valid request for the operation that
can run in the source Amazon Web Services Region. Valid for Cluster Type: Aurora DB
clusters onlyIf you supply a value for this operation's SourceRegion parameter, a
pre-signed URL will be calculated on your behalf.
- `"PreferredBackupWindow"`: The daily time range during which automated backups are
created if automated backups are enabled using the BackupRetentionPeriod parameter. Valid
for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters The default is a 30-minute
window selected at random from an 8-hour block of time for each Amazon Web Services Region.
To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal Coordinated
Time (UTC). Must not conflict with the preferred maintenance window. Must be at least
30 minutes.
- `"PreferredMaintenanceWindow"`: The weekly time range during which system maintenance can
occur. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters 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. To see the time blocks available,
see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
Constraints: Must be in the format ddd:hh24:mi-ddd:hh24:mi. Days must be one of Mon |
Tue | Wed | Thu | Fri | Sat | Sun. Must be in Universal Coordinated Time (UTC). Must be
at least 30 minutes.
- `"PubliclyAccessible"`: Specifies whether the DB cluster is publicly accessible. When the
DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the
private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to
the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is
ultimately controlled by the security group it uses. That public access isn't permitted if
the security group assigned to the DB cluster doesn't permit it. When the DB cluster isn't
publicly accessible, it is an internal DB cluster with a DNS name that resolves to a
private IP address. Valid for Cluster Type: Multi-AZ DB clusters only Default: The default
behavior varies depending on whether DBSubnetGroupName is specified. If DBSubnetGroupName
isn't specified, and PubliclyAccessible isn't specified, the following applies: If the
default VPC in the target Region doesn’t have an internet gateway attached to it, the DB
cluster is private. If the default VPC in the target Region has an internet gateway
attached to it, the DB cluster is public. If DBSubnetGroupName is specified, and
PubliclyAccessible isn't specified, the following applies: If the subnets are part of a
VPC that doesn’t have an internet gateway attached to it, the DB cluster is private. If
the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster
is public.
- `"RdsCustomClusterConfiguration"`: Reserved for future use.
- `"ReplicationSourceIdentifier"`: The Amazon Resource Name (ARN) of the source DB instance
or DB cluster if this DB cluster is created as a read replica. Valid for Cluster Type:
Aurora DB clusters and Multi-AZ DB clusters
- `"ScalingConfiguration"`: For DB clusters in serverless DB engine mode, the scaling
properties of the DB cluster. Valid for Cluster Type: Aurora DB clusters only
- `"ServerlessV2ScalingConfiguration"`:
- `"SourceRegion"`: The ID of the region that contains the source for the read replica.
- `"StorageEncrypted"`: Specifies whether the DB cluster is encrypted. Valid for Cluster
Type: Aurora DB clusters and Multi-AZ DB clusters
- `"StorageType"`: The storage type to associate with the DB cluster. For information on
storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB
clusters. For information on storage types for Multi-AZ DB clusters, see Settings for
creating Multi-AZ DB clusters. This setting is required to create a Multi-AZ DB cluster.
When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required. Valid
for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: Aurora DB
clusters - aurora | aurora-iopt1 Multi-AZ DB clusters - io1 | io2 | gp3 Default:
Aurora DB clusters - aurora Multi-AZ DB clusters - io1 When you create an Aurora DB
cluster with the storage type set to aurora-iopt1, the storage type is returned in the
response. The storage type isn't returned when you set it to aurora.
- `"Tags"`: Tags to assign to the DB cluster. Valid for Cluster Type: Aurora DB clusters
and Multi-AZ DB clusters
- `"VpcSecurityGroupIds"`: A list of EC2 VPC security groups to associate with this DB
cluster. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
"""
function create_dbcluster(
DBClusterIdentifier, Engine; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"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 rds(
"CreateDBCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBClusterIdentifier" => DBClusterIdentifier, "Engine" => Engine
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dbcluster_endpoint(dbcluster_endpoint_identifier, dbcluster_identifier, endpoint_type)
create_dbcluster_endpoint(dbcluster_endpoint_identifier, dbcluster_identifier, endpoint_type, params::Dict{String,<:Any})
Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster. This
action applies only to Aurora DB clusters.
# Arguments
- `dbcluster_endpoint_identifier`: The identifier to use for the new endpoint. This
parameter is stored as a lowercase string.
- `dbcluster_identifier`: The DB cluster identifier of the DB cluster associated with the
endpoint. This parameter is stored as a lowercase string.
- `endpoint_type`: The type of the endpoint, one of: READER, WRITER, ANY.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExcludedMembers"`: List of DB instance identifiers that aren't part of the custom
endpoint group. All other eligible instances are reachable through the custom endpoint.
This parameter is relevant only if the list of static members is empty.
- `"StaticMembers"`: List of DB instance identifiers that are part of the custom endpoint
group.
- `"Tags"`: The tags to be assigned to the Amazon RDS resource.
"""
function create_dbcluster_endpoint(
DBClusterEndpointIdentifier,
DBClusterIdentifier,
EndpointType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"CreateDBClusterEndpoint",
Dict{String,Any}(
"DBClusterEndpointIdentifier" => DBClusterEndpointIdentifier,
"DBClusterIdentifier" => DBClusterIdentifier,
"EndpointType" => EndpointType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dbcluster_endpoint(
DBClusterEndpointIdentifier,
DBClusterIdentifier,
EndpointType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"CreateDBClusterEndpoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBClusterEndpointIdentifier" => DBClusterEndpointIdentifier,
"DBClusterIdentifier" => DBClusterIdentifier,
"EndpointType" => EndpointType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dbcluster_parameter_group(dbcluster_parameter_group_name, dbparameter_group_family, description)
create_dbcluster_parameter_group(dbcluster_parameter_group_name, dbparameter_group_family, description, params::Dict{String,<:Any})
Creates a new DB cluster parameter group. Parameters in a DB cluster parameter group apply
to all of the instances in a DB cluster. A DB cluster parameter group is initially created
with the default parameters for the database engine used by instances in the DB cluster. To
provide custom values for any of the parameters, you must modify the group after creating
it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group,
you need to associate it with your DB cluster using ModifyDBCluster. When you associate a
new DB cluster parameter group with a running Aurora DB cluster, reboot the DB instances in
the DB cluster without failover for the new DB cluster parameter group and associated
settings to take effect. When you associate a new DB cluster parameter group with a running
Multi-AZ DB cluster, reboot the DB cluster without failover for the new DB cluster
parameter group and associated settings to take effect. After you create a DB cluster
parameter group, you should wait at least 5 minutes before creating your first DB cluster
that uses that DB cluster parameter group as the default parameter group. This allows
Amazon RDS to fully complete the create action before the DB cluster parameter group is
used as the default for a new DB cluster. This is especially important for parameters that
are critical when creating the default database for a DB cluster, such as the character set
for the default database defined by the character_set_database parameter. You can use the
Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters
operation to verify that your DB cluster parameter group has been created or modified. For
more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User
Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments
in the Amazon RDS User Guide.
# Arguments
- `dbcluster_parameter_group_name`: The name of the DB cluster parameter group.
Constraints: Must not match the name of an existing DB cluster parameter group. This
value is stored as a lowercase string.
- `dbparameter_group_family`: The DB cluster parameter group family name. A DB cluster
parameter group can be associated with one and only one DB cluster parameter group family,
and can be applied only to a DB cluster running a database engine and engine version
compatible with that DB cluster parameter group family. Aurora MySQL Example:
aurora-mysql5.7, aurora-mysql8.0 Aurora PostgreSQL Example: aurora-postgresql14 RDS
for MySQL Example: mysql8.0 RDS for PostgreSQL Example: postgres13 To list all of the
available parameter group families for a DB engine, use the following command: aws rds
describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine
<engine> For example, to list all of the available parameter group families for the
Aurora PostgreSQL DB engine, use the following command: aws rds
describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine
aurora-postgresql The output contains duplicates. The following are the valid DB engine
values: aurora-mysql aurora-postgresql mysql postgres
- `description`: The description for the DB cluster parameter group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: Tags to assign to the DB cluster parameter group.
"""
function create_dbcluster_parameter_group(
DBClusterParameterGroupName,
DBParameterGroupFamily,
Description;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"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 rds(
"CreateDBClusterParameterGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBClusterParameterGroupName" => DBClusterParameterGroupName,
"DBParameterGroupFamily" => DBParameterGroupFamily,
"Description" => Description,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dbcluster_snapshot(dbcluster_identifier, dbcluster_snapshot_identifier)
create_dbcluster_snapshot(dbcluster_identifier, dbcluster_snapshot_identifier, params::Dict{String,<:Any})
Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see What is
Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB
clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
# Arguments
- `dbcluster_identifier`: The identifier of the DB cluster to create a snapshot for. This
parameter isn't case-sensitive. Constraints: Must match the identifier of an existing
DBCluster. Example: my-cluster1
- `dbcluster_snapshot_identifier`: The identifier of the DB cluster snapshot. This
parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63
letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen
or contain two consecutive hyphens. Example: my-cluster1-snapshot1
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: The tags to be assigned to the DB cluster snapshot.
"""
function create_dbcluster_snapshot(
DBClusterIdentifier,
DBClusterSnapshotIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"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 rds(
"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(dbinstance_class, dbinstance_identifier, engine)
create_dbinstance(dbinstance_class, dbinstance_identifier, engine, params::Dict{String,<:Any})
Creates a new DB instance. The new DB instance can be an RDS DB instance, or it can be a DB
instance in an Aurora DB cluster. For an Aurora DB cluster, you can call this operation
multiple times to add more than one DB instance to the cluster. For more information about
creating an RDS DB instance, see Creating an Amazon RDS DB instance in the Amazon RDS User
Guide. For more information about creating a DB instance in an Aurora DB cluster, see
Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide.
# Arguments
- `dbinstance_class`: The compute and memory capacity of the DB instance, for example
db.m5.large. Not all DB instance classes are available in all Amazon Web Services Regions,
or for all database engines. For the full list of DB instance classes, and availability for
your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance
classes in the Amazon Aurora User Guide.
- `dbinstance_identifier`: The identifier for this DB instance. This parameter is stored as
a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter. Can't end with a hyphen or contain two consecutive
hyphens. Example: mydbinstance
- `engine`: The database engine to use for this DB instance. Not every database engine is
available in every Amazon Web Services Region. Valid Values: aurora-mysql (for Aurora
MySQL DB instances) aurora-postgresql (for Aurora PostgreSQL DB instances)
custom-oracle-ee (for RDS Custom for Oracle DB instances) custom-oracle-ee-cdb (for RDS
Custom for Oracle DB instances) custom-oracle-se2 (for RDS Custom for Oracle DB
instances) custom-oracle-se2-cdb (for RDS Custom for Oracle DB instances)
custom-sqlserver-ee (for RDS Custom for SQL Server DB instances) custom-sqlserver-se
(for RDS Custom for SQL Server DB instances) custom-sqlserver-web (for RDS Custom for
SQL Server DB instances) db2-ae db2-se mariadb mysql oracle-ee
oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee
sqlserver-se sqlserver-ex sqlserver-web
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllocatedStorage"`: The amount of storage in gibibytes (GiB) to allocate for the DB
instance. This setting doesn't apply to Amazon Aurora DB instances. Aurora cluster volumes
automatically grow as the amount of data in your database increases, though you are only
charged for the space that you use in an Aurora cluster volume. Amazon RDS Custom
Constraints to the amount of storage for each storage type are the following: General
Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for
Oracle, 16384 for RDS Custom for SQL Server. Provisioned IOPS storage (io1, io2): Must be
an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.
RDS for Db2 Constraints to the amount of storage for each storage type are the
following: General Purpose (SSD) storage (gp3): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536. RDS for
MariaDB Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536. Magnetic
storage (standard): Must be an integer from 5 to 3072. RDS for MySQL Constraints to the
amount of storage for each storage type are the following: General Purpose (SSD) storage
(gp2, gp3): Must be an integer from 20 to 65536. Provisioned IOPS storage (io1, io2):
Must be an integer from 100 to 65536. Magnetic storage (standard): Must be an integer
from 5 to 3072. RDS for Oracle Constraints to the amount of storage for each storage
type are the following: General Purpose (SSD) storage (gp2, gp3): Must be an integer from
20 to 65536. Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 10 to 3072. RDS for PostgreSQL
Constraints to the amount of storage for each storage type are the following: General
Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536. Provisioned IOPS
storage (io1, io2): Must be an integer from 100 to 65536. Magnetic storage (standard):
Must be an integer from 5 to 3072. RDS for SQL Server Constraints to the amount of
storage for each storage type are the following: General Purpose (SSD) storage (gp2,
gp3): Enterprise and Standard editions: Must be an integer from 20 to 16384. Web and
Express editions: Must be an integer from 20 to 16384. Provisioned IOPS storage (io1,
io2): Enterprise and Standard editions: Must be an integer from 100 to 16384. Web and
Express editions: Must be an integer from 100 to 16384. Magnetic storage (standard):
Enterprise and Standard editions: Must be an integer from 20 to 1024. Web and Express
editions: Must be an integer from 20 to 1024.
- `"AutoMinorVersionUpgrade"`: Specifies whether minor engine upgrades are applied
automatically to the DB instance during the maintenance window. By default, minor engine
upgrades are applied automatically. If you create an RDS Custom DB instance, you must set
AutoMinorVersionUpgrade to false.
- `"AvailabilityZone"`: The Availability Zone (AZ) where the database will be created. For
information on Amazon Web Services Regions and Availability Zones, see Regions and
Availability Zones. For Amazon Aurora, each Aurora DB cluster hosts copies of its storage
in three separate Availability Zones. Specify one of these Availability Zones. Aurora
automatically chooses an appropriate Availability Zone if you don't specify one. Default: A
random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
Constraints: The AvailabilityZone parameter can't be specified if the DB instance is a
Multi-AZ deployment. The specified Availability Zone must be in the same Amazon Web
Services Region as the current endpoint. Example: us-east-1d
- `"BackupRetentionPeriod"`: The number of days for which automated backups are retained.
Setting this parameter to a positive number enables backups. Setting this parameter to 0
disables automated backups. This setting doesn't apply to Amazon Aurora DB instances. The
retention period for automated backups is managed by the DB cluster. Default: 1
Constraints: Must be a value from 0 to 35. Can't be set to 0 if the DB instance is a
source to read replicas. Can't be set to 0 for an RDS Custom for Oracle DB instance.
- `"BackupTarget"`: The location for storing automated backups and manual snapshots. Valid
Values: outposts (Amazon Web Services Outposts) region (Amazon Web Services Region)
Default: region For more information, see Working with Amazon RDS on Amazon Web Services
Outposts in the Amazon RDS User Guide.
- `"CACertificateIdentifier"`: The CA certificate identifier to use for the DB instance's
server certificate. This setting doesn't apply to RDS Custom DB instances. For more
information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS
User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora
User Guide.
- `"CharacterSetName"`: For supported engines, the character set (CharacterSet) to
associate the DB instance with. This setting doesn't apply to the following DB instances:
Amazon Aurora - The character set is managed by the DB cluster. For more information, see
CreateDBCluster. RDS Custom - However, if you need to change the character set, you can
change it on the database itself.
- `"CopyTagsToSnapshot"`: Specifies whether to copy tags from the DB instance to snapshots
of the DB instance. By default, tags are not copied. This setting doesn't apply to Amazon
Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this
value for an Aurora DB instance has no effect on the DB cluster setting.
- `"CustomIamInstanceProfile"`: The instance profile associated with the underlying Amazon
EC2 instance of an RDS Custom DB instance. This setting is required for RDS Custom.
Constraints: The profile must exist in your account. The profile must have an IAM role
that Amazon EC2 has permissions to assume. The instance profile name and the associated
IAM role name must start with the prefix AWSRDSCustom. For the list of permissions
required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
- `"DBClusterIdentifier"`: The identifier of the DB cluster that this DB instance will
belong to. This setting doesn't apply to RDS Custom DB instances.
- `"DBName"`: The meaning of this parameter differs according to the database engine you
use. Amazon Aurora MySQL The name of the database to create when the primary DB instance
of the Aurora MySQL DB cluster is created. If this parameter isn't specified for an Aurora
MySQL DB cluster, no database is created in the DB cluster. Constraints: Must contain 1
to 64 alphanumeric characters. Can't be a word reserved by the database engine. Amazon
Aurora PostgreSQL The name of the database to create when the primary DB instance of the
Aurora PostgreSQL DB cluster is created. A database named postgres is always created. If
this parameter is specified, an additional database with this name is created. Constraints:
It must contain 1 to 63 alphanumeric characters. Must begin with a letter. Subsequent
characters can be letters, underscores, or digits (0 to 9). Can't be a word reserved by
the database engine. Amazon RDS Custom for Oracle The Oracle System ID (SID) of the
created RDS Custom DB instance. If you don't specify a value, the default value is ORCL for
non-CDBs and RDSCDB for CDBs. Default: ORCL Constraints: Must contain 1 to 8
alphanumeric characters. Must contain a letter. Can't be a word reserved by the
database engine. Amazon RDS Custom for SQL Server Not applicable. Must be null. RDS
for Db2 The name of the database to create when the DB instance is created. If this
parameter isn't specified, no database is created in the DB instance. In some cases, we
recommend that you don't add a database name. For more information, see Additional
considerations in the Amazon RDS User Guide. Constraints: Must contain 1 to 64 letters or
numbers. Must begin with a letter. Subsequent characters can be letters, underscores, or
digits (0-9). Can't be a word reserved by the specified database engine. RDS for
MariaDB The name of the database to create when the DB instance is created. If this
parameter isn't specified, no database is created in the DB instance. Constraints: Must
contain 1 to 64 letters or numbers. Must begin with a letter. Subsequent characters can
be letters, underscores, or digits (0-9). Can't be a word reserved by the specified
database engine. RDS for MySQL The name of the database to create when the DB instance
is created. If this parameter isn't specified, no database is created in the DB instance.
Constraints: Must contain 1 to 64 letters or numbers. Must begin with a letter.
Subsequent characters can be letters, underscores, or digits (0-9). Can't be a word
reserved by the specified database engine. RDS for Oracle The Oracle System ID (SID) of
the created DB instance. If you don't specify a value, the default value is ORCL. You can't
specify the string null, or any other reserved word, for DBName. Default: ORCL
Constraints: Can't be longer than 8 characters. RDS for PostgreSQL The name of the
database to create when the DB instance is created. A database named postgres is always
created. If this parameter is specified, an additional database with this name is created.
Constraints: Must contain 1 to 63 letters, numbers, or underscores. Must begin with a
letter. Subsequent characters can be letters, underscores, or digits (0-9). Can't be a
word reserved by the specified database engine. RDS for SQL Server Not applicable. Must
be null.
- `"DBParameterGroupName"`: The name of the DB parameter group to associate with this DB
instance. If you don't specify a value, then Amazon RDS uses the default DB parameter group
for the specified DB engine and version. This setting doesn't apply to RDS Custom DB
instances. Constraints: Must be 1 to 255 letters, numbers, or hyphens. The first
character must be a letter. Can't end with a hyphen or contain two consecutive hyphens.
- `"DBSecurityGroups"`: A list of DB security groups to associate with this DB instance.
This setting applies to the legacy EC2-Classic platform, which is no longer used to create
new DB instances. Use the VpcSecurityGroupIds setting instead.
- `"DBSubnetGroupName"`: A DB subnet group to associate with this DB instance. Constraints:
Must match the name of an existing DB subnet group. Must not be default. Example:
mydbsubnetgroup
- `"DBSystemId"`: The Oracle system identifier (SID), which is the name of the Oracle
database instance that manages your database files. In this context, the term \"Oracle
database instance\" refers exclusively to the system global area (SGA) and Oracle
background processes. If you don't specify a SID, the value defaults to RDSCDB. The Oracle
SID is also the name of your CDB.
- `"DedicatedLogVolume"`: Indicates whether the DB instance has a dedicated log volume
(DLV) enabled.
- `"DeletionProtection"`: Specifies whether the DB instance has deletion protection
enabled. The database can't be deleted when deletion protection is enabled. By default,
deletion protection isn't enabled. For more information, see Deleting a DB Instance. This
setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion
protection for the DB cluster. For more information, see CreateDBCluster. DB instances in a
DB cluster can be deleted even when deletion protection is enabled for the DB cluster.
- `"Domain"`: The Active Directory directory ID to create the DB instance in. Currently,
you can create only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances
in an Active Directory Domain. For more information, see Kerberos Authentication in the
Amazon RDS User Guide. This setting doesn't apply to the following DB instances: Amazon
Aurora (The domain is managed by the DB cluster.) RDS Custom
- `"DomainAuthSecretArn"`: The ARN for the Secrets Manager secret with the credentials for
the user joining the domain. Example:
arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
- `"DomainDnsIps"`: The IPv4 DNS IP addresses of your primary and secondary Active
Directory domain controllers. Constraints: Two IP addresses must be provided. If there
isn't a secondary domain controller, use the IP address of the primary domain controller
for both entries in the list. Example: 123.124.125.126,234.235.236.237
- `"DomainFqdn"`: The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints: Can't be longer than 64 characters. Example:
mymanagedADtest.mymanagedAD.mydomain
- `"DomainIAMRoleName"`: The name of the IAM role to use when making API calls to the
Directory Service. This setting doesn't apply to the following DB instances: Amazon
Aurora (The domain is managed by the DB cluster.) RDS Custom
- `"DomainOu"`: The Active Directory organizational unit for your DB instance to join.
Constraints: Must be in the distinguished name format. Can't be longer than 64
characters. Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
- `"EnableCloudwatchLogsExports"`: The list of log types to enable for exporting to
CloudWatch Logs. For more information, see Publishing Database Logs to Amazon CloudWatch
Logs in the Amazon RDS User Guide. This setting doesn't apply to the following DB
instances: Amazon Aurora (CloudWatch Logs exports are managed by the DB cluster.) RDS
Custom The following values are valid for each DB engine: RDS for Db2 - diag.log |
notify.log RDS for MariaDB - audit | error | general | slowquery RDS for Microsoft
SQL Server - agent | error RDS for MySQL - audit | error | general | slowquery RDS
for Oracle - alert | audit | listener | trace | oemagent RDS for PostgreSQL - postgresql
| upgrade
- `"EnableCustomerOwnedIp"`: Specifies whether to enable a customer-owned IP address (CoIP)
for an RDS on Outposts DB instance. A CoIP provides local or external connectivity to
resources in your Outpost subnets through your on-premises network. For some use cases, a
CoIP can provide lower latency for connections to the DB instance from outside of its
virtual private cloud (VPC) on your local network. For more information about RDS on
Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS
User Guide. For more information about CoIPs, see Customer-owned IP addresses in the Amazon
Web Services Outposts User Guide.
- `"EnableIAMDatabaseAuthentication"`: Specifies whether to enable mapping of Amazon Web
Services Identity and Access Management (IAM) accounts to database accounts. By default,
mapping isn't enabled. For more information, see IAM Database Authentication for MySQL and
PostgreSQL in the Amazon RDS User Guide. This setting doesn't apply to the following DB
instances: Amazon Aurora (Mapping Amazon Web Services IAM accounts to database accounts
is managed by the DB cluster.) RDS Custom
- `"EnablePerformanceInsights"`: Specifies whether to enable Performance Insights for the
DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS
User Guide. This setting doesn't apply to RDS Custom DB instances.
- `"EngineLifecycleSupport"`: The life cycle type for this DB instance. By default, this
value is set to open-source-rds-extended-support, which enrolls your DB instance into
Amazon RDS Extended Support. At the end of standard support, you can avoid charges for
Extended Support by setting the value to open-source-rds-extended-support-disabled. In this
case, creating the DB instance will fail if the DB major version is past its end of
standard support date. This setting applies only to RDS for MySQL and RDS for PostgreSQL.
For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster. You can
use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS
Extended Support, you can run the selected major engine version on your DB instance past
the end of standard support for that engine version. For more information, see Using Amazon
RDS Extended Support in the Amazon RDS User Guide. Valid Values:
open-source-rds-extended-support | open-source-rds-extended-support-disabled Default:
open-source-rds-extended-support
- `"EngineVersion"`: The version number of the database engine to use. This setting doesn't
apply to Amazon Aurora DB instances. The version number of the database engine the DB
instance uses is managed by the DB cluster. For a list of valid engine versions, use the
DescribeDBEngineVersions operation. The following are the database engines and links to
information about the major and minor versions that are available with Amazon RDS. Not
every database engine is available for every Amazon Web Services Region. Amazon RDS Custom
for Oracle A custom engine version (CEV) that you have previously created. This setting is
required for RDS Custom for Oracle. The CEV name has the following format:
19.customized_string. A valid CEV name is 19.my_cev1. For more information, see Creating
an RDS Custom for Oracle DB instance in the Amazon RDS User Guide. Amazon RDS Custom for
SQL Server See RDS Custom for SQL Server general requirements in the Amazon RDS User
Guide. RDS for Db2 For information, see Db2 on Amazon RDS versions in the Amazon RDS User
Guide. RDS for MariaDB For information, see MariaDB on Amazon RDS versions in the Amazon
RDS User Guide. RDS for Microsoft SQL Server For information, see Microsoft SQL Server
versions on Amazon RDS in the Amazon RDS User Guide. RDS for MySQL For information, see
MySQL on Amazon RDS versions in the Amazon RDS User Guide. RDS for Oracle For
information, see Oracle Database Engine release notes in the Amazon RDS User Guide. RDS
for PostgreSQL For information, see Amazon RDS for PostgreSQL versions and extensions in
the Amazon RDS User Guide.
- `"Iops"`: The amount of Provisioned IOPS (input/output operations per second) to
initially allocate for the DB instance. For information about valid IOPS values, see Amazon
RDS DB instance storage in the Amazon RDS User Guide. This setting doesn't apply to Amazon
Aurora DB instances. Storage is managed by the DB cluster. Constraints: For RDS for Db2,
MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the
storage amount for the DB instance. For RDS for SQL Server - Must be a multiple between 1
and 50 of the storage amount for the DB instance.
- `"KmsKeyId"`: The Amazon Web Services KMS key identifier for an encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name
for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the
key ARN or alias ARN. This setting doesn't apply to Amazon Aurora DB instances. The Amazon
Web Services KMS key identifier is managed by the DB cluster. For more information, see
CreateDBCluster. If StorageEncrypted is enabled, and you do not specify a value for the
KmsKeyId parameter, then Amazon RDS 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. For Amazon RDS Custom, a KMS key is
required for DB instances. For most RDS engines, if you leave this parameter empty while
enabling StorageEncrypted, the engine uses the default KMS key. However, RDS Custom doesn't
use the default key when this parameter is empty. You must explicitly specify a key.
- `"LicenseModel"`: The license model information for this DB instance. License models for
RDS for Db2 require additional configuration. The Bring Your Own License (BYOL) model
requires a custom parameter group. The Db2 license through Amazon Web Services Marketplace
model requires an Amazon Web Services Marketplace subscription. For more information, see
RDS for Db2 licensing options in the Amazon RDS User Guide. The default for RDS for Db2 is
bring-your-own-license. This setting doesn't apply to Amazon Aurora or RDS Custom DB
instances. Valid Values: RDS for Db2 - bring-your-own-license | marketplace-license
RDS for MariaDB - general-public-license RDS for Microsoft SQL Server - license-included
RDS for MySQL - general-public-license RDS for Oracle - bring-your-own-license |
license-included RDS for PostgreSQL - postgresql-license
- `"ManageMasterUserPassword"`: Specifies whether to manage the master user password with
Amazon Web Services Secrets Manager. For more information, see Password management with
Amazon Web Services Secrets Manager in the Amazon RDS User Guide. Constraints: Can't
manage the master user password with Amazon Web Services Secrets Manager if
MasterUserPassword is specified.
- `"MasterUserPassword"`: The password for the master user. This setting doesn't apply to
Amazon Aurora DB instances. The password for the master user is managed by the DB cluster.
Constraints: Can't be specified if ManageMasterUserPassword is turned on. Can include
any printable ASCII character except \"/\", \"\"\", or \"@\". For RDS for Oracle, can't
include the \"&\" (ampersand) or the \"'\" (single quotes) character. Length
Constraints: RDS for Db2 - Must contain from 8 to 255 characters. RDS for MariaDB -
Must contain from 8 to 41 characters. RDS for Microsoft SQL Server - Must contain from 8
to 128 characters. RDS for MySQL - Must contain from 8 to 41 characters. RDS for Oracle
- Must contain from 8 to 30 characters. RDS for PostgreSQL - Must contain from 8 to 128
characters.
- `"MasterUserSecretKmsKeyId"`: The Amazon Web Services KMS key identifier to encrypt a
secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web
Services Secrets Manager for the DB instance. The Amazon Web Services KMS key identifier is
the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a
different Amazon Web Services account, specify the key ARN or alias ARN. If you don't
specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt
the secret. If the secret is in a different Amazon Web Services account, then you can't use
the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed
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.
- `"MasterUsername"`: The name for the master user. This setting doesn't apply to Amazon
Aurora DB instances. The name for the master user is managed by the DB cluster. This
setting is required for RDS DB instances. Constraints: Must be 1 to 16 letters, numbers,
or underscores. First character must be a letter. Can't be a reserved word for the
chosen database engine.
- `"MaxAllocatedStorage"`: The upper limit in gibibytes (GiB) to which Amazon RDS can
automatically scale the storage of the DB instance. For more information about this
setting, including limitations that apply to it, see Managing capacity automatically with
Amazon RDS storage autoscaling in the Amazon RDS User Guide. This setting doesn't apply to
the following DB instances: Amazon Aurora (Storage is managed by the DB cluster.) RDS
Custom
- `"MonitoringInterval"`: The interval, in seconds, between points when Enhanced Monitoring
metrics are collected for the DB instance. To disable collection of Enhanced Monitoring
metrics, specify 0. If MonitoringRoleArn is specified, then you must set MonitoringInterval
to a value other than 0. This setting doesn't apply to RDS Custom DB instances. Valid
Values: 0 | 1 | 5 | 10 | 15 | 30 | 60 Default: 0
- `"MonitoringRoleArn"`: The ARN for the IAM role that permits RDS to send enhanced
monitoring metrics to Amazon CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see
Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide. If
MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn
value. This setting doesn't apply to RDS Custom DB instances.
- `"MultiAZ"`: Specifies whether the DB instance is a Multi-AZ deployment. You can't set
the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment. This setting
doesn't apply to the following DB instances: Amazon Aurora (DB instance Availability
Zones (AZs) are managed by the DB cluster.) RDS Custom
- `"MultiTenant"`: Specifies whether to use the multi-tenant configuration or the
single-tenant configuration (default). This parameter only applies to RDS for Oracle
container database (CDB) engines. Note the following restrictions: The DB engine that
you specify in the request must support the multi-tenant configuration. If you attempt to
enable the multi-tenant configuration on a DB engine that doesn't support it, the request
fails. If you specify the multi-tenant configuration when you create your DB instance,
you can't later modify this DB instance to use the single-tenant configuration.
- `"NcharCharacterSetName"`: The name of the NCHAR character set for the Oracle DB
instance. This setting doesn't apply to RDS Custom DB instances.
- `"NetworkType"`: The network type of the DB instance. The network type is determined by
the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4
protocol or the IPv4 and the IPv6 protocols (DUAL). For more information, see Working with
a DB instance in a VPC in the Amazon RDS User Guide. Valid Values: IPV4 | DUAL
- `"OptionGroupName"`: The option group to associate the DB instance with. Permanent
options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an
option group. Also, that option group can't be removed from a DB instance after it is
associated with a DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB
instances.
- `"PerformanceInsightsKMSKeyId"`: The Amazon Web Services KMS key identifier for
encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the
key ARN, key ID, alias ARN, or alias name for the KMS key. If you don't specify a value for
PerformanceInsightsKMSKeyId, then Amazon RDS 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. This setting doesn't apply
to RDS Custom DB instances.
- `"PerformanceInsightsRetentionPeriod"`: The number of days to retain Performance Insights
data. This setting doesn't apply to RDS Custom DB instances. Valid Values: 7 month *
31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11
months * 31), 589 (19 months * 31) 731 Default: 7 days If you specify a retention
period that isn't valid, such as 94, Amazon RDS returns an error.
- `"Port"`: The port number on which the database accepts connections. This setting doesn't
apply to Aurora DB instances. The port number is managed by the cluster. Valid Values:
1150-65535 Default: RDS for Db2 - 50000 RDS for MariaDB - 3306 RDS for Microsoft
SQL Server - 1433 RDS for MySQL - 3306 RDS for Oracle - 1521 RDS for PostgreSQL -
5432 Constraints: For RDS for Microsoft SQL Server, the value can't be 1234, 1434,
3260, 3343, 3389, 47001, or 49152-49156.
- `"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. For more information, see Backup window in the Amazon RDS User
Guide. This setting doesn't apply to Amazon Aurora DB instances. The daily time range for
creating automated backups is managed by the DB cluster. 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 time range each week during which system maintenance
can occur. For more information, see Amazon RDS Maintenance Window in the Amazon RDS User
Guide. The default is a 30-minute window selected at random from an 8-hour block of time
for each Amazon Web Services Region, occurring on a random day of the week. Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi. The day values must be mon | tue | wed |
thu | fri | sat | sun. Must be in Universal Coordinated Time (UTC). Must not conflict
with the preferred backup window. Must be at least 30 minutes.
- `"ProcessorFeatures"`: The number of CPU cores and the number of threads per core for the
DB instance class of the DB instance. This setting doesn't apply to Amazon Aurora or RDS
Custom DB instances.
- `"PromotionTier"`: The order of priority in which an Aurora Replica is promoted to the
primary instance after a failure of the existing primary instance. For more information,
see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. This setting
doesn't apply to RDS Custom DB instances. Default: 1 Valid Values: 0 - 15
- `"PubliclyAccessible"`: Specifies whether the DB instance is publicly accessible. When
the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to
the private IP address from within the DB instance's virtual private cloud (VPC). It
resolves to the public IP address from outside of the DB instance's VPC. Access to the DB
instance is ultimately controlled by the security group it uses. That public access is not
permitted if the security group assigned to the DB instance doesn't permit it. When the DB
instance isn't publicly accessible, it is an internal DB instance with a DNS name that
resolves to a private IP address. Default: The default behavior varies depending on whether
DBSubnetGroupName is specified. If DBSubnetGroupName isn't specified, and
PubliclyAccessible isn't specified, the following applies: If the default VPC in the
target Region doesn’t have an internet gateway attached to it, the DB instance is
private. If the default VPC in the target Region has an internet gateway attached to it,
the DB instance is public. If DBSubnetGroupName is specified, and PubliclyAccessible
isn't specified, the following applies: If the subnets are part of a VPC that doesn’t
have an internet gateway attached to it, the DB instance is private. If the subnets are
part of a VPC that has an internet gateway attached to it, the DB instance is public.
- `"StorageEncrypted"`: Specifes whether the DB instance is encrypted. By default, it isn't
encrypted. For RDS Custom DB instances, either enable this setting or leave it unset.
Otherwise, Amazon RDS reports an error. This setting doesn't apply to Amazon Aurora DB
instances. The encryption for DB instances is managed by the DB cluster.
- `"StorageThroughput"`: The storage throughput value for the DB instance. This setting
applies only to the gp3 storage type. This setting doesn't apply to Amazon Aurora or RDS
Custom DB instances.
- `"StorageType"`: The storage type to associate with the DB instance. If you specify io1,
io2, or gp3, you must also include a value for the Iops parameter. This setting doesn't
apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. Valid Values:
gp2 | gp3 | io1 | io2 | standard Default: io1, if the Iops parameter is specified.
Otherwise, gp2.
- `"Tags"`: Tags to assign to the DB instance.
- `"TdeCredentialArn"`: The ARN from the key store with which to associate the instance for
TDE encryption. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
- `"TdeCredentialPassword"`: The password for the given ARN from the key store in order to
access the device. This setting doesn't apply to RDS Custom DB instances.
- `"Timezone"`: The time zone of the DB instance. The time zone parameter is currently
supported only by RDS for Db2 and RDS for SQL Server.
- `"VpcSecurityGroupIds"`: A list of Amazon EC2 VPC security groups to associate with this
DB instance. This setting doesn't apply to Amazon Aurora DB instances. The associated list
of EC2 VPC security groups is managed by the DB cluster. Default: The default EC2 VPC
security group for the DB subnet group's VPC.
"""
function create_dbinstance(
DBInstanceClass,
DBInstanceIdentifier,
Engine;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"CreateDBInstance",
Dict{String,Any}(
"DBInstanceClass" => DBInstanceClass,
"DBInstanceIdentifier" => DBInstanceIdentifier,
"Engine" => Engine,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dbinstance(
DBInstanceClass,
DBInstanceIdentifier,
Engine,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"CreateDBInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBInstanceClass" => DBInstanceClass,
"DBInstanceIdentifier" => DBInstanceIdentifier,
"Engine" => Engine,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dbinstance_read_replica(dbinstance_identifier)
create_dbinstance_read_replica(dbinstance_identifier, params::Dict{String,<:Any})
Creates a new DB instance that acts as a read replica for an existing source DB instance or
Multi-AZ DB cluster. You can create a read replica for a DB instance running Db2, MariaDB,
MySQL, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a Multi-AZ DB
cluster running MySQL or PostgreSQL. For more information, see Working with read replicas
and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the
Amazon RDS User Guide. Amazon Aurora doesn't support this operation. To create a DB
instance for an Aurora DB cluster, use the CreateDBInstance operation. All read replica DB
instances are created with backups disabled. All other attributes (including DB security
groups and DB parameter groups) are inherited from the source DB instance or cluster,
except as specified. Your source DB instance or cluster must have backup retention
enabled.
# Arguments
- `dbinstance_identifier`: The DB instance identifier of the read replica. This identifier
is the unique key that identifies a DB instance. This parameter is stored as a lowercase
string.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllocatedStorage"`: The amount of storage (in gibibytes) to allocate initially for the
read replica. Follow the allocation rules specified in CreateDBInstance. Be sure to
allocate enough storage for your read replica so that the create operation can succeed. You
can also allocate additional storage for future growth.
- `"AutoMinorVersionUpgrade"`: Specifies whether to automatically apply minor engine
upgrades to the read replica during the maintenance window. This setting doesn't apply to
RDS Custom DB instances. Default: Inherits the value from the source DB instance.
- `"AvailabilityZone"`: The Availability Zone (AZ) where the read replica will be created.
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 read replica's
server certificate. This setting doesn't apply to RDS Custom DB instances. For more
information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS
User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora
User Guide.
- `"CopyTagsToSnapshot"`: Specifies whether to copy all tags from the read replica to
snapshots of the read replica. By default, tags aren't copied.
- `"CustomIamInstanceProfile"`: The instance profile associated with the underlying Amazon
EC2 instance of an RDS Custom DB instance. The instance profile must meet the following
requirements: The profile must exist in your account. The profile must have an IAM role
that Amazon EC2 has permissions to assume. The instance profile name and the associated
IAM role name must start with the prefix AWSRDSCustom. For the list of permissions
required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
This setting is required for RDS Custom DB instances.
- `"DBInstanceClass"`: The compute and memory capacity of the read replica, for example
db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions,
or for all database engines. For the full list of DB instance classes, and availability for
your engine, see DB Instance Class in the Amazon RDS User Guide. Default: Inherits the
value from the source DB instance.
- `"DBParameterGroupName"`: The name of the DB parameter group to associate with this DB
instance. If you don't specify a value for DBParameterGroupName, then Amazon RDS uses the
DBParameterGroup of the source DB instance for a same Region read replica, or the default
DBParameterGroup for the specified DB engine for a cross-Region read replica. Specifying a
parameter group for this operation is only supported for MySQL DB instances for
cross-Region read replicas and for Oracle DB instances. It isn't supported for MySQL DB
instances for same Region read replicas or for RDS Custom. Constraints: Must be 1 to 255
letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen
or contain two consecutive hyphens.
- `"DBSubnetGroupName"`: A DB subnet group for the DB instance. The new DB instance is
created in the VPC associated with the DB subnet group. If no DB subnet group is specified,
then the new DB instance isn't created in a VPC. Constraints: If supplied, must match the
name of an existing DB subnet group. The specified DB subnet group must be in the same
Amazon Web Services Region in which the operation is running. All read replicas in one
Amazon Web Services Region that are created from the same source DB instance must either:
Specify DB subnet groups from the same VPC. All these read replicas are created in the same
VPC. Not specify a DB subnet group. All these read replicas are created outside of any
VPC. Example: mydbsubnetgroup
- `"DedicatedLogVolume"`: Indicates whether the DB instance has a dedicated log volume
(DLV) enabled.
- `"DeletionProtection"`: Specifies whether to enable deletion protection for the DB
instance. The database can't be deleted when deletion protection is enabled. By default,
deletion protection isn't enabled. For more information, see Deleting a DB Instance.
- `"Domain"`: The Active Directory directory ID to create the DB instance in. Currently,
only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an
Active Directory Domain. For more information, see Kerberos Authentication in the Amazon
RDS User Guide. This setting doesn't apply to RDS Custom DB instances.
- `"DomainAuthSecretArn"`: The ARN for the Secrets Manager secret with the credentials for
the user joining the domain. Example:
arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
- `"DomainDnsIps"`: The IPv4 DNS IP addresses of your primary and secondary Active
Directory domain controllers. Constraints: Two IP addresses must be provided. If there
isn't a secondary domain controller, use the IP address of the primary domain controller
for both entries in the list. Example: 123.124.125.126,234.235.236.237
- `"DomainFqdn"`: The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints: Can't be longer than 64 characters. Example:
mymanagedADtest.mymanagedAD.mydomain
- `"DomainIAMRoleName"`: The name of the IAM role to use when making API calls to the
Directory Service. This setting doesn't apply to RDS Custom DB instances.
- `"DomainOu"`: The Active Directory organizational unit for your DB instance to join.
Constraints: Must be in the distinguished name format. Can't be longer than 64
characters. Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
- `"EnableCloudwatchLogsExports"`: The list of logs that the new DB instance is to export
to CloudWatch Logs. The values in the list depend on the DB engine being used. For more
information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User
Guide. This setting doesn't apply to RDS Custom DB instances.
- `"EnableCustomerOwnedIp"`: Specifies whether to enable a customer-owned IP address (CoIP)
for an RDS on Outposts read replica. A CoIP provides local or external connectivity to
resources in your Outpost subnets through your on-premises network. For some use cases, a
CoIP can provide lower latency for connections to the read replica from outside of its
virtual private cloud (VPC) on your local network. For more information about RDS on
Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS
User Guide. For more information about CoIPs, see Customer-owned IP addresses in the Amazon
Web Services Outposts User Guide.
- `"EnableIAMDatabaseAuthentication"`: Specifies whether to enable mapping of Amazon Web
Services Identity and Access Management (IAM) accounts to database accounts. By default,
mapping isn't enabled. For more information about IAM database authentication, see IAM
Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide. This setting
doesn't apply to RDS Custom DB instances.
- `"EnablePerformanceInsights"`: Specifies whether to enable Performance Insights for the
read replica. For more information, see Using Amazon Performance Insights in the Amazon RDS
User Guide. This setting doesn't apply to RDS Custom DB instances.
- `"Iops"`: The amount of Provisioned IOPS (input/output operations per second) to
initially allocate for the DB instance.
- `"KmsKeyId"`: The Amazon Web Services KMS key identifier for an encrypted read replica.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name
for the KMS key. If you create an encrypted read replica in the same Amazon Web Services
Region as the source DB instance or Multi-AZ DB cluster, don't specify a value for this
parameter. A read replica in the same Amazon Web Services Region is always encrypted with
the same KMS key as the source DB instance or cluster. If you create an encrypted read
replica in a different Amazon Web Services Region, then you must specify a KMS key
identifier for the destination Amazon Web Services Region. KMS keys are specific to the
Amazon Web Services Region that they are created in, and you can't use KMS keys from one
Amazon Web Services Region in another Amazon Web Services Region. You can't create an
encrypted read replica from an unencrypted DB instance or Multi-AZ DB cluster. This setting
doesn't apply to RDS Custom, which uses the same KMS key as the primary replica.
- `"MaxAllocatedStorage"`: The upper limit in gibibytes (GiB) to which Amazon RDS can
automatically scale the storage of the DB instance. For more information about this
setting, including limitations that apply to it, see Managing capacity automatically with
Amazon RDS storage autoscaling in the Amazon RDS User Guide.
- `"MonitoringInterval"`: The interval, in seconds, between points when Enhanced Monitoring
metrics are collected for the read replica. To disable collection of Enhanced Monitoring
metrics, specify 0. The default is 0. If MonitoringRoleArn is specified, then you must set
MonitoringInterval to a value other than 0. This setting doesn't apply to RDS Custom DB
instances. Valid Values: 0, 1, 5, 10, 15, 30, 60 Default: 0
- `"MonitoringRoleArn"`: The ARN for the IAM role that permits RDS to send enhanced
monitoring metrics to Amazon CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go
to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must supply a
MonitoringRoleArn value. This setting doesn't apply to RDS Custom DB instances.
- `"MultiAZ"`: Specifies whether the read replica is in a Multi-AZ deployment. You can
create a read replica as a Multi-AZ DB instance. RDS creates a standby of your replica in
another Availability Zone for failover support for the replica. Creating your read replica
as a Multi-AZ DB instance is independent of whether the source is a Multi-AZ DB instance or
a Multi-AZ DB cluster. This setting doesn't apply to RDS Custom DB instances.
- `"NetworkType"`: The network type of the DB instance. Valid Values: IPV4 DUAL
The network type is determined by the DBSubnetGroup specified for read replica. A
DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User
Guide.
- `"OptionGroupName"`: The option group to associate the DB instance with. If not
specified, RDS uses the option group associated with the source DB instance or cluster.
For SQL Server, you must use the option group associated with the source. This setting
doesn't apply to RDS Custom DB instances.
- `"PerformanceInsightsKMSKeyId"`: The Amazon Web Services KMS key identifier for
encryption of Performance Insights data. The Amazon Web Services 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 RDS 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. This setting doesn't apply
to RDS Custom DB instances.
- `"PerformanceInsightsRetentionPeriod"`: The number of days to retain Performance Insights
data. This setting doesn't apply to RDS Custom DB instances. Valid Values: 7 month *
31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11
months * 31), 589 (19 months * 31) 731 Default: 7 days If you specify a retention
period that isn't valid, such as 94, Amazon RDS returns an error.
- `"Port"`: The port number that the DB instance uses for connections. Valid Values:
1150-65535 Default: Inherits the value from the source DB instance.
- `"PreSignedUrl"`: When you are creating a read replica from one Amazon Web Services
GovCloud (US) Region to another or from one China Amazon Web Services Region to another,
the URL that contains a Signature Version 4 signed request for the
CreateDBInstanceReadReplica API operation in the source Amazon Web Services Region that
contains the source DB instance. This setting applies only to Amazon Web Services GovCloud
(US) Regions and China Amazon Web Services Regions. It's ignored in other Amazon Web
Services Regions. This setting applies only when replicating from a source DB instance.
Source DB clusters aren't supported in Amazon Web Services GovCloud (US) Regions and China
Amazon Web Services Regions. You must specify this parameter when you create an encrypted
read replica from another Amazon Web Services Region by using the Amazon RDS API. Don't
specify PreSignedUrl when you are creating an encrypted read replica in the same Amazon Web
Services Region. The presigned URL must be a valid request for the
CreateDBInstanceReadReplica API operation that can run in the source Amazon Web Services
Region that contains the encrypted source DB instance. The presigned URL request must
contain the following parameter values: DestinationRegion - The Amazon Web Services
Region that the encrypted read replica is created in. This Amazon Web Services Region is
the same one where the CreateDBInstanceReadReplica operation is called that contains this
presigned URL. For example, if you create an encrypted DB instance in the us-west-1 Amazon
Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region,
then you call the CreateDBInstanceReadReplica operation in the us-east-1 Amazon Web
Services Region and provide a presigned URL that contains a call to the
CreateDBInstanceReadReplica operation in the us-west-2 Amazon Web Services Region. For this
example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web
Services Region. KmsKeyId - The KMS key identifier for the key to use to encrypt the
read replica in the destination Amazon Web Services Region. This is the same identifier for
both the CreateDBInstanceReadReplica operation that is called in the destination Amazon Web
Services Region, and the operation contained in the presigned URL.
SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be
replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source
Amazon Web Services Region. For example, if you are creating an encrypted read replica from
a DB instance in the us-west-2 Amazon Web Services Region, then your
SourceDBInstanceIdentifier looks like the following example:
arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115. To learn how to
generate a Signature Version 4 signed request, see Authenticating Requests: Using Query
Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing
Process. 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 presigned URL that is a valid request for the
operation that can run in the source Amazon Web Services Region. SourceRegion isn't
supported for SQL Server, because Amazon RDS for SQL Server doesn't support cross-Region
read replicas. This setting doesn't apply to RDS Custom DB instances.If you supply a value
for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your
behalf.
- `"ProcessorFeatures"`: The number of CPU cores and the number of threads per core for the
DB instance class of the DB instance. This setting doesn't apply to RDS Custom DB instances.
- `"PubliclyAccessible"`: Specifies whether the DB instance is publicly accessible. When
the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to
the private IP address from within the DB cluster's virtual private cloud (VPC). It
resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB
cluster is ultimately controlled by the security group it uses. That public access isn't
permitted if the security group assigned to the DB cluster doesn't permit it. When the DB
instance isn't publicly accessible, it is an internal DB instance with a DNS name that
resolves to a private IP address. For more information, see CreateDBInstance.
- `"ReplicaMode"`: The open mode of the replica database: mounted or read-only. This
parameter is only supported for Oracle DB instances. Mounted DB replicas are included in
Oracle Database Enterprise Edition. The main use case for mounted replicas is cross-Region
disaster recovery. The primary database doesn't use Active Data Guard to transmit
information to the mounted replica. Because it doesn't accept user connections, a mounted
replica can't serve a read-only workload. You can create a combination of mounted and
read-only DB replicas for the same primary DB instance. For more information, see Working
with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. For RDS Custom, you
must specify this parameter and set it to mounted. The value won't be set by default. After
replica creation, you can manage the open mode manually.
- `"SourceDBClusterIdentifier"`: The identifier of the Multi-AZ DB cluster that will act as
the source for the read replica. Each DB cluster can have up to 15 read replicas.
Constraints: Must be the identifier of an existing Multi-AZ DB cluster. Can't be
specified if the SourceDBInstanceIdentifier parameter is also specified. The specified DB
cluster must have automatic backups enabled, that is, its backup retention period must be
greater than 0. The source DB cluster must be in the same Amazon Web Services Region as
the read replica. Cross-Region replication isn't supported.
- `"SourceDBInstanceIdentifier"`: The identifier of the DB instance that will act as the
source for the read replica. Each DB instance can have up to 15 read replicas, with the
exception of Oracle and SQL Server, which can have up to five. Constraints: Must be the
identifier of an existing Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server DB
instance. Can't be specified if the SourceDBClusterIdentifier parameter is also
specified. For the limitations of Oracle read replicas, see Version and licensing
considerations for RDS for Oracle replicas in the Amazon RDS User Guide. For the
limitations of SQL Server read replicas, see Read replica limitations with SQL Server in
the Amazon RDS User Guide. The specified DB instance must have automatic backups enabled,
that is, its backup retention period must be greater than 0. If the source DB instance is
in the same Amazon Web Services Region as the read replica, specify a valid DB instance
identifier. If the source DB instance is in a different Amazon Web Services Region from
the read replica, specify a valid DB instance ARN. For more information, see Constructing
an ARN for Amazon RDS in the Amazon RDS User Guide. This doesn't apply to SQL Server or RDS
Custom, which don't support cross-Region replicas.
- `"SourceRegion"`: The ID of the region that contains the source for the read replica.
- `"StorageThroughput"`: Specifies the storage throughput value for the read replica. This
setting doesn't apply to RDS Custom or Amazon Aurora DB instances.
- `"StorageType"`: The storage type to associate with the read replica. If you specify io1,
io2, or gp3, you must also include a value for the Iops parameter. Valid Values: gp2 | gp3
| io1 | io2 | standard Default: io1 if the Iops parameter is specified. Otherwise, gp2.
- `"Tags"`:
- `"UpgradeStorageConfig"`: Whether to upgrade the storage file system configuration on the
read replica. This option migrates the read replica from the old storage file system layout
to the preferred layout.
- `"UseDefaultProcessorFeatures"`: Specifies whether the DB instance class of the DB
instance uses its default processor features. This setting doesn't apply to RDS Custom DB
instances.
- `"VpcSecurityGroupIds"`: A list of Amazon EC2 VPC security groups to associate with the
read replica. This setting doesn't apply to RDS Custom DB instances. Default: The default
EC2 VPC security group for the DB subnet group's VPC.
"""
function create_dbinstance_read_replica(
DBInstanceIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"CreateDBInstanceReadReplica",
Dict{String,Any}("DBInstanceIdentifier" => DBInstanceIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dbinstance_read_replica(
DBInstanceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"CreateDBInstanceReadReplica",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBInstanceIdentifier" => DBInstanceIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dbparameter_group(dbparameter_group_family, dbparameter_group_name, description)
create_dbparameter_group(dbparameter_group_family, dbparameter_group_name, description, params::Dict{String,<:Any})
Creates a new DB parameter group. A DB parameter group is initially created with the
default parameters for the database engine used by the DB instance. To provide custom
values for any of the parameters, you must modify the group after creating it using
ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it
with your DB instance using ModifyDBInstance. When you associate a new DB parameter group
with a running DB instance, you need to reboot the DB instance without failover for the new
DB parameter group and associated settings to take effect. This command doesn't apply to
RDS Custom. After you create a DB parameter group, you should wait at least 5 minutes
before creating your first DB instance that uses that DB parameter group as the default
parameter group. This allows Amazon RDS to fully complete the create action before the
parameter group is used as the default for a new DB instance. This is especially important
for parameters that are critical when creating the default database for a DB instance, such
as the character set for the default database defined by the character_set_database
parameter. You can use the Parameter Groups option of the Amazon RDS console or the
DescribeDBParameters command to verify that your DB parameter group has been created or
modified.
# Arguments
- `dbparameter_group_family`: The DB parameter group family name. A DB parameter group can
be associated with one and only one DB parameter group family, and can be applied only to a
DB instance running a database engine and engine version compatible with that DB parameter
group family. To list all of the available parameter group families for a DB engine, use
the following command: aws rds describe-db-engine-versions --query
\"DBEngineVersions[].DBParameterGroupFamily\" --engine <engine> For example, to list
all of the available parameter group families for the MySQL DB engine, use the following
command: aws rds describe-db-engine-versions --query
\"DBEngineVersions[].DBParameterGroupFamily\" --engine mysql The output contains
duplicates. The following are the valid DB engine values: aurora-mysql
aurora-postgresql db2-ae db2-se mysql oracle-ee oracle-ee-cdb
oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se
sqlserver-ex sqlserver-web
- `dbparameter_group_name`: The name of the DB parameter group. Constraints: Must be 1 to
255 letters, numbers, or hyphens. First character must be a letter Can't end with a
hyphen or contain two consecutive hyphens This value is stored as a lowercase string.
- `description`: The description for the DB parameter group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: Tags to assign to the DB parameter group.
"""
function create_dbparameter_group(
DBParameterGroupFamily,
DBParameterGroupName,
Description;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"CreateDBParameterGroup",
Dict{String,Any}(
"DBParameterGroupFamily" => DBParameterGroupFamily,
"DBParameterGroupName" => DBParameterGroupName,
"Description" => Description,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dbparameter_group(
DBParameterGroupFamily,
DBParameterGroupName,
Description,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"CreateDBParameterGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBParameterGroupFamily" => DBParameterGroupFamily,
"DBParameterGroupName" => DBParameterGroupName,
"Description" => Description,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dbproxy(auth, dbproxy_name, engine_family, role_arn, vpc_subnet_ids)
create_dbproxy(auth, dbproxy_name, engine_family, role_arn, vpc_subnet_ids, params::Dict{String,<:Any})
Creates a new DB proxy.
# Arguments
- `auth`: The authorization mechanism that the proxy uses.
- `dbproxy_name`: The identifier for the proxy. This name must be unique for all proxies
owned by your Amazon Web Services account in the specified Amazon Web Services Region. 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.
- `engine_family`: The kinds of databases that the proxy can connect to. This value
determines which database network protocol the proxy recognizes when it interprets network
traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL
databases, specify MYSQL. For Aurora PostgreSQL and RDS for PostgreSQL databases, specify
POSTGRESQL. For RDS for Microsoft SQL Server, specify SQLSERVER.
- `role_arn`: The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access
secrets in Amazon Web Services Secrets Manager.
- `vpc_subnet_ids`: One or more VPC subnet IDs to associate with the new proxy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DebugLogging"`: Specifies whether the proxy includes detailed information about SQL
statements in its logs. This information helps you to debug issues involving SQL behavior
or the performance and scalability of the proxy connections. The debug information includes
the text of SQL statements that you submit through the proxy. Thus, only enable this
setting when needed for debugging, and only when you have security measures in place to
safeguard any sensitive information that appears in the logs.
- `"IdleClientTimeout"`: The number of seconds that a connection to the proxy can be
inactive before the proxy disconnects it. You can set this value higher or lower than the
connection timeout limit for the associated database.
- `"RequireTLS"`: Specifies whether Transport Layer Security (TLS) encryption is required
for connections to the proxy. By enabling this setting, you can enforce encrypted TLS
connections to the proxy.
- `"Tags"`: An optional set of key-value pairs to associate arbitrary data of your choosing
with the proxy.
- `"VpcSecurityGroupIds"`: One or more VPC security group IDs to associate with the new
proxy.
"""
function create_dbproxy(
Auth,
DBProxyName,
EngineFamily,
RoleArn,
VpcSubnetIds;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"CreateDBProxy",
Dict{String,Any}(
"Auth" => Auth,
"DBProxyName" => DBProxyName,
"EngineFamily" => EngineFamily,
"RoleArn" => RoleArn,
"VpcSubnetIds" => VpcSubnetIds,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dbproxy(
Auth,
DBProxyName,
EngineFamily,
RoleArn,
VpcSubnetIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"CreateDBProxy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Auth" => Auth,
"DBProxyName" => DBProxyName,
"EngineFamily" => EngineFamily,
"RoleArn" => RoleArn,
"VpcSubnetIds" => VpcSubnetIds,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dbproxy_endpoint(dbproxy_endpoint_name, dbproxy_name, vpc_subnet_ids)
create_dbproxy_endpoint(dbproxy_endpoint_name, dbproxy_name, vpc_subnet_ids, params::Dict{String,<:Any})
Creates a DBProxyEndpoint. Only applies to proxies that are associated with Aurora DB
clusters. You can use DB proxy endpoints to specify read/write or read-only access to the
DB cluster. You can also use DB proxy endpoints to access a DB proxy through a different
VPC than the proxy's default VPC.
# Arguments
- `dbproxy_endpoint_name`: The name of the DB proxy endpoint to create.
- `dbproxy_name`: The name of the DB proxy associated with the DB proxy endpoint that you
create.
- `vpc_subnet_ids`: The VPC subnet IDs for the DB proxy endpoint that you create. You can
specify a different set of subnet IDs than for the original DB proxy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`:
- `"TargetRole"`: The role of the DB proxy endpoint. The role determines whether the
endpoint can be used for read/write or only read operations. The default is READ_WRITE. The
only role that proxies for RDS for Microsoft SQL Server support is READ_WRITE.
- `"VpcSecurityGroupIds"`: The VPC security group IDs for the DB proxy endpoint that you
create. You can specify a different set of security group IDs than for the original DB
proxy. The default is the default security group for the VPC.
"""
function create_dbproxy_endpoint(
DBProxyEndpointName,
DBProxyName,
VpcSubnetIds;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"CreateDBProxyEndpoint",
Dict{String,Any}(
"DBProxyEndpointName" => DBProxyEndpointName,
"DBProxyName" => DBProxyName,
"VpcSubnetIds" => VpcSubnetIds,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dbproxy_endpoint(
DBProxyEndpointName,
DBProxyName,
VpcSubnetIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"CreateDBProxyEndpoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBProxyEndpointName" => DBProxyEndpointName,
"DBProxyName" => DBProxyName,
"VpcSubnetIds" => VpcSubnetIds,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dbsecurity_group(dbsecurity_group_description, dbsecurity_group_name)
create_dbsecurity_group(dbsecurity_group_description, dbsecurity_group_name, params::Dict{String,<:Any})
Creates a new DB security group. DB security groups control access to a DB instance. A DB
security group controls access to EC2-Classic DB instances that are not in a VPC.
EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a
VPC, we recommend that you migrate as soon as possible. For more information, see Migrate
from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is
Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in
the Amazon RDS User Guide.
# Arguments
- `dbsecurity_group_description`: The description for the DB security group.
- `dbsecurity_group_name`: The name for the DB security group. This value is stored as a
lowercase string. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First
character must be a letter Can't end with a hyphen or contain two consecutive hyphens
Must not be \"Default\" Example: mysecuritygroup
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: Tags to assign to the DB security group.
"""
function create_dbsecurity_group(
DBSecurityGroupDescription,
DBSecurityGroupName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"CreateDBSecurityGroup",
Dict{String,Any}(
"DBSecurityGroupDescription" => DBSecurityGroupDescription,
"DBSecurityGroupName" => DBSecurityGroupName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dbsecurity_group(
DBSecurityGroupDescription,
DBSecurityGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"CreateDBSecurityGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBSecurityGroupDescription" => DBSecurityGroupDescription,
"DBSecurityGroupName" => DBSecurityGroupName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dbshard_group(dbcluster_identifier, dbshard_group_identifier, max_acu)
create_dbshard_group(dbcluster_identifier, dbshard_group_identifier, max_acu, params::Dict{String,<:Any})
Creates a new DB shard group for Aurora Limitless Database. You must enable Aurora
Limitless Database to create a DB shard group. Valid for: Aurora DB clusters only
# Arguments
- `dbcluster_identifier`: The name of the primary DB cluster for the DB shard group.
- `dbshard_group_identifier`: The name of the DB shard group.
- `max_acu`: The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ComputeRedundancy"`: Specifies whether to create standby instances for the DB shard
group. Valid values are the following: 0 - Creates a single, primary DB instance for each
physical shard. This is the default value, and the only one supported for the preview. 1
- Creates a primary DB instance and a standby instance in a different Availability Zone
(AZ) for each physical shard. 2 - Creates a primary DB instance and two standby instances
in different AZs for each physical shard.
- `"PubliclyAccessible"`: Specifies whether the DB shard group is publicly accessible. When
the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves
to the private IP address from within the DB shard group's virtual private cloud (VPC). It
resolves to the public IP address from outside of the DB shard group's VPC. Access to the
DB shard group is ultimately controlled by the security group it uses. That public access
is not permitted if the security group assigned to the DB shard group doesn't permit it.
When the DB shard group isn't publicly accessible, it is an internal DB shard group with a
DNS name that resolves to a private IP address. Default: The default behavior varies
depending on whether DBSubnetGroupName is specified. If DBSubnetGroupName isn't specified,
and PubliclyAccessible isn't specified, the following applies: If the default VPC in the
target Region doesn’t have an internet gateway attached to it, the DB shard group is
private. If the default VPC in the target Region has an internet gateway attached to it,
the DB shard group is public. If DBSubnetGroupName is specified, and PubliclyAccessible
isn't specified, the following applies: If the subnets are part of a VPC that doesn’t
have an internet gateway attached to it, the DB shard group is private. If the subnets
are part of a VPC that has an internet gateway attached to it, the DB shard group is
public.
"""
function create_dbshard_group(
DBClusterIdentifier,
DBShardGroupIdentifier,
MaxACU;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"CreateDBShardGroup",
Dict{String,Any}(
"DBClusterIdentifier" => DBClusterIdentifier,
"DBShardGroupIdentifier" => DBShardGroupIdentifier,
"MaxACU" => MaxACU,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dbshard_group(
DBClusterIdentifier,
DBShardGroupIdentifier,
MaxACU,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"CreateDBShardGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBClusterIdentifier" => DBClusterIdentifier,
"DBShardGroupIdentifier" => DBShardGroupIdentifier,
"MaxACU" => MaxACU,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dbsnapshot(dbinstance_identifier, dbsnapshot_identifier)
create_dbsnapshot(dbinstance_identifier, dbsnapshot_identifier, params::Dict{String,<:Any})
Creates a snapshot of a DB instance. The source DB instance must be in the available or
storage-optimization state.
# Arguments
- `dbinstance_identifier`: The identifier of the DB instance that you want to create the
snapshot of. Constraints: Must match the identifier of an existing DBInstance.
- `dbsnapshot_identifier`: The identifier for the DB snapshot. Constraints: Can't be
null, empty, or blank Must contain from 1 to 255 letters, numbers, or hyphens First
character must be a letter Can't end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`:
"""
function create_dbsnapshot(
DBInstanceIdentifier,
DBSnapshotIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"CreateDBSnapshot",
Dict{String,Any}(
"DBInstanceIdentifier" => DBInstanceIdentifier,
"DBSnapshotIdentifier" => DBSnapshotIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dbsnapshot(
DBInstanceIdentifier,
DBSnapshotIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"CreateDBSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBInstanceIdentifier" => DBInstanceIdentifier,
"DBSnapshotIdentifier" => DBSnapshotIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dbsubnet_group(dbsubnet_group_description, dbsubnet_group_name, subnet_identifier)
create_dbsubnet_group(dbsubnet_group_description, dbsubnet_group_name, subnet_identifier, params::Dict{String,<:Any})
Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at
least two AZs in the Amazon Web Services Region.
# Arguments
- `dbsubnet_group_description`: The description for the DB subnet group.
- `dbsubnet_group_name`: The name for the DB subnet group. This value is stored as a
lowercase string. Constraints: Must contain no more than 255 letters, numbers, periods,
underscores, spaces, or hyphens. Must not be default. First character must be a letter.
Example: mydbsubnetgroup
- `subnet_identifier`: The EC2 Subnet IDs for the DB subnet group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SubnetIds"`: The EC2 Subnet IDs for the DB subnet group.
- `"Tags"`: Tags to assign to the DB subnet group.
"""
function create_dbsubnet_group(
DBSubnetGroupDescription,
DBSubnetGroupName,
SubnetIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"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 rds(
"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 RDS event notification subscription. This operation requires a topic Amazon
Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API. To
obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic.
The ARN is displayed in the SNS console. You can specify the type of source (SourceType)
that you want to be notified of and provide a list of RDS sources (SourceIds) that triggers
the events. You can also 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 SourceIds =
myDBInstance1, you are notified of all the db-instance events for the specified source. If
you specify a SourceType but do not specify SourceIds, you receive notice of the events for
that source type for all your RDS sources. If you don't specify either the SourceType or
the SourceIds, you are notified of events generated from all RDS sources belonging to your
customer account. For more information about subscribing to an event for RDS DB engines,
see Subscribing to Amazon RDS event notification in the Amazon RDS User Guide. For more
information about subscribing to an event for Aurora DB engines, see Subscribing to Amazon
RDS event notification in the Amazon Aurora User Guide.
# Arguments
- `sns_topic_arn`: The Amazon Resource Name (ARN) of the SNS topic created for event
notification. SNS automatically creates the ARN when you create a topic and subscribe to
it. RDS doesn't support FIFO (first in, first out) topics. For more information, see
Message ordering and deduplication (FIFO topics) in the Amazon Simple Notification Service
Developer Guide.
- `subscription_name`: The name of the subscription. Constraints: The name must be less
than 255 characters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Enabled"`: Specifies whether to activate the subscription. If the event notification
subscription isn't activated, the subscription is created but not active.
- `"EventCategories"`: A list of event categories for a particular source type (SourceType)
that you want to subscribe to. You can see a list of the categories for a given source type
in the \"Amazon RDS event categories and event messages\" section of the Amazon RDS User
Guide or the Amazon Aurora User Guide . You can also see this list by using the
DescribeEventCategories operation.
- `"SourceIds"`: The list of identifiers of the event sources for which events are
returned. If not specified, then all sources are included in the response. An identifier
must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't
end with a hyphen or contain two consecutive hyphens. Constraints: If SourceIds are
supplied, SourceType must also be provided. If the source type is a DB instance, a
DBInstanceIdentifier value must be supplied. If the source type is a DB cluster, a
DBClusterIdentifier value must be supplied. If the source type is a DB parameter group, a
DBParameterGroupName value must be supplied. If the source type is a DB security group, a
DBSecurityGroupName value must be supplied. If the source type is a DB snapshot, a
DBSnapshotIdentifier value must be supplied. If the source type is a DB cluster snapshot,
a DBClusterSnapshotIdentifier value must be supplied. If the source type is an RDS Proxy,
a DBProxyName value must be supplied.
- `"SourceType"`: The type of source that is generating the events. For example, if you
want to be notified of events generated by a DB instance, you set this parameter to
db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all
events are returned. Valid Values: db-instance | db-cluster | db-parameter-group |
db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl |
custom-engine-version | blue-green-deployment
- `"Tags"`:
"""
function create_event_subscription(
SnsTopicArn, SubscriptionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"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 rds(
"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()
create_global_cluster(params::Dict{String,<:Any})
Creates an Aurora global database spread across multiple Amazon Web Services Regions. The
global database contains a single primary cluster with read-write capability, and a
read-only secondary cluster that receives data from the primary cluster through high-speed
replication performed by the Aurora storage subsystem. You can create a global database
that is initially empty, and then create the primary and secondary DB clusters in the
global database. Or you can specify an existing Aurora cluster during the create operation,
and this cluster becomes the primary cluster of the global database. This operation
applies only to Aurora DB clusters.
# 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 alphanumeric characters. If you
don't specify a name, Amazon Aurora doesn't create a database in the global database
cluster. Constraints: Can't be specified if SourceDBClusterIdentifier is specified. In
this case, Amazon Aurora uses the database name from the source DB cluster.
- `"DeletionProtection"`: Specifies whether to enable deletion protection for the new
global database cluster. The global database can't be deleted when deletion protection is
enabled.
- `"Engine"`: The database engine to use for this global database cluster. Valid Values:
aurora-mysql | aurora-postgresql Constraints: Can't be specified if
SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the engine of the
source DB cluster.
- `"EngineLifecycleSupport"`: The life cycle type for this global database cluster. By
default, this value is set to open-source-rds-extended-support, which enrolls your global
cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid
charges for Extended Support by setting the value to
open-source-rds-extended-support-disabled. In this case, creating the global cluster will
fail if the DB major version is past its end of standard support date. This setting only
applies to Aurora PostgreSQL-based global databases. You can use this setting to enroll
your global cluster into Amazon RDS Extended Support. With RDS Extended Support, you can
run the selected major engine version on your global cluster past the end of standard
support for that engine version. For more information, see Using Amazon RDS Extended
Support in the Amazon Aurora User Guide. Valid Values: open-source-rds-extended-support |
open-source-rds-extended-support-disabled Default: open-source-rds-extended-support
- `"EngineVersion"`: The engine version to use for this global database cluster.
Constraints: Can't be specified if SourceDBClusterIdentifier is specified. In this case,
Amazon Aurora uses the engine version of the source DB cluster.
- `"GlobalClusterIdentifier"`: The cluster identifier for this global database cluster.
This parameter is stored as a lowercase string.
- `"SourceDBClusterIdentifier"`: The Amazon Resource Name (ARN) to use as the primary
cluster of the global database. If you provide a value for this parameter, don't specify
values for the following settings because Amazon Aurora uses the values from the specified
source DB cluster: DatabaseName Engine EngineVersion StorageEncrypted
- `"StorageEncrypted"`: Specifies whether to enable storage encryption for the new global
database cluster. Constraints: Can't be specified if SourceDBClusterIdentifier is
specified. In this case, Amazon Aurora uses the setting from the source DB cluster.
"""
function create_global_cluster(; aws_config::AbstractAWSConfig=global_aws_config())
return rds(
"CreateGlobalCluster"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function create_global_cluster(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"CreateGlobalCluster",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_integration(integration_name, source_arn, target_arn)
create_integration(integration_name, source_arn, target_arn, params::Dict{String,<:Any})
Creates a zero-ETL integration with Amazon Redshift.
# Arguments
- `integration_name`: The name of the integration.
- `source_arn`: The Amazon Resource Name (ARN) of the database to use as the source for
replication.
- `target_arn`: The ARN of the Redshift data warehouse to use as the target for replication.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AdditionalEncryptionContext"`: An optional set of non-secret key–value pairs that
contains additional contextual information about the data. For more information, see
Encryption context in the Amazon Web Services Key Management Service Developer Guide. You
can only include this parameter if you specify the KMSKeyId parameter.
- `"DataFilter"`: Data filtering options for the integration. For more information, see
Data filtering for Aurora zero-ETL integrations with Amazon Redshift. Valid for:
Integrations with Aurora MySQL source DB clusters only
- `"Description"`: A description of the integration.
- `"KMSKeyId"`: The Amazon Web Services Key Management System (Amazon Web Services KMS) key
identifier for the key to use to encrypt the integration. If you don't specify an
encryption key, RDS uses a default Amazon Web Services owned key.
- `"Tags"`:
"""
function create_integration(
IntegrationName, SourceArn, TargetArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"CreateIntegration",
Dict{String,Any}(
"IntegrationName" => IntegrationName,
"SourceArn" => SourceArn,
"TargetArn" => TargetArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_integration(
IntegrationName,
SourceArn,
TargetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"CreateIntegration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IntegrationName" => IntegrationName,
"SourceArn" => SourceArn,
"TargetArn" => TargetArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_option_group(engine_name, major_engine_version, option_group_description, option_group_name)
create_option_group(engine_name, major_engine_version, option_group_description, option_group_name, params::Dict{String,<:Any})
Creates a new option group. You can create up to 20 option groups. This command doesn't
apply to RDS Custom.
# Arguments
- `engine_name`: The name of the engine to associate this option group with. Valid Values:
db2-ae db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2
oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex
sqlserver-web
- `major_engine_version`: Specifies the major version of the engine that this option group
should be associated with.
- `option_group_description`: The description of the option group.
- `option_group_name`: Specifies the name of the option group to be created. Constraints:
Must be 1 to 255 letters, numbers, or hyphens First character must be a letter Can't
end with a hyphen or contain two consecutive hyphens Example: myoptiongroup
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: Tags to assign to the option group.
"""
function create_option_group(
EngineName,
MajorEngineVersion,
OptionGroupDescription,
OptionGroupName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"CreateOptionGroup",
Dict{String,Any}(
"EngineName" => EngineName,
"MajorEngineVersion" => MajorEngineVersion,
"OptionGroupDescription" => OptionGroupDescription,
"OptionGroupName" => OptionGroupName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_option_group(
EngineName,
MajorEngineVersion,
OptionGroupDescription,
OptionGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"CreateOptionGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EngineName" => EngineName,
"MajorEngineVersion" => MajorEngineVersion,
"OptionGroupDescription" => OptionGroupDescription,
"OptionGroupName" => OptionGroupName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_tenant_database(dbinstance_identifier, master_user_password, master_username, tenant_dbname)
create_tenant_database(dbinstance_identifier, master_user_password, master_username, tenant_dbname, params::Dict{String,<:Any})
Creates a tenant database in a DB instance that uses the multi-tenant configuration. Only
RDS for Oracle container database (CDB) instances are supported.
# Arguments
- `dbinstance_identifier`: The user-supplied DB instance identifier. RDS creates your
tenant database in this DB instance. This parameter isn't case-sensitive.
- `master_user_password`: The password for the master user in your tenant database.
Constraints: Must be 8 to 30 characters. Can include any printable ASCII character
except forward slash (/), double quote (\"), at symbol (@), ampersand (&), or single
quote (').
- `master_username`: The name for the master user account in your tenant database. RDS
creates this user account in the tenant database and grants privileges to the master user.
This parameter is case-sensitive. Constraints: Must be 1 to 16 letters, numbers, or
underscores. First character must be a letter. Can't be a reserved word for the chosen
database engine.
- `tenant_dbname`: The user-supplied name of the tenant database that you want to create in
your DB instance. This parameter has the same constraints as DBName in CreateDBInstance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CharacterSetName"`: The character set for your tenant database. If you don't specify a
value, the character set name defaults to AL32UTF8.
- `"NcharCharacterSetName"`: The NCHAR value for the tenant database.
- `"Tags"`:
"""
function create_tenant_database(
DBInstanceIdentifier,
MasterUserPassword,
MasterUsername,
TenantDBName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"CreateTenantDatabase",
Dict{String,Any}(
"DBInstanceIdentifier" => DBInstanceIdentifier,
"MasterUserPassword" => MasterUserPassword,
"MasterUsername" => MasterUsername,
"TenantDBName" => TenantDBName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_tenant_database(
DBInstanceIdentifier,
MasterUserPassword,
MasterUsername,
TenantDBName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"CreateTenantDatabase",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBInstanceIdentifier" => DBInstanceIdentifier,
"MasterUserPassword" => MasterUserPassword,
"MasterUsername" => MasterUsername,
"TenantDBName" => TenantDBName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_blue_green_deployment(blue_green_deployment_identifier)
delete_blue_green_deployment(blue_green_deployment_identifier, params::Dict{String,<:Any})
Deletes a blue/green deployment. For more information, see Using Amazon RDS Blue/Green
Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS
Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
# Arguments
- `blue_green_deployment_identifier`: The unique identifier of the blue/green deployment to
delete. This parameter isn't case-sensitive. Constraints: Must match an existing
blue/green deployment identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeleteTarget"`: Specifies whether to delete the resources in the green environment. You
can't specify this option if the blue/green deployment status is SWITCHOVER_COMPLETED.
"""
function delete_blue_green_deployment(
BlueGreenDeploymentIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DeleteBlueGreenDeployment",
Dict{String,Any}("BlueGreenDeploymentIdentifier" => BlueGreenDeploymentIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_blue_green_deployment(
BlueGreenDeploymentIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"DeleteBlueGreenDeployment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"BlueGreenDeploymentIdentifier" => BlueGreenDeploymentIdentifier
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_custom_dbengine_version(engine, engine_version)
delete_custom_dbengine_version(engine, engine_version, params::Dict{String,<:Any})
Deletes a custom engine version. To run this command, make sure you meet the following
prerequisites: The CEV must not be the default for RDS Custom. If it is, change the
default before running this command. The CEV must not be associated with an RDS Custom DB
instance, RDS Custom instance snapshot, or automated backup of your RDS Custom instance.
Typically, deletion takes a few minutes. The MediaImport service that imports files from
Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn
on data logging for Amazon RDS in CloudTrail, calls to the DeleteCustomDbEngineVersion
event aren't logged. However, you might see calls from the API gateway that accesses your
Amazon S3 bucket. These calls originate from the MediaImport service for the
DeleteCustomDbEngineVersion event. For more information, see Deleting a CEV in the Amazon
RDS User Guide.
# Arguments
- `engine`: The database engine. RDS Custom for Oracle supports the following values:
custom-oracle-ee custom-oracle-ee-cdb custom-oracle-se2 custom-oracle-se2-cdb
- `engine_version`: The custom engine version (CEV) for your DB instance. This option is
required for RDS Custom, but optional for Amazon RDS. The combination of Engine and
EngineVersion is unique per customer per Amazon Web Services Region.
"""
function delete_custom_dbengine_version(
Engine, EngineVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DeleteCustomDBEngineVersion",
Dict{String,Any}("Engine" => Engine, "EngineVersion" => EngineVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_custom_dbengine_version(
Engine,
EngineVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"DeleteCustomDBEngineVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Engine" => Engine, "EngineVersion" => EngineVersion),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dbcluster(dbcluster_identifier)
delete_dbcluster(dbcluster_identifier, params::Dict{String,<:Any})
The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a
DB cluster, all automated backups for that DB cluster are deleted and can't be recovered.
Manual DB cluster snapshots of the specified DB cluster are not deleted. If you're deleting
a Multi-AZ DB cluster with read replicas, all cluster members are terminated and read
replicas are promoted to standalone instances. For more information on Amazon Aurora, see
What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB
clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
# Arguments
- `dbcluster_identifier`: The DB cluster identifier for the DB cluster to be deleted. This
parameter isn't case-sensitive. Constraints: Must match an existing DBClusterIdentifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeleteAutomatedBackups"`: Specifies whether to remove automated backups immediately
after the DB cluster is deleted. This parameter isn't case-sensitive. The default is to
remove automated backups immediately after the DB cluster is deleted.
- `"FinalDBSnapshotIdentifier"`: The DB cluster snapshot identifier of the new DB cluster
snapshot created when SkipFinalSnapshot is disabled. Specifying this parameter and also
skipping the creation of a final DB cluster snapshot with the SkipFinalShapshot parameter
results in an error. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First
character must be a letter Can't end with a hyphen or contain two consecutive hyphens
- `"SkipFinalSnapshot"`: Specifies whether to skip the creation of a final DB cluster
snapshot before the DB cluster is deleted. If skip is specified, no DB cluster snapshot is
created. If skip isn't specified, a DB cluster snapshot is created before the DB cluster is
deleted. By default, skip isn't specified, and the DB cluster snapshot is created. By
default, this parameter is disabled. You must specify a FinalDBSnapshotIdentifier
parameter if SkipFinalSnapshot is disabled.
"""
function delete_dbcluster(
DBClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"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 rds(
"DeleteDBCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBClusterIdentifier" => DBClusterIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dbcluster_automated_backup(db_cluster_resource_id)
delete_dbcluster_automated_backup(db_cluster_resource_id, params::Dict{String,<:Any})
Deletes automated backups using the DbClusterResourceId value of the source DB cluster or
the Amazon Resource Name (ARN) of the automated backups.
# Arguments
- `db_cluster_resource_id`: The identifier for the source DB cluster, which can't be
changed and which is unique to an Amazon Web Services Region.
"""
function delete_dbcluster_automated_backup(
DbClusterResourceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DeleteDBClusterAutomatedBackup",
Dict{String,Any}("DbClusterResourceId" => DbClusterResourceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_dbcluster_automated_backup(
DbClusterResourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"DeleteDBClusterAutomatedBackup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DbClusterResourceId" => DbClusterResourceId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dbcluster_endpoint(dbcluster_endpoint_identifier)
delete_dbcluster_endpoint(dbcluster_endpoint_identifier, params::Dict{String,<:Any})
Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster. This action
only applies to Aurora DB clusters.
# Arguments
- `dbcluster_endpoint_identifier`: The identifier associated with the custom endpoint. This
parameter is stored as a lowercase string.
"""
function delete_dbcluster_endpoint(
DBClusterEndpointIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DeleteDBClusterEndpoint",
Dict{String,Any}("DBClusterEndpointIdentifier" => DBClusterEndpointIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_dbcluster_endpoint(
DBClusterEndpointIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"DeleteDBClusterEndpoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBClusterEndpointIdentifier" => DBClusterEndpointIdentifier
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dbcluster_parameter_group(dbcluster_parameter_group_name)
delete_dbcluster_parameter_group(dbcluster_parameter_group_name, params::Dict{String,<:Any})
Deletes a specified DB cluster parameter group. The DB cluster parameter group to be
deleted can't be associated with any DB clusters. For more information on Amazon Aurora,
see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on
Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
# Arguments
- `dbcluster_parameter_group_name`: The name of the DB cluster parameter group.
Constraints: Must be the name of an existing DB cluster parameter group. You can't
delete a default DB cluster parameter group. Can't be associated with any DB clusters.
"""
function delete_dbcluster_parameter_group(
DBClusterParameterGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"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 rds(
"DeleteDBClusterParameterGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBClusterParameterGroupName" => DBClusterParameterGroupName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dbcluster_snapshot(dbcluster_snapshot_identifier)
delete_dbcluster_snapshot(dbcluster_snapshot_identifier, params::Dict{String,<:Any})
Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is
terminated. The DB cluster snapshot must be in the available state to be deleted. For
more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User
Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments
in the Amazon RDS User Guide.
# Arguments
- `dbcluster_snapshot_identifier`: The identifier of the DB cluster snapshot to delete.
Constraints: Must be the name of an existing DB cluster snapshot in the available state.
"""
function delete_dbcluster_snapshot(
DBClusterSnapshotIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"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 rds(
"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 DB instance. When you delete a DB instance, all automated
backups for that instance are deleted and can't be recovered. However, manual DB snapshots
of the DB instance aren't deleted. If you request a final DB snapshot, the status of the
Amazon RDS DB instance is deleting until the DB snapshot is created. This operation can't
be canceled or reverted after it begins. To monitor the status of this operation, use
DescribeDBInstance. When a DB instance is in a failure state and has a status of failed,
incompatible-restore, or incompatible-network, you can only delete it when you skip
creation of the final snapshot with the SkipFinalSnapshot parameter. If the specified DB
instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both
of the following conditions are true: The DB cluster is a read replica of another Amazon
Aurora DB cluster. The DB instance is the only instance in the DB cluster. To delete a
DB instance in this case, first use the PromoteReadReplicaDBCluster operation to promote
the DB cluster so that it's no longer a read replica. After the promotion completes, use
the DeleteDBInstance operation to delete the final instance in the DB cluster. For RDS
Custom DB instances, deleting the DB instance permanently deletes the EC2 instance and the
associated EBS volumes. Make sure that you don't terminate or delete these resources before
you delete the DB instance. Otherwise, deleting the DB instance and creation of the final
snapshot might fail.
# Arguments
- `dbinstance_identifier`: The DB instance identifier for the DB instance to be deleted.
This parameter isn't case-sensitive. Constraints: Must match the name of an existing DB
instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeleteAutomatedBackups"`: Specifies whether to remove automated backups immediately
after the DB instance is deleted. This parameter isn't case-sensitive. The default is to
remove automated backups immediately after the DB instance is deleted.
- `"FinalDBSnapshotIdentifier"`: The DBSnapshotIdentifier of the new DBSnapshot created
when the SkipFinalSnapshot parameter is disabled. If you enable this parameter and also
enable SkipFinalShapshot, the command results in an error. This setting doesn't apply to
RDS Custom. Constraints: Must be 1 to 255 letters or numbers. First character must be a
letter. Can't end with a hyphen or contain two consecutive hyphens. Can't be specified
when deleting a read replica.
- `"SkipFinalSnapshot"`: Specifies whether to skip the creation of a final DB snapshot
before deleting the instance. If you enable this parameter, RDS doesn't create a DB
snapshot. If you don't enable this parameter, RDS creates a DB snapshot before the DB
instance is deleted. By default, skip isn't enabled, and the DB snapshot is created. If
you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.
When a DB instance is in a failure state and has a status of failed, incompatible-restore,
or incompatible-network, RDS can delete the instance only if you enable this parameter. If
you delete a read replica or an RDS Custom instance, you must enable this setting. This
setting is required for RDS Custom.
"""
function delete_dbinstance(
DBInstanceIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"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 rds(
"DeleteDBInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBInstanceIdentifier" => DBInstanceIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dbinstance_automated_backup()
delete_dbinstance_automated_backup(params::Dict{String,<:Any})
Deletes automated backups using the DbiResourceId value of the source DB instance or the
Amazon Resource Name (ARN) of the automated backups.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBInstanceAutomatedBackupsArn"`: The Amazon Resource Name (ARN) of the automated
backups to delete, for example,
arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE. This setting
doesn't apply to RDS Custom.
- `"DbiResourceId"`: The identifier for the source DB instance, which can't be changed and
which is unique to an Amazon Web Services Region.
"""
function delete_dbinstance_automated_backup(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DeleteDBInstanceAutomatedBackup";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_dbinstance_automated_backup(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DeleteDBInstanceAutomatedBackup",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dbparameter_group(dbparameter_group_name)
delete_dbparameter_group(dbparameter_group_name, params::Dict{String,<:Any})
Deletes a specified DB parameter group. The DB parameter group to be deleted can't be
associated with any DB instances.
# Arguments
- `dbparameter_group_name`: The name of the DB parameter group. Constraints: Must be the
name of an existing DB parameter group You can't delete a default DB parameter group
Can't be associated with any DB instances
"""
function delete_dbparameter_group(
DBParameterGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DeleteDBParameterGroup",
Dict{String,Any}("DBParameterGroupName" => DBParameterGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_dbparameter_group(
DBParameterGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"DeleteDBParameterGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBParameterGroupName" => DBParameterGroupName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dbproxy(dbproxy_name)
delete_dbproxy(dbproxy_name, params::Dict{String,<:Any})
Deletes an existing DB proxy.
# Arguments
- `dbproxy_name`: The name of the DB proxy to delete.
"""
function delete_dbproxy(DBProxyName; aws_config::AbstractAWSConfig=global_aws_config())
return rds(
"DeleteDBProxy",
Dict{String,Any}("DBProxyName" => DBProxyName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_dbproxy(
DBProxyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"DeleteDBProxy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DBProxyName" => DBProxyName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dbproxy_endpoint(dbproxy_endpoint_name)
delete_dbproxy_endpoint(dbproxy_endpoint_name, params::Dict{String,<:Any})
Deletes a DBProxyEndpoint. Doing so removes the ability to access the DB proxy using the
endpoint that you defined. The endpoint that you delete might have provided capabilities
such as read/write or read-only operations, or using a different VPC than the DB proxy's
default VPC.
# Arguments
- `dbproxy_endpoint_name`: The name of the DB proxy endpoint to delete.
"""
function delete_dbproxy_endpoint(
DBProxyEndpointName; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DeleteDBProxyEndpoint",
Dict{String,Any}("DBProxyEndpointName" => DBProxyEndpointName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_dbproxy_endpoint(
DBProxyEndpointName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"DeleteDBProxyEndpoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBProxyEndpointName" => DBProxyEndpointName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dbsecurity_group(dbsecurity_group_name)
delete_dbsecurity_group(dbsecurity_group_name, params::Dict{String,<:Any})
Deletes a DB security group. The specified DB security group must not be associated with
any DB instances. EC2-Classic was retired on August 15, 2022. If you haven't migrated from
EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more
information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog
EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance
not in a VPC into a VPC in the Amazon RDS User Guide.
# Arguments
- `dbsecurity_group_name`: The name of the DB security group to delete. You can't delete
the default DB security group. Constraints: Must be 1 to 255 letters, numbers, or
hyphens. First character must be a letter Can't end with a hyphen or contain two
consecutive hyphens Must not be \"Default\"
"""
function delete_dbsecurity_group(
DBSecurityGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DeleteDBSecurityGroup",
Dict{String,Any}("DBSecurityGroupName" => DBSecurityGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_dbsecurity_group(
DBSecurityGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"DeleteDBSecurityGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBSecurityGroupName" => DBSecurityGroupName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dbshard_group(dbshard_group_identifier)
delete_dbshard_group(dbshard_group_identifier, params::Dict{String,<:Any})
Deletes an Aurora Limitless Database DB shard group.
# Arguments
- `dbshard_group_identifier`: Teh name of the DB shard group to delete.
"""
function delete_dbshard_group(
DBShardGroupIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DeleteDBShardGroup",
Dict{String,Any}("DBShardGroupIdentifier" => DBShardGroupIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_dbshard_group(
DBShardGroupIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"DeleteDBShardGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBShardGroupIdentifier" => DBShardGroupIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dbsnapshot(dbsnapshot_identifier)
delete_dbsnapshot(dbsnapshot_identifier, params::Dict{String,<:Any})
Deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated.
The DB snapshot must be in the available state to be deleted.
# Arguments
- `dbsnapshot_identifier`: The DB snapshot identifier. Constraints: Must be the name of an
existing DB snapshot in the available state.
"""
function delete_dbsnapshot(
DBSnapshotIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DeleteDBSnapshot",
Dict{String,Any}("DBSnapshotIdentifier" => DBSnapshotIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_dbsnapshot(
DBSnapshotIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"DeleteDBSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBSnapshotIdentifier" => DBSnapshotIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dbsubnet_group(dbsubnet_group_name)
delete_dbsubnet_group(dbsubnet_group_name, params::Dict{String,<:Any})
Deletes a DB subnet group. The specified database subnet group must not be associated with
any DB instances.
# Arguments
- `dbsubnet_group_name`: The name of the database subnet group to delete. You can't delete
the default subnet group. Constraints: Must match the name of an existing DBSubnetGroup.
Must not be default. Example: mydbsubnetgroup
"""
function delete_dbsubnet_group(
DBSubnetGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"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 rds(
"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 RDS event notification subscription.
# Arguments
- `subscription_name`: The name of the RDS event notification subscription you want to
delete.
"""
function delete_event_subscription(
SubscriptionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"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 rds(
"DeleteEventSubscription",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("SubscriptionName" => SubscriptionName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_global_cluster(global_cluster_identifier)
delete_global_cluster(global_cluster_identifier, params::Dict{String,<:Any})
Deletes a global database cluster. The primary and secondary clusters must already be
detached or destroyed first. This action only applies to Aurora DB clusters.
# Arguments
- `global_cluster_identifier`: The cluster identifier of the global database cluster being
deleted.
"""
function delete_global_cluster(
GlobalClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"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 rds(
"DeleteGlobalCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("GlobalClusterIdentifier" => GlobalClusterIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_integration(integration_identifier)
delete_integration(integration_identifier, params::Dict{String,<:Any})
Deletes a zero-ETL integration with Amazon Redshift.
# Arguments
- `integration_identifier`: The unique identifier of the integration.
"""
function delete_integration(
IntegrationIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DeleteIntegration",
Dict{String,Any}("IntegrationIdentifier" => IntegrationIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_integration(
IntegrationIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"DeleteIntegration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("IntegrationIdentifier" => IntegrationIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_option_group(option_group_name)
delete_option_group(option_group_name, params::Dict{String,<:Any})
Deletes an existing option group.
# Arguments
- `option_group_name`: The name of the option group to be deleted. You can't delete
default option groups.
"""
function delete_option_group(
OptionGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DeleteOptionGroup",
Dict{String,Any}("OptionGroupName" => OptionGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_option_group(
OptionGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"DeleteOptionGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("OptionGroupName" => OptionGroupName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_tenant_database(dbinstance_identifier, tenant_dbname)
delete_tenant_database(dbinstance_identifier, tenant_dbname, params::Dict{String,<:Any})
Deletes a tenant database from your DB instance. This command only applies to RDS for
Oracle container database (CDB) instances. You can't delete a tenant database when it is
the only tenant in the DB instance.
# Arguments
- `dbinstance_identifier`: The user-supplied identifier for the DB instance that contains
the tenant database that you want to delete.
- `tenant_dbname`: The user-supplied name of the tenant database that you want to remove
from your DB instance. Amazon RDS deletes the tenant database with this name. This
parameter isn’t case-sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FinalDBSnapshotIdentifier"`: The DBSnapshotIdentifier of the new DBSnapshot created
when the SkipFinalSnapshot parameter is disabled. If you enable this parameter and also
enable SkipFinalShapshot, the command results in an error.
- `"SkipFinalSnapshot"`: Specifies whether to skip the creation of a final DB snapshot
before removing the tenant database from your DB instance. If you enable this parameter,
RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS creates a DB
snapshot before it deletes the tenant database. By default, RDS doesn't skip the final
snapshot. If you don't enable this parameter, you must specify the
FinalDBSnapshotIdentifier parameter.
"""
function delete_tenant_database(
DBInstanceIdentifier, TenantDBName; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DeleteTenantDatabase",
Dict{String,Any}(
"DBInstanceIdentifier" => DBInstanceIdentifier, "TenantDBName" => TenantDBName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_tenant_database(
DBInstanceIdentifier,
TenantDBName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"DeleteTenantDatabase",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBInstanceIdentifier" => DBInstanceIdentifier,
"TenantDBName" => TenantDBName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_dbproxy_targets(dbproxy_name)
deregister_dbproxy_targets(dbproxy_name, params::Dict{String,<:Any})
Remove the association between one or more DBProxyTarget data structures and a
DBProxyTargetGroup.
# Arguments
- `dbproxy_name`: The identifier of the DBProxy that is associated with the
DBProxyTargetGroup.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBClusterIdentifiers"`: One or more DB cluster identifiers.
- `"DBInstanceIdentifiers"`: One or more DB instance identifiers.
- `"TargetGroupName"`: The identifier of the DBProxyTargetGroup.
"""
function deregister_dbproxy_targets(
DBProxyName; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DeregisterDBProxyTargets",
Dict{String,Any}("DBProxyName" => DBProxyName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_dbproxy_targets(
DBProxyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"DeregisterDBProxyTargets",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DBProxyName" => DBProxyName), 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 attributes for a customer account. The attributes include Amazon RDS
quotas for the account, such as the number of DB instances allowed. The description for a
quota includes the quota name, current usage toward that quota, and the quota's maximum
value. This command doesn't take any parameters.
"""
function describe_account_attributes(; aws_config::AbstractAWSConfig=global_aws_config())
return rds(
"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 rds(
"DescribeAccountAttributes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_blue_green_deployments()
describe_blue_green_deployments(params::Dict{String,<:Any})
Describes one or more blue/green deployments. For more information, see Using Amazon RDS
Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon
RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BlueGreenDeploymentIdentifier"`: The blue/green deployment identifier. If you specify
this parameter, the response only includes information about the specific blue/green
deployment. This parameter isn't case-sensitive. Constraints: Must match an existing
blue/green deployment identifier.
- `"Filters"`: A filter that specifies one or more blue/green deployments to describe.
Valid Values: blue-green-deployment-identifier - Accepts system-generated identifiers
for blue/green deployments. The results list only includes information about the blue/green
deployments with the specified identifiers. blue-green-deployment-name - Accepts
user-supplied names for blue/green deployments. The results list only includes information
about the blue/green deployments with the specified names. source - Accepts source
databases for a blue/green deployment. The results list only includes information about the
blue/green deployments with the specified source databases. target - Accepts target
databases for a blue/green deployment. The results list only includes information about the
blue/green deployments with the specified target databases.
- `"Marker"`: An optional pagination token provided by a previous
DescribeBlueGreenDeployments request. If you specify this parameter, the response only
includes records beyond the marker, up to the value specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, a pagination token called a marker is included
in the response so you can retrieve the remaining results. Default: 100 Constraints: Must
be a minimum of 20. Can't exceed 100.
"""
function describe_blue_green_deployments(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeBlueGreenDeployments";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_blue_green_deployments(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeBlueGreenDeployments",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_certificates()
describe_certificates(params::Dict{String,<:Any})
Lists the set of certificate authority (CA) certificates provided by Amazon RDS for this
Amazon Web Services account. For more information, see Using SSL/TLS to encrypt a
connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a
connection to a DB cluster in the Amazon Aurora User Guide.
# 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 identified certificate is returned. This parameter
isn't case-sensitive. Constraints: Must match an existing CertificateIdentifier.
- `"Filters"`: This parameter isn't 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 you can retrieve the remaining results. Default: 100 Constraints:
Minimum 20, maximum 100.
"""
function describe_certificates(; aws_config::AbstractAWSConfig=global_aws_config())
return rds(
"DescribeCertificates"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_certificates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeCertificates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dbcluster_automated_backups()
describe_dbcluster_automated_backups(params::Dict{String,<:Any})
Displays backups for both current and deleted DB clusters. For example, use this operation
to find details about automated backups for previously deleted clusters. Current clusters
are returned for both the DescribeDBClusterAutomatedBackups and DescribeDBClusters
operations. All parameters are optional.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBClusterIdentifier"`: (Optional) The user-supplied DB cluster identifier. If this
parameter is specified, it must match the identifier of an existing DB cluster. It returns
information from the specific DB cluster's automated backup. This parameter isn't
case-sensitive.
- `"DbClusterResourceId"`: The resource ID of the DB cluster that is the source of the
automated backup. This parameter isn't case-sensitive.
- `"Filters"`: A filter that specifies which resources to return based on status. Supported
filters are the following: status retained - Automated backups for deleted clusters
and after backup replication is stopped. db-cluster-id - Accepts DB cluster
identifiers and Amazon Resource Names (ARNs). The results list includes only information
about the DB cluster automated backups identified by these ARNs. db-cluster-resource-id
- Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list
includes only information about the DB cluster resources identified by these ARNs.
Returns all resources by default. The status for each resource is specified in the response.
- `"Marker"`: The pagination token provided in the previous request. If this parameter is
specified the response includes only records beyond the marker, up to 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_dbcluster_automated_backups(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeDBClusterAutomatedBackups";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_dbcluster_automated_backups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeDBClusterAutomatedBackups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dbcluster_backtracks(dbcluster_identifier)
describe_dbcluster_backtracks(dbcluster_identifier, params::Dict{String,<:Any})
Returns information about backtracks for a DB cluster. For more information on Amazon
Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. This action only
applies to Aurora MySQL DB clusters.
# Arguments
- `dbcluster_identifier`: The DB cluster identifier of the DB cluster to be described. This
parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63
alphanumeric characters or hyphens. First character must be a letter. Can't end with a
hyphen or contain two consecutive hyphens. Example: my-cluster1
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BacktrackIdentifier"`: If specified, this value is the backtrack identifier of the
backtrack to be described. Constraints: Must contain a valid universally unique
identifier (UUID). For more information about UUIDs, see Universally unique identifier.
Example: 123e4567-e89b-12d3-a456-426655440000
- `"Filters"`: A filter that specifies one or more DB clusters to describe. Supported
filters include the following: db-cluster-backtrack-id - Accepts backtrack identifiers.
The results list includes information about only the backtracks identified by these
identifiers. db-cluster-backtrack-status - Accepts any of the following backtrack status
values: applying completed failed pending The results list includes
information about only the backtracks identified by these values.
- `"Marker"`: An optional pagination token provided by a previous
DescribeDBClusterBacktracks request. If this parameter is specified, the response includes
only records beyond the marker, up to the value specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, a pagination token called a marker is included
in the response so you can retrieve the remaining results. Default: 100 Constraints:
Minimum 20, maximum 100.
"""
function describe_dbcluster_backtracks(
DBClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeDBClusterBacktracks",
Dict{String,Any}("DBClusterIdentifier" => DBClusterIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_dbcluster_backtracks(
DBClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"DescribeDBClusterBacktracks",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBClusterIdentifier" => DBClusterIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dbcluster_endpoints()
describe_dbcluster_endpoints(params::Dict{String,<:Any})
Returns information about endpoints for an Amazon Aurora DB cluster. This action only
applies to Aurora DB clusters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBClusterEndpointIdentifier"`: The identifier of the endpoint to describe. This
parameter is stored as a lowercase string.
- `"DBClusterIdentifier"`: The DB cluster identifier of the DB cluster associated with the
endpoint. This parameter is stored as a lowercase string.
- `"Filters"`: A set of name-value pairs that define which endpoints to include in the
output. The filters are specified as name-value pairs, in the format
Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name can be one of:
db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id,
db-cluster-endpoint-status. Values for the db-cluster-endpoint-type filter can be one or
more of: reader, writer, custom. Values for the db-cluster-endpoint-custom-type filter can
be one or more of: reader, any. Values for the db-cluster-endpoint-status filter can be one
or more of: available, creating, deleting, inactive, modifying.
- `"Marker"`: An optional pagination token provided by a previous
DescribeDBClusterEndpoints request. If this parameter is specified, the response includes
only records beyond the marker, up to the value specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, a pagination token called a marker is included
in the response so you can retrieve the remaining results. Default: 100 Constraints:
Minimum 20, maximum 100.
"""
function describe_dbcluster_endpoints(; aws_config::AbstractAWSConfig=global_aws_config())
return rds(
"DescribeDBClusterEndpoints"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_dbcluster_endpoints(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeDBClusterEndpoints",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dbcluster_parameter_groups()
describe_dbcluster_parameter_groups(params::Dict{String,<:Any})
Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName
parameter is specified, the list will contain only the description of the specified DB
cluster parameter group. For more information on Amazon Aurora, see What is Amazon Aurora?
in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see
Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBClusterParameterGroupName"`: The name of a specific DB cluster parameter group to
return details for. Constraints: If supplied, must match the name of an existing
DBClusterParameterGroup.
- `"Filters"`: This parameter isn't currently supported.
- `"Marker"`: An optional pagination token provided by a previous
DescribeDBClusterParameterGroups request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, a pagination token called a marker is included
in the response so you can retrieve the remaining results. Default: 100 Constraints:
Minimum 20, maximum 100.
"""
function describe_dbcluster_parameter_groups(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"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 rds(
"DescribeDBClusterParameterGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dbcluster_parameters(dbcluster_parameter_group_name)
describe_dbcluster_parameters(dbcluster_parameter_group_name, params::Dict{String,<:Any})
Returns the detailed parameter list for a particular DB cluster parameter group. For more
information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the
Amazon RDS User Guide.
# Arguments
- `dbcluster_parameter_group_name`: The name of a specific DB cluster parameter group to
return parameter details for. Constraints: If supplied, must match the name of an
existing DBClusterParameterGroup.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: This parameter isn't currently supported.
- `"Marker"`: An optional pagination token provided by a previous
DescribeDBClusterParameters request. If this parameter is specified, the response includes
only records beyond the marker, up to the value specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, a pagination token called a marker is included
in the response so you can retrieve the remaining results. Default: 100 Constraints:
Minimum 20, maximum 100.
- `"Source"`: A specific source to return parameters for. Valid Values: customer
engine service
"""
function describe_dbcluster_parameters(
DBClusterParameterGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"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 rds(
"DescribeDBClusterParameters",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBClusterParameterGroupName" => DBClusterParameterGroupName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dbcluster_snapshot_attributes(dbcluster_snapshot_identifier)
describe_dbcluster_snapshot_attributes(dbcluster_snapshot_identifier, params::Dict{String,<:Any})
Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster
snapshot. When sharing snapshots with other Amazon 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 DB cluster
snapshot. If all is included in the list of values for the restore attribute, then the
manual DB cluster snapshot is public and can be copied or restored by all Amazon Web
Services accounts. To add or remove access for an Amazon Web Services account to copy or
restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or
private, use the ModifyDBClusterSnapshotAttribute API action.
# Arguments
- `dbcluster_snapshot_identifier`: The identifier for the DB cluster snapshot to describe
the attributes for.
"""
function describe_dbcluster_snapshot_attributes(
DBClusterSnapshotIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"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 rds(
"DescribeDBClusterSnapshotAttributes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBClusterSnapshotIdentifier" => DBClusterSnapshotIdentifier
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dbcluster_snapshots()
describe_dbcluster_snapshots(params::Dict{String,<:Any})
Returns information about DB cluster snapshots. This API action supports pagination. For
more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon
Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster
deployments in the Amazon RDS User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBClusterIdentifier"`: The ID of the DB cluster to retrieve the list of DB cluster
snapshots for. This parameter can't be used in conjunction with the
DBClusterSnapshotIdentifier parameter. This parameter isn't case-sensitive. Constraints:
If supplied, must match the identifier of an existing DBCluster.
- `"DBClusterSnapshotIdentifier"`: A specific DB cluster snapshot identifier to describe.
This parameter can't be used in conjunction with the DBClusterIdentifier parameter. This
value is stored as a lowercase string. Constraints: If supplied, must match the
identifier of an existing DBClusterSnapshot. If this identifier is for an automated
snapshot, the SnapshotType parameter must also be specified.
- `"DbClusterResourceId"`: A specific DB cluster resource ID to describe.
- `"Filters"`: A filter that specifies one or more DB cluster snapshots to describe.
Supported filters: db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon
Resource Names (ARNs). db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.
snapshot-type - Accepts types of DB cluster snapshots. engine - Accepts names of
database engines.
- `"IncludePublic"`: Specifies whether to include manual DB cluster snapshots that are
public and can be copied or restored by any Amazon Web Services account. By default, the
public snapshots are not included. You can share a manual DB cluster snapshot as public by
using the ModifyDBClusterSnapshotAttribute API action.
- `"IncludeShared"`: Specifies whether to include shared manual DB cluster snapshots from
other Amazon Web Services accounts that this Amazon Web Services account has been given
permission to copy or restore. By default, these snapshots are not included. You can give
an Amazon Web Services account permission to restore a manual DB cluster snapshot from
another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.
- `"Marker"`: An optional pagination token provided by a previous
DescribeDBClusterSnapshots request. If this parameter is specified, the response includes
only records beyond the marker, up to the value specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, a pagination token called a marker is included
in the response so you can retrieve the remaining results. Default: 100 Constraints:
Minimum 20, maximum 100.
- `"SnapshotType"`: The type of DB cluster snapshots to be returned. You can specify one of
the following values: automated - Return all DB cluster snapshots that have been
automatically taken by Amazon RDS for my Amazon Web Services account. manual - Return
all DB cluster snapshots that have been taken by my Amazon Web Services account. shared
- Return all manual DB cluster snapshots that have been shared to my Amazon Web Services
account. public - Return all DB cluster snapshots that have been marked as public. If
you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots
are returned. You can include shared DB cluster snapshots with these results by enabling
the IncludeShared parameter. You can include public DB cluster snapshots with these results
by enabling the IncludePublic parameter. 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 rds(
"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 rds(
"DescribeDBClusterSnapshots",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dbclusters()
describe_dbclusters(params::Dict{String,<:Any})
Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports
pagination. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora?
in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see
Multi-AZ DB cluster deployments in the Amazon RDS User Guide. This operation can also
return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBClusterIdentifier"`: The user-supplied DB cluster identifier or the Amazon Resource
Name (ARN) of the DB cluster. If this parameter is specified, information for only the
specific DB cluster is returned. This parameter isn't case-sensitive. Constraints: If
supplied, must match an existing DB cluster identifier.
- `"Filters"`: A filter that specifies one or more DB clusters to describe. Supported
Filters: clone-group-id - Accepts clone group identifiers. The results list only
includes information about the DB clusters associated with these clone groups.
db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).
The results list only includes information about the DB clusters identified by these ARNs.
db-cluster-resource-id - Accepts DB cluster resource identifiers. The results list will
only include information about the DB clusters identified by these DB cluster resource
identifiers. domain - Accepts Active Directory directory IDs. The results list only
includes information about the DB clusters associated with these domains. engine -
Accepts engine names. The results list only includes information about the DB clusters for
these engines.
- `"IncludeShared"`: Specifies whether the output includes information about clusters
shared from other Amazon Web Services accounts.
- `"Marker"`: An optional pagination token provided by a previous DescribeDBClusters
request. If this parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, a pagination token called a marker is included
in the response so you can retrieve the remaining results. Default: 100 Constraints:
Minimum 20, maximum 100
"""
function describe_dbclusters(; aws_config::AbstractAWSConfig=global_aws_config())
return rds("DescribeDBClusters"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_dbclusters(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeDBClusters", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_dbengine_versions()
describe_dbengine_versions(params::Dict{String,<:Any})
Describes the properties of specific versions of DB engines.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBParameterGroupFamily"`: The name of a specific DB parameter group family to return
details for. Constraints: If supplied, must match an existing DB parameter group family.
- `"DefaultOnly"`: Specifies whether to return only the default version of the specified
engine or the engine and major version combination.
- `"Engine"`: The database engine to return version details for. Valid Values:
aurora-mysql aurora-postgresql custom-oracle-ee custom-oracle-ee-cdb
custom-oracle-se2 custom-oracle-se2-cdb db2-ae db2-se mariadb mysql
oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee
sqlserver-se sqlserver-ex sqlserver-web
- `"EngineVersion"`: A specific database engine version to return details for. Example:
5.1.49
- `"Filters"`: A filter that specifies one or more DB engine versions to describe.
Supported filters: db-parameter-group-family - Accepts parameter groups family names.
The results list only includes information about the DB engine versions for these parameter
group families. engine - Accepts engine names. The results list only includes
information about the DB engine versions for these engines. engine-mode - Accepts DB
engine modes. The results list only includes information about the DB engine versions for
these engine modes. Valid DB engine modes are the following: global multimaster
parallelquery provisioned serverless engine-version - Accepts engine
versions. The results list only includes information about the DB engine versions for these
engine versions. status - Accepts engine version statuses. The results list only
includes information about the DB engine versions for these statuses. Valid statuses are
the following: available deprecated
- `"IncludeAll"`: Specifies whether to also list the engine versions that aren't available.
The default is to list only available engine versions.
- `"ListSupportedCharacterSets"`: Specifies whether to list the supported character sets
for each engine version. If this parameter is enabled and the requested engine supports the
CharacterSetName parameter for CreateDBInstance, the response includes a list of supported
character sets for each engine version. For RDS Custom, the default is not to list
supported character sets. If you enable this parameter, RDS Custom returns no results.
- `"ListSupportedTimezones"`: Specifies whether to list the supported time zones for each
engine version. If this parameter is enabled and the requested engine supports the TimeZone
parameter for CreateDBInstance, the response includes a list of supported time zones for
each engine version. For RDS Custom, the default is not to list supported time zones. If
you enable this parameter, RDS Custom returns no results.
- `"Marker"`: An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the marker, up to the
value specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more than
the MaxRecords value is available, a pagination token called a marker is included in the
response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20,
maximum 100.
"""
function describe_dbengine_versions(; aws_config::AbstractAWSConfig=global_aws_config())
return rds(
"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 rds(
"DescribeDBEngineVersions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dbinstance_automated_backups()
describe_dbinstance_automated_backups(params::Dict{String,<:Any})
Displays backups for both current and deleted instances. For example, use this operation to
find details about automated backups for previously deleted instances. Current instances
with retention periods greater than zero (0) are returned for both the
DescribeDBInstanceAutomatedBackups and DescribeDBInstances operations. All parameters are
optional.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBInstanceAutomatedBackupsArn"`: The Amazon Resource Name (ARN) of the replicated
automated backups, for example,
arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE. This setting
doesn't apply to RDS Custom.
- `"DBInstanceIdentifier"`: (Optional) The user-supplied instance identifier. If this
parameter is specified, it must match the identifier of an existing DB instance. It returns
information from the specific DB instance's automated backup. This parameter isn't
case-sensitive.
- `"DbiResourceId"`: The resource ID of the DB instance that is the source of the automated
backup. This parameter isn't case-sensitive.
- `"Filters"`: A filter that specifies which resources to return based on status. Supported
filters are the following: status active - Automated backups for current instances.
creating - Automated backups that are waiting for the first automated snapshot to be
available. retained - Automated backups for deleted instances and after backup
replication is stopped. db-instance-id - Accepts DB instance identifiers and Amazon
Resource Names (ARNs). The results list includes only information about the DB instance
automated backups identified by these ARNs. dbi-resource-id - Accepts DB resource
identifiers and Amazon Resource Names (ARNs). The results list includes only information
about the DB instance resources identified by these ARNs. Returns all resources by
default. The status for each resource is specified in the response.
- `"Marker"`: The pagination token provided in the previous request. If this parameter is
specified the response includes only records beyond the marker, up to 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_dbinstance_automated_backups(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeDBInstanceAutomatedBackups";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_dbinstance_automated_backups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeDBInstanceAutomatedBackups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dbinstances()
describe_dbinstances(params::Dict{String,<:Any})
Describes provisioned RDS instances. This API supports pagination. This operation can also
return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBInstanceIdentifier"`: The user-supplied instance identifier or the Amazon Resource
Name (ARN) of the DB instance. If this parameter is specified, information from only the
specific DB instance is returned. This parameter isn't case-sensitive. Constraints: If
supplied, must match the identifier of an existing DB instance.
- `"Filters"`: A filter that specifies one or more DB instances to describe. Supported
Filters: db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource
Names (ARNs). The results list only includes information about the DB instances associated
with the DB clusters identified by these ARNs. db-instance-id - Accepts DB instance
identifiers and DB instance Amazon Resource Names (ARNs). The results list only includes
information about the DB instances identified by these ARNs. dbi-resource-id - Accepts
DB instance resource identifiers. The results list only includes information about the DB
instances identified by these DB instance resource identifiers. domain - Accepts Active
Directory directory IDs. The results list only includes information about the DB instances
associated with these domains. engine - Accepts engine names. The results list only
includes information about the DB instances for these engines.
- `"Marker"`: An optional pagination token provided by a previous DescribeDBInstances
request. If this parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, a pagination token called a marker is included
in the response so that you can retrieve the remaining results. Default: 100 Constraints:
Minimum 20, maximum 100.
"""
function describe_dbinstances(; aws_config::AbstractAWSConfig=global_aws_config())
return rds(
"DescribeDBInstances"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_dbinstances(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeDBInstances",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dblog_files(dbinstance_identifier)
describe_dblog_files(dbinstance_identifier, params::Dict{String,<:Any})
Returns a list of DB log files for the DB instance. This command doesn't apply to RDS
Custom.
# Arguments
- `dbinstance_identifier`: The customer-assigned name of the DB instance that contains the
log files you want to list. 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:
- `"FileLastWritten"`: Filters the available log files for files written since the
specified date, in POSIX timestamp format with milliseconds.
- `"FileSize"`: Filters the available log files for files larger than the specified size.
- `"FilenameContains"`: Filters the available log files for log file names that contain the
specified string.
- `"Filters"`: This parameter isn't currently supported.
- `"Marker"`: The pagination token provided in the previous request. If this parameter is
specified the response includes only records beyond the marker, up to MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, a pagination token called a marker is included
in the response so you can retrieve the remaining results.
"""
function describe_dblog_files(
DBInstanceIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeDBLogFiles",
Dict{String,Any}("DBInstanceIdentifier" => DBInstanceIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_dblog_files(
DBInstanceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"DescribeDBLogFiles",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBInstanceIdentifier" => DBInstanceIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dbparameter_groups()
describe_dbparameter_groups(params::Dict{String,<:Any})
Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified,
the list will contain only the description of the specified DB parameter group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBParameterGroupName"`: The name of a specific DB parameter group to return details
for. Constraints: If supplied, must match the name of an existing
DBClusterParameterGroup.
- `"Filters"`: This parameter isn't currently supported.
- `"Marker"`: An optional pagination token provided by a previous DescribeDBParameterGroups
request. If this parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, a pagination token called a marker is included
in the response so that you can retrieve the remaining results. Default: 100 Constraints:
Minimum 20, maximum 100.
"""
function describe_dbparameter_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return rds(
"DescribeDBParameterGroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_dbparameter_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeDBParameterGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dbparameters(dbparameter_group_name)
describe_dbparameters(dbparameter_group_name, params::Dict{String,<:Any})
Returns the detailed parameter list for a particular DB parameter group.
# Arguments
- `dbparameter_group_name`: The name of a specific DB parameter group to return details
for. Constraints: If supplied, must match the name of an existing DBParameterGroup.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: This parameter isn't currently supported.
- `"Marker"`: An optional pagination token provided by a previous DescribeDBParameters
request. If this parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, a pagination token called a marker is included
in the response so that you can retrieve the remaining results. Default: 100 Constraints:
Minimum 20, maximum 100.
- `"Source"`: The parameter types to return. Default: All parameter types returned Valid
Values: user | system | engine-default
"""
function describe_dbparameters(
DBParameterGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeDBParameters",
Dict{String,Any}("DBParameterGroupName" => DBParameterGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_dbparameters(
DBParameterGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"DescribeDBParameters",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBParameterGroupName" => DBParameterGroupName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dbproxies()
describe_dbproxies(params::Dict{String,<:Any})
Returns information about DB proxies.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBProxyName"`: The name of the DB proxy. If you omit this parameter, the output
includes information about all DB proxies owned by your Amazon Web Services account ID.
- `"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 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_dbproxies(; aws_config::AbstractAWSConfig=global_aws_config())
return rds("DescribeDBProxies"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_dbproxies(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeDBProxies", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_dbproxy_endpoints()
describe_dbproxy_endpoints(params::Dict{String,<:Any})
Returns information about DB proxy endpoints.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBProxyEndpointName"`: The name of a DB proxy endpoint to describe. If you omit this
parameter, the output includes information about all DB proxy endpoints associated with the
specified proxy.
- `"DBProxyName"`: The name of the DB proxy whose endpoints you want to describe. If you
omit this parameter, the output includes information about all DB proxy endpoints
associated with all your DB proxies.
- `"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 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_dbproxy_endpoints(; aws_config::AbstractAWSConfig=global_aws_config())
return rds(
"DescribeDBProxyEndpoints"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_dbproxy_endpoints(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeDBProxyEndpoints",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dbproxy_target_groups(dbproxy_name)
describe_dbproxy_target_groups(dbproxy_name, params::Dict{String,<:Any})
Returns information about DB proxy target groups, represented by DBProxyTargetGroup data
structures.
# Arguments
- `dbproxy_name`: The identifier of the DBProxy associated with the target group.
# 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 called a marker is included
in the response so that the remaining results can be retrieved. Default: 100 Constraints:
Minimum 20, maximum 100.
- `"TargetGroupName"`: The identifier of the DBProxyTargetGroup to describe.
"""
function describe_dbproxy_target_groups(
DBProxyName; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeDBProxyTargetGroups",
Dict{String,Any}("DBProxyName" => DBProxyName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_dbproxy_target_groups(
DBProxyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"DescribeDBProxyTargetGroups",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DBProxyName" => DBProxyName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dbproxy_targets(dbproxy_name)
describe_dbproxy_targets(dbproxy_name, params::Dict{String,<:Any})
Returns information about DBProxyTarget objects. This API supports pagination.
# Arguments
- `dbproxy_name`: The identifier of the DBProxyTarget to describe.
# 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 called a marker is included
in the response so that the remaining results can be retrieved. Default: 100 Constraints:
Minimum 20, maximum 100.
- `"TargetGroupName"`: The identifier of the DBProxyTargetGroup to describe.
"""
function describe_dbproxy_targets(
DBProxyName; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeDBProxyTargets",
Dict{String,Any}("DBProxyName" => DBProxyName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_dbproxy_targets(
DBProxyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"DescribeDBProxyTargets",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DBProxyName" => DBProxyName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dbrecommendations()
describe_dbrecommendations(params::Dict{String,<:Any})
Describes the recommendations to resolve the issues for your DB instances, DB clusters, and
DB parameter groups.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: A filter that specifies one or more recommendations to describe. Supported
Filters: recommendation-id - Accepts a list of recommendation identifiers. The results
list only includes the recommendations whose identifier is one of the specified filter
values. status - Accepts a list of recommendation statuses. Valid values: active -
The recommendations which are ready for you to apply. pending - The applied or scheduled
recommendations which are in progress. resolved - The recommendations which are
completed. dismissed - The recommendations that you dismissed. The results list only
includes the recommendations whose status is one of the specified filter values.
severity - Accepts a list of recommendation severities. The results list only includes the
recommendations whose severity is one of the specified filter values. Valid values: high
medium low informational type-id - Accepts a list of recommendation type
identifiers. The results list only includes the recommendations whose type is one of the
specified filter values. dbi-resource-id - Accepts a list of database resource
identifiers. The results list only includes the recommendations that generated for the
specified databases. cluster-resource-id - Accepts a list of cluster resource
identifiers. The results list only includes the recommendations that generated for the
specified clusters. pg-arn - Accepts a list of parameter group ARNs. The results list
only includes the recommendations that generated for the specified parameter groups.
cluster-pg-arn - Accepts a list of cluster parameter group ARNs. The results list only
includes the recommendations that generated for the specified cluster parameter groups.
- `"LastUpdatedAfter"`: A filter to include only the recommendations that were updated
after this specified time.
- `"LastUpdatedBefore"`: A filter to include only the recommendations that were updated
before this specified time.
- `"Locale"`: The language that you choose to return the list of recommendations. Valid
values: en en_UK de es fr id it ja ko pt_BR
zh_TW zh_CN
- `"Marker"`: An optional pagination token provided by a previous DescribeDBRecommendations
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 recommendations 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_dbrecommendations(; aws_config::AbstractAWSConfig=global_aws_config())
return rds(
"DescribeDBRecommendations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_dbrecommendations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeDBRecommendations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dbsecurity_groups()
describe_dbsecurity_groups(params::Dict{String,<:Any})
Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the
list will contain only the descriptions of the specified DB security group. EC2-Classic
was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we
recommend that you migrate as soon as possible. For more information, see Migrate from
EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is
Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in
the Amazon RDS User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBSecurityGroupName"`: The name of the DB security group to return details for.
- `"Filters"`: This parameter isn't currently supported.
- `"Marker"`: An optional pagination token provided by a previous DescribeDBSecurityGroups
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. Default: 100 Constraints:
Minimum 20, maximum 100.
"""
function describe_dbsecurity_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return rds(
"DescribeDBSecurityGroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_dbsecurity_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeDBSecurityGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dbshard_groups()
describe_dbshard_groups(params::Dict{String,<:Any})
Describes existing Aurora Limitless Database DB shard groups.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBShardGroupIdentifier"`: The user-supplied DB shard group identifier or the Amazon
Resource Name (ARN) of the DB shard group. If this parameter is specified, information for
only the specific DB shard group is returned. This parameter isn't case-sensitive.
Constraints: If supplied, must match an existing DB shard group identifier.
- `"Filters"`: A filter that specifies one or more DB shard groups to describe.
- `"Marker"`: An optional pagination token provided by a previous DescribeDBShardGroups
request. If this parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, a pagination token called a marker is included
in the response so you can retrieve the remaining results. Default: 100 Constraints:
Minimum 20, maximum 100
"""
function describe_dbshard_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return rds(
"DescribeDBShardGroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_dbshard_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeDBShardGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dbsnapshot_attributes(dbsnapshot_identifier)
describe_dbsnapshot_attributes(dbsnapshot_identifier, params::Dict{String,<:Any})
Returns a list of DB snapshot attribute names and values for a manual DB snapshot. When
sharing snapshots with other Amazon Web Services accounts, DescribeDBSnapshotAttributes
returns the restore attribute and a list of IDs for the Amazon Web Services accounts that
are authorized to copy or restore the manual DB snapshot. If all is included in the list of
values for the restore attribute, then the manual DB snapshot is public and can be copied
or restored by all Amazon Web Services accounts. To add or remove access for an Amazon Web
Services account to copy or restore a manual DB snapshot, or to make the manual DB snapshot
public or private, use the ModifyDBSnapshotAttribute API action.
# Arguments
- `dbsnapshot_identifier`: The identifier for the DB snapshot to describe the attributes
for.
"""
function describe_dbsnapshot_attributes(
DBSnapshotIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeDBSnapshotAttributes",
Dict{String,Any}("DBSnapshotIdentifier" => DBSnapshotIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_dbsnapshot_attributes(
DBSnapshotIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"DescribeDBSnapshotAttributes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBSnapshotIdentifier" => DBSnapshotIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dbsnapshot_tenant_databases()
describe_dbsnapshot_tenant_databases(params::Dict{String,<:Any})
Describes the tenant databases that exist in a DB snapshot. This command only applies to
RDS for Oracle DB instances in the multi-tenant configuration. You can use this command to
inspect the tenant databases within a snapshot before restoring it. You can't directly
interact with the tenant databases in a DB snapshot. If you restore a snapshot that was
taken from DB instance using the multi-tenant configuration, you restore all its tenant
databases.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBInstanceIdentifier"`: The ID of the DB instance used to create the DB snapshots. This
parameter isn't case-sensitive. Constraints: If supplied, must match the identifier of an
existing DBInstance.
- `"DBSnapshotIdentifier"`: The ID of a DB snapshot that contains the tenant databases to
describe. This value is stored as a lowercase string. Constraints: If you specify this
parameter, the value must match the ID of an existing DB snapshot. If you specify an
automatic snapshot, you must also specify SnapshotType.
- `"DbiResourceId"`: A specific DB resource identifier to describe.
- `"Filters"`: A filter that specifies one or more tenant databases to describe. Supported
filters: tenant-db-name - Tenant database names. The results list only includes
information about the tenant databases that match these tenant DB names.
tenant-database-resource-id - Tenant database resource identifiers. The results list only
includes information about the tenant databases contained within the DB snapshots.
dbi-resource-id - DB instance resource identifiers. The results list only includes
information about snapshots containing tenant databases contained within the DB instances
identified by these resource identifiers. db-instance-id - Accepts DB instance
identifiers and DB instance Amazon Resource Names (ARNs). db-snapshot-id - Accepts DB
snapshot identifiers. snapshot-type - Accepts types of DB snapshots.
- `"Marker"`: An optional pagination token provided by a previous
DescribeDBSnapshotTenantDatabases 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.
- `"SnapshotType"`: The type of DB snapshots to be returned. You can specify one of the
following values: automated – All DB snapshots that have been automatically taken by
Amazon RDS for my Amazon Web Services account. manual – All DB snapshots that have
been taken by my Amazon Web Services account. shared – All manual DB snapshots that
have been shared to my Amazon Web Services account. public – All DB snapshots that
have been marked as public. awsbackup – All DB snapshots managed by the Amazon Web
Services Backup service.
"""
function describe_dbsnapshot_tenant_databases(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeDBSnapshotTenantDatabases";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_dbsnapshot_tenant_databases(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeDBSnapshotTenantDatabases",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dbsnapshots()
describe_dbsnapshots(params::Dict{String,<:Any})
Returns information about DB snapshots. This API action supports pagination.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBInstanceIdentifier"`: The ID of the DB instance to retrieve the list of DB snapshots
for. This parameter isn't case-sensitive. Constraints: If supplied, must match the
identifier of an existing DBInstance.
- `"DBSnapshotIdentifier"`: A specific DB snapshot identifier to describe. This value is
stored as a lowercase string. Constraints: If supplied, must match the identifier of an
existing DBSnapshot. If this identifier is for an automated snapshot, the SnapshotType
parameter must also be specified.
- `"DbiResourceId"`: A specific DB resource ID to describe.
- `"Filters"`: A filter that specifies one or more DB snapshots to describe. Supported
filters: db-instance-id - Accepts DB instance identifiers and DB instance Amazon
Resource Names (ARNs). db-snapshot-id - Accepts DB snapshot identifiers.
dbi-resource-id - Accepts identifiers of source DB instances. snapshot-type - Accepts
types of DB snapshots. engine - Accepts names of database engines.
- `"IncludePublic"`: Specifies whether to include manual DB cluster snapshots that are
public and can be copied or restored by any Amazon Web Services account. By default, the
public snapshots are not included. You can share a manual DB snapshot as public by using
the ModifyDBSnapshotAttribute API. This setting doesn't apply to RDS Custom.
- `"IncludeShared"`: Specifies whether to include shared manual DB cluster snapshots from
other Amazon Web Services accounts that this Amazon Web Services account has been given
permission to copy or restore. By default, these snapshots are not included. You can give
an Amazon Web Services account permission to restore a manual DB snapshot from another
Amazon Web Services account by using the ModifyDBSnapshotAttribute API action. This setting
doesn't apply to RDS Custom.
- `"Marker"`: An optional pagination token provided by a previous DescribeDBSnapshots
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. Default: 100 Constraints:
Minimum 20, maximum 100.
- `"SnapshotType"`: The type of snapshots to be returned. You can specify one of the
following values: automated - Return all DB snapshots that have been automatically taken
by Amazon RDS for my Amazon Web Services account. manual - Return all DB snapshots that
have been taken by my Amazon Web Services account. shared - Return all manual DB
snapshots that have been shared to my Amazon Web Services account. public - Return all
DB snapshots that have been marked as public. awsbackup - Return the DB snapshots
managed by the Amazon Web Services Backup service. For information about Amazon Web
Services Backup, see the Amazon Web Services Backup Developer Guide. The awsbackup type
does not apply to Aurora. If you don't specify a SnapshotType value, then both automated
and manual snapshots are returned. Shared and public DB snapshots are not included in the
returned results by default. You can include shared snapshots with these results by
enabling the IncludeShared parameter. You can include public snapshots with these results
by enabling the IncludePublic parameter. 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_dbsnapshots(; aws_config::AbstractAWSConfig=global_aws_config())
return rds(
"DescribeDBSnapshots"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_dbsnapshots(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeDBSnapshots",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dbsubnet_groups()
describe_dbsubnet_groups(params::Dict{String,<:Any})
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list
will contain only the descriptions of the specified DBSubnetGroup. For an overview of CIDR
ranges, go to the Wikipedia Tutorial.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBSubnetGroupName"`: The name of the DB subnet group to return details for.
- `"Filters"`: This parameter isn't currently supported.
- `"Marker"`: An optional pagination token provided by a previous DescribeDBSubnetGroups
request. If this parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, a pagination token called a marker is included
in the response so that you can retrieve the remaining results. Default: 100 Constraints:
Minimum 20, maximum 100.
"""
function describe_dbsubnet_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return rds(
"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 rds(
"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. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon
Aurora User Guide.
# Arguments
- `dbparameter_group_family`: The name of the DB cluster parameter group family to return
engine parameter information for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: This parameter isn't currently supported.
- `"Marker"`: An optional pagination token provided by a previous
DescribeEngineDefaultClusterParameters request. If this parameter is specified, the
response includes only records beyond the marker, up to the value specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, a pagination token called a marker is included
in the response so you can retrieve the remaining results. Default: 100 Constraints:
Minimum 20, maximum 100.
"""
function describe_engine_default_cluster_parameters(
DBParameterGroupFamily; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"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 rds(
"DescribeEngineDefaultClusterParameters",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBParameterGroupFamily" => DBParameterGroupFamily),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_engine_default_parameters(dbparameter_group_family)
describe_engine_default_parameters(dbparameter_group_family, params::Dict{String,<:Any})
Returns the default engine and system parameter information for the specified database
engine.
# Arguments
- `dbparameter_group_family`: The name of the DB parameter group family. Valid Values:
aurora-mysql5.7 aurora-mysql8.0 aurora-postgresql10 aurora-postgresql11
aurora-postgresql12 aurora-postgresql13 aurora-postgresql14 custom-oracle-ee-19
custom-oracle-ee-cdb-19 db2-ae db2-se mariadb10.2 mariadb10.3
mariadb10.4 mariadb10.5 mariadb10.6 mysql5.7 mysql8.0 oracle-ee-19
oracle-ee-cdb-19 oracle-ee-cdb-21 oracle-se2-19 oracle-se2-cdb-19
oracle-se2-cdb-21 postgres10 postgres11 postgres12 postgres13
postgres14 sqlserver-ee-11.0 sqlserver-ee-12.0 sqlserver-ee-13.0
sqlserver-ee-14.0 sqlserver-ee-15.0 sqlserver-ex-11.0 sqlserver-ex-12.0
sqlserver-ex-13.0 sqlserver-ex-14.0 sqlserver-ex-15.0 sqlserver-se-11.0
sqlserver-se-12.0 sqlserver-se-13.0 sqlserver-se-14.0 sqlserver-se-15.0
sqlserver-web-11.0 sqlserver-web-12.0 sqlserver-web-13.0 sqlserver-web-14.0
sqlserver-web-15.0
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: This parameter isn't currently supported.
- `"Marker"`: An optional pagination token provided by a previous
DescribeEngineDefaultParameters request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, a pagination token called a marker is included
in the response so you can retrieve the remaining results. Default: 100 Constraints:
Minimum 20, maximum 100.
"""
function describe_engine_default_parameters(
DBParameterGroupFamily; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeEngineDefaultParameters",
Dict{String,Any}("DBParameterGroupFamily" => DBParameterGroupFamily);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_engine_default_parameters(
DBParameterGroupFamily,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"DescribeEngineDefaultParameters",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBParameterGroupFamily" => DBParameterGroupFamily),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_event_categories()
describe_event_categories(params::Dict{String,<:Any})
Displays a list of categories for all event source types, or, if specified, for a specified
source type. You can also see this list in the \"Amazon RDS event categories and event
messages\" section of the Amazon RDS User Guide or the Amazon Aurora User Guide .
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: This parameter isn't currently supported.
- `"SourceType"`: The type of source that is generating the events. For RDS Proxy events,
specify db-proxy. Valid Values: db-instance | db-cluster | db-parameter-group |
db-security-group | db-snapshot | db-cluster-snapshot | db-proxy
"""
function describe_event_categories(; aws_config::AbstractAWSConfig=global_aws_config())
return rds(
"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 rds(
"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 isn't currently supported.
- `"Marker"`: An optional pagination token provided by a previous
DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords .
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, a pagination token called a marker is included
in the response so that you can retrieve the remaining results. Default: 100 Constraints:
Minimum 20, maximum 100.
- `"SubscriptionName"`: The name of the RDS event notification subscription you want to
describe.
"""
function describe_event_subscriptions(; aws_config::AbstractAWSConfig=global_aws_config())
return rds(
"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 rds(
"DescribeEventSubscriptions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_events()
describe_events(params::Dict{String,<:Any})
Returns events related to DB instances, DB clusters, DB parameter groups, DB security
groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. Events
specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB
snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by providing the name as
a parameter. For more information on working with events, see Monitoring Amazon RDS events
in the Amazon RDS User Guide and Monitoring Amazon Aurora events in the Amazon Aurora User
Guide. By default, RDS returns events that were generated in the past hour.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Duration"`: The number of minutes to retrieve events for. Default: 60
- `"EndTime"`: The end of the time interval for which to retrieve events, specified in ISO
8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
- `"EventCategories"`: A list of event categories that trigger notifications for a event
notification subscription.
- `"Filters"`: This parameter isn't currently supported.
- `"Marker"`: An optional pagination token provided by a previous DescribeEvents request.
If this parameter is specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, a pagination token called a marker is included
in the response so that you can retrieve the remaining results. Default: 100 Constraints:
Minimum 20, maximum 100.
- `"SourceIdentifier"`: The identifier of the event source for which events are returned.
If not specified, then all sources are included in the response. Constraints: If
SourceIdentifier is supplied, SourceType must also be provided. If the source type is a
DB instance, a DBInstanceIdentifier value must be supplied. If the source type is a DB
cluster, a DBClusterIdentifier value must be supplied. If the source type is a DB
parameter group, a DBParameterGroupName value must be supplied. If the source type is a
DB security group, a DBSecurityGroupName value must be supplied. If the source type is a
DB snapshot, a DBSnapshotIdentifier value must be supplied. If the source type is a DB
cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied. If the source
type is an RDS Proxy, a DBProxyName value must be supplied. Can't end with a hyphen or
contain two consecutive hyphens.
- `"SourceType"`: The event source to retrieve events for. If no value is specified, all
events are returned.
- `"StartTime"`: The beginning of the time interval to retrieve events for, specified in
ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
"""
function describe_events(; aws_config::AbstractAWSConfig=global_aws_config())
return rds("DescribeEvents"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_events(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeEvents", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_export_tasks()
describe_export_tasks(params::Dict{String,<:Any})
Returns information about a snapshot or cluster export to Amazon S3. This API operation
supports pagination.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExportTaskIdentifier"`: The identifier of the snapshot or cluster export task to be
described.
- `"Filters"`: Filters specify one or more snapshot or cluster exports to describe. The
filters are specified as name-value pairs that define what to include in the output. Filter
names and values are case-sensitive. Supported filters include the following:
export-task-identifier - An identifier for the snapshot or cluster export task.
s3-bucket - The Amazon S3 bucket the data is exported to. source-arn - The Amazon
Resource Name (ARN) of the snapshot or cluster exported to Amazon S3. status - The
status of the export task. Must be lowercase. Valid statuses are the following: canceled
canceling complete failed in_progress starting
- `"Marker"`: An optional pagination token provided by a previous DescribeExportTasks
request. If you specify this parameter, the response includes only records beyond the
marker, up to the value specified by the MaxRecords parameter.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified value, a pagination token called a marker is included in the
response. You can use the marker in a later DescribeExportTasks request to retrieve the
remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
- `"SourceArn"`: The Amazon Resource Name (ARN) of the snapshot or cluster exported to
Amazon S3.
- `"SourceType"`: The type of source for the export.
"""
function describe_export_tasks(; aws_config::AbstractAWSConfig=global_aws_config())
return rds(
"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 rds(
"DescribeExportTasks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_global_clusters()
describe_global_clusters(params::Dict{String,<:Any})
Returns information about Aurora global database clusters. This API supports pagination.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora
User Guide. This action only applies to Aurora DB 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 database clusters to describe.
This parameter is case-sensitive. Currently, the only supported filter is region. If used,
the request returns information about any global cluster with at least one member (primary
or secondary) in the specified Amazon Web Services Regions.
- `"GlobalClusterIdentifier"`: The user-supplied DB cluster identifier. If this parameter
is specified, information from only the specific DB cluster is returned. This parameter
isn't case-sensitive. Constraints: If supplied, must match an existing
DBClusterIdentifier.
- `"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. Default: 100 Constraints:
Minimum 20, maximum 100.
"""
function describe_global_clusters(; aws_config::AbstractAWSConfig=global_aws_config())
return rds(
"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 rds(
"DescribeGlobalClusters",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_integrations()
describe_integrations(params::Dict{String,<:Any})
Describe one or more zero-ETL integrations with Amazon Redshift.
# 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.
- `"IntegrationIdentifier"`: The unique identifier of the integration.
- `"Marker"`: An optional pagination token provided by a previous DescribeIntegrations
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. Default: 100 Constraints:
Minimum 20, maximum 100.
"""
function describe_integrations(; aws_config::AbstractAWSConfig=global_aws_config())
return rds(
"DescribeIntegrations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_integrations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeIntegrations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_option_group_options(engine_name)
describe_option_group_options(engine_name, params::Dict{String,<:Any})
Describes all available options for the specified engine.
# Arguments
- `engine_name`: The name of the engine to describe options for. Valid Values: db2-ae
db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2
oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex
sqlserver-web
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: This parameter isn't currently supported.
- `"MajorEngineVersion"`: If specified, filters the results to include only options for the
specified major 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 you can retrieve the remaining results. Default: 100 Constraints:
Minimum 20, maximum 100.
"""
function describe_option_group_options(
EngineName; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeOptionGroupOptions",
Dict{String,Any}("EngineName" => EngineName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_option_group_options(
EngineName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"DescribeOptionGroupOptions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EngineName" => EngineName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_option_groups()
describe_option_groups(params::Dict{String,<:Any})
Describes the available option groups.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EngineName"`: A filter to only include option groups associated with this database
engine. Valid Values: db2-ae db2-se mariadb mysql oracle-ee
oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee
sqlserver-se sqlserver-ex sqlserver-web
- `"Filters"`: This parameter isn't currently supported.
- `"MajorEngineVersion"`: Filters the list of option groups to only include groups
associated with a specific database engine version. If specified, then EngineName must also
be specified.
- `"Marker"`: An optional pagination token provided by a previous DescribeOptionGroups
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. Default: 100 Constraints:
Minimum 20, maximum 100.
- `"OptionGroupName"`: The name of the option group to describe. Can't be supplied together
with EngineName or MajorEngineVersion.
"""
function describe_option_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return rds(
"DescribeOptionGroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_option_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeOptionGroups",
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})
Describes the orderable DB instance options for a specified DB engine.
# Arguments
- `engine`: The name of the database engine to describe DB instance options for. Valid
Values: aurora-mysql aurora-postgresql custom-oracle-ee custom-oracle-ee-cdb
custom-oracle-se2 custom-oracle-se2-cdb db2-ae db2-se mariadb mysql
oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres
sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AvailabilityZoneGroup"`: The Availability Zone group associated with a Local Zone.
Specify this parameter to retrieve available options for the Local Zones in the group. Omit
this parameter to show the available options in the specified Amazon Web Services Region.
This setting doesn't apply to RDS Custom DB instances.
- `"DBInstanceClass"`: A filter to include only the available options for the specified DB
instance class.
- `"EngineVersion"`: A filter to include only the available options for the specified
engine version.
- `"Filters"`: This parameter isn't currently supported.
- `"LicenseModel"`: A filter to include only the available options for the specified
license model. RDS Custom supports only the BYOL licensing model.
- `"Marker"`: An optional pagination token provided by a previous
DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, a pagination token called a marker is included
in the response so that you can retrieve the remaining results. Default: 100 Constraints:
Minimum 20, maximum 1000.
- `"Vpc"`: Specifies whether to show only VPC or non-VPC offerings. RDS Custom supports
only VPC offerings. RDS Custom supports only VPC offerings. If you describe non-VPC
offerings for RDS Custom, the output shows VPC offerings.
"""
function describe_orderable_dbinstance_options(
Engine; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"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 rds(
"DescribeOrderableDBInstanceOptions",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Engine" => Engine), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_pending_maintenance_actions()
describe_pending_maintenance_actions(params::Dict{String,<:Any})
Returns a list of resources (for example, DB instances) that have at least one pending
maintenance action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: A filter that specifies one or more resources to return pending maintenance
actions for. Supported filters: db-cluster-id - Accepts DB cluster identifiers and DB
cluster Amazon Resource Names (ARNs). The results list only includes pending maintenance
actions for the DB clusters identified by these ARNs. db-instance-id - Accepts DB
instance identifiers and DB instance ARNs. The results list only includes pending
maintenance actions for the DB instances identified by these ARNs.
- `"Marker"`: An optional pagination token provided by a previous
DescribePendingMaintenanceActions request. If this parameter is specified, the response
includes only records beyond the marker, up to a number of records specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, a pagination token called a marker is included
in the response so that you can retrieve the remaining results. 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 rds(
"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 rds(
"DescribePendingMaintenanceActions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_reserved_dbinstances()
describe_reserved_dbinstances(params::Dict{String,<:Any})
Returns information about reserved DB instances for this account, or about a specified
reserved DB instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBInstanceClass"`: The DB instance class filter value. Specify this parameter to show
only those reservations matching the specified DB instances class.
- `"Duration"`: The duration filter value, specified in years or seconds. Specify this
parameter to show only reservations for this duration. Valid Values: 1 | 3 | 31536000 |
94608000
- `"Filters"`: This parameter isn't currently supported.
- `"LeaseId"`: The lease identifier filter value. Specify this parameter to show only the
reservation that matches the specified lease ID. Amazon Web Services Support might request
the lease ID for an issue related to a reserved DB instance.
- `"Marker"`: An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the marker, up to the
value specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more than
the MaxRecords value is available, a pagination token called a marker is included in the
response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20,
maximum 100.
- `"MultiAZ"`: Specifies whether to show only those reservations that support Multi-AZ.
- `"OfferingType"`: The offering type filter value. Specify this parameter to show only the
available offerings matching the specified offering type. Valid Values: \"Partial Upfront\"
| \"All Upfront\" | \"No Upfront\"
- `"ProductDescription"`: The product description filter value. Specify this parameter to
show only those reservations matching the specified product description.
- `"ReservedDBInstanceId"`: The reserved DB instance identifier filter value. Specify this
parameter to show only the reservation that matches the specified reservation ID.
- `"ReservedDBInstancesOfferingId"`: The offering identifier filter value. Specify this
parameter to show only purchased reservations matching the specified offering identifier.
"""
function describe_reserved_dbinstances(; aws_config::AbstractAWSConfig=global_aws_config())
return rds(
"DescribeReservedDBInstances";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_reserved_dbinstances(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeReservedDBInstances",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_reserved_dbinstances_offerings()
describe_reserved_dbinstances_offerings(params::Dict{String,<:Any})
Lists available reserved DB instance offerings.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBInstanceClass"`: The DB instance class filter value. Specify this parameter to show
only the available offerings matching the specified DB instance class.
- `"Duration"`: Duration filter value, specified in years or seconds. Specify this
parameter to show only reservations for this duration. Valid Values: 1 | 3 | 31536000 |
94608000
- `"Filters"`: This parameter isn't 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 than
the MaxRecords value is available, a pagination token called a marker is included in the
response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20,
maximum 100.
- `"MultiAZ"`: Specifies whether to show only those reservations that support Multi-AZ.
- `"OfferingType"`: The offering type filter value. Specify this parameter to show only the
available offerings matching the specified offering type. Valid Values: \"Partial Upfront\"
| \"All Upfront\" | \"No Upfront\"
- `"ProductDescription"`: Product description filter value. Specify this parameter to show
only the available offerings that contain the specified product description. The results
show offerings that partially match the filter value.
- `"ReservedDBInstancesOfferingId"`: The offering identifier filter value. Specify this
parameter to show only the available offering that matches the specified reservation
identifier. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
"""
function describe_reserved_dbinstances_offerings(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeReservedDBInstancesOfferings";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_reserved_dbinstances_offerings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeReservedDBInstancesOfferings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_source_regions()
describe_source_regions(params::Dict{String,<:Any})
Returns a list of the source Amazon Web Services Regions where the current Amazon Web
Services Region can create a read replica, copy a DB snapshot from, or replicate automated
backups from. Use this operation to determine whether cross-Region features are supported
between other Regions and your current Region. This operation supports pagination. To
return information about the Regions that are enabled for your account, or all Regions, use
the EC2 operation DescribeRegions. For more information, see DescribeRegions in the Amazon
EC2 API Reference.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: This parameter isn't currently supported.
- `"Marker"`: An optional pagination token provided by a previous DescribeSourceRegions
request. If this parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, a pagination token called a marker is included
in the response so you can retrieve the remaining results. Default: 100 Constraints:
Minimum 20, maximum 100.
- `"RegionName"`: The source Amazon Web Services Region name. For example, us-east-1.
Constraints: Must specify a valid Amazon Web Services Region name.
"""
function describe_source_regions(; aws_config::AbstractAWSConfig=global_aws_config())
return rds(
"DescribeSourceRegions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_source_regions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeSourceRegions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_tenant_databases()
describe_tenant_databases(params::Dict{String,<:Any})
Describes the tenant databases in a DB instance that uses the multi-tenant configuration.
Only RDS for Oracle CDB instances are supported.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBInstanceIdentifier"`: The user-supplied DB instance identifier, which must match the
identifier of an existing instance owned by the Amazon Web Services account. This parameter
isn't case-sensitive.
- `"Filters"`: A filter that specifies one or more database tenants to describe. Supported
filters: tenant-db-name - Tenant database names. The results list only includes
information about the tenant databases that match these tenant DB names.
tenant-database-resource-id - Tenant database resource identifiers. dbi-resource-id - DB
instance resource identifiers. The results list only includes information about the tenants
contained within the DB instances identified by these resource identifiers.
- `"Marker"`: An optional pagination token provided by a previous DescribeTenantDatabases
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.
- `"TenantDBName"`: The user-supplied tenant database name, which must match the name of an
existing tenant database on the specified DB instance owned by your Amazon Web Services
account. This parameter isn’t case-sensitive.
"""
function describe_tenant_databases(; aws_config::AbstractAWSConfig=global_aws_config())
return rds(
"DescribeTenantDatabases"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_tenant_databases(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeTenantDatabases",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_valid_dbinstance_modifications(dbinstance_identifier)
describe_valid_dbinstance_modifications(dbinstance_identifier, params::Dict{String,<:Any})
You can call DescribeValidDBInstanceModifications to learn what modifications you can make
to your DB instance. You can use this information when you call ModifyDBInstance. This
command doesn't apply to RDS Custom.
# Arguments
- `dbinstance_identifier`: The customer identifier or the ARN of your DB instance.
"""
function describe_valid_dbinstance_modifications(
DBInstanceIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DescribeValidDBInstanceModifications",
Dict{String,Any}("DBInstanceIdentifier" => DBInstanceIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_valid_dbinstance_modifications(
DBInstanceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"DescribeValidDBInstanceModifications",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBInstanceIdentifier" => DBInstanceIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_http_endpoint(resource_arn)
disable_http_endpoint(resource_arn, params::Dict{String,<:Any})
Disables the HTTP endpoint for the specified DB cluster. Disabling this endpoint disables
RDS Data API. For more information, see Using RDS Data API in the Amazon Aurora User Guide.
This operation applies only to Aurora PostgreSQL Serverless v2 and provisioned DB
clusters. To disable the HTTP endpoint for Aurora Serverless v1 DB clusters, use the
EnableHttpEndpoint parameter of the ModifyDBCluster operation.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the DB cluster.
"""
function disable_http_endpoint(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DisableHttpEndpoint",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_http_endpoint(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"DisableHttpEndpoint",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
download_dblog_file_portion(dbinstance_identifier, log_file_name)
download_dblog_file_portion(dbinstance_identifier, log_file_name, params::Dict{String,<:Any})
Downloads all or a portion of the specified log file, up to 1 MB in size. This command
doesn't apply to RDS Custom.
# Arguments
- `dbinstance_identifier`: The customer-assigned name of the DB instance that contains the
log files you want to list. Constraints: Must match the identifier of an existing
DBInstance.
- `log_file_name`: The name of the log file to be downloaded.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: The pagination token provided in the previous request or \"0\". If the Marker
parameter is specified the response includes only records beyond the marker until the end
of the file or up to NumberOfLines.
- `"NumberOfLines"`: The number of lines to download. If the number of lines specified
results in a file over 1 MB in size, the file is truncated at 1 MB in size. If the
NumberOfLines parameter is specified, then the block of lines returned can be from the
beginning or the end of the log file, depending on the value of the Marker parameter. If
neither Marker or NumberOfLines are specified, the entire log file is returned up to a
maximum of 10000 lines, starting with the most recent log entries first. If NumberOfLines
is specified and Marker isn't specified, then the most recent lines from the end of the log
file are returned. If Marker is specified as \"0\", then the specified number of lines
from the beginning of the log file are returned. You can download the log file in blocks
of lines by specifying the size of the block using the NumberOfLines parameter, and by
specifying a value of \"0\" for the Marker parameter in your first request. Include the
Marker value returned in the response as the Marker value for the next request, continuing
until the AdditionalDataPending response element returns false.
"""
function download_dblog_file_portion(
DBInstanceIdentifier, LogFileName; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"DownloadDBLogFilePortion",
Dict{String,Any}(
"DBInstanceIdentifier" => DBInstanceIdentifier, "LogFileName" => LogFileName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function download_dblog_file_portion(
DBInstanceIdentifier,
LogFileName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"DownloadDBLogFilePortion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBInstanceIdentifier" => DBInstanceIdentifier,
"LogFileName" => LogFileName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_http_endpoint(resource_arn)
enable_http_endpoint(resource_arn, params::Dict{String,<:Any})
Enables the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.
When enabled, this endpoint provides a connectionless web service API (RDS Data API) for
running SQL queries on the Aurora DB cluster. You can also query your database from inside
the RDS console with the RDS query editor. For more information, see Using RDS Data API in
the Amazon Aurora User Guide. This operation applies only to Aurora PostgreSQL Serverless
v2 and provisioned DB clusters. To enable the HTTP endpoint for Aurora Serverless v1 DB
clusters, use the EnableHttpEndpoint parameter of the ModifyDBCluster operation.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the DB cluster.
"""
function enable_http_endpoint(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"EnableHttpEndpoint",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_http_endpoint(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"EnableHttpEndpoint",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
failover_dbcluster(dbcluster_identifier)
failover_dbcluster(dbcluster_identifier, params::Dict{String,<:Any})
Forces a failover for a DB cluster. For an Aurora DB cluster, failover for a DB cluster
promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the
primary DB instance (the cluster writer). For a Multi-AZ DB cluster, after RDS terminates
the primary DB instance, the internal monitoring system detects that the primary DB
instance is unhealthy and promotes a readable standby (read-only instances) in the DB
cluster to be the primary DB instance (the cluster writer). Failover times are typically
less than 35 seconds. An Amazon Aurora DB cluster automatically fails over to an Aurora
Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster
automatically fails over to a readable standby DB instance when the primary DB instance
fails. To simulate a failure of a primary instance for testing, you can force a failover.
Because each instance in a DB cluster has its own endpoint address, make sure to clean up
and re-establish any existing connections that use those endpoint addresses when the
failover is complete. For more information on Amazon Aurora DB clusters, see What is
Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB
clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
# Arguments
- `dbcluster_identifier`: The identifier of the DB cluster to force a failover for. This
parameter isn't case-sensitive. Constraints: Must match the identifier of an existing DB
cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"TargetDBInstanceIdentifier"`: The name of the DB instance to promote to the primary DB
instance. Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable
standby in the DB cluster, for example mydbcluster-replica1. This setting isn't supported
for RDS for MySQL Multi-AZ DB clusters.
"""
function failover_dbcluster(
DBClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"FailoverDBCluster",
Dict{String,Any}("DBClusterIdentifier" => DBClusterIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function failover_dbcluster(
DBClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"FailoverDBCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBClusterIdentifier" => DBClusterIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
failover_global_cluster(global_cluster_identifier, target_db_cluster_identifier)
failover_global_cluster(global_cluster_identifier, target_db_cluster_identifier, params::Dict{String,<:Any})
Promotes the specified secondary DB cluster to be the primary DB cluster in the global
database cluster to fail over or switch over a global database. Switchover operations were
previously called \"managed planned failovers.\" Although this operation can be used
either to fail over or to switch over a global database cluster, its intended use is for
global database failover. To switch over a global database cluster, we recommend that you
use the SwitchoverGlobalCluster operation instead. How you use this operation depends on
whether you are failing over or switching over your global database cluster: Failing over
- Specify the AllowDataLoss parameter and don't specify the Switchover parameter.
Switching over - Specify the Switchover parameter or omit it, but don't specify the
AllowDataLoss parameter. About failing over and switching over While failing over and
switching over a global database cluster both change the primary DB cluster, you use these
operations for different reasons: Failing over - Use this operation to respond to an
unplanned event, such as a Regional disaster in the primary Region. Failing over can result
in a loss of write transaction data that wasn't replicated to the chosen secondary before
the failover event occurred. However, the recovery process that promotes a DB instance on
the chosen seconday DB cluster to be the primary writer DB instance guarantees that the
data is in a transactionally consistent state. For more information about failing over an
Amazon Aurora global database, see Performing managed failovers for Aurora global databases
in the Amazon Aurora User Guide. Switching over - Use this operation on a healthy global
database cluster for planned events, such as Regional rotation or to fail back to the
original primary DB cluster after a failover operation. With this operation, there is no
data loss. For more information about switching over an Amazon Aurora global database, see
Performing switchovers for Aurora global databases in the Amazon Aurora User Guide.
# Arguments
- `global_cluster_identifier`: The identifier of the global database cluster (Aurora global
database) this operation should apply to. The identifier is the unique key assigned by the
user when the Aurora global database is created. In other words, it's the name of the
Aurora global database. Constraints: Must match the identifier of an existing global
database cluster.
- `target_db_cluster_identifier`: The identifier of the secondary Aurora DB cluster that
you want to promote to the primary for the global database cluster. Use the Amazon Resource
Name (ARN) for the identifier so that Aurora can locate the cluster in its Amazon Web
Services Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllowDataLoss"`: Specifies whether to allow data loss for this global database cluster
operation. Allowing data loss triggers a global failover operation. If you don't specify
AllowDataLoss, the global database cluster operation defaults to a switchover. Constraints:
Can't be specified together with the Switchover parameter.
- `"Switchover"`: Specifies whether to switch over this global database cluster.
Constraints: Can't be specified together with the AllowDataLoss parameter.
"""
function failover_global_cluster(
GlobalClusterIdentifier,
TargetDbClusterIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"FailoverGlobalCluster",
Dict{String,Any}(
"GlobalClusterIdentifier" => GlobalClusterIdentifier,
"TargetDbClusterIdentifier" => TargetDbClusterIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function failover_global_cluster(
GlobalClusterIdentifier,
TargetDbClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"FailoverGlobalCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GlobalClusterIdentifier" => GlobalClusterIdentifier,
"TargetDbClusterIdentifier" => TargetDbClusterIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_name)
list_tags_for_resource(resource_name, params::Dict{String,<:Any})
Lists all tags on an Amazon RDS resource. For an overview on tagging an Amazon RDS
resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
# Arguments
- `resource_name`: The Amazon RDS resource with tags to be listed. This value is an Amazon
Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for
Amazon RDS in the Amazon RDS User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: This parameter isn't currently supported.
"""
function list_tags_for_resource(
ResourceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"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 rds(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceName" => ResourceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_activity_stream()
modify_activity_stream(params::Dict{String,<:Any})
Changes the audit policy state of a database activity stream to either locked (default) or
unlocked. A locked policy is read-only, whereas an unlocked policy is read/write. If your
activity stream is started and locked, you can unlock it, customize your audit policy, and
then lock your activity stream. Restarting the activity stream isn't required. For more
information, see Modifying a database activity stream in the Amazon RDS User Guide. This
operation is supported for RDS for Oracle and Microsoft SQL Server.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AuditPolicyState"`: The audit policy state. When a policy is unlocked, it is
read/write. When it is locked, it is read-only. You can edit your audit policy only when
the activity stream is unlocked or stopped.
- `"ResourceArn"`: The Amazon Resource Name (ARN) of the RDS for Oracle or Microsoft SQL
Server DB instance. For example, arn:aws:rds:us-east-1:12345667890:db:my-orcl-db.
"""
function modify_activity_stream(; aws_config::AbstractAWSConfig=global_aws_config())
return rds(
"ModifyActivityStream"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function modify_activity_stream(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"ModifyActivityStream",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_certificates()
modify_certificates(params::Dict{String,<:Any})
Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS)
certificate for Amazon RDS for new DB instances, or remove the override. By using this
operation, you can specify an RDS-approved SSL/TLS certificate for new DB instances that is
different from the default certificate provided by RDS. You can also use this operation to
remove the override, so that new DB instances use the default certificate provided by RDS.
You might need to override the default certificate in the following situations: You
already migrated your applications to support the latest certificate authority (CA)
certificate, but the new CA certificate is not yet the RDS default CA certificate for the
specified Amazon Web Services Region. RDS has already moved to a new default CA
certificate for the specified Amazon Web Services Region, but you are still in the process
of supporting the new CA certificate. In this case, you temporarily need additional time to
finish your application changes. For more information about rotating your SSL/TLS
certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate in the Amazon RDS
User Guide. For more information about rotating your SSL/TLS certificate for Aurora DB
engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CertificateIdentifier"`: The new default certificate identifier to override the current
one with. To determine the valid values, use the describe-certificates CLI command or the
DescribeCertificates API operation.
- `"RemoveCustomerOverride"`: Specifies whether to remove the override for the default
certificate. If the override is removed, the default certificate is the system default.
"""
function modify_certificates(; aws_config::AbstractAWSConfig=global_aws_config())
return rds("ModifyCertificates"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function modify_certificates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"ModifyCertificates", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
modify_current_dbcluster_capacity(dbcluster_identifier)
modify_current_dbcluster_capacity(dbcluster_identifier, params::Dict{String,<:Any})
Set the capacity of an Aurora Serverless v1 DB cluster to a specific value. Aurora
Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the
capacity might not scale fast enough to meet a sudden change in workload, such as a large
number of new transactions. Call ModifyCurrentDBClusterCapacity to set the capacity
explicitly. After this call sets the DB cluster capacity, Aurora Serverless v1 can
automatically scale the DB cluster based on the cooldown period for scaling up and the
cooldown period for scaling down. For more information about Aurora Serverless v1, see
Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide. If you call
ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that prevent
Aurora Serverless v1 from finding a scaling point might be dropped. For more information
about scaling points, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User
Guide. This operation only applies to Aurora Serverless v1 DB clusters.
# Arguments
- `dbcluster_identifier`: The DB cluster identifier for the cluster being modified. This
parameter isn't case-sensitive. Constraints: Must match the identifier of an existing DB
cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Capacity"`: The DB cluster capacity. When you change the capacity of a paused Aurora
Serverless v1 DB cluster, it automatically resumes. Constraints: For Aurora MySQL, valid
capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. For Aurora PostgreSQL, valid
capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.
- `"SecondsBeforeTimeout"`: The amount of time, in seconds, that Aurora Serverless v1 tries
to find a scaling point to perform seamless scaling before enforcing the timeout action.
The default is 300. Specify a value between 10 and 600 seconds.
- `"TimeoutAction"`: The action to take when the timeout is reached, either
ForceApplyCapacityChange or RollbackCapacityChange. ForceApplyCapacityChange, the default,
sets the capacity to the specified value as soon as possible. RollbackCapacityChange
ignores the capacity change if a scaling point isn't found in the timeout period.
"""
function modify_current_dbcluster_capacity(
DBClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"ModifyCurrentDBClusterCapacity",
Dict{String,Any}("DBClusterIdentifier" => DBClusterIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_current_dbcluster_capacity(
DBClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"ModifyCurrentDBClusterCapacity",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBClusterIdentifier" => DBClusterIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_custom_dbengine_version(engine, engine_version)
modify_custom_dbengine_version(engine, engine_version, params::Dict{String,<:Any})
Modifies the status of a custom engine version (CEV). You can find CEVs to modify by
calling DescribeDBEngineVersions. The MediaImport service that imports files from Amazon
S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data
logging for Amazon RDS in CloudTrail, calls to the ModifyCustomDbEngineVersion event aren't
logged. However, you might see calls from the API gateway that accesses your Amazon S3
bucket. These calls originate from the MediaImport service for the
ModifyCustomDbEngineVersion event. For more information, see Modifying CEV status in the
Amazon RDS User Guide.
# Arguments
- `engine`: The database engine. RDS Custom for Oracle supports the following values:
custom-oracle-ee custom-oracle-ee-cdb custom-oracle-se2 custom-oracle-se2-cdb
- `engine_version`: The custom engine version (CEV) that you want to modify. This option is
required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine
and EngineVersion is unique per customer per Amazon Web Services Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: An optional description of your CEV.
- `"Status"`: The availability status to be assigned to the CEV. Valid values are as
follows: available You can use this CEV to create a new RDS Custom DB instance. inactive
You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. You
can't patch or create new instances with this CEV. You can change any status to any
status. A typical reason to change status is to prevent the accidental use of a CEV, or to
make a deprecated CEV eligible for use again. For example, you might change the status of
your CEV from available to inactive, and from inactive back to available. To change the
availability status of the CEV, it must not currently be in use by an RDS Custom instance,
snapshot, or automated backup.
"""
function modify_custom_dbengine_version(
Engine, EngineVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"ModifyCustomDBEngineVersion",
Dict{String,Any}("Engine" => Engine, "EngineVersion" => EngineVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_custom_dbengine_version(
Engine,
EngineVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"ModifyCustomDBEngineVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Engine" => Engine, "EngineVersion" => EngineVersion),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_dbcluster(dbcluster_identifier)
modify_dbcluster(dbcluster_identifier, params::Dict{String,<:Any})
Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster. You can
change one or more settings by specifying these parameters and the new values in the
request. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in
the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ
DB cluster deployments in the Amazon RDS User Guide.
# Arguments
- `dbcluster_identifier`: The DB cluster identifier for the cluster being modified. This
parameter isn't case-sensitive. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB
clusters Constraints: Must match the identifier of an existing DB cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllocatedStorage"`: The amount of storage in gibibytes (GiB) to allocate to each DB
instance in the Multi-AZ DB cluster. Valid for Cluster Type: Multi-AZ DB clusters only
- `"AllowEngineModeChange"`: Specifies whether engine mode changes from serverless to
provisioned are allowed. Valid for Cluster Type: Aurora Serverless v1 DB clusters only
Constraints: You must allow engine mode changes when specifying a different value for the
EngineMode parameter from the DB cluster's current engine mode.
- `"AllowMajorVersionUpgrade"`: Specifies whether major version upgrades are allowed. Valid
for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters 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"`: Specifies whether the modifications in this request and any pending
modifications are asynchronously applied as soon as possible, regardless of the
PreferredMaintenanceWindow setting for the DB cluster. If this parameter is disabled,
changes to the DB cluster are applied during the next maintenance window. Most
modifications can be applied immediately or during the next scheduled maintenance window.
Some modifications, such as turning on deletion protection and changing the master
password, are applied immediately—regardless of when you choose to apply them. By
default, this parameter is disabled. Valid for Cluster Type: Aurora DB clusters and
Multi-AZ DB clusters
- `"AutoMinorVersionUpgrade"`: Specifies whether minor engine upgrades are applied
automatically to the DB cluster during the maintenance window. By default, minor engine
upgrades are applied automatically. Valid for Cluster Type: Multi-AZ DB clusters only
- `"AwsBackupRecoveryPointArn"`: The Amazon Resource Name (ARN) of the recovery point in
Amazon Web Services Backup.
- `"BacktrackWindow"`: The target backtrack window, in seconds. To disable backtracking,
set this value to 0. Valid for Cluster Type: Aurora MySQL DB clusters only Default: 0
Constraints: If specified, this value must be set to a number from 0 to 259,200 (72
hours).
- `"BackupRetentionPeriod"`: The number of days for which automated backups are retained.
Specify a minimum value of 1. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB
clusters Default: 1 Constraints: Must be a value from 1 to 35.
- `"CACertificateIdentifier"`: The CA certificate identifier to use for the DB cluster's
server certificate. For more information, see Using SSL/TLS to encrypt a connection to a DB
instance in the Amazon RDS User Guide. Valid for Cluster Type: Multi-AZ DB clusters
- `"CloudwatchLogsExportConfiguration"`: The configuration setting for the log types to be
enabled for export to CloudWatch Logs for a specific DB cluster. Valid for Cluster Type:
Aurora DB clusters and Multi-AZ DB clusters The following values are valid for each DB
engine: Aurora MySQL - audit | error | general | slowquery Aurora PostgreSQL -
postgresql RDS for MySQL - error | general | slowquery RDS for PostgreSQL -
postgresql | upgrade For more information about exporting CloudWatch Logs for Amazon
RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing
Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
- `"CopyTagsToSnapshot"`: Specifies whether to copy all tags from the DB cluster to
snapshots of the DB cluster. The default is not to copy them. Valid for Cluster Type:
Aurora DB clusters and Multi-AZ DB clusters
- `"DBClusterInstanceClass"`: The compute and memory capacity of each DB instance in the
Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available
in all Amazon Web Services Regions, or for all database engines. For the full list of DB
instance classes and availability for your engine, see DB Instance Class in the Amazon RDS
User Guide. Valid for Cluster Type: Multi-AZ DB clusters only
- `"DBClusterParameterGroupName"`: The name of the DB cluster parameter group to use for
the DB cluster. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
- `"DBInstanceParameterGroupName"`: The name of the DB parameter group to apply to all
instances of the DB cluster. When you apply a parameter group using the
DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also,
parameter changes are applied immediately rather than during the next maintenance window.
Valid for Cluster Type: Aurora DB clusters only Default: The existing name setting
Constraints: The DB parameter group must be in the same DB parameter group family as this
DB cluster. The DBInstanceParameterGroupName parameter is valid in combination with the
AllowMajorVersionUpgrade parameter for a major version upgrade only.
- `"DeletionProtection"`: Specifies whether the DB cluster has deletion protection enabled.
The database can't be deleted when deletion protection is enabled. By default, deletion
protection isn't enabled. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB
clusters
- `"Domain"`: The Active Directory directory ID to move the DB cluster to. Specify none to
remove the cluster from its current domain. The domain must be created prior to this
operation. For more information, see Kerberos Authentication in the Amazon Aurora User
Guide. Valid for Cluster Type: Aurora DB clusters only
- `"DomainIAMRoleName"`: The name of the IAM role to use when making API calls to the
Directory Service. Valid for Cluster Type: Aurora DB clusters only
- `"EnableGlobalWriteForwarding"`: Specifies whether to enable this DB cluster to forward
write operations to the primary cluster of a global cluster (Aurora global database). By
default, write operations are not allowed on Aurora DB clusters that are secondary clusters
in an Aurora global database. You can set this value only on Aurora DB clusters that are
members of an Aurora global database. With this parameter enabled, a secondary cluster can
forward writes to the current primary cluster, and the resulting changes are replicated
back to this cluster. For the primary DB cluster of an Aurora global database, this value
is used immediately if the primary is demoted by a global cluster API operation, but it
does nothing until then. Valid for Cluster Type: Aurora DB clusters only
- `"EnableHttpEndpoint"`: Specifies whether to enable the HTTP endpoint for an Aurora
Serverless v1 DB cluster. By default, the HTTP endpoint isn't enabled. When enabled, the
HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL
queries on the Aurora Serverless v1 DB cluster. You can also query your database from
inside the RDS console with the RDS query editor. For more information, see Using RDS Data
API in the Amazon Aurora User Guide. This parameter applies only to Aurora Serverless v1
DB clusters. To enable or disable the HTTP endpoint for an Aurora PostgreSQL Serverless v2
or provisioned DB cluster, use the EnableHttpEndpoint and DisableHttpEndpoint operations.
Valid for Cluster Type: Aurora DB clusters only
- `"EnableIAMDatabaseAuthentication"`: Specifies whether to enable mapping of Amazon Web
Services Identity and Access Management (IAM) accounts to database accounts. By default,
mapping isn't enabled. For more information, see IAM Database Authentication in the Amazon
Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only
- `"EnableLimitlessDatabase"`: Specifies whether to enable Aurora Limitless Database. You
must enable Aurora Limitless Database to create a DB shard group. Valid for: Aurora DB
clusters only
- `"EnableLocalWriteForwarding"`: Specifies whether read replicas can forward write
operations to the writer DB instance in the DB cluster. By default, write operations aren't
allowed on reader DB instances. Valid for: Aurora DB clusters only
- `"EnablePerformanceInsights"`: Specifies whether to turn on Performance Insights for the
DB cluster. For more information, see Using Amazon Performance Insights in the Amazon RDS
User Guide. Valid for Cluster Type: Multi-AZ DB clusters only
- `"EngineMode"`: The DB engine mode of the DB cluster, either provisioned or serverless.
The DB engine mode can be modified only from serverless to provisioned. For more
information, see CreateDBCluster. Valid for Cluster Type: Aurora DB clusters only
- `"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. If the cluster that you're
modifying has one or more read replicas, all replicas must be running an engine version
that's the same or later than the version you specify. To list all of the available engine
versions for Aurora MySQL, use the following command: aws rds describe-db-engine-versions
--engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\" To list all of the
available engine versions for Aurora PostgreSQL, use the following command: aws rds
describe-db-engine-versions --engine aurora-postgresql --query
\"DBEngineVersions[].EngineVersion\" To list all of the available engine versions for RDS
for MySQL, use the following command: aws rds describe-db-engine-versions --engine mysql
--query \"DBEngineVersions[].EngineVersion\" To list all of the available engine versions
for RDS for PostgreSQL, use the following command: aws rds describe-db-engine-versions
--engine postgres --query \"DBEngineVersions[].EngineVersion\" Valid for Cluster Type:
Aurora DB clusters and Multi-AZ DB clusters
- `"Iops"`: The amount of Provisioned IOPS (input/output operations per second) to be
initially allocated for each DB instance in the Multi-AZ DB cluster. For information about
valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only Constraints: Must be a multiple between
.5 and 50 of the storage amount for the DB cluster.
- `"ManageMasterUserPassword"`: Specifies whether to manage the master user password with
Amazon Web Services Secrets Manager. If the DB cluster doesn't manage the master user
password with Amazon Web Services Secrets Manager, you can turn on this management. In this
case, you can't specify MasterUserPassword. If the DB cluster already manages the master
user password with Amazon Web Services Secrets Manager, and you specify that the master
user password is not managed with Amazon Web Services Secrets Manager, then you must
specify MasterUserPassword. In this case, RDS deletes the secret and uses the new password
for the master user specified by MasterUserPassword. For more information, see Password
management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and
Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User
Guide. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
- `"MasterUserPassword"`: The new password for the master database user. Valid for Cluster
Type: Aurora DB clusters and Multi-AZ DB clusters Constraints: Must contain from 8 to 41
characters. Can contain any printable ASCII character except \"/\", \"\"\", or \"@\".
Can't be specified if ManageMasterUserPassword is turned on.
- `"MasterUserSecretKmsKeyId"`: The Amazon Web Services KMS key identifier to encrypt a
secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if both of the following conditions are met: The DB cluster
doesn't manage the master user password in Amazon Web Services Secrets Manager. If the DB
cluster already manages the master user password in Amazon Web Services Secrets Manager,
you can't change the KMS key that is used to encrypt the secret. You are turning on
ManageMasterUserPassword to manage the master user password in Amazon Web Services Secrets
Manager. If you are turning on ManageMasterUserPassword and don't specify
MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the
secret. If the secret is in a different Amazon Web Services account, then you can't use the
aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS
key. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or
alias name for the KMS key. To use a KMS key in a different Amazon Web Services account,
specify the key ARN or alias ARN. 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. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
- `"MonitoringInterval"`: The interval, in seconds, between points when Enhanced Monitoring
metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring
metrics, specify 0. If MonitoringRoleArn is specified, also set MonitoringInterval to a
value other than 0. Valid for Cluster Type: Multi-AZ DB clusters only Valid Values: 0 | 1 |
5 | 10 | 15 | 30 | 60 Default: 0
- `"MonitoringRoleArn"`: The Amazon Resource Name (ARN) for the IAM role that permits RDS
to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is
arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see
To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide. If
MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value. Valid
for Cluster Type: Multi-AZ DB clusters only
- `"NetworkType"`: The network type of the DB cluster. The network type is determined by
the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4
protocol or the IPv4 and the IPv6 protocols (DUAL). For more information, see Working with
a DB instance in a VPC in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB
clusters only Valid Values: IPV4 | DUAL
- `"NewDBClusterIdentifier"`: The new DB cluster identifier for the DB cluster when
renaming a DB cluster. This value is stored as a lowercase string. Valid for Cluster Type:
Aurora DB clusters and Multi-AZ DB clusters Constraints: Must contain from 1 to 63
letters, numbers, or hyphens. The first character must be a letter. Can't end with a
hyphen or contain two consecutive hyphens. Example: my-cluster2
- `"OptionGroupName"`: The option group to associate the DB cluster with. DB clusters are
associated with a default option group that can't be modified.
- `"PerformanceInsightsKMSKeyId"`: The Amazon Web Services KMS key identifier for
encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the
key ARN, key ID, alias ARN, or alias name for the KMS key. If you don't specify a value for
PerformanceInsightsKMSKeyId, then Amazon RDS 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. Valid for Cluster Type:
Multi-AZ DB clusters only
- `"PerformanceInsightsRetentionPeriod"`: The number of days to retain Performance Insights
data. Valid for Cluster Type: Multi-AZ DB clusters only Valid Values: 7 month * 31,
where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months *
31), 589 (19 months * 31) 731 Default: 7 days If you specify a retention period that
isn't valid, such as 94, Amazon RDS issues an error.
- `"Port"`: The port number on which the DB cluster accepts connections. Valid for Cluster
Type: Aurora DB clusters only Valid Values: 1150-65535 Default: The same port as the
original DB cluster.
- `"PreferredBackupWindow"`: The daily time range during which automated backups are
created if automated backups are enabled, using the BackupRetentionPeriod parameter. The
default is a 30-minute window selected at random from an 8-hour block of time for each
Amazon Web Services Region. To view the time blocks available, see Backup window in the
Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB
clusters 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). Valid for Cluster Type: Aurora DB clusters and
Multi-AZ DB clusters 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.
To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance
Window in the Amazon Aurora User Guide. Constraints: Must be in the format
ddd:hh24:mi-ddd:hh24:mi. Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun.
Must be in Universal Coordinated Time (UTC). Must be at least 30 minutes.
- `"RotateMasterUserPassword"`: Specifies whether to rotate the secret managed by Amazon
Web Services Secrets Manager for the master user password. This setting is valid only if
the master user password is managed by RDS in Amazon Web Services Secrets Manager for the
DB cluster. The secret value contains the updated password. For more information, see
Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide
and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User
Guide. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Constraints:
You must apply the change immediately when rotating the master user password.
- `"ScalingConfiguration"`: The scaling properties of the DB cluster. You can only modify
scaling properties for DB clusters in serverless DB engine mode. Valid for Cluster Type:
Aurora DB clusters only
- `"ServerlessV2ScalingConfiguration"`:
- `"StorageType"`: The storage type to associate with the DB cluster. For information on
storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB
clusters. For information on storage types for Multi-AZ DB clusters, see Settings for
creating Multi-AZ DB clusters. When specified for a Multi-AZ DB cluster, a value for the
Iops parameter is required. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB
clusters Valid Values: Aurora DB clusters - aurora | aurora-iopt1 Multi-AZ DB clusters
- io1 | io2 | gp3 Default: Aurora DB clusters - aurora Multi-AZ DB clusters - io1
- `"VpcSecurityGroupIds"`: A list of EC2 VPC security groups to associate with this DB
cluster. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
"""
function modify_dbcluster(
DBClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"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 rds(
"ModifyDBCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBClusterIdentifier" => DBClusterIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_dbcluster_endpoint(dbcluster_endpoint_identifier)
modify_dbcluster_endpoint(dbcluster_endpoint_identifier, params::Dict{String,<:Any})
Modifies the properties of an endpoint in an Amazon Aurora DB cluster. This operation only
applies to Aurora DB clusters.
# Arguments
- `dbcluster_endpoint_identifier`: The identifier of the endpoint to modify. This parameter
is stored as a lowercase string.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EndpointType"`: The type of the endpoint. One of: READER, WRITER, ANY.
- `"ExcludedMembers"`: List of DB instance identifiers that aren't part of the custom
endpoint group. All other eligible instances are reachable through the custom endpoint.
Only relevant if the list of static members is empty.
- `"StaticMembers"`: List of DB instance identifiers that are part of the custom endpoint
group.
"""
function modify_dbcluster_endpoint(
DBClusterEndpointIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"ModifyDBClusterEndpoint",
Dict{String,Any}("DBClusterEndpointIdentifier" => DBClusterEndpointIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_dbcluster_endpoint(
DBClusterEndpointIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"ModifyDBClusterEndpoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBClusterEndpointIdentifier" => DBClusterEndpointIdentifier
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_dbcluster_parameter_group(dbcluster_parameter_group_name, parameter)
modify_dbcluster_parameter_group(dbcluster_parameter_group_name, parameter, params::Dict{String,<:Any})
Modifies the parameters of a DB cluster parameter group. To modify more than one parameter,
submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum
of 20 parameters can be modified in a single request. After you create a DB cluster
parameter group, you should wait at least 5 minutes before creating your first DB cluster
that uses that DB cluster parameter group as the default parameter group. This allows
Amazon RDS to fully complete the create operation before the parameter group is used as the
default for a new DB cluster. This is especially important for parameters that are critical
when creating the default database for a DB cluster, such as the character set for the
default database defined by the character_set_database parameter. You can use the Parameter
Groups option of the Amazon RDS console or the DescribeDBClusterParameters operation to
verify that your DB cluster parameter group has been created or modified. If the modified
DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora applies the
update immediately. The cluster restart might interrupt your workload. In that case, your
application must reopen any connections and retry any transactions that were active when
the parameter changes took effect. For more information on Amazon Aurora DB clusters, see
What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB
clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
# Arguments
- `dbcluster_parameter_group_name`: The name of the DB cluster parameter group to modify.
- `parameter`: A list of parameters in the DB cluster parameter group to modify. Valid
Values (for the application method): immediate | pending-reboot You can use the immediate
value with dynamic parameters only. You can use the pending-reboot value for both dynamic
and static parameters. When the application method is immediate, changes to dynamic
parameters are applied immediately to the DB clusters associated with the parameter group.
When the application method is pending-reboot, changes to dynamic and static parameters are
applied after a reboot without failover to the DB clusters associated with the parameter
group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Parameters"`: A list of parameters in the DB cluster parameter group to modify. Valid
Values (for the application method): immediate | pending-reboot You can use the immediate
value with dynamic parameters only. You can use the pending-reboot value for both dynamic
and static parameters. When the application method is immediate, changes to dynamic
parameters are applied immediately to the DB clusters associated with the parameter group.
When the application method is pending-reboot, changes to dynamic and static parameters are
applied after a reboot without failover to the DB clusters associated with the parameter
group.
"""
function modify_dbcluster_parameter_group(
DBClusterParameterGroupName,
Parameter;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"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 rds(
"ModifyDBClusterParameterGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBClusterParameterGroupName" => DBClusterParameterGroupName,
"Parameter" => Parameter,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_dbcluster_snapshot_attribute(attribute_name, dbcluster_snapshot_identifier)
modify_dbcluster_snapshot_attribute(attribute_name, dbcluster_snapshot_identifier, params::Dict{String,<:Any})
Adds an attribute and values to, or removes an attribute and values from, a manual DB
cluster snapshot. To share a manual DB cluster snapshot with other Amazon 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
DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which
means that it can be copied or restored by all Amazon Web Services accounts. Don't add the
all value for any manual DB cluster snapshots that contain private information that you
don't want available to all Amazon Web Services accounts. If a manual DB 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. To view which Amazon Web Services accounts have access to copy or
restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot is public or
private, use the DescribeDBClusterSnapshotAttributes API operation. The accounts are
returned as values for the restore attribute.
# Arguments
- `attribute_name`: The name of the DB cluster snapshot attribute to modify. To manage
authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster
snapshot, set this value to restore. To view the list of attributes available to modify,
use the DescribeDBClusterSnapshotAttributes API operation.
- `dbcluster_snapshot_identifier`: The identifier for the DB cluster snapshot to modify the
attributes for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ValuesToAdd"`: A list of DB cluster snapshot attributes to add to the attribute
specified by AttributeName. To authorize other Amazon Web Services accounts to copy or
restore a manual DB cluster snapshot, set this list to include one or more Amazon Web
Services account IDs, or all to make the manual DB cluster snapshot restorable by any
Amazon Web Services account. Do not add the all value for any manual DB cluster snapshots
that contain private information that you don't want available to all Amazon Web Services
accounts.
- `"ValuesToRemove"`: A list of DB 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 DB cluster snapshot, set this list to include one or more
Amazon Web Services account identifiers, or all to remove authorization for any Amazon Web
Services account to copy or restore the DB cluster snapshot. 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 DB cluster snapshot.
"""
function modify_dbcluster_snapshot_attribute(
AttributeName,
DBClusterSnapshotIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"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 rds(
"ModifyDBClusterSnapshotAttribute",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AttributeName" => AttributeName,
"DBClusterSnapshotIdentifier" => DBClusterSnapshotIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_dbinstance(dbinstance_identifier)
modify_dbinstance(dbinstance_identifier, params::Dict{String,<:Any})
Modifies settings for a DB instance. You can change one or more database configuration
parameters by specifying these parameters and the new values in the request. To learn what
modifications you can make to your DB instance, call DescribeValidDBInstanceModifications
before you call ModifyDBInstance.
# Arguments
- `dbinstance_identifier`: The identifier of DB instance to modify. This value is stored as
a lowercase string. Constraints: Must match the identifier of an existing DB instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllocatedStorage"`: The new amount of storage in gibibytes (GiB) to allocate for the DB
instance. For RDS for Db2, MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL,
the value supplied must be at least 10% greater than the current value. Values that are not
at least 10% greater than the existing value are rounded up so that they are 10% greater
than the current value. For the valid values for allocated storage for each engine, see
CreateDBInstance. Constraints: When you increase the allocated storage for a DB instance
that uses Provisioned IOPS (gp3, io1, or io2 storage type), you must also specify the Iops
parameter. You can use the current value for Iops.
- `"AllowMajorVersionUpgrade"`: Specifies whether major version upgrades are allowed.
Changing this parameter doesn't result in an outage and the change is asynchronously
applied as soon as possible. This setting doesn't apply to RDS Custom DB instances.
Constraints: Major version upgrades must be allowed when specifying a value for the
EngineVersion parameter that's a different major version than the DB instance's current
version.
- `"ApplyImmediately"`: Specifies whether the modifications in this request and any pending
modifications are asynchronously applied as soon as possible, regardless of the
PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is
disabled. If this parameter is disabled, changes to the DB instance are applied during the
next maintenance window. Some parameter changes can cause an outage and are applied on the
next call to RebootDBInstance, or the next failure reboot. Review the table of parameters
in Modifying a DB Instance in the Amazon RDS User Guide to see the impact of enabling or
disabling ApplyImmediately for each modified parameter and to determine when the changes
are applied.
- `"AutoMinorVersionUpgrade"`: Specifies whether minor version upgrades are applied
automatically to the DB instance during the maintenance window. An outage occurs when all
the following conditions are met: The automatic upgrade is enabled for the maintenance
window. A newer minor version is available. RDS has enabled automatic patching for the
engine version. If any of the preceding conditions isn't met, Amazon RDS applies the
change as soon as possible and doesn't cause an outage. For an RDS Custom DB instance,
don't enable this setting. Otherwise, the operation returns an error.
- `"AutomationMode"`: The automation mode of the RDS Custom DB instance. If full, the DB
instance automates monitoring and instance recovery. If all paused, the instance pauses
automation for the duration set by ResumeFullAutomationModeMinutes.
- `"AwsBackupRecoveryPointArn"`: The Amazon Resource Name (ARN) of the recovery point in
Amazon Web Services Backup. This setting doesn't apply to RDS Custom DB instances.
- `"BackupRetentionPeriod"`: The number of days to retain automated backups. Setting this
parameter to a positive number enables backups. Setting this parameter to 0 disables
automated backups. Enabling and disabling backups can result in a brief I/O suspension
that lasts from a few seconds to a few minutes, depending on the size and class of your DB
instance. These changes are applied during the next maintenance window unless the
ApplyImmediately parameter is enabled for this request. If you change the parameter from
one non-zero value to another non-zero value, the change is asynchronously applied as soon
as possible. This setting doesn't apply to Amazon Aurora DB instances. The retention period
for automated backups is managed by the DB cluster. For more information, see
ModifyDBCluster. Default: Uses existing setting Constraints: Must be a value from 0 to
35. Can't be set to 0 if the DB instance is a source to read replicas. Can't be set to
0 for an RDS Custom for Oracle DB instance.
- `"CACertificateIdentifier"`: The CA certificate identifier to use for the DB instance's
server certificate. This setting doesn't apply to RDS Custom DB instances. For more
information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS
User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora
User Guide.
- `"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, follow the appropriate
instructions for your DB engine to rotate your SSL/TLS certificate: For more information
about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS
Certificate. in the Amazon RDS User Guide. For more information about rotating your
SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the
Amazon Aurora User Guide. This setting doesn't apply to RDS Custom DB instances.
- `"CloudwatchLogsExportConfiguration"`: The log types to be enabled for export to
CloudWatch Logs for a specific DB instance. A change to the
CloudwatchLogsExportConfiguration parameter is always applied to the DB instance
immediately. Therefore, the ApplyImmediately parameter has no effect. This setting doesn't
apply to RDS Custom DB instances.
- `"CopyTagsToSnapshot"`: Specifies whether to copy all tags from the DB instance to
snapshots of the DB instance. By default, tags aren't copied. This setting doesn't apply to
Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting
this value for an Aurora DB instance has no effect on the DB cluster setting. For more
information, see ModifyDBCluster.
- `"DBInstanceClass"`: The new compute and memory capacity of the DB instance, for example
db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions,
or for all database engines. For the full list of DB instance classes, and availability for
your engine, see DB Instance Class in the Amazon RDS User Guide or Aurora DB instance
classes in the Amazon Aurora User Guide. For RDS Custom, see DB instance class support for
RDS Custom for Oracle and DB instance class support for RDS Custom for SQL Server. If you
modify the DB instance class, an outage occurs during the change. The change is applied
during the next maintenance window, unless you specify ApplyImmediately in your request.
Default: Uses existing setting Constraints: If you are modifying the DB instance class
and upgrading the engine version at the same time, the currently running engine version
must be supported on the specified DB instance class. Otherwise, the operation returns an
error. In this case, first run the operation to upgrade the engine version, and then run it
again to modify the DB instance class.
- `"DBParameterGroupName"`: The name of the DB parameter group to apply to the DB instance.
Changing this setting doesn't result in an outage. The parameter group name itself is
changed immediately, but the actual parameter changes are not applied until you reboot the
instance without failover. In this case, the DB instance isn't rebooted automatically, and
the parameter changes aren't applied during the next maintenance window. However, if you
modify dynamic parameters in the newly associated DB parameter group, these changes are
applied immediately without a reboot. This setting doesn't apply to RDS Custom DB
instances. Default: Uses existing setting Constraints: Must be in the same DB parameter
group family as the DB instance.
- `"DBPortNumber"`: The port number on which the database accepts connections. The value of
the DBPortNumber parameter must not match any of the port values specified for options in
the option group for the DB instance. If you change the DBPortNumber value, your database
restarts regardless of the value of the ApplyImmediately parameter. This setting doesn't
apply to RDS Custom DB instances. Valid Values: 1150-65535 Default: Amazon Aurora - 3306
RDS for Db2 - 50000 RDS for MariaDB - 3306 RDS for Microsoft SQL Server - 1433
RDS for MySQL - 3306 RDS for Oracle - 1521 RDS for PostgreSQL - 5432 Constraints:
For RDS for Microsoft SQL Server, the value can't be 1234, 1434, 3260, 3343, 3389, 47001,
or 49152-49156.
- `"DBSecurityGroups"`: A list of DB security groups to authorize on this DB instance.
Changing this setting doesn't result in an outage and the change is asynchronously applied
as soon as possible. This setting doesn't apply to RDS Custom DB instances. Constraints:
If supplied, must match existing DB security groups.
- `"DBSubnetGroupName"`: The new DB subnet group for the DB instance. You can use this
parameter to move your DB instance to a different VPC. If your DB instance isn't in a VPC,
you can also use this parameter to move your DB instance into a VPC. For more information,
see Working with a DB instance in a VPC in the Amazon RDS User Guide. Changing the subnet
group causes an outage during the change. The change is applied during the next maintenance
window, unless you enable ApplyImmediately. This setting doesn't apply to RDS Custom DB
instances. Constraints: If supplied, must match existing DB subnet group. Example:
mydbsubnetgroup
- `"DedicatedLogVolume"`: Indicates whether the DB instance has a dedicated log volume
(DLV) enabled.
- `"DeletionProtection"`: Specifies whether the DB instance has deletion protection
enabled. The database can't be deleted when deletion protection is enabled. By default,
deletion protection isn't enabled. For more information, see Deleting a DB Instance. This
setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion
protection for the DB cluster. For more information, see ModifyDBCluster. DB instances in a
DB cluster can be deleted even when deletion protection is enabled for the DB cluster.
- `"DisableDomain"`: Specifies whether to remove the DB instance from the Active Directory
domain.
- `"Domain"`: The Active Directory directory ID to move the DB instance to. Specify none to
remove the instance from its current domain. You must create the domain before this
operation. Currently, you can create only Db2, MySQL, Microsoft SQL Server, Oracle, and
PostgreSQL DB instances in an Active Directory Domain. For more information, see Kerberos
Authentication in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB
instances.
- `"DomainAuthSecretArn"`: The ARN for the Secrets Manager secret with the credentials for
the user joining the domain. Example:
arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
- `"DomainDnsIps"`: The IPv4 DNS IP addresses of your primary and secondary Active
Directory domain controllers. Constraints: Two IP addresses must be provided. If there
isn't a secondary domain controller, use the IP address of the primary domain controller
for both entries in the list. Example: 123.124.125.126,234.235.236.237
- `"DomainFqdn"`: The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints: Can't be longer than 64 characters. Example:
mymanagedADtest.mymanagedAD.mydomain
- `"DomainIAMRoleName"`: The name of the IAM role to use when making API calls to the
Directory Service. This setting doesn't apply to RDS Custom DB instances.
- `"DomainOu"`: The Active Directory organizational unit for your DB instance to join.
Constraints: Must be in the distinguished name format. Can't be longer than 64
characters. Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
- `"EnableCustomerOwnedIp"`: Specifies whether to enable a customer-owned IP address (CoIP)
for an RDS on Outposts DB instance. A CoIP provides local or external connectivity to
resources in your Outpost subnets through your on-premises network. For some use cases, a
CoIP can provide lower latency for connections to the DB instance from outside of its
virtual private cloud (VPC) on your local network. For more information about RDS on
Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS
User Guide. For more information about CoIPs, see Customer-owned IP addresses in the Amazon
Web Services Outposts User Guide.
- `"EnableIAMDatabaseAuthentication"`: Specifies whether to enable mapping of Amazon Web
Services Identity and Access Management (IAM) accounts to database accounts. By default,
mapping isn't enabled. This setting doesn't apply to Amazon Aurora. Mapping Amazon Web
Services IAM accounts to database accounts is managed by the DB cluster. For more
information about IAM database authentication, see IAM Database Authentication for MySQL
and PostgreSQL in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB
instances.
- `"EnablePerformanceInsights"`: Specifies whether to enable Performance Insights for the
DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS
User Guide. This setting doesn't apply to RDS Custom DB instances.
- `"Engine"`: The target Oracle DB engine when you convert a non-CDB to a CDB. This
intermediate step is necessary to upgrade an Oracle Database 19c non-CDB to an Oracle
Database 21c CDB. Note the following requirements: Make sure that you specify
oracle-ee-cdb or oracle-se2-cdb. Make sure that your DB engine runs Oracle Database 19c
with an April 2021 or later RU. Note the following limitations: You can't convert a CDB
to a non-CDB. You can't convert a replica database. You can't convert a non-CDB to a
CDB and upgrade the engine version in the same command. You can't convert the existing
custom parameter or option group when it has options or parameters that are permanent or
persistent. In this situation, the DB instance reverts to the default option and parameter
group. To avoid reverting to the default, specify a new parameter group with
--db-parameter-group-name and a new option group with --option-group-name.
- `"EngineVersion"`: The version number of the database engine to upgrade to. Changing this
parameter results in an outage and the change is applied during the next maintenance window
unless the ApplyImmediately parameter is enabled for this request. For major version
upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group
in the DB parameter group family for the new engine version must be specified. The new DB
parameter group can be the default for that DB parameter group family. If you specify only
a major version, Amazon RDS updates the DB instance to the default minor version if the
current minor version is lower. For information about valid engine versions, see
CreateDBInstance, or call DescribeDBEngineVersions. If the instance that you're modifying
is acting as a read replica, the engine version that you specify must be the same or higher
than the version that the source DB instance or cluster is running. In RDS Custom for
Oracle, this parameter is supported for read replicas only if they are in the
PATCH_DB_FAILURE lifecycle. Constraints: If you are upgrading the engine version and
modifying the DB instance class at the same time, the currently running engine version must
be supported on the specified DB instance class. Otherwise, the operation returns an error.
In this case, first run the operation to upgrade the engine version, and then run it again
to modify the DB instance class.
- `"Iops"`: The new Provisioned IOPS (I/O operations per second) value for the RDS
instance. Changing this setting doesn't result in an outage and the change is applied
during the next maintenance window unless the ApplyImmediately parameter is enabled for
this request. If you are migrating from Provisioned IOPS to standard storage, set this
value to 0. The DB instance will require a reboot for the change in storage type to take
effect. If you choose to migrate your DB instance from using standard storage to using
Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can
take time. The duration of the migration depends on several factors such as database load,
storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if
any), and the number of prior scale storage operations. Typical migration times are under
24 hours, but the process can take up to several days in some cases. During the migration,
the DB instance is available for use, but might experience performance degradation. While
the migration takes place, nightly backups for the instance are suspended. No other Amazon
RDS operations can take place for the instance, including modifying the instance, rebooting
the instance, deleting the instance, creating a read replica for the instance, and creating
a DB snapshot of the instance. Constraints: For RDS for MariaDB, RDS for MySQL, RDS for
Oracle, and RDS for PostgreSQL - The value supplied must be at least 10% greater than the
current value. Values that are not at least 10% greater than the existing value are rounded
up so that they are 10% greater than the current value. When you increase the Provisioned
IOPS, you must also specify the AllocatedStorage parameter. You can use the current value
for AllocatedStorage. Default: Uses existing setting
- `"LicenseModel"`: The license model for the DB instance. This setting doesn't apply to
Amazon Aurora or RDS Custom DB instances. Valid Values: RDS for Db2 -
bring-your-own-license RDS for MariaDB - general-public-license RDS for Microsoft SQL
Server - license-included RDS for MySQL - general-public-license RDS for Oracle -
bring-your-own-license | license-included RDS for PostgreSQL - postgresql-license
- `"ManageMasterUserPassword"`: Specifies whether to manage the master user password with
Amazon Web Services Secrets Manager. If the DB instance doesn't manage the master user
password with Amazon Web Services Secrets Manager, you can turn on this management. In this
case, you can't specify MasterUserPassword. If the DB instance already manages the master
user password with Amazon Web Services Secrets Manager, and you specify that the master
user password is not managed with Amazon Web Services Secrets Manager, then you must
specify MasterUserPassword. In this case, Amazon RDS deletes the secret and uses the new
password for the master user specified by MasterUserPassword. For more information, see
Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints: Can't manage the master user password with Amazon Web Services Secrets
Manager if MasterUserPassword is specified.
- `"MasterUserPassword"`: The new password for the master user. Changing this parameter
doesn't result in an outage and the change is asynchronously applied as soon as possible.
Between the time of the request and the completion of the request, the MasterUserPassword
element exists in the PendingModifiedValues element of the operation response. Amazon RDS
API operations never return the password, so this operation provides a way to regain access
to a primary instance user if the password is lost. This includes restoring privileges that
might have been accidentally revoked. This setting doesn't apply to the following DB
instances: Amazon Aurora (The password for the master user is managed by the DB cluster.
For more information, see ModifyDBCluster.) RDS Custom Default: Uses existing setting
Constraints: Can't be specified if ManageMasterUserPassword is turned on. Can include
any printable ASCII character except \"/\", \"\"\", or \"@\". For RDS for Oracle, can't
include the \"&\" (ampersand) or the \"'\" (single quotes) character. Length
Constraints: RDS for Db2 - Must contain from 8 to 255 characters. RDS for MariaDB -
Must contain from 8 to 41 characters. RDS for Microsoft SQL Server - Must contain from 8
to 128 characters. RDS for MySQL - Must contain from 8 to 41 characters. RDS for Oracle
- Must contain from 8 to 30 characters. RDS for PostgreSQL - Must contain from 8 to 128
characters.
- `"MasterUserSecretKmsKeyId"`: The Amazon Web Services KMS key identifier to encrypt a
secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if both of the following conditions are met: The DB instance
doesn't manage the master user password in Amazon Web Services Secrets Manager. If the DB
instance already manages the master user password in Amazon Web Services Secrets Manager,
you can't change the KMS key used to encrypt the secret. You are turning on
ManageMasterUserPassword to manage the master user password in Amazon Web Services Secrets
Manager. If you are turning on ManageMasterUserPassword and don't specify
MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the
secret. If the secret is in a different Amazon Web Services account, then you can't use the
aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS
key. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or
alias name for the KMS key. To use a KMS key in a different Amazon Web Services account,
specify the key ARN or alias ARN. 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.
- `"MaxAllocatedStorage"`: The upper limit in gibibytes (GiB) to which Amazon RDS can
automatically scale the storage of the DB instance. For more information about this
setting, including limitations that apply to it, see Managing capacity automatically with
Amazon RDS storage autoscaling in the Amazon RDS User Guide. This setting doesn't apply to
RDS Custom DB instances.
- `"MonitoringInterval"`: The interval, in seconds, between points when Enhanced Monitoring
metrics are collected for the DB instance. To disable collection of Enhanced Monitoring
metrics, specify 0. If MonitoringRoleArn is specified, set MonitoringInterval to a value
other than 0. This setting doesn't apply to RDS Custom DB instances. Valid Values: 0 | 1 |
5 | 10 | 15 | 30 | 60 Default: 0
- `"MonitoringRoleArn"`: The ARN for the IAM role that permits RDS to send enhanced
monitoring metrics to Amazon CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see
To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide. If
MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value. This
setting doesn't apply to RDS Custom DB instances.
- `"MultiAZ"`: Specifies whether the DB instance is a Multi-AZ deployment. Changing this
parameter doesn't result in an outage. The change is applied during the next maintenance
window unless the ApplyImmediately parameter is enabled for this request. This setting
doesn't apply to RDS Custom DB instances.
- `"MultiTenant"`: Specifies whether the to convert your DB instance from the single-tenant
configuration to the multi-tenant configuration. This parameter is supported only for RDS
for Oracle CDB instances. During the conversion, RDS creates an initial tenant database and
associates the DB name, master user name, character set, and national character set
metadata with this database. The tags associated with the instance also propagate to the
initial tenant database. You can add more tenant databases to your DB instance by using the
CreateTenantDatabase operation. The conversion to the multi-tenant configuration is
permanent and irreversible, so you can't later convert back to the single-tenant
configuration. When you specify this parameter, you must also specify ApplyImmediately.
- `"NetworkType"`: The network type of the DB instance. The network type is determined by
the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4
protocol or the IPv4 and the IPv6 protocols (DUAL). For more information, see Working with
a DB instance in a VPC in the Amazon RDS User Guide. Valid Values: IPV4 | DUAL
- `"NewDBInstanceIdentifier"`: The new identifier for the DB instance when renaming a DB
instance. When you change the DB instance identifier, an instance reboot occurs immediately
if you enable ApplyImmediately, or will occur during the next maintenance window if you
disable ApplyImmediately. This value is stored as a lowercase string. This setting doesn't
apply to RDS Custom DB instances. Constraints: Must contain from 1 to 63 letters,
numbers, or hyphens. The first character must be a letter. Can't end with a hyphen or
contain two consecutive hyphens. Example: mydbinstance
- `"OptionGroupName"`: The option group to associate the DB instance with. Changing this
parameter doesn't result in an outage, with one exception. If the parameter change results
in an option group that enables OEM, it can cause a brief period, lasting less than a
second, during which new connections are rejected but existing connections aren't
interrupted. The change is applied during the next maintenance window unless the
ApplyImmediately parameter is enabled for this request. Permanent options, such as the TDE
option for Oracle Advanced Security TDE, can't be removed from an option group, and that
option group can't be removed from a DB instance after it is associated with a DB instance.
This setting doesn't apply to RDS Custom DB instances.
- `"PerformanceInsightsKMSKeyId"`: The Amazon Web Services KMS key identifier for
encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the
key ARN, key ID, alias ARN, or alias name for the KMS key. If you don't specify a value for
PerformanceInsightsKMSKeyId, then Amazon RDS 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. This setting doesn't apply
to RDS Custom DB instances.
- `"PerformanceInsightsRetentionPeriod"`: The number of days to retain Performance Insights
data. This setting doesn't apply to RDS Custom DB instances. Valid Values: 7 month *
31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11
months * 31), 589 (19 months * 31) 731 Default: 7 days If you specify a retention
period that isn't valid, such as 94, Amazon RDS returns an error.
- `"PreferredBackupWindow"`: The daily time range during which automated backups are
created if automated backups are enabled, as determined by the BackupRetentionPeriod
parameter. Changing this parameter doesn't result in an outage and the change is
asynchronously applied as soon as possible. The default is a 30-minute window selected at
random from an 8-hour block of time for each Amazon Web Services Region. For more
information, see Backup window in the Amazon RDS User Guide. This setting doesn't apply to
Amazon Aurora DB instances. The daily time range for creating automated backups is managed
by the DB cluster. For more information, see ModifyDBCluster. Constraints: Must be in the
format hh24:mi-hh24:mi. Must be in Universal 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, which might result in an outage. Changing this parameter doesn't result in an
outage, except in the following situation, and the change is asynchronously applied as soon
as possible. If there are pending actions that cause a reboot, and the maintenance window
is changed to include the current time, then changing this parameter causes a reboot of the
DB instance. If you change 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. For more information, see Amazon RDS Maintenance Window in the Amazon RDS User
Guide. Default: Uses existing setting Constraints: Must be in the format
ddd:hh24:mi-ddd:hh24:mi. The day values must be mon | tue | wed | thu | fri | sat | sun.
Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred
backup window. Must be at least 30 minutes.
- `"ProcessorFeatures"`: The number of CPU cores and the number of threads per core for the
DB instance class of the DB instance. This setting doesn't apply to RDS Custom DB instances.
- `"PromotionTier"`: The order of priority in which an Aurora Replica is promoted to the
primary instance after a failure of the existing primary instance. For more information,
see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. This setting
doesn't apply to RDS Custom DB instances. Default: 1 Valid Values: 0 - 15
- `"PubliclyAccessible"`: Specifies whether the DB instance is publicly accessible. When
the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to
the private IP address from within the DB cluster's virtual private cloud (VPC). It
resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB
cluster is ultimately controlled by the security group it uses. That public access isn't
permitted if the security group assigned to the DB cluster doesn't permit it. When the DB
instance isn't publicly accessible, it is an internal DB instance with a DNS name that
resolves to a private IP address. PubliclyAccessible only applies to DB instances in a
VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be enabled
for it to be publicly accessible. Changes to the PubliclyAccessible parameter are applied
immediately regardless of the value of the ApplyImmediately parameter.
- `"ReplicaMode"`: A value that sets the open mode of a replica database to either mounted
or read-only. Currently, this parameter is only supported for Oracle DB instances.
Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for
mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active
Data Guard to transmit information to the mounted replica. Because it doesn't accept user
connections, a mounted replica can't serve a read-only workload. For more information, see
Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This setting
doesn't apply to RDS Custom DB instances.
- `"ResumeFullAutomationModeMinutes"`: The number of minutes to pause the automation. When
the time period ends, RDS Custom resumes full automation. Default: 60 Constraints: Must
be at least 60. Must be no more than 1,440.
- `"RotateMasterUserPassword"`: Specifies whether to rotate the secret managed by Amazon
Web Services Secrets Manager for the master user password. This setting is valid only if
the master user password is managed by RDS in Amazon Web Services Secrets Manager for the
DB cluster. The secret value contains the updated password. For more information, see
Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints: You must apply the change immediately when rotating the master user
password.
- `"StorageThroughput"`: The storage throughput value for the DB instance. This setting
applies only to the gp3 storage type. This setting doesn't apply to Amazon Aurora or RDS
Custom DB instances.
- `"StorageType"`: The storage type to associate with the DB instance. If you specify io1,
io2, or gp3 you must also include a value for the Iops parameter. If you choose to migrate
your DB instance from using standard storage to using Provisioned IOPS, or from using
Provisioned IOPS to using standard storage, the process can take time. The duration of the
migration depends on several factors such as database load, storage size, storage type
(standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of
prior scale storage operations. Typical migration times are under 24 hours, but the process
can take up to several days in some cases. During the migration, the DB instance is
available for use, but might experience performance degradation. While the migration takes
place, nightly backups for the instance are suspended. No other Amazon RDS operations can
take place for the instance, including modifying the instance, rebooting the instance,
deleting the instance, creating a read replica for the instance, and creating a DB snapshot
of the instance. Valid Values: gp2 | gp3 | io1 | io2 | standard Default: io1, if the Iops
parameter is specified. Otherwise, gp2.
- `"TdeCredentialArn"`: The ARN from the key store with which to associate the instance for
TDE encryption. This setting doesn't apply to RDS Custom DB instances.
- `"TdeCredentialPassword"`: The password for the given ARN from the key store in order to
access the device. This setting doesn't apply to RDS Custom DB instances.
- `"UseDefaultProcessorFeatures"`: Specifies whether the DB instance class of the DB
instance uses its default processor features. This setting doesn't apply to RDS Custom DB
instances.
- `"VpcSecurityGroupIds"`: A list of Amazon EC2 VPC security groups to associate with this
DB instance. This change is asynchronously applied as soon as possible. This setting
doesn't apply to the following DB instances: Amazon Aurora (The associated list of EC2
VPC security groups is managed by the DB cluster. For more information, see
ModifyDBCluster.) RDS Custom Constraints: If supplied, must match existing VPC
security group IDs.
"""
function modify_dbinstance(
DBInstanceIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"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 rds(
"ModifyDBInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBInstanceIdentifier" => DBInstanceIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_dbparameter_group(dbparameter_group_name, parameter)
modify_dbparameter_group(dbparameter_group_name, parameter, params::Dict{String,<:Any})
Modifies the parameters of a DB parameter group. To modify more than one parameter, submit
a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20
parameters can be modified in a single request. After you modify a DB parameter group, you
should wait at least 5 minutes before creating your first DB instance that uses that DB
parameter group as the default parameter group. This allows Amazon RDS to fully complete
the modify operation before the parameter group is used as the default for a new DB
instance. This is especially important for parameters that are critical when creating the
default database for a DB instance, such as the character set for the default database
defined by the character_set_database parameter. You can use the Parameter Groups option of
the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter
group has been created or modified.
# Arguments
- `dbparameter_group_name`: The name of the DB parameter group. Constraints: If supplied,
must match the name of an existing DBParameterGroup.
- `parameter`: An array of parameter names, values, and the application methods for the
parameter update. At least one parameter name, value, and application method must be
supplied; later arguments are optional. A maximum of 20 parameters can be modified in a
single request. Valid Values (for the application method): immediate | pending-reboot You
can use the immediate value with dynamic parameters only. You can use the pending-reboot
value for both dynamic and static parameters. When the application method is immediate,
changes to dynamic parameters are applied immediately to the DB instances associated with
the parameter group. When the application method is pending-reboot, changes to dynamic and
static parameters are applied after a reboot without failover to the DB instances
associated with the parameter group. You can't use pending-reboot with dynamic parameters
on RDS for SQL Server DB instances. Use immediate. For more information on modifying DB
parameters, see Working with DB parameter groups in the Amazon RDS User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Parameters"`: An array of parameter names, values, and the application methods for the
parameter update. At least one parameter name, value, and application method must be
supplied; later arguments are optional. A maximum of 20 parameters can be modified in a
single request. Valid Values (for the application method): immediate | pending-reboot You
can use the immediate value with dynamic parameters only. You can use the pending-reboot
value for both dynamic and static parameters. When the application method is immediate,
changes to dynamic parameters are applied immediately to the DB instances associated with
the parameter group. When the application method is pending-reboot, changes to dynamic and
static parameters are applied after a reboot without failover to the DB instances
associated with the parameter group. You can't use pending-reboot with dynamic parameters
on RDS for SQL Server DB instances. Use immediate. For more information on modifying DB
parameters, see Working with DB parameter groups in the Amazon RDS User Guide.
"""
function modify_dbparameter_group(
DBParameterGroupName, Parameter; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"ModifyDBParameterGroup",
Dict{String,Any}(
"DBParameterGroupName" => DBParameterGroupName, "Parameter" => Parameter
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_dbparameter_group(
DBParameterGroupName,
Parameter,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"ModifyDBParameterGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBParameterGroupName" => DBParameterGroupName, "Parameter" => Parameter
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_dbproxy(dbproxy_name)
modify_dbproxy(dbproxy_name, params::Dict{String,<:Any})
Changes the settings for an existing DB proxy.
# Arguments
- `dbproxy_name`: The identifier for the DBProxy to modify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Auth"`: The new authentication settings for the DBProxy.
- `"DebugLogging"`: Whether the proxy includes detailed information about SQL statements in
its logs. This information helps you to debug issues involving SQL behavior or the
performance and scalability of the proxy connections. The debug information includes the
text of SQL statements that you submit through the proxy. Thus, only enable this setting
when needed for debugging, and only when you have security measures in place to safeguard
any sensitive information that appears in the logs.
- `"IdleClientTimeout"`: The number of seconds that a connection to the proxy can be
inactive before the proxy disconnects it. You can set this value higher or lower than the
connection timeout limit for the associated database.
- `"NewDBProxyName"`: The new identifier for the DBProxy. 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.
- `"RequireTLS"`: Whether Transport Layer Security (TLS) encryption is required for
connections to the proxy. By enabling this setting, you can enforce encrypted TLS
connections to the proxy, even if the associated database doesn't use TLS.
- `"RoleArn"`: The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access
secrets in Amazon Web Services Secrets Manager.
- `"SecurityGroups"`: The new list of security groups for the DBProxy.
"""
function modify_dbproxy(DBProxyName; aws_config::AbstractAWSConfig=global_aws_config())
return rds(
"ModifyDBProxy",
Dict{String,Any}("DBProxyName" => DBProxyName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_dbproxy(
DBProxyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"ModifyDBProxy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DBProxyName" => DBProxyName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_dbproxy_endpoint(dbproxy_endpoint_name)
modify_dbproxy_endpoint(dbproxy_endpoint_name, params::Dict{String,<:Any})
Changes the settings for an existing DB proxy endpoint.
# Arguments
- `dbproxy_endpoint_name`: The name of the DB proxy sociated with the DB proxy endpoint
that you want to modify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NewDBProxyEndpointName"`: The new identifier for the DBProxyEndpoint. 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.
- `"VpcSecurityGroupIds"`: The VPC security group IDs for the DB proxy endpoint. When the
DB proxy endpoint uses a different VPC than the original proxy, you also specify a
different set of security group IDs than for the original proxy.
"""
function modify_dbproxy_endpoint(
DBProxyEndpointName; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"ModifyDBProxyEndpoint",
Dict{String,Any}("DBProxyEndpointName" => DBProxyEndpointName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_dbproxy_endpoint(
DBProxyEndpointName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"ModifyDBProxyEndpoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBProxyEndpointName" => DBProxyEndpointName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_dbproxy_target_group(dbproxy_name, target_group_name)
modify_dbproxy_target_group(dbproxy_name, target_group_name, params::Dict{String,<:Any})
Modifies the properties of a DBProxyTargetGroup.
# Arguments
- `dbproxy_name`: The name of the proxy.
- `target_group_name`: The name of the target group to modify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConnectionPoolConfig"`: The settings that determine the size and behavior of the
connection pool for the target group.
- `"NewName"`: The new name for the modified DBProxyTarget. 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.
"""
function modify_dbproxy_target_group(
DBProxyName, TargetGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"ModifyDBProxyTargetGroup",
Dict{String,Any}(
"DBProxyName" => DBProxyName, "TargetGroupName" => TargetGroupName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_dbproxy_target_group(
DBProxyName,
TargetGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"ModifyDBProxyTargetGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBProxyName" => DBProxyName, "TargetGroupName" => TargetGroupName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_dbrecommendation(recommendation_id)
modify_dbrecommendation(recommendation_id, params::Dict{String,<:Any})
Updates the recommendation status and recommended action status for the specified
recommendation.
# Arguments
- `recommendation_id`: The identifier of the recommendation to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Locale"`: The language of the modified recommendation.
- `"RecommendedActionUpdates"`: The list of recommended action status to update. You can
update multiple recommended actions at one time.
- `"Status"`: The recommendation status to update. Valid values: active dismissed
"""
function modify_dbrecommendation(
RecommendationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"ModifyDBRecommendation",
Dict{String,Any}("RecommendationId" => RecommendationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_dbrecommendation(
RecommendationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"ModifyDBRecommendation",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("RecommendationId" => RecommendationId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_dbshard_group(dbshard_group_identifier)
modify_dbshard_group(dbshard_group_identifier, params::Dict{String,<:Any})
Modifies the settings of an Aurora Limitless Database DB shard group. You can change one or
more settings by specifying these parameters and the new values in the request.
# Arguments
- `dbshard_group_identifier`: The name of the DB shard group to modify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxACU"`: The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
"""
function modify_dbshard_group(
DBShardGroupIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"ModifyDBShardGroup",
Dict{String,Any}("DBShardGroupIdentifier" => DBShardGroupIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_dbshard_group(
DBShardGroupIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"ModifyDBShardGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBShardGroupIdentifier" => DBShardGroupIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_dbsnapshot(dbsnapshot_identifier)
modify_dbsnapshot(dbsnapshot_identifier, params::Dict{String,<:Any})
Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or
unencrypted, but not shared or public. Amazon RDS supports upgrading DB snapshots for
MySQL, PostgreSQL, and Oracle. This operation doesn't apply to RDS Custom or RDS for Db2.
# Arguments
- `dbsnapshot_identifier`: The identifier of the DB snapshot to modify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EngineVersion"`: The engine version to upgrade the DB snapshot to. The following are
the database engines and engine versions that are available when you upgrade a DB snapshot.
MySQL For the list of engine versions that are available for upgrading a DB snapshot, see
Upgrading a MySQL DB snapshot engine version in the Amazon RDS User Guide. Oracle
19.0.0.0.ru-2022-01.rur-2022-01.r1 (supported for 12.2.0.1 DB snapshots)
19.0.0.0.ru-2022-07.rur-2022-07.r1 (supported for 12.1.0.2 DB snapshots) 12.1.0.2.v8
(supported for 12.1.0.1 DB snapshots) 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)
11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots) PostgreSQL For the list of engine
versions that are available for upgrading a DB snapshot, see Upgrading a PostgreSQL DB
snapshot engine version in the Amazon RDS User Guide.
- `"OptionGroupName"`: The option group to identify with the upgraded DB snapshot. You can
specify this parameter when you upgrade an Oracle DB snapshot. The same option group
considerations apply when upgrading a DB snapshot as when upgrading a DB instance. For more
information, see Option group considerations in the Amazon RDS User Guide.
"""
function modify_dbsnapshot(
DBSnapshotIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"ModifyDBSnapshot",
Dict{String,Any}("DBSnapshotIdentifier" => DBSnapshotIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_dbsnapshot(
DBSnapshotIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"ModifyDBSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBSnapshotIdentifier" => DBSnapshotIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_dbsnapshot_attribute(attribute_name, dbsnapshot_identifier)
modify_dbsnapshot_attribute(attribute_name, dbsnapshot_identifier, params::Dict{String,<:Any})
Adds an attribute and values to, or removes an attribute and values from, a manual DB
snapshot. To share a manual DB 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 DB snapshot. Uses
the value all to make the manual DB snapshot public, which means it can be copied or
restored by all Amazon Web Services accounts. Don't add the all value for any manual DB
snapshots that contain private information that you don't want available to all Amazon Web
Services accounts. If the manual DB 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. To view which
Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or
whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API
operation. The accounts are returned as values for the restore attribute.
# Arguments
- `attribute_name`: The name of the DB snapshot attribute to modify. To manage
authorization for other Amazon Web Services accounts to copy or restore a manual DB
snapshot, set this value to restore. To view the list of attributes available to modify,
use the DescribeDBSnapshotAttributes API operation.
- `dbsnapshot_identifier`: The identifier for the DB snapshot to modify the attributes for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ValuesToAdd"`: A list of DB snapshot attributes to add to the attribute specified by
AttributeName. To authorize other Amazon Web Services accounts to copy or restore a manual
snapshot, set this list to include one or more Amazon Web Services account IDs, or all to
make the manual DB snapshot restorable by any Amazon Web Services account. Do not add the
all value for any manual DB snapshots that contain private information that you don't want
available to all Amazon Web Services accounts.
- `"ValuesToRemove"`: A list of DB 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 snapshot, set this list to include one or more Amazon Web
Services account identifiers, or all to remove authorization for any Amazon Web Services
account to copy or restore the DB snapshot. If you specify all, an Amazon Web Services
account whose account ID is explicitly added to the restore attribute can still copy or
restore the manual DB snapshot.
"""
function modify_dbsnapshot_attribute(
AttributeName, DBSnapshotIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"ModifyDBSnapshotAttribute",
Dict{String,Any}(
"AttributeName" => AttributeName, "DBSnapshotIdentifier" => DBSnapshotIdentifier
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_dbsnapshot_attribute(
AttributeName,
DBSnapshotIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"ModifyDBSnapshotAttribute",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AttributeName" => AttributeName,
"DBSnapshotIdentifier" => DBSnapshotIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_dbsubnet_group(dbsubnet_group_name, subnet_identifier)
modify_dbsubnet_group(dbsubnet_group_name, subnet_identifier, params::Dict{String,<:Any})
Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in
at least two AZs in the Amazon Web Services Region.
# Arguments
- `dbsubnet_group_name`: The name for the DB subnet group. This value is stored as a
lowercase string. You can't modify the default subnet group. Constraints: Must match the
name of an existing DBSubnetGroup. Must not be default. Example: mydbsubnetgroup
- `subnet_identifier`: The EC2 subnet IDs for the DB subnet group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBSubnetGroupDescription"`: The description for the DB subnet group.
- `"SubnetIds"`: The EC2 subnet IDs for the DB subnet group.
"""
function modify_dbsubnet_group(
DBSubnetGroupName, SubnetIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"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 rds(
"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 RDS event notification subscription. You can't modify the source
identifiers using this call. To change source identifiers for a subscription, use the
AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls. You can
see a list of the event categories for a given source type (SourceType) in Events in the
Amazon RDS User Guide or by using the DescribeEventCategories operation.
# Arguments
- `subscription_name`: The name of the RDS event notification subscription.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Enabled"`: Specifies whether to activate the subscription.
- `"EventCategories"`: A list of event categories for a source type (SourceType) that you
want to subscribe to. You can see a list of the categories for a given source type in
Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.
- `"SnsTopicArn"`: The Amazon Resource Name (ARN) of the SNS topic created for event
notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
- `"SourceType"`: The type of source that is generating the events. For example, if you
want to be notified of events generated by a DB instance, you would set this parameter to
db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all
events are returned. Valid Values: db-instance | db-cluster | db-parameter-group |
db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl |
custom-engine-version | blue-green-deployment
"""
function modify_event_subscription(
SubscriptionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"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 rds(
"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()
modify_global_cluster(params::Dict{String,<:Any})
Modifies a setting for an Amazon Aurora global database cluster. You can change one or more
database configuration parameters by specifying these parameters and the new values in the
request. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon
Aurora User Guide. This operation only applies to Aurora global database clusters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllowMajorVersionUpgrade"`: Specifies whether to allow major version upgrades.
Constraints: Must be enabled if you specify a value for the EngineVersion parameter that's
a different major version than the global cluster's current version. If you upgrade the
major version of a global database, the cluster and DB instance parameter groups are set to
the default parameter groups for the new version. Apply any custom parameter groups after
completing the upgrade.
- `"DeletionProtection"`: Specifies whether to enable deletion protection for the global
database cluster. The global database cluster can't be deleted when deletion protection is
enabled.
- `"EngineVersion"`: The version number of the database engine to which you want to
upgrade. To list all of the available engine versions for aurora-mysql (for MySQL-based
Aurora global databases), use the following command: aws rds describe-db-engine-versions
--engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
To list all of the available engine versions for aurora-postgresql (for PostgreSQL-based
Aurora global databases), use the following command: aws rds describe-db-engine-versions
--engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases ==
`true`].[EngineVersion]'
- `"GlobalClusterIdentifier"`: The cluster identifier for the global cluster to modify.
This parameter isn't case-sensitive. Constraints: Must match the identifier of an
existing global database cluster.
- `"NewGlobalClusterIdentifier"`: The new cluster identifier for the global database
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. Can't end with a
hyphen or contain two consecutive hyphens. Example: my-cluster2
"""
function modify_global_cluster(; aws_config::AbstractAWSConfig=global_aws_config())
return rds(
"ModifyGlobalCluster"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function modify_global_cluster(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"ModifyGlobalCluster",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_integration(integration_identifier)
modify_integration(integration_identifier, params::Dict{String,<:Any})
Modifies a zero-ETL integration with Amazon Redshift. Currently, you can only modify
integrations that have Aurora MySQL source DB clusters. Integrations with Aurora PostgreSQL
and RDS sources currently don't support modifying the integration.
# Arguments
- `integration_identifier`: The unique identifier of the integration to modify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataFilter"`: A new data filter for the integration. For more information, see Data
filtering for Aurora zero-ETL integrations with Amazon Redshift.
- `"Description"`: A new description for the integration.
- `"IntegrationName"`: A new name for the integration.
"""
function modify_integration(
IntegrationIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"ModifyIntegration",
Dict{String,Any}("IntegrationIdentifier" => IntegrationIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_integration(
IntegrationIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"ModifyIntegration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("IntegrationIdentifier" => IntegrationIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_option_group(option_group_name)
modify_option_group(option_group_name, params::Dict{String,<:Any})
Modifies an existing option group.
# Arguments
- `option_group_name`: The name of the option group to be modified. Permanent options, such
as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group,
and that option group can't be removed from a DB instance once it is associated with a DB
instance
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ApplyImmediately"`: Specifies whether to apply the change immediately or during the
next maintenance window for each instance associated with the option group.
- `"OptionsToInclude"`: Options in this list are added to the option group or, if already
present, the specified configuration is used to update the existing configuration.
- `"OptionsToRemove"`: Options in this list are removed from the option group.
"""
function modify_option_group(
OptionGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"ModifyOptionGroup",
Dict{String,Any}("OptionGroupName" => OptionGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_option_group(
OptionGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"ModifyOptionGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("OptionGroupName" => OptionGroupName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_tenant_database(dbinstance_identifier, tenant_dbname)
modify_tenant_database(dbinstance_identifier, tenant_dbname, params::Dict{String,<:Any})
Modifies an existing tenant database in a DB instance. You can change the tenant database
name or the master user password. This operation is supported only for RDS for Oracle CDB
instances using the multi-tenant configuration.
# Arguments
- `dbinstance_identifier`: The identifier of the DB instance that contains the tenant
database that you are modifying. This parameter isn't case-sensitive. Constraints: Must
match the identifier of an existing DB instance.
- `tenant_dbname`: The user-supplied name of the tenant database that you want to modify.
This parameter isn’t case-sensitive. Constraints: Must match the identifier of an
existing tenant database.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MasterUserPassword"`: The new password for the master user of the specified tenant
database in your DB instance. Amazon RDS operations never return the password, so this
action provides a way to regain access to a tenant database user if the password is lost.
This includes restoring privileges that might have been accidentally revoked. Constraints:
Can include any printable ASCII character except /, \" (double quote), @, &
(ampersand), and ' (single quote). Length constraints: Must contain between 8 and 30
characters.
- `"NewTenantDBName"`: The new name of the tenant database when renaming a tenant database.
This parameter isn’t case-sensitive. Constraints: Can't be the string null or any other
reserved word. Can't be longer than 8 characters.
"""
function modify_tenant_database(
DBInstanceIdentifier, TenantDBName; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"ModifyTenantDatabase",
Dict{String,Any}(
"DBInstanceIdentifier" => DBInstanceIdentifier, "TenantDBName" => TenantDBName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_tenant_database(
DBInstanceIdentifier,
TenantDBName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"ModifyTenantDatabase",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBInstanceIdentifier" => DBInstanceIdentifier,
"TenantDBName" => TenantDBName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
promote_read_replica(dbinstance_identifier)
promote_read_replica(dbinstance_identifier, params::Dict{String,<:Any})
Promotes a read replica DB instance to a standalone DB instance. Backup duration is a
function of the amount of changes to the database since the previous backup. If you plan to
promote a read replica to a standalone instance, we recommend that you enable backups and
complete at least one backup prior to promotion. In addition, a read replica cannot be
promoted to a standalone instance when it is in the backing-up status. If you have enabled
backups on your read replica, configure the automated backup window so that daily backups
do not interfere with read replica promotion. This command doesn't apply to Aurora MySQL,
Aurora PostgreSQL, or RDS Custom.
# Arguments
- `dbinstance_identifier`: The DB instance identifier. This value is stored as a lowercase
string. Constraints: Must match the identifier of an existing read replica DB instance.
Example: mydbinstance
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BackupRetentionPeriod"`: The number of days for which automated backups are retained.
Setting this parameter to a positive number enables backups. Setting this parameter to 0
disables automated backups. Default: 1 Constraints: Must be a value from 0 to 35. Can't
be set to 0 if the DB instance is a source to read replicas.
- `"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. To see the time blocks available, see Adjusting the Preferred
Maintenance Window in the Amazon RDS User Guide. Constraints: Must be in the format
hh24:mi-hh24:mi. Must be in Universal Coordinated Time (UTC). Must not conflict with
the preferred maintenance window. Must be at least 30 minutes.
"""
function promote_read_replica(
DBInstanceIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"PromoteReadReplica",
Dict{String,Any}("DBInstanceIdentifier" => DBInstanceIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function promote_read_replica(
DBInstanceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"PromoteReadReplica",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBInstanceIdentifier" => DBInstanceIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
promote_read_replica_dbcluster(dbcluster_identifier)
promote_read_replica_dbcluster(dbcluster_identifier, params::Dict{String,<:Any})
Promotes a read replica DB cluster to a standalone DB cluster.
# Arguments
- `dbcluster_identifier`: The identifier of the DB cluster read replica to promote. This
parameter isn't case-sensitive. Constraints: Must match the identifier of an existing DB
cluster read replica. Example: my-cluster-replica1
"""
function promote_read_replica_dbcluster(
DBClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"PromoteReadReplicaDBCluster",
Dict{String,Any}("DBClusterIdentifier" => DBClusterIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function promote_read_replica_dbcluster(
DBClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"PromoteReadReplicaDBCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBClusterIdentifier" => DBClusterIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
purchase_reserved_dbinstances_offering(reserved_dbinstances_offering_id)
purchase_reserved_dbinstances_offering(reserved_dbinstances_offering_id, params::Dict{String,<:Any})
Purchases a reserved DB instance offering.
# Arguments
- `reserved_dbinstances_offering_id`: The ID of the Reserved DB instance 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:
- `"DBInstanceCount"`: The number of instances to reserve. Default: 1
- `"ReservedDBInstanceId"`: Customer-specified identifier to track this reservation.
Example: myreservationID
- `"Tags"`:
"""
function purchase_reserved_dbinstances_offering(
ReservedDBInstancesOfferingId; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"PurchaseReservedDBInstancesOffering",
Dict{String,Any}("ReservedDBInstancesOfferingId" => ReservedDBInstancesOfferingId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function purchase_reserved_dbinstances_offering(
ReservedDBInstancesOfferingId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"PurchaseReservedDBInstancesOffering",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ReservedDBInstancesOfferingId" => ReservedDBInstancesOfferingId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reboot_dbcluster(dbcluster_identifier)
reboot_dbcluster(dbcluster_identifier, params::Dict{String,<:Any})
You might need to reboot your DB cluster, usually for maintenance reasons. For example, if
you make certain modifications, or if you change the DB cluster parameter group associated
with the DB cluster, reboot the DB cluster for the changes to take effect. Rebooting a DB
cluster restarts the database engine service. Rebooting a DB cluster results in a momentary
outage, during which the DB cluster status is set to rebooting. Use this operation only for
a non-Aurora Multi-AZ DB cluster. For more information on Multi-AZ DB clusters, see
Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
# Arguments
- `dbcluster_identifier`: The DB cluster identifier. This parameter is stored as a
lowercase string. Constraints: Must match the identifier of an existing DBCluster.
"""
function reboot_dbcluster(
DBClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"RebootDBCluster",
Dict{String,Any}("DBClusterIdentifier" => DBClusterIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reboot_dbcluster(
DBClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"RebootDBCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBClusterIdentifier" => DBClusterIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reboot_dbinstance(dbinstance_identifier)
reboot_dbinstance(dbinstance_identifier, params::Dict{String,<:Any})
You might need to reboot your DB instance, usually for maintenance reasons. For example, if
you make certain modifications, or if you change the DB parameter group associated with the
DB instance, you must reboot the instance for the changes to take effect. Rebooting a DB
instance restarts the database engine service. Rebooting a DB instance results in a
momentary outage, during which the DB instance status is set to rebooting. For more
information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.
This command doesn't apply to RDS Custom. If your DB instance is part of a Multi-AZ DB
cluster, you can reboot the DB cluster with the RebootDBCluster operation.
# Arguments
- `dbinstance_identifier`: The DB instance identifier. This parameter is stored as a
lowercase string. Constraints: Must match the identifier of an existing DBInstance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ForceFailover"`: Specifies whether the reboot is conducted through a Multi-AZ failover.
Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.
"""
function reboot_dbinstance(
DBInstanceIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"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 rds(
"RebootDBInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBInstanceIdentifier" => DBInstanceIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reboot_dbshard_group(dbshard_group_identifier)
reboot_dbshard_group(dbshard_group_identifier, params::Dict{String,<:Any})
You might need to reboot your DB shard group, usually for maintenance reasons. For example,
if you make certain modifications, reboot the DB shard group for the changes to take
effect. This operation applies only to Aurora Limitless Database DBb shard groups.
# Arguments
- `dbshard_group_identifier`: The name of the DB shard group to reboot.
"""
function reboot_dbshard_group(
DBShardGroupIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"RebootDBShardGroup",
Dict{String,Any}("DBShardGroupIdentifier" => DBShardGroupIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reboot_dbshard_group(
DBShardGroupIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"RebootDBShardGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBShardGroupIdentifier" => DBShardGroupIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_dbproxy_targets(dbproxy_name)
register_dbproxy_targets(dbproxy_name, params::Dict{String,<:Any})
Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.
# Arguments
- `dbproxy_name`: The identifier of the DBProxy that is associated with the
DBProxyTargetGroup.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBClusterIdentifiers"`: One or more DB cluster identifiers.
- `"DBInstanceIdentifiers"`: One or more DB instance identifiers.
- `"TargetGroupName"`: The identifier of the DBProxyTargetGroup.
"""
function register_dbproxy_targets(
DBProxyName; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"RegisterDBProxyTargets",
Dict{String,Any}("DBProxyName" => DBProxyName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_dbproxy_targets(
DBProxyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"RegisterDBProxyTargets",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DBProxyName" => DBProxyName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_from_global_cluster()
remove_from_global_cluster(params::Dict{String,<:Any})
Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster
becomes a standalone cluster with read-write capability instead of being read-only and
receiving data from a primary cluster in a different Region. This operation only applies
to Aurora DB clusters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DbClusterIdentifier"`: The Amazon Resource Name (ARN) identifying the cluster that was
detached from the Aurora global database cluster.
- `"GlobalClusterIdentifier"`: The cluster identifier to detach from the Aurora global
database cluster.
"""
function remove_from_global_cluster(; aws_config::AbstractAWSConfig=global_aws_config())
return rds(
"RemoveFromGlobalCluster"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function remove_from_global_cluster(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"RemoveFromGlobalCluster",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_role_from_dbcluster(dbcluster_identifier, role_arn)
remove_role_from_dbcluster(dbcluster_identifier, role_arn, params::Dict{String,<:Any})
Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM)
role from a DB cluster. For more information on Amazon Aurora DB clusters, see What is
Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB
clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
# Arguments
- `dbcluster_identifier`: The name of the DB cluster to disassociate the IAM role from.
- `role_arn`: The Amazon Resource Name (ARN) of the IAM role to disassociate from the
Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FeatureName"`: The name of the feature for the DB cluster that the IAM role is to be
disassociated from. For information about supported feature names, see DBEngineVersion.
"""
function remove_role_from_dbcluster(
DBClusterIdentifier, RoleArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"RemoveRoleFromDBCluster",
Dict{String,Any}(
"DBClusterIdentifier" => DBClusterIdentifier, "RoleArn" => RoleArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_role_from_dbcluster(
DBClusterIdentifier,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"RemoveRoleFromDBCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBClusterIdentifier" => DBClusterIdentifier, "RoleArn" => RoleArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_role_from_dbinstance(dbinstance_identifier, feature_name, role_arn)
remove_role_from_dbinstance(dbinstance_identifier, feature_name, role_arn, params::Dict{String,<:Any})
Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB
instance.
# Arguments
- `dbinstance_identifier`: The name of the DB instance to disassociate the IAM role from.
- `feature_name`: The name of the feature for the DB instance that the IAM role is to be
disassociated from. For information about supported feature names, see DBEngineVersion.
- `role_arn`: The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB
instance, for example, arn:aws:iam::123456789012:role/AccessRole.
"""
function remove_role_from_dbinstance(
DBInstanceIdentifier,
FeatureName,
RoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"RemoveRoleFromDBInstance",
Dict{String,Any}(
"DBInstanceIdentifier" => DBInstanceIdentifier,
"FeatureName" => FeatureName,
"RoleArn" => RoleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_role_from_dbinstance(
DBInstanceIdentifier,
FeatureName,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"RemoveRoleFromDBInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBInstanceIdentifier" => DBInstanceIdentifier,
"FeatureName" => FeatureName,
"RoleArn" => RoleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_source_identifier_from_subscription(source_identifier, subscription_name)
remove_source_identifier_from_subscription(source_identifier, subscription_name, params::Dict{String,<:Any})
Removes a source identifier from an existing RDS event notification subscription.
# Arguments
- `source_identifier`: The source identifier to be removed from the subscription, such as
the DB instance identifier for a DB instance or the name of a security group.
- `subscription_name`: The name of the RDS event notification subscription you want to
remove a source identifier from.
"""
function remove_source_identifier_from_subscription(
SourceIdentifier, SubscriptionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"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 rds(
"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 RDS resource. For an overview on tagging an Amazon RDS
resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
# Arguments
- `resource_name`: The Amazon RDS resource that the tags are removed from. This value is an
Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN
for Amazon RDS in the Amazon RDS User Guide.
- `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 rds(
"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 rds(
"RemoveTagsFromResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceName" => ResourceName, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reset_dbcluster_parameter_group(dbcluster_parameter_group_name)
reset_dbcluster_parameter_group(dbcluster_parameter_group_name, params::Dict{String,<:Any})
Modifies the parameters of a DB cluster parameter group to the default value. To reset
specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset
the entire DB cluster parameter group, specify the DBClusterParameterGroupName and
ResetAllParameters parameters. When resetting the entire group, dynamic parameters are
updated immediately and static parameters are set to pending-reboot to take effect on the
next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for
every DB instance in your DB cluster that you want the updated static parameter to apply
to. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the
Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB
cluster deployments in the Amazon RDS User Guide.
# Arguments
- `dbcluster_parameter_group_name`: The name of the DB cluster parameter group to reset.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Parameters"`: A list of parameter names in the DB cluster parameter group to reset to
the default values. You can't use this parameter if the ResetAllParameters parameter is
enabled.
- `"ResetAllParameters"`: Specifies whether to reset all parameters in the DB cluster
parameter group to their default values. 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 rds(
"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 rds(
"ResetDBClusterParameterGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBClusterParameterGroupName" => DBClusterParameterGroupName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reset_dbparameter_group(dbparameter_group_name)
reset_dbparameter_group(dbparameter_group_name, params::Dict{String,<:Any})
Modifies the parameters of a DB parameter group to the engine/system default value. To
reset specific parameters, provide a list of the following: ParameterName and ApplyMethod.
To reset the entire DB parameter group, specify the DBParameterGroup name and
ResetAllParameters parameters. When resetting the entire group, dynamic parameters are
updated immediately and static parameters are set to pending-reboot to take effect on the
next DB instance restart or RebootDBInstance request.
# Arguments
- `dbparameter_group_name`: The name of the DB parameter group. Constraints: Must match
the name of an existing DBParameterGroup.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Parameters"`: To reset the entire DB parameter group, specify the DBParameterGroup name
and ResetAllParameters parameters. To reset specific parameters, provide a list of the
following: ParameterName and ApplyMethod. A maximum of 20 parameters can be modified in a
single request. MySQL Valid Values (for Apply method): immediate | pending-reboot You
can use the immediate value with dynamic parameters only. You can use the pending-reboot
value for both dynamic and static parameters, and changes are applied when DB instance
reboots. MariaDB Valid Values (for Apply method): immediate | pending-reboot You can use
the immediate value with dynamic parameters only. You can use the pending-reboot value for
both dynamic and static parameters, and changes are applied when DB instance reboots.
Oracle Valid Values (for Apply method): pending-reboot
- `"ResetAllParameters"`: Specifies whether to reset all parameters in the DB parameter
group to default values. By default, all parameters in the DB parameter group are reset to
default values.
"""
function reset_dbparameter_group(
DBParameterGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"ResetDBParameterGroup",
Dict{String,Any}("DBParameterGroupName" => DBParameterGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reset_dbparameter_group(
DBParameterGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"ResetDBParameterGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBParameterGroupName" => DBParameterGroupName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restore_dbcluster_from_s3(dbcluster_identifier, engine, master_username, s3_bucket_name, s3_ingestion_role_arn, source_engine, source_engine_version)
restore_dbcluster_from_s3(dbcluster_identifier, engine, master_username, s3_bucket_name, s3_ingestion_role_arn, source_engine, source_engine_version, params::Dict{String,<:Any})
Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon
RDS must be authorized to access the Amazon S3 bucket and the data must be created using
the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an
Amazon S3 Bucket in the Amazon Aurora User Guide. This operation only restores the DB
cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance
operation to create DB instances for the restored DB cluster, specifying the identifier of
the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the
RestoreDBClusterFromS3 operation has completed and the DB cluster is available. For more
information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This operation only applies to Aurora DB clusters. The source DB engine must be MySQL.
# Arguments
- `dbcluster_identifier`: The name of the DB cluster to create from the source data in the
Amazon S3 bucket. This parameter isn't case-sensitive. Constraints: Must contain from 1
to 63 letters, numbers, or hyphens. First character must be a letter. Can't end with a
hyphen or contain two consecutive hyphens. Example: my-cluster1
- `engine`: The name of the database engine to be used for this DB cluster. Valid Values:
aurora-mysql (for Aurora MySQL)
- `master_username`: The name of the master user for the restored DB cluster. Constraints:
Must be 1 to 16 letters or numbers. First character must be a letter. Can't be a
reserved word for the chosen database engine.
- `s3_bucket_name`: The name of the Amazon S3 bucket that contains the data used to create
the Amazon Aurora DB cluster.
- `s3_ingestion_role_arn`: The Amazon Resource Name (ARN) of the Amazon Web Services
Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon
S3 bucket on your behalf.
- `source_engine`: The identifier for the database engine that was backed up to create the
files stored in the Amazon S3 bucket. Valid Values: mysql
- `source_engine_version`: The version of the database that the backup files were created
from. MySQL versions 5.7 and 8.0 are supported. Example: 5.7.40, 8.0.28
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AvailabilityZones"`: A list of Availability Zones (AZs) where instances in the restored
DB cluster can be created.
- `"BacktrackWindow"`: The target backtrack window, in seconds. To disable backtracking,
set this value to 0. Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0 Constraints: If specified, this value must be set to a number from 0 to
259,200 (72 hours).
- `"BackupRetentionPeriod"`: The number of days for which automated backups of the restored
DB cluster are retained. You must specify a minimum value of 1. Default: 1 Constraints:
Must be a value from 1 to 35
- `"CharacterSetName"`: A value that indicates that the restored DB cluster should be
associated with the specified CharacterSet.
- `"CopyTagsToSnapshot"`: Specifies whether to copy all tags from the restored DB cluster
to snapshots of the restored DB cluster. The default is not to copy them.
- `"DBClusterParameterGroupName"`: The name of the DB cluster parameter group to associate
with the restored DB cluster. If this argument is omitted, the default parameter group for
the engine version is used. Constraints: If supplied, must match the name of an existing
DBClusterParameterGroup.
- `"DBSubnetGroupName"`: A DB subnet group to associate with the restored DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example:
mydbsubnetgroup
- `"DatabaseName"`: The database name for the restored DB cluster.
- `"DeletionProtection"`: Specifies whether to enable deletion protection for the DB
cluster. The database can't be deleted when deletion protection is enabled. By default,
deletion protection isn't enabled.
- `"Domain"`: Specify the Active Directory directory ID to restore the DB cluster in. The
domain must be created prior to this operation. For Amazon Aurora DB clusters, Amazon RDS
can use Kerberos Authentication to authenticate users that connect to the DB cluster. For
more information, see Kerberos Authentication in the Amazon Aurora User Guide.
- `"DomainIAMRoleName"`: Specify the name of the IAM role to be used when making API calls
to the Directory Service.
- `"EnableCloudwatchLogsExports"`: The list of logs that the restored DB cluster is to
export to CloudWatch Logs. The values in the list depend on the DB engine being used.
Aurora MySQL Possible values are audit, error, general, and slowquery. For more
information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs
to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
- `"EnableIAMDatabaseAuthentication"`: Specifies whether to enable mapping of Amazon Web
Services Identity and Access Management (IAM) accounts to database accounts. By default,
mapping isn't enabled. For more information, see IAM Database Authentication in the Amazon
Aurora User Guide.
- `"EngineLifecycleSupport"`: The life cycle type for this DB cluster. By default, this
value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon
RDS Extended Support. At the end of standard support, you can avoid charges for Extended
Support by setting the value to open-source-rds-extended-support-disabled. In this case,
RDS automatically upgrades your restored DB cluster to a higher engine version, if the
major engine version is past its end of standard support date. You can use this setting to
enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can
run the selected major engine version on your DB cluster past the end of standard support
for that engine version. For more information, see the following sections: Amazon Aurora
(PostgreSQL only) - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide Valid for
Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values:
open-source-rds-extended-support | open-source-rds-extended-support-disabled Default:
open-source-rds-extended-support
- `"EngineVersion"`: The version number of the database engine to use. To list all of the
available engine versions for aurora-mysql (Aurora MySQL), use the following command: aws
rds describe-db-engine-versions --engine aurora-mysql --query
\"DBEngineVersions[].EngineVersion\" Aurora MySQL Examples: 5.7.mysql_aurora.2.12.0,
8.0.mysql_aurora.3.04.0
- `"KmsKeyId"`: The Amazon Web Services KMS key identifier for an encrypted DB cluster. The
Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for
the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key
ARN or alias ARN. If the StorageEncrypted parameter is enabled, and you do not specify a
value for the KmsKeyId parameter, then Amazon RDS will use 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.
- `"ManageMasterUserPassword"`: Specifies whether to manage the master user password with
Amazon Web Services Secrets Manager. For more information, see Password management with
Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management
with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide. Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if
MasterUserPassword is specified.
- `"MasterUserPassword"`: The password for the master database user. This password can
contain any printable ASCII character except \"/\", \"\"\", or \"@\". Constraints: Must
contain from 8 to 41 characters. Can't be specified if ManageMasterUserPassword is turned
on.
- `"MasterUserSecretKmsKeyId"`: The Amazon Web Services KMS key identifier to encrypt a
secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web
Services Secrets Manager for the DB cluster. The Amazon Web Services KMS key identifier is
the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a
different Amazon Web Services account, specify the key ARN or alias ARN. If you don't
specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt
the secret. If the secret is in a different Amazon Web Services account, then you can't use
the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed
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.
- `"NetworkType"`: The network type of the DB cluster. Valid Values: IPV4 DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A
DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User
Guide.
- `"OptionGroupName"`: A value that indicates that the restored DB cluster should be
associated with the specified option group. Permanent options can't be removed from an
option group. An option group can't be removed from a DB cluster once it is associated with
a DB cluster.
- `"Port"`: The port number on which the instances in the restored DB cluster accept
connections. Default: 3306
- `"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. To view the time blocks available, see Backup window in the
Amazon Aurora User Guide. Constraints: Must be in the format hh24:mi-hh24:mi. Must be
in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance
window. Must be at least 30 minutes.
- `"PreferredMaintenanceWindow"`: The weekly time range during which system maintenance can
occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is
a 30-minute window selected at random from an 8-hour block of time for each Amazon Web
Services Region, occurring on a random day of the week. To see the time blocks available,
see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide. Valid
Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window.
- `"S3Prefix"`: The prefix for all of the file names that contain the data used to create
the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon
Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.
- `"ServerlessV2ScalingConfiguration"`:
- `"StorageEncrypted"`: Specifies whether the restored DB cluster is encrypted.
- `"StorageType"`: Specifies the storage type to be associated with the DB cluster. Valid
Values: aurora, aurora-iopt1 Default: aurora Valid for: Aurora DB clusters only
- `"Tags"`:
- `"VpcSecurityGroupIds"`: A list of EC2 VPC security groups to associate with the restored
DB cluster.
"""
function restore_dbcluster_from_s3(
DBClusterIdentifier,
Engine,
MasterUsername,
S3BucketName,
S3IngestionRoleArn,
SourceEngine,
SourceEngineVersion;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"RestoreDBClusterFromS3",
Dict{String,Any}(
"DBClusterIdentifier" => DBClusterIdentifier,
"Engine" => Engine,
"MasterUsername" => MasterUsername,
"S3BucketName" => S3BucketName,
"S3IngestionRoleArn" => S3IngestionRoleArn,
"SourceEngine" => SourceEngine,
"SourceEngineVersion" => SourceEngineVersion,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function restore_dbcluster_from_s3(
DBClusterIdentifier,
Engine,
MasterUsername,
S3BucketName,
S3IngestionRoleArn,
SourceEngine,
SourceEngineVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"RestoreDBClusterFromS3",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBClusterIdentifier" => DBClusterIdentifier,
"Engine" => Engine,
"MasterUsername" => MasterUsername,
"S3BucketName" => S3BucketName,
"S3IngestionRoleArn" => S3IngestionRoleArn,
"SourceEngine" => SourceEngine,
"SourceEngineVersion" => SourceEngineVersion,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restore_dbcluster_from_snapshot(dbcluster_identifier, engine, snapshot_identifier)
restore_dbcluster_from_snapshot(dbcluster_identifier, engine, snapshot_identifier, params::Dict{String,<:Any})
Creates a new DB cluster from a DB snapshot or DB cluster snapshot. The target DB cluster
is created from the source snapshot with a default configuration. If you don't specify a
security group, the new DB cluster is associated with the default security group. This
operation only restores the DB cluster, not the DB instances for that DB cluster. You must
invoke the CreateDBInstance operation to create DB instances for the restored DB cluster,
specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create
DB instances only after the RestoreDBClusterFromSnapshot operation has completed and the DB
cluster is available. For more information on Amazon Aurora DB clusters, see What is
Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB
clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
# Arguments
- `dbcluster_identifier`: The name of the DB cluster to create from the DB snapshot or DB
cluster snapshot. This parameter isn't case-sensitive. Constraints: Must contain from 1
to 63 letters, numbers, or hyphens First character must be a letter Can't end with a
hyphen or contain two consecutive hyphens Example: my-snapshot-id Valid for: Aurora DB
clusters and Multi-AZ DB clusters
- `engine`: The database engine to use for the new DB cluster. Default: The same as source
Constraint: Must be compatible with the engine of the source Valid for: Aurora DB clusters
and Multi-AZ DB clusters
- `snapshot_identifier`: The identifier for the DB snapshot or DB cluster snapshot to
restore from. You can use either the name or the Amazon Resource Name (ARN) to specify a DB
cluster snapshot. However, you can use only the ARN to specify a DB snapshot. Constraints:
Must match the identifier of an existing Snapshot. Valid for: Aurora DB clusters and
Multi-AZ DB clusters
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AvailabilityZones"`: Provides the list of Availability Zones (AZs) where instances in
the restored DB cluster can be created. Valid for: Aurora DB clusters only
- `"BacktrackWindow"`: The target backtrack window, in seconds. To disable backtracking,
set this value to 0. Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0 Constraints: If specified, this value must be set to a number from 0 to
259,200 (72 hours). Valid for: Aurora DB clusters only
- `"CopyTagsToSnapshot"`: Specifies whether to copy all tags from the restored DB cluster
to snapshots of the restored DB cluster. The default is not to copy them. Valid for: Aurora
DB clusters and Multi-AZ DB clusters
- `"DBClusterInstanceClass"`: The compute and memory capacity of the each DB instance in
the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are
available in all Amazon Web Services Regions, or for all database engines. For the full
list of DB instance classes, and availability for your engine, see DB Instance Class in the
Amazon RDS User Guide. Valid for: Multi-AZ DB clusters only
- `"DBClusterParameterGroupName"`: The name of the DB cluster parameter group to associate
with this DB cluster. If this argument is omitted, the default DB cluster parameter group
for the specified engine is used. Constraints: If supplied, must match the name of an
existing default DB cluster parameter group. Must be 1 to 255 letters, numbers, or
hyphens. First character must be a letter. Can't end with a hyphen or contain two
consecutive hyphens. Valid for: Aurora DB clusters and Multi-AZ DB clusters
- `"DBSubnetGroupName"`: The name of the DB subnet group to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DB subnet group. Example:
mydbsubnetgroup Valid for: Aurora DB clusters and Multi-AZ DB clusters
- `"DatabaseName"`: The database name for the restored DB cluster. Valid for: Aurora DB
clusters and Multi-AZ DB clusters
- `"DeletionProtection"`: Specifies whether to enable deletion protection for the DB
cluster. The database can't be deleted when deletion protection is enabled. By default,
deletion protection isn't enabled. Valid for: Aurora DB clusters and Multi-AZ DB clusters
- `"Domain"`: The Active Directory directory ID to restore the DB cluster in. The domain
must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server,
Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more
information, see Kerberos Authentication in the Amazon RDS User Guide. Valid for: Aurora
DB clusters only
- `"DomainIAMRoleName"`: The name of the IAM role to be used when making API calls to the
Directory Service. Valid for: Aurora DB clusters only
- `"EnableCloudwatchLogsExports"`: The list of logs that the restored DB cluster is to
export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being
used. RDS for MySQL Possible values are error, general, and slowquery. RDS for
PostgreSQL Possible values are postgresql and upgrade. Aurora MySQL Possible values are
audit, error, general, and slowquery. Aurora PostgreSQL Possible value is postgresql. For
more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database
Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide. For more information about
exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon
CloudWatch Logs in the Amazon Aurora User Guide. Valid for: Aurora DB clusters and Multi-AZ
DB clusters
- `"EnableIAMDatabaseAuthentication"`: Specifies whether to enable mapping of Amazon Web
Services Identity and Access Management (IAM) accounts to database accounts. By default,
mapping isn't enabled. For more information, see IAM Database Authentication in the Amazon
Aurora User Guide. Valid for: Aurora DB clusters only
- `"EngineLifecycleSupport"`: The life cycle type for this DB cluster. By default, this
value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon
RDS Extended Support. At the end of standard support, you can avoid charges for Extended
Support by setting the value to open-source-rds-extended-support-disabled. In this case,
RDS automatically upgrades your restored DB cluster to a higher engine version, if the
major engine version is past its end of standard support date. You can use this setting to
enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can
run the selected major engine version on your DB cluster past the end of standard support
for that engine version. For more information, see the following sections: Amazon Aurora
(PostgreSQL only) - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide Valid for
Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values:
open-source-rds-extended-support | open-source-rds-extended-support-disabled Default:
open-source-rds-extended-support
- `"EngineMode"`: The DB engine mode of the DB cluster, either provisioned or serverless.
For more information, see CreateDBCluster. Valid for: Aurora DB clusters only
- `"EngineVersion"`: The version of the database engine to use for the new DB cluster. If
you don't specify an engine version, the default version for the database engine in the
Amazon Web Services Region is used. To list all of the available engine versions for Aurora
MySQL, use the following command: aws rds describe-db-engine-versions --engine
aurora-mysql --query \"DBEngineVersions[].EngineVersion\" To list all of the available
engine versions for Aurora PostgreSQL, use the following command: aws rds
describe-db-engine-versions --engine aurora-postgresql --query
\"DBEngineVersions[].EngineVersion\" To list all of the available engine versions for RDS
for MySQL, use the following command: aws rds describe-db-engine-versions --engine mysql
--query \"DBEngineVersions[].EngineVersion\" To list all of the available engine versions
for RDS for PostgreSQL, use the following command: aws rds describe-db-engine-versions
--engine postgres --query \"DBEngineVersions[].EngineVersion\" Aurora MySQL See Database
engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide. Aurora PostgreSQL
See Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.
MySQL See Amazon RDS for MySQL in the Amazon RDS User Guide. PostgreSQL See Amazon RDS
for PostgreSQL versions and extensions in the Amazon RDS User Guide. Valid for: Aurora DB
clusters and Multi-AZ DB clusters
- `"Iops"`: The amount of Provisioned IOPS (input/output operations per second) to be
initially allocated for each DB instance in the Multi-AZ DB cluster. For information about
valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB
instance. Valid for: Aurora DB clusters and Multi-AZ DB clusters
- `"KmsKeyId"`: The Amazon Web Services KMS key identifier to use when restoring an
encrypted DB cluster from a DB snapshot or DB cluster snapshot. The Amazon Web Services KMS
key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a
KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. When
you don't specify a value for the KmsKeyId parameter, then the following occurs: If the
DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB
cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB
cluster snapshot. If the DB snapshot or DB cluster snapshot in SnapshotIdentifier isn't
encrypted, then the restored DB cluster isn't encrypted. Valid for: Aurora DB clusters
and Multi-AZ DB clusters
- `"NetworkType"`: The network type of the DB cluster. Valid Values: IPV4 DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A
DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User
Guide. Valid for: Aurora DB clusters only
- `"OptionGroupName"`: The name of the option group to use for the restored DB cluster. DB
clusters are associated with a default option group that can't be modified.
- `"Port"`: The port number on which the new DB cluster accepts connections. Constraints:
This value must be 1150-65535 Default: The same port as the original DB cluster. Valid
for: Aurora DB clusters and Multi-AZ DB clusters
- `"PubliclyAccessible"`: Specifies whether the DB cluster is publicly accessible. When the
DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the
private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to
the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is
ultimately controlled by the security group it uses. That public access is not permitted if
the security group assigned to the DB cluster doesn't permit it. When the DB cluster isn't
publicly accessible, it is an internal DB cluster with a DNS name that resolves to a
private IP address. Default: The default behavior varies depending on whether
DBSubnetGroupName is specified. If DBSubnetGroupName isn't specified, and
PubliclyAccessible isn't specified, the following applies: If the default VPC in the
target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB
cluster is public. If DBSubnetGroupName is specified, and PubliclyAccessible isn't
specified, the following applies: If the subnets are part of a VPC that doesn’t have an
internet gateway attached to it, the DB cluster is private. If the subnets are part of a
VPC that has an internet gateway attached to it, the DB cluster is public. Valid for:
Aurora DB clusters and Multi-AZ DB clusters
- `"RdsCustomClusterConfiguration"`: Reserved for future use.
- `"ScalingConfiguration"`: For DB clusters in serverless DB engine mode, the scaling
properties of the DB cluster. Valid for: Aurora DB clusters only
- `"ServerlessV2ScalingConfiguration"`:
- `"StorageType"`: Specifies the storage type to be associated with the DB cluster. When
specified for a Multi-AZ DB cluster, a value for the Iops parameter is required. Valid
Values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters) Default:
aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters) Valid for: Aurora DB clusters and
Multi-AZ DB clusters
- `"Tags"`: The tags to be assigned to the restored DB cluster. Valid for: Aurora DB
clusters and Multi-AZ DB clusters
- `"VpcSecurityGroupIds"`: A list of VPC security groups that the new DB cluster will
belong to. Valid for: Aurora DB clusters and Multi-AZ DB clusters
"""
function restore_dbcluster_from_snapshot(
DBClusterIdentifier,
Engine,
SnapshotIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"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 rds(
"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)
restore_dbcluster_to_point_in_time(dbcluster_identifier, params::Dict{String,<:Any})
Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time
before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is
created from the source DB cluster with the same configuration as the original DB cluster,
except that the new DB cluster is created with the default DB security group. For Aurora,
this operation only restores the DB cluster, not the DB instances for that DB cluster. You
must invoke the CreateDBInstance operation to create DB instances for the restored DB
cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You
can create DB instances only after the RestoreDBClusterToPointInTime operation has
completed and the DB cluster is available. For more information on Amazon Aurora DB
clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information
on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
# Arguments
- `dbcluster_identifier`: The name of the new DB cluster to be created. Constraints: Must
contain from 1 to 63 letters, numbers, or hyphens First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens Valid for: Aurora DB clusters
and Multi-AZ DB clusters
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BacktrackWindow"`: The target backtrack window, in seconds. To disable backtracking,
set this value to 0. Default: 0 Constraints: If specified, this value must be set to a
number from 0 to 259,200 (72 hours). Valid for: Aurora MySQL DB clusters only
- `"CopyTagsToSnapshot"`: Specifies whether to copy all tags from the restored DB cluster
to snapshots of the restored DB cluster. The default is not to copy them. Valid for: Aurora
DB clusters and Multi-AZ DB clusters
- `"DBClusterInstanceClass"`: The compute and memory capacity of the each DB instance in
the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are
available in all Amazon Web Services Regions, or for all database engines. For the full
list of DB instance classes, and availability for your engine, see DB instance class in the
Amazon RDS User Guide. Valid for: Multi-AZ DB clusters only
- `"DBClusterParameterGroupName"`: The name of the custom DB cluster parameter group to
associate with this DB cluster. If the DBClusterParameterGroupName parameter is omitted,
the default DB cluster parameter group for the specified engine is used. Constraints: If
supplied, must match the name of an existing DB cluster parameter group. Must be 1 to 255
letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen
or contain two consecutive hyphens. Valid for: Aurora DB clusters and Multi-AZ DB clusters
- `"DBSubnetGroupName"`: The DB subnet group name to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example:
mydbsubnetgroup Valid for: Aurora DB clusters and Multi-AZ DB clusters
- `"DeletionProtection"`: Specifies whether to enable deletion protection for the DB
cluster. The database can't be deleted when deletion protection is enabled. By default,
deletion protection isn't enabled. Valid for: Aurora DB clusters and Multi-AZ DB clusters
- `"Domain"`: The Active Directory directory ID to restore the DB cluster in. The domain
must be created prior to this operation. For Amazon Aurora DB clusters, Amazon RDS can use
Kerberos Authentication to authenticate users that connect to the DB cluster. For more
information, see Kerberos Authentication in the Amazon Aurora User Guide. Valid for: Aurora
DB clusters only
- `"DomainIAMRoleName"`: The name of the IAM role to be used when making API calls to the
Directory Service. Valid for: Aurora DB clusters only
- `"EnableCloudwatchLogsExports"`: The list of logs that the restored DB cluster is to
export to CloudWatch Logs. The values in the list depend on the DB engine being used. RDS
for MySQL Possible values are error, general, and slowquery. RDS for PostgreSQL Possible
values are postgresql and upgrade. Aurora MySQL Possible values are audit, error,
general, and slowquery. Aurora PostgreSQL Possible value is postgresql. For more
information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to
Amazon CloudWatch Logs in the Amazon RDS User Guide. For more information about exporting
CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs
in the Amazon Aurora User Guide. Valid for: Aurora DB clusters and Multi-AZ DB clusters
- `"EnableIAMDatabaseAuthentication"`: Specifies whether to enable mapping of Amazon Web
Services Identity and Access Management (IAM) accounts to database accounts. By default,
mapping isn't enabled. For more information, see IAM Database Authentication in the Amazon
Aurora User Guide. Valid for: Aurora DB clusters only
- `"EngineLifecycleSupport"`: The life cycle type for this DB cluster. By default, this
value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon
RDS Extended Support. At the end of standard support, you can avoid charges for Extended
Support by setting the value to open-source-rds-extended-support-disabled. In this case,
RDS automatically upgrades your restored DB cluster to a higher engine version, if the
major engine version is past its end of standard support date. You can use this setting to
enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can
run the selected major engine version on your DB cluster past the end of standard support
for that engine version. For more information, see the following sections: Amazon Aurora
(PostgreSQL only) - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide Valid for
Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values:
open-source-rds-extended-support | open-source-rds-extended-support-disabled Default:
open-source-rds-extended-support
- `"EngineMode"`: The engine mode of the new cluster. Specify provisioned or serverless,
depending on the type of the cluster you are creating. You can create an Aurora Serverless
v1 clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1
cluster. To create a clone that is an Aurora Serverless v1 cluster, the original cluster
must be an Aurora Serverless v1 cluster or an encrypted provisioned cluster. Valid for:
Aurora DB clusters only
- `"Iops"`: The amount of Provisioned IOPS (input/output operations per second) to be
initially allocated for each DB instance in the Multi-AZ DB cluster. For information about
valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB
instance. Valid for: Multi-AZ DB clusters only
- `"KmsKeyId"`: The Amazon Web Services KMS key identifier to use when restoring an
encrypted DB cluster from an encrypted DB cluster. The Amazon Web Services KMS key
identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS
key in a different Amazon Web Services account, specify the key ARN or alias ARN. You can
restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different
from the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted
with the KMS key identified by the KmsKeyId parameter. If you don't specify a value for the
KmsKeyId parameter, then the following occurs: If the DB cluster is encrypted, then the
restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB
cluster. If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.
If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore
request is rejected. Valid for: Aurora DB clusters and Multi-AZ DB clusters
- `"NetworkType"`: The network type of the DB cluster. Valid Values: IPV4 DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A
DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User
Guide. Valid for: Aurora DB clusters only
- `"OptionGroupName"`: The name of the option group for the new DB cluster. DB clusters are
associated with a default option group that can't be modified.
- `"Port"`: The port number on which the new DB cluster accepts connections. Constraints: A
value from 1150-65535. Default: The default port for the engine. Valid for: Aurora DB
clusters and Multi-AZ DB clusters
- `"PubliclyAccessible"`: Specifies whether the DB cluster is publicly accessible. When the
DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the
private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to
the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is
ultimately controlled by the security group it uses. That public access is not permitted if
the security group assigned to the DB cluster doesn't permit it. When the DB cluster isn't
publicly accessible, it is an internal DB cluster with a DNS name that resolves to a
private IP address. Default: The default behavior varies depending on whether
DBSubnetGroupName is specified. If DBSubnetGroupName isn't specified, and
PubliclyAccessible isn't specified, the following applies: If the default VPC in the
target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB
cluster is public. If DBSubnetGroupName is specified, and PubliclyAccessible isn't
specified, the following applies: If the subnets are part of a VPC that doesn’t have an
internet gateway attached to it, the DB cluster is private. If the subnets are part of a
VPC that has an internet gateway attached to it, the DB cluster is public. Valid for:
Multi-AZ DB clusters only
- `"RdsCustomClusterConfiguration"`: Reserved for future use.
- `"RestoreToTime"`: The date and time to restore the DB cluster to. Valid Values: Value
must be a time in Universal Coordinated Time (UTC) format Constraints: Must be before the
latest restorable time for the DB instance Must be specified if UseLatestRestorableTime
parameter isn't provided Can't be specified if the UseLatestRestorableTime parameter is
enabled Can't be specified if the RestoreType parameter is copy-on-write Example:
2015-03-07T23:45:00Z Valid for: Aurora DB clusters and Multi-AZ DB clusters
- `"RestoreType"`: The type of restore to be performed. You can specify one of the
following values: full-copy - The new DB cluster is restored as a full copy of the
source DB cluster. copy-on-write - The new DB cluster is restored as a clone of the
source DB cluster. If you don't specify a RestoreType value, then the new DB cluster is
restored as a full copy of the source DB cluster. Valid for: Aurora DB clusters and
Multi-AZ DB clusters
- `"ScalingConfiguration"`: For DB clusters in serverless DB engine mode, the scaling
properties of the DB cluster. Valid for: Aurora DB clusters only
- `"ServerlessV2ScalingConfiguration"`:
- `"SourceDBClusterIdentifier"`: The identifier of the source DB cluster from which to
restore. Constraints: Must match the identifier of an existing DBCluster. Valid for:
Aurora DB clusters and Multi-AZ DB clusters
- `"SourceDbClusterResourceId"`: The resource ID of the source DB cluster from which to
restore.
- `"StorageType"`: Specifies the storage type to be associated with the DB cluster. When
specified for a Multi-AZ DB cluster, a value for the Iops parameter is required. Valid
Values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters) Default:
aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters) Valid for: Aurora DB clusters and
Multi-AZ DB clusters
- `"Tags"`:
- `"UseLatestRestorableTime"`: Specifies whether to restore the DB cluster to the latest
restorable backup time. By default, the DB cluster isn't restored to the latest restorable
backup time. Constraints: Can't be specified if RestoreToTime parameter is provided. Valid
for: Aurora DB clusters and Multi-AZ DB clusters
- `"VpcSecurityGroupIds"`: A list of VPC security groups that the new DB cluster belongs
to. Valid for: Aurora DB clusters and Multi-AZ DB clusters
"""
function restore_dbcluster_to_point_in_time(
DBClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"RestoreDBClusterToPointInTime",
Dict{String,Any}("DBClusterIdentifier" => DBClusterIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function restore_dbcluster_to_point_in_time(
DBClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"RestoreDBClusterToPointInTime",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBClusterIdentifier" => DBClusterIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restore_dbinstance_from_dbsnapshot(dbinstance_identifier)
restore_dbinstance_from_dbsnapshot(dbinstance_identifier, params::Dict{String,<:Any})
Creates a new DB instance from a DB snapshot. The target database is created from the
source database restore point with most of the source's original configuration, including
the default security group and DB parameter group. By default, the new DB instance is
created as a Single-AZ deployment, except when the instance is a SQL Server instance that
has an option group associated with mirroring. In this case, the instance becomes a
Multi-AZ deployment, not a Single-AZ deployment. If you want to replace your original DB
instance with the new, restored DB instance, then rename your original DB instance before
you call the RestoreDBInstanceFromDBSnapshot operation. RDS doesn't allow two DB instances
with the same name. After you have renamed your original DB instance with a different
identifier, then you can pass the original name of the DB instance as the
DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot operation. The
result is that you replace the original DB instance with the DB instance created from the
snapshot. If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier
must be the ARN of the shared DB snapshot. This command doesn't apply to Aurora MySQL and
Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.
# Arguments
- `dbinstance_identifier`: The name of the DB instance to create from the DB snapshot. This
parameter isn't case-sensitive. Constraints: Must contain from 1 to 63 numbers, letters,
or hyphens. First character must be a letter. Can't end with a hyphen or contain two
consecutive hyphens. Example: my-snapshot-id
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllocatedStorage"`: The amount of storage (in gibibytes) to allocate initially for the
DB instance. Follow the allocation rules specified in CreateDBInstance. Be sure to
allocate enough storage for your new DB instance so that the restore operation can succeed.
You can also allocate additional storage for future growth.
- `"AutoMinorVersionUpgrade"`: Specifies whether to automatically apply minor version
upgrades to the DB instance during the maintenance window. If you restore an RDS Custom DB
instance, you must disable this parameter.
- `"AvailabilityZone"`: The Availability Zone (AZ) where the DB instance will be created.
Default: A random, system-chosen Availability Zone. Constraint: You can't specify the
AvailabilityZone parameter if the DB instance is a Multi-AZ deployment. Example: us-east-1a
- `"BackupTarget"`: Specifies where automated backups and manual snapshots are stored for
the restored DB instance. Possible values are outposts (Amazon Web Services Outposts) and
region (Amazon Web Services Region). The default is region. For more information, see
Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
- `"CACertificateIdentifier"`: The CA certificate identifier to use for the DB instance's
server certificate. This setting doesn't apply to RDS Custom DB instances. For more
information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS
User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora
User Guide.
- `"CopyTagsToSnapshot"`: Specifies whether to copy all tags from the restored DB instance
to snapshots of the DB instance. In most cases, tags aren't copied by default. However,
when you restore a DB instance from a DB snapshot, RDS checks whether you specify new tags.
If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS
looks for the tags from the source DB instance for the DB snapshot, and then adds those
tags to the restored DB instance. For more information, see Copying tags to DB instance
snapshots in the Amazon RDS User Guide.
- `"CustomIamInstanceProfile"`: The instance profile associated with the underlying Amazon
EC2 instance of an RDS Custom DB instance. The instance profile must meet the following
requirements: The profile must exist in your account. The profile must have an IAM role
that Amazon EC2 has permissions to assume. The instance profile name and the associated
IAM role name must start with the prefix AWSRDSCustom. For the list of permissions
required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
This setting is required for RDS Custom.
- `"DBClusterSnapshotIdentifier"`: The identifier for the Multi-AZ DB cluster snapshot to
restore from. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster
deployments in the Amazon RDS User Guide. Constraints: Must match the identifier of an
existing Multi-AZ DB cluster snapshot. Can't be specified when DBSnapshotIdentifier is
specified. Must be specified when DBSnapshotIdentifier isn't specified. If you are
restoring from a shared manual Multi-AZ DB cluster snapshot, the
DBClusterSnapshotIdentifier must be the ARN of the shared snapshot. Can't be the
identifier of an Aurora DB cluster snapshot.
- `"DBInstanceClass"`: The compute and memory capacity of the Amazon RDS DB instance, for
example db.m4.large. Not all DB instance classes are available in all Amazon Web Services
Regions, or for all database engines. For the full list of DB instance classes, and
availability for your engine, see DB Instance Class in the Amazon RDS User Guide. Default:
The same DBInstanceClass as the original DB instance.
- `"DBName"`: The name of the database for the restored DB instance. This parameter only
applies to RDS for Oracle and RDS for SQL Server DB instances. It doesn't apply to the
other engines or to RDS Custom DB instances.
- `"DBParameterGroupName"`: The name of the DB parameter group to associate with this DB
instance. If you don't specify a value for DBParameterGroupName, then RDS uses the default
DBParameterGroup for the specified DB engine. This setting doesn't apply to RDS Custom.
Constraints: If supplied, must match the name of an existing DB parameter group. Must
be 1 to 255 letters, numbers, or hyphens. First character must be a letter. Can't end
with a hyphen or contain two consecutive hyphens.
- `"DBSnapshotIdentifier"`: The identifier for the DB snapshot to restore from.
Constraints: Must match the identifier of an existing DB snapshot. Can't be specified
when DBClusterSnapshotIdentifier is specified. Must be specified when
DBClusterSnapshotIdentifier isn't specified. If you are restoring from a shared manual DB
snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.
- `"DBSubnetGroupName"`: The name of the DB subnet group to use for the new instance.
Constraints: If supplied, must match the name of an existing DB subnet group. Example:
mydbsubnetgroup
- `"DedicatedLogVolume"`: Specifies whether to enable a dedicated log volume (DLV) for the
DB instance.
- `"DeletionProtection"`: Specifies whether to enable deletion protection for the DB
instance. The database can't be deleted when deletion protection is enabled. By default,
deletion protection isn't enabled. For more information, see Deleting a DB Instance.
- `"Domain"`: The Active Directory directory ID to restore the DB instance in. The domain/
must be created prior to this operation. Currently, you can create only Db2, MySQL,
Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide. This
setting doesn't apply to RDS Custom.
- `"DomainAuthSecretArn"`: The ARN for the Secrets Manager secret with the credentials for
the user joining the domain. Constraints: Can't be longer than 64 characters. Example:
arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
- `"DomainDnsIps"`: The IPv4 DNS IP addresses of your primary and secondary Active
Directory domain controllers. Constraints: Two IP addresses must be provided. If there
isn't a secondary domain controller, use the IP address of the primary domain controller
for both entries in the list. Example: 123.124.125.126,234.235.236.237
- `"DomainFqdn"`: The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints: Can't be longer than 64 characters. Example:
mymanagedADtest.mymanagedAD.mydomain
- `"DomainIAMRoleName"`: The name of the IAM role to use when making API calls to the
Directory Service. This setting doesn't apply to RDS Custom DB instances.
- `"DomainOu"`: The Active Directory organizational unit for your DB instance to join.
Constraints: Must be in the distinguished name format. Can't be longer than 64
characters. Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
- `"EnableCloudwatchLogsExports"`: The list of logs for the restored DB instance to export
to CloudWatch Logs. The values in the list depend on the DB engine. For more information,
see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide. This
setting doesn't apply to RDS Custom.
- `"EnableCustomerOwnedIp"`: Specifies whether to enable a customer-owned IP address (CoIP)
for an RDS on Outposts DB instance. A CoIP provides local or external connectivity to
resources in your Outpost subnets through your on-premises network. For some use cases, a
CoIP can provide lower latency for connections to the DB instance from outside of its
virtual private cloud (VPC) on your local network. This setting doesn't apply to RDS
Custom. For more information about RDS on Outposts, see Working with Amazon RDS on Amazon
Web Services Outposts in the Amazon RDS User Guide. For more information about CoIPs, see
Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
- `"EnableIAMDatabaseAuthentication"`: Specifies whether to enable mapping of Amazon Web
Services Identity and Access Management (IAM) accounts to database accounts. By default,
mapping is disabled. For more information about IAM database authentication, see IAM
Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide. This
setting doesn't apply to RDS Custom.
- `"Engine"`: The database engine to use for the new instance. This setting doesn't apply
to RDS Custom. Default: The same as source Constraint: Must be compatible with the engine
of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6
snapshot. Valid Values: db2-ae db2-se mariadb mysql oracle-ee
oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee
sqlserver-se sqlserver-ex sqlserver-web
- `"EngineLifecycleSupport"`: The life cycle type for this DB instance. By default, this
value is set to open-source-rds-extended-support, which enrolls your DB instance into
Amazon RDS Extended Support. At the end of standard support, you can avoid charges for
Extended Support by setting the value to open-source-rds-extended-support-disabled. In this
case, RDS automatically upgrades your restored DB instance to a higher engine version, if
the major engine version is past its end of standard support date. You can use this
setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended
Support, you can run the selected major engine version on your DB instance past the end of
standard support for that engine version. For more information, see Using Amazon RDS
Extended Support in the Amazon RDS User Guide. This setting applies only to RDS for MySQL
and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by
the DB cluster. Valid Values: open-source-rds-extended-support |
open-source-rds-extended-support-disabled Default: open-source-rds-extended-support
- `"Iops"`: Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O
operations per second. If this parameter isn't specified, the IOPS value is taken from the
backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS
instance. The conversion takes additional time, though your DB instance is available for
connections before the conversion starts. The provisioned IOPS value must follow the
requirements for your database engine. For more information, see Amazon RDS Provisioned
IOPS storage in the Amazon RDS User Guide. Constraints: Must be an integer greater than
1000.
- `"LicenseModel"`: License model information for the restored DB instance. License models
for RDS for Db2 require additional configuration. The Bring Your Own License (BYOL) model
requires a custom parameter group. The Db2 license through Amazon Web Services Marketplace
model requires an Amazon Web Services Marketplace subscription. For more information, see
RDS for Db2 licensing options in the Amazon RDS User Guide. This setting doesn't apply to
Amazon Aurora or RDS Custom DB instances. Valid Values: RDS for Db2 -
bring-your-own-license | marketplace-license RDS for MariaDB - general-public-license
RDS for Microsoft SQL Server - license-included RDS for MySQL - general-public-license
RDS for Oracle - bring-your-own-license | license-included RDS for PostgreSQL -
postgresql-license Default: Same as the source.
- `"MultiAZ"`: Specifies whether the DB instance is a Multi-AZ deployment. This setting
doesn't apply to RDS Custom. Constraint: You can't specify the AvailabilityZone parameter
if the DB instance is a Multi-AZ deployment.
- `"NetworkType"`: The network type of the DB instance. Valid Values: IPV4 DUAL
The network type is determined by the DBSubnetGroup specified for the DB instance. A
DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User
Guide.
- `"OptionGroupName"`: The name of the option group to be used for the restored DB
instance. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't
be removed from an option group, and that option group can't be removed from a DB instance
after it is associated with a DB instance. This setting doesn't apply to RDS Custom.
- `"Port"`: The port number on which the database accepts connections. Default: The same
port as the original DB instance Constraints: Value must be 1150-65535
- `"ProcessorFeatures"`: The number of CPU cores and the number of threads per core for the
DB instance class of the DB instance. This setting doesn't apply to RDS Custom.
- `"PubliclyAccessible"`: Specifies whether the DB instance is publicly accessible. When
the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to
the private IP address from within the DB instance's virtual private cloud (VPC). It
resolves to the public IP address from outside of the DB instance's VPC. Access to the DB
instance is ultimately controlled by the security group it uses. That public access is not
permitted if the security group assigned to the DB instance doesn't permit it. When the DB
instance isn't publicly accessible, it is an internal DB instance with a DNS name that
resolves to a private IP address. For more information, see CreateDBInstance.
- `"StorageThroughput"`: Specifies the storage throughput value for the DB instance. This
setting doesn't apply to RDS Custom or Amazon Aurora.
- `"StorageType"`: Specifies the storage type to be associated with the DB instance. Valid
Values: gp2 | gp3 | io1 | io2 | standard If you specify io1, io2, or gp3, you must also
include a value for the Iops parameter. Default: io1 if the Iops parameter is specified,
otherwise gp2
- `"Tags"`:
- `"TdeCredentialArn"`: The ARN from the key store with which to associate the instance for
TDE encryption. This setting doesn't apply to RDS Custom.
- `"TdeCredentialPassword"`: The password for the given ARN from the key store in order to
access the device. This setting doesn't apply to RDS Custom.
- `"UseDefaultProcessorFeatures"`: Specifies whether the DB instance class of the DB
instance uses its default processor features. This setting doesn't apply to RDS Custom.
- `"VpcSecurityGroupIds"`: A list of EC2 VPC security groups to associate with this DB
instance. Default: The default EC2 VPC security group for the DB subnet group's VPC.
"""
function restore_dbinstance_from_dbsnapshot(
DBInstanceIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"RestoreDBInstanceFromDBSnapshot",
Dict{String,Any}("DBInstanceIdentifier" => DBInstanceIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function restore_dbinstance_from_dbsnapshot(
DBInstanceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"RestoreDBInstanceFromDBSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBInstanceIdentifier" => DBInstanceIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restore_dbinstance_from_s3(dbinstance_class, dbinstance_identifier, engine, s3_bucket_name, s3_ingestion_role_arn, source_engine, source_engine_version)
restore_dbinstance_from_s3(dbinstance_class, dbinstance_identifier, engine, s3_bucket_name, s3_ingestion_role_arn, source_engine, source_engine_version, params::Dict{String,<:Any})
Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using
backup files. You can create a backup of your on-premises database, store it on Amazon
Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS
DB instance running MySQL. For more information, see Importing Data into an Amazon RDS
MySQL DB Instance in the Amazon RDS User Guide. This operation doesn't apply to RDS Custom.
# Arguments
- `dbinstance_class`: The compute and memory capacity of the DB instance, for example
db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions,
or for all database engines. For the full list of DB instance classes, and availability for
your engine, see DB Instance Class in the Amazon RDS User Guide. Importing from Amazon S3
isn't supported on the db.t2.micro DB instance class.
- `dbinstance_identifier`: The DB instance identifier. This parameter is stored as a
lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter. Can't end with a hyphen or contain two consecutive
hyphens. Example: mydbinstance
- `engine`: The name of the database engine to be used for this instance. Valid Values:
mysql
- `s3_bucket_name`: The name of your Amazon S3 bucket that contains your database backup
file.
- `s3_ingestion_role_arn`: An Amazon Web Services Identity and Access Management (IAM) role
with a trust policy and a permissions policy that allows Amazon RDS to access your Amazon
S3 bucket. For information about this role, see Creating an IAM role manually in the
Amazon RDS User Guide.
- `source_engine`: The name of the engine of your source database. Valid Values: mysql
- `source_engine_version`: The version of the database that the backup files were created
from. MySQL versions 5.6 and 5.7 are supported. Example: 5.6.40
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllocatedStorage"`: The amount of storage (in gibibytes) to allocate initially for the
DB instance. Follow the allocation rules specified in CreateDBInstance. Be sure to
allocate enough storage for your new DB instance so that the restore operation can succeed.
You can also allocate additional storage for future growth.
- `"AutoMinorVersionUpgrade"`: Specifies whether to automatically apply minor engine
upgrades to the DB instance during the maintenance window. By default, minor engine
upgrades are not applied automatically.
- `"AvailabilityZone"`: The Availability Zone that the DB instance is created in. For
information about Amazon Web Services Regions and Availability Zones, see Regions and
Availability Zones in the Amazon RDS User Guide. Default: A random, system-chosen
Availability Zone in the endpoint's Amazon Web Services Region. Example: us-east-1d
Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a
Multi-AZ deployment. The specified Availability Zone must be in the same Amazon Web
Services Region as the current endpoint.
- `"BackupRetentionPeriod"`: The number of days for which automated backups are retained.
Setting this parameter to a positive number enables backups. For more information, see
CreateDBInstance.
- `"CACertificateIdentifier"`: The CA certificate identifier to use for the DB instance's
server certificate. This setting doesn't apply to RDS Custom DB instances. For more
information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS
User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora
User Guide.
- `"CopyTagsToSnapshot"`: Specifies whether to copy all tags from the DB instance to
snapshots of the DB instance. By default, tags are not copied.
- `"DBName"`: The name of the database to create when the DB instance is created. Follow
the naming rules specified in CreateDBInstance.
- `"DBParameterGroupName"`: The name of the DB parameter group to associate with this DB
instance. If you do not specify a value for DBParameterGroupName, then the default
DBParameterGroup for the specified DB engine is used.
- `"DBSecurityGroups"`: A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
- `"DBSubnetGroupName"`: A DB subnet group to associate with this DB instance. Constraints:
If supplied, must match the name of an existing DBSubnetGroup. Example: mydbsubnetgroup
- `"DedicatedLogVolume"`: Specifies whether to enable a dedicated log volume (DLV) for the
DB instance.
- `"DeletionProtection"`: Specifies whether to enable deletion protection for the DB
instance. The database can't be deleted when deletion protection is enabled. By default,
deletion protection isn't enabled. For more information, see Deleting a DB Instance.
- `"EnableCloudwatchLogsExports"`: The list of logs that the restored DB instance is to
export to CloudWatch Logs. The values in the list depend on the DB engine being used. For
more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS
User Guide.
- `"EnableIAMDatabaseAuthentication"`: Specifies whether to enable mapping of Amazon Web
Services Identity and Access Management (IAM) accounts to database accounts. By default,
mapping isn't enabled. For more information about IAM database authentication, see IAM
Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
- `"EnablePerformanceInsights"`: Specifies whether to enable Performance Insights for the
DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS
User Guide.
- `"EngineLifecycleSupport"`: The life cycle type for this DB instance. By default, this
value is set to open-source-rds-extended-support, which enrolls your DB instance into
Amazon RDS Extended Support. At the end of standard support, you can avoid charges for
Extended Support by setting the value to open-source-rds-extended-support-disabled. In this
case, RDS automatically upgrades your restored DB instance to a higher engine version, if
the major engine version is past its end of standard support date. You can use this
setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended
Support, you can run the selected major engine version on your DB instance past the end of
standard support for that engine version. For more information, see Using Amazon RDS
Extended Support in the Amazon RDS User Guide. This setting applies only to RDS for MySQL
and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by
the DB cluster. Valid Values: open-source-rds-extended-support |
open-source-rds-extended-support-disabled Default: open-source-rds-extended-support
- `"EngineVersion"`: The version number of the database engine to use. Choose the latest
minor version of your database engine. For information about engine versions, see
CreateDBInstance, or call DescribeDBEngineVersions.
- `"Iops"`: The amount of Provisioned IOPS (input/output operations per second) to allocate
initially for the DB instance. For information about valid IOPS values, see Amazon RDS
Provisioned IOPS storage in the Amazon RDS User Guide.
- `"KmsKeyId"`: The Amazon Web Services KMS key identifier for an encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name
for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the
key ARN or alias ARN. If the StorageEncrypted parameter is enabled, and you do not specify
a value for the KmsKeyId parameter, then Amazon RDS will use 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.
- `"LicenseModel"`: The license model for this DB instance. Use general-public-license.
- `"ManageMasterUserPassword"`: Specifies whether to manage the master user password with
Amazon Web Services Secrets Manager. For more information, see Password management with
Amazon Web Services Secrets Manager in the Amazon RDS User Guide. Constraints: Can't
manage the master user password with Amazon Web Services Secrets Manager if
MasterUserPassword is specified.
- `"MasterUserPassword"`: The password for the master user. Constraints: Can't be
specified if ManageMasterUserPassword is turned on. Can include any printable ASCII
character except \"/\", \"\"\", or \"@\". For RDS for Oracle, can't include the \"&\"
(ampersand) or the \"'\" (single quotes) character. Length Constraints: RDS for Db2 -
Must contain from 8 to 128 characters. RDS for MariaDB - Must contain from 8 to 41
characters. RDS for Microsoft SQL Server - Must contain from 8 to 128 characters. RDS
for MySQL - Must contain from 8 to 41 characters. RDS for Oracle - Must contain from 8 to
30 characters. RDS for PostgreSQL - Must contain from 8 to 128 characters.
- `"MasterUserSecretKmsKeyId"`: The Amazon Web Services KMS key identifier to encrypt a
secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web
Services Secrets Manager for the DB instance. The Amazon Web Services KMS key identifier is
the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a
different Amazon Web Services account, specify the key ARN or alias ARN. If you don't
specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt
the secret. If the secret is in a different Amazon Web Services account, then you can't use
the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed
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.
- `"MasterUsername"`: The name for the master user. Constraints: Must be 1 to 16 letters
or numbers. First character must be a letter. Can't be a reserved word for the chosen
database engine.
- `"MaxAllocatedStorage"`: The upper limit in gibibytes (GiB) to which Amazon RDS can
automatically scale the storage of the DB instance. For more information about this
setting, including limitations that apply to it, see Managing capacity automatically with
Amazon RDS storage autoscaling in the Amazon RDS User Guide.
- `"MonitoringInterval"`: The interval, in seconds, between points when Enhanced Monitoring
metrics are collected for the DB instance. To disable collecting Enhanced Monitoring
metrics, specify 0. If MonitoringRoleArn is specified, then you must also set
MonitoringInterval to a value other than 0. Valid Values: 0, 1, 5, 10, 15, 30, 60 Default:
0
- `"MonitoringRoleArn"`: The ARN for the IAM role that permits RDS to send enhanced
monitoring metrics to Amazon CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see
Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide. If
MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn
value.
- `"MultiAZ"`: Specifies whether the DB instance is a Multi-AZ deployment. If the DB
instance is a Multi-AZ deployment, you can't set the AvailabilityZone parameter.
- `"NetworkType"`: The network type of the DB instance. Valid Values: IPV4 DUAL
The network type is determined by the DBSubnetGroup specified for the DB instance. A
DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User
Guide.
- `"OptionGroupName"`: The name of the option group to associate with this DB instance. If
this argument is omitted, the default option group for the specified engine is used.
- `"PerformanceInsightsKMSKeyId"`: The Amazon Web Services KMS key identifier for
encryption of Performance Insights data. The Amazon Web Services 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 RDS 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.
- `"PerformanceInsightsRetentionPeriod"`: The number of days to retain Performance Insights
data. The default is 7 days. The following values are valid: 7 month * 31, where month
is a number of months from 1-23 731 For example, the following values are valid: 93
(3 months * 31) 341 (11 months * 31) 589 (19 months * 31) 731 If you specify a
retention period such as 94, which isn't a valid value, RDS issues an error.
- `"Port"`: The port number on which the database accepts connections. Type: Integer Valid
Values: 1150-65535 Default: 3306
- `"PreferredBackupWindow"`: The time range each day during which automated backups are
created if automated backups are enabled. For more information, see Backup window in the
Amazon RDS User Guide. Constraints: Must be in the format hh24:mi-hh24:mi. Must be in
Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance
window. Must be at least 30 minutes.
- `"PreferredMaintenanceWindow"`: The time range each week during which system maintenance
can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS
Maintenance Window in the Amazon RDS User Guide. Constraints: Must be in the format
ddd:hh24:mi-ddd:hh24:mi. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Must be in
Universal Coordinated Time (UTC). Must not conflict with the preferred backup window.
Must be at least 30 minutes.
- `"ProcessorFeatures"`: The number of CPU cores and the number of threads per core for the
DB instance class of the DB instance.
- `"PubliclyAccessible"`: Specifies whether the DB instance is publicly accessible. When
the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to
the private IP address from within the DB instance's virtual private cloud (VPC). It
resolves to the public IP address from outside of the DB instance's VPC. Access to the DB
instance is ultimately controlled by the security group it uses. That public access is not
permitted if the security group assigned to the DB instance doesn't permit it. When the DB
instance isn't publicly accessible, it is an internal DB instance with a DNS name that
resolves to a private IP address. For more information, see CreateDBInstance.
- `"S3Prefix"`: The prefix of your Amazon S3 bucket.
- `"StorageEncrypted"`: Specifies whether the new DB instance is encrypted or not.
- `"StorageThroughput"`: Specifies the storage throughput value for the DB instance. This
setting doesn't apply to RDS Custom or Amazon Aurora.
- `"StorageType"`: Specifies the storage type to be associated with the DB instance. Valid
Values: gp2 | gp3 | io1 | io2 | standard If you specify io1, io2, or gp3, you must also
include a value for the Iops parameter. Default: io1 if the Iops parameter is specified;
otherwise gp2
- `"Tags"`: A list of tags to associate with this DB instance. For more information, see
Tagging Amazon RDS Resources in the Amazon RDS User Guide.
- `"UseDefaultProcessorFeatures"`: Specifies whether the DB instance class of the DB
instance uses its default processor features.
- `"VpcSecurityGroupIds"`: A list of VPC security groups to associate with this DB instance.
"""
function restore_dbinstance_from_s3(
DBInstanceClass,
DBInstanceIdentifier,
Engine,
S3BucketName,
S3IngestionRoleArn,
SourceEngine,
SourceEngineVersion;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"RestoreDBInstanceFromS3",
Dict{String,Any}(
"DBInstanceClass" => DBInstanceClass,
"DBInstanceIdentifier" => DBInstanceIdentifier,
"Engine" => Engine,
"S3BucketName" => S3BucketName,
"S3IngestionRoleArn" => S3IngestionRoleArn,
"SourceEngine" => SourceEngine,
"SourceEngineVersion" => SourceEngineVersion,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function restore_dbinstance_from_s3(
DBInstanceClass,
DBInstanceIdentifier,
Engine,
S3BucketName,
S3IngestionRoleArn,
SourceEngine,
SourceEngineVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"RestoreDBInstanceFromS3",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBInstanceClass" => DBInstanceClass,
"DBInstanceIdentifier" => DBInstanceIdentifier,
"Engine" => Engine,
"S3BucketName" => S3BucketName,
"S3IngestionRoleArn" => S3IngestionRoleArn,
"SourceEngine" => SourceEngine,
"SourceEngineVersion" => SourceEngineVersion,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restore_dbinstance_to_point_in_time(target_dbinstance_identifier)
restore_dbinstance_to_point_in_time(target_dbinstance_identifier, params::Dict{String,<:Any})
Restores a DB instance to an arbitrary point in time. You can restore to any point in time
before the time identified by the LatestRestorableTime property. You can restore to a point
up to the number of days specified by the BackupRetentionPeriod property. The target
database is created with most of the original configuration, but in a system-selected
Availability Zone, with the default security group, the default subnet group, and the
default DB parameter group. By default, the new DB instance is created as a single-AZ
deployment except when the instance is a SQL Server instance that has an option group that
is associated with mirroring; in this case, the instance becomes a mirrored deployment and
not a single-AZ deployment. This operation doesn't apply to Aurora MySQL and Aurora
PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.
# Arguments
- `target_dbinstance_identifier`: The name of the new DB instance to create. Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter.
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:
- `"AllocatedStorage"`: The amount of storage (in gibibytes) to allocate initially for the
DB instance. Follow the allocation rules specified in CreateDBInstance. Be sure to
allocate enough storage for your new DB instance so that the restore operation can succeed.
You can also allocate additional storage for future growth.
- `"AutoMinorVersionUpgrade"`: Specifies whether minor version upgrades are applied
automatically to the DB instance during the maintenance window. This setting doesn't apply
to RDS Custom.
- `"AvailabilityZone"`: The Availability Zone (AZ) where the DB instance will be created.
Default: A random, system-chosen Availability Zone. Constraints: You can't specify the
AvailabilityZone parameter if the DB instance is a Multi-AZ deployment. Example:
us-east-1a
- `"BackupTarget"`: The location for storing automated backups and manual snapshots for the
restored DB instance. Valid Values: outposts (Amazon Web Services Outposts) region
(Amazon Web Services Region) Default: region For more information, see Working with
Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
- `"CACertificateIdentifier"`: The CA certificate identifier to use for the DB instance's
server certificate. This setting doesn't apply to RDS Custom DB instances. For more
information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS
User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora
User Guide.
- `"CopyTagsToSnapshot"`: Specifies whether to copy all tags from the restored DB instance
to snapshots of the DB instance. By default, tags are not copied.
- `"CustomIamInstanceProfile"`: The instance profile associated with the underlying Amazon
EC2 instance of an RDS Custom DB instance. The instance profile must meet the following
requirements: The profile must exist in your account. The profile must have an IAM role
that Amazon EC2 has permissions to assume. The instance profile name and the associated
IAM role name must start with the prefix AWSRDSCustom. For the list of permissions
required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
This setting is required for RDS Custom.
- `"DBInstanceClass"`: The compute and memory capacity of the Amazon RDS DB instance, for
example db.m4.large. Not all DB instance classes are available in all Amazon Web Services
Regions, or for all database engines. For the full list of DB instance classes, and
availability for your engine, see DB Instance Class in the Amazon RDS User Guide. Default:
The same DB instance class as the original DB instance.
- `"DBName"`: The database name for the restored DB instance. This parameter doesn't apply
to the following DB instances: RDS Custom RDS for Db2 RDS for MariaDB RDS for MySQL
- `"DBParameterGroupName"`: The name of the DB parameter group to associate with this DB
instance. If you do not specify a value for DBParameterGroupName, then the default
DBParameterGroup for the specified DB engine is used. This setting doesn't apply to RDS
Custom. Constraints: If supplied, must match the name of an existing DB parameter group.
Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter. Can't
end with a hyphen or contain two consecutive hyphens.
- `"DBSubnetGroupName"`: The DB subnet group name to use for the new instance. Constraints:
If supplied, must match the name of an existing DB subnet group. Example:
mydbsubnetgroup
- `"DedicatedLogVolume"`: Specifies whether to enable a dedicated log volume (DLV) for the
DB instance.
- `"DeletionProtection"`: Specifies whether the DB instance has deletion protection
enabled. The database can't be deleted when deletion protection is enabled. By default,
deletion protection isn't enabled. For more information, see Deleting a DB Instance.
- `"Domain"`: The Active Directory directory ID to restore the DB instance in. Create the
domain before running this command. Currently, you can create only the MySQL, Microsoft SQL
Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain. This setting
doesn't apply to RDS Custom. For more information, see Kerberos Authentication in the
Amazon RDS User Guide.
- `"DomainAuthSecretArn"`: The ARN for the Secrets Manager secret with the credentials for
the user joining the domain. Constraints: Can't be longer than 64 characters. Example:
arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
- `"DomainDnsIps"`: The IPv4 DNS IP addresses of your primary and secondary Active
Directory domain controllers. Constraints: Two IP addresses must be provided. If there
isn't a secondary domain controller, use the IP address of the primary domain controller
for both entries in the list. Example: 123.124.125.126,234.235.236.237
- `"DomainFqdn"`: The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints: Can't be longer than 64 characters. Example:
mymanagedADtest.mymanagedAD.mydomain
- `"DomainIAMRoleName"`: The name of the IAM role to use when making API calls to the
Directory Service. This setting doesn't apply to RDS Custom DB instances.
- `"DomainOu"`: The Active Directory organizational unit for your DB instance to join.
Constraints: Must be in the distinguished name format. Can't be longer than 64
characters. Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
- `"EnableCloudwatchLogsExports"`: The list of logs that the restored DB instance is to
export to CloudWatch Logs. The values in the list depend on the DB engine being used. For
more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS
User Guide. This setting doesn't apply to RDS Custom.
- `"EnableCustomerOwnedIp"`: Specifies whether to enable a customer-owned IP address (CoIP)
for an RDS on Outposts DB instance. A CoIP provides local or external connectivity to
resources in your Outpost subnets through your on-premises network. For some use cases, a
CoIP can provide lower latency for connections to the DB instance from outside of its
virtual private cloud (VPC) on your local network. This setting doesn't apply to RDS
Custom. For more information about RDS on Outposts, see Working with Amazon RDS on Amazon
Web Services Outposts in the Amazon RDS User Guide. For more information about CoIPs, see
Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
- `"EnableIAMDatabaseAuthentication"`: Specifies whether to enable mapping of Amazon Web
Services Identity and Access Management (IAM) accounts to database accounts. By default,
mapping isn't enabled. This setting doesn't apply to RDS Custom. For more information about
IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in
the Amazon RDS User Guide.
- `"Engine"`: The database engine to use for the new instance. This setting doesn't apply
to RDS Custom. Valid Values: db2-ae db2-se mariadb mysql oracle-ee
oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee
sqlserver-se sqlserver-ex sqlserver-web Default: The same as source Constraints:
Must be compatible with the engine of the source.
- `"EngineLifecycleSupport"`: The life cycle type for this DB instance. By default, this
value is set to open-source-rds-extended-support, which enrolls your DB instance into
Amazon RDS Extended Support. At the end of standard support, you can avoid charges for
Extended Support by setting the value to open-source-rds-extended-support-disabled. In this
case, RDS automatically upgrades your restored DB instance to a higher engine version, if
the major engine version is past its end of standard support date. You can use this
setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended
Support, you can run the selected major engine version on your DB instance past the end of
standard support for that engine version. For more information, see Using Amazon RDS
Extended Support in the Amazon RDS User Guide. This setting applies only to RDS for MySQL
and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by
the DB cluster. Valid Values: open-source-rds-extended-support |
open-source-rds-extended-support-disabled Default: open-source-rds-extended-support
- `"Iops"`: The amount of Provisioned IOPS (input/output operations per second) to
initially allocate for the DB instance. This setting doesn't apply to SQL Server.
Constraints: Must be an integer greater than 1000.
- `"LicenseModel"`: The license model information for the restored DB instance. License
models for RDS for Db2 require additional configuration. The Bring Your Own License (BYOL)
model requires a custom parameter group. The Db2 license through Amazon Web Services
Marketplace model requires an Amazon Web Services Marketplace subscription. For more
information, see RDS for Db2 licensing options in the Amazon RDS User Guide. This setting
doesn't apply to Amazon Aurora or RDS Custom DB instances. Valid Values: RDS for Db2 -
bring-your-own-license | marketplace-license RDS for MariaDB - general-public-license
RDS for Microsoft SQL Server - license-included RDS for MySQL - general-public-license
RDS for Oracle - bring-your-own-license | license-included RDS for PostgreSQL -
postgresql-license Default: Same as the source.
- `"MaxAllocatedStorage"`: The upper limit in gibibytes (GiB) to which Amazon RDS can
automatically scale the storage of the DB instance. For more information about this
setting, including limitations that apply to it, see Managing capacity automatically with
Amazon RDS storage autoscaling in the Amazon RDS User Guide. This setting doesn't apply to
RDS Custom.
- `"MultiAZ"`: Secifies whether the DB instance is a Multi-AZ deployment. This setting
doesn't apply to RDS Custom. Constraints: You can't specify the AvailabilityZone
parameter if the DB instance is a Multi-AZ deployment.
- `"NetworkType"`: The network type of the DB instance. The network type is determined by
the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4
protocol or the IPv4 and the IPv6 protocols (DUAL). For more information, see Working with
a DB instance in a VPC in the Amazon RDS User Guide. Valid Values: IPV4 DUAL
- `"OptionGroupName"`: The name of the option group to use for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be
removed from an option group, and that option group can't be removed from a DB instance
after it is associated with a DB instance This setting doesn't apply to RDS Custom.
- `"Port"`: The port number on which the database accepts connections. Default: The same
port as the original DB instance. Constraints: The value must be 1150-65535.
- `"ProcessorFeatures"`: The number of CPU cores and the number of threads per core for the
DB instance class of the DB instance. This setting doesn't apply to RDS Custom.
- `"PubliclyAccessible"`: Specifies whether the DB instance is publicly accessible. When
the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to
the private IP address from within the DB cluster's virtual private cloud (VPC). It
resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB
cluster is ultimately controlled by the security group it uses. That public access isn't
permitted if the security group assigned to the DB cluster doesn't permit it. When the DB
instance isn't publicly accessible, it is an internal DB instance with a DNS name that
resolves to a private IP address. For more information, see CreateDBInstance.
- `"RestoreTime"`: The date and time to restore from. Constraints: Must be a time in
Universal Coordinated Time (UTC) format. Must be before the latest restorable time for
the DB instance. Can't be specified if the UseLatestRestorableTime parameter is enabled.
Example: 2009-09-07T23:45:00Z
- `"SourceDBInstanceAutomatedBackupsArn"`: The Amazon Resource Name (ARN) of the replicated
automated backups from which to restore, for example,
arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE. This setting
doesn't apply to RDS Custom.
- `"SourceDBInstanceIdentifier"`: The identifier of the source DB instance from which to
restore. Constraints: Must match the identifier of an existing DB instance.
- `"SourceDbiResourceId"`: The resource ID of the source DB instance from which to restore.
- `"StorageThroughput"`: The storage throughput value for the DB instance. This setting
doesn't apply to RDS Custom or Amazon Aurora.
- `"StorageType"`: The storage type to associate with the DB instance. Valid Values: gp2 |
gp3 | io1 | io2 | standard Default: io1, if the Iops parameter is specified. Otherwise,
gp2. Constraints: If you specify io1, io2, or gp3, you must also include a value for the
Iops parameter.
- `"Tags"`:
- `"TdeCredentialArn"`: The ARN from the key store with which to associate the instance for
TDE encryption. This setting doesn't apply to RDS Custom.
- `"TdeCredentialPassword"`: The password for the given ARN from the key store in order to
access the device. This setting doesn't apply to RDS Custom.
- `"UseDefaultProcessorFeatures"`: Specifies whether the DB instance class of the DB
instance uses its default processor features. This setting doesn't apply to RDS Custom.
- `"UseLatestRestorableTime"`: Specifies whether the DB instance is restored from the
latest backup time. By default, the DB instance isn't restored from the latest backup time.
Constraints: Can't be specified if the RestoreTime parameter is provided.
- `"VpcSecurityGroupIds"`: A list of EC2 VPC security groups to associate with this DB
instance. Default: The default EC2 VPC security group for the DB subnet group's VPC.
"""
function restore_dbinstance_to_point_in_time(
TargetDBInstanceIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"RestoreDBInstanceToPointInTime",
Dict{String,Any}("TargetDBInstanceIdentifier" => TargetDBInstanceIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function restore_dbinstance_to_point_in_time(
TargetDBInstanceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"RestoreDBInstanceToPointInTime",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TargetDBInstanceIdentifier" => TargetDBInstanceIdentifier
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
revoke_dbsecurity_group_ingress(dbsecurity_group_name)
revoke_dbsecurity_group_ingress(dbsecurity_group_name, params::Dict{String,<:Any})
Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC
security groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for
VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).
EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a
VPC, we recommend that you migrate as soon as possible. For more information, see Migrate
from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is
Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in
the Amazon RDS User Guide.
# Arguments
- `dbsecurity_group_name`: The name of the DB security group to revoke ingress from.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CIDRIP"`: The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is
specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId can't be
provided.
- `"EC2SecurityGroupId"`: The id of the EC2 security group to revoke access from. For VPC
DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId
and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
- `"EC2SecurityGroupName"`: The name of the EC2 security group to revoke access from. For
VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise,
EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be
provided.
- `"EC2SecurityGroupOwnerId"`: The Amazon Web Services account number of the owner of the
EC2 security group specified in the EC2SecurityGroupName parameter. The Amazon Web Services
access key ID isn't an acceptable value. For VPC DB security groups, EC2SecurityGroupId
must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or
EC2SecurityGroupId must be provided.
"""
function revoke_dbsecurity_group_ingress(
DBSecurityGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"RevokeDBSecurityGroupIngress",
Dict{String,Any}("DBSecurityGroupName" => DBSecurityGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function revoke_dbsecurity_group_ingress(
DBSecurityGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"RevokeDBSecurityGroupIngress",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBSecurityGroupName" => DBSecurityGroupName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_activity_stream(kms_key_id, mode, resource_arn)
start_activity_stream(kms_key_id, mode, resource_arn, params::Dict{String,<:Any})
Starts a database activity stream to monitor activity on the database. For more
information, see Monitoring Amazon Aurora with Database Activity Streams in the Amazon
Aurora User Guide or Monitoring Amazon RDS with Database Activity Streams in the Amazon
RDS User Guide.
# Arguments
- `kms_key_id`: The Amazon Web Services KMS key identifier for encrypting messages in the
database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key
ID, alias ARN, or alias name for the KMS key.
- `mode`: Specifies the mode of the database activity stream. Database events such as a
change or access generate an activity stream event. The database session can handle these
events either synchronously or asynchronously.
- `resource_arn`: The Amazon Resource Name (ARN) of the DB cluster, for example,
arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ApplyImmediately"`: Specifies whether or not the database activity stream is to start
as soon as possible, regardless of the maintenance window for the database.
- `"EngineNativeAuditFieldsIncluded"`: Specifies whether the database activity stream
includes engine-native audit fields. This option applies to an Oracle or Microsoft SQL
Server DB instance. By default, no engine-native audit fields are included.
"""
function start_activity_stream(
KmsKeyId, Mode, ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"StartActivityStream",
Dict{String,Any}(
"KmsKeyId" => KmsKeyId, "Mode" => Mode, "ResourceArn" => ResourceArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_activity_stream(
KmsKeyId,
Mode,
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"StartActivityStream",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"KmsKeyId" => KmsKeyId, "Mode" => Mode, "ResourceArn" => ResourceArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_dbcluster(dbcluster_identifier)
start_dbcluster(dbcluster_identifier, params::Dict{String,<:Any})
Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console,
the stop-db-cluster CLI command, or the StopDBCluster operation. For more information, see
Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide. This operation
only applies to Aurora DB clusters.
# Arguments
- `dbcluster_identifier`: The DB cluster identifier of the Amazon Aurora DB cluster to be
started. This parameter is stored as a lowercase string.
"""
function start_dbcluster(
DBClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"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 rds(
"StartDBCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBClusterIdentifier" => DBClusterIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_dbinstance(dbinstance_identifier)
start_dbinstance(dbinstance_identifier, params::Dict{String,<:Any})
Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console,
the stop-db-instance CLI command, or the StopDBInstance operation. For more information,
see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User
Guide. This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For
Aurora DB clusters, use StartDBCluster instead.
# Arguments
- `dbinstance_identifier`: The user-supplied instance identifier.
"""
function start_dbinstance(
DBInstanceIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"StartDBInstance",
Dict{String,Any}("DBInstanceIdentifier" => DBInstanceIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_dbinstance(
DBInstanceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"StartDBInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBInstanceIdentifier" => DBInstanceIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_dbinstance_automated_backups_replication(source_dbinstance_arn)
start_dbinstance_automated_backups_replication(source_dbinstance_arn, params::Dict{String,<:Any})
Enables replication of automated backups to a different Amazon Web Services Region. This
command doesn't apply to RDS Custom. For more information, see Replicating Automated
Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
# Arguments
- `source_dbinstance_arn`: The Amazon Resource Name (ARN) of the source DB instance for the
replicated automated backups, for example, arn:aws:rds:us-west-2:123456789012:db:mydatabase.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BackupRetentionPeriod"`: The retention period for the replicated automated backups.
- `"KmsKeyId"`: The Amazon Web Services KMS key identifier for encryption of the replicated
automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption
key in the destination Amazon Web Services Region, for example,
arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE.
- `"PreSignedUrl"`: In an Amazon Web Services GovCloud (US) Region, an URL that contains a
Signature Version 4 signed request for the StartDBInstanceAutomatedBackupsReplication
operation to call in the Amazon Web Services Region of the source DB instance. The
presigned URL must be a valid request for the StartDBInstanceAutomatedBackupsReplication
API operation that can run in the Amazon Web Services Region that contains the source DB
instance. This setting applies only to Amazon Web Services GovCloud (US) Regions. It's
ignored in other Amazon Web Services Regions. To learn how to generate a Signature Version
4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services
Signature Version 4) and Signature Version 4 Signing Process. 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
presigned URL that is a valid request for the operation that can run in the source Amazon
Web Services Region.
"""
function start_dbinstance_automated_backups_replication(
SourceDBInstanceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"StartDBInstanceAutomatedBackupsReplication",
Dict{String,Any}("SourceDBInstanceArn" => SourceDBInstanceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_dbinstance_automated_backups_replication(
SourceDBInstanceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"StartDBInstanceAutomatedBackupsReplication",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("SourceDBInstanceArn" => SourceDBInstanceArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_export_task(export_task_identifier, iam_role_arn, kms_key_id, s3_bucket_name, source_arn)
start_export_task(export_task_identifier, iam_role_arn, kms_key_id, s3_bucket_name, source_arn, params::Dict{String,<:Any})
Starts an export of DB snapshot or DB cluster data to Amazon S3. The provided IAM role must
have access to the S3 bucket. You can't export snapshot data from Db2 or RDS Custom DB
instances. You can't export cluster data from Multi-AZ DB clusters. For more information on
exporting DB snapshot data, see Exporting DB snapshot data to Amazon S3 in the Amazon RDS
User Guide or Exporting DB cluster snapshot data to Amazon S3 in the Amazon Aurora User
Guide. For more information on exporting DB cluster data, see Exporting DB cluster data to
Amazon S3 in the Amazon Aurora User Guide.
# Arguments
- `export_task_identifier`: A unique identifier for the export task. This ID isn't an
identifier for the Amazon S3 bucket where the data is to be exported.
- `iam_role_arn`: The name of the IAM role to use for writing to the Amazon S3 bucket when
exporting a snapshot or cluster. In the IAM policy attached to your IAM role, include the
following required actions to allow the transfer of files from Amazon RDS or Amazon Aurora
to an S3 bucket: s3:PutObject* s3:GetObject* s3:ListBucket s3:DeleteObject*
s3:GetBucketLocation In the policy, include the resources to identify the S3 bucket and
objects in the bucket. The following list of resources shows the Amazon Resource Name (ARN)
format for accessing S3: arn:aws:s3:::your-s3-bucket arn:aws:s3:::your-s3-bucket/*
- `kms_key_id`: The ID of the Amazon Web Services KMS key to use to encrypt the data
exported to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID,
alias ARN, or alias name for the KMS key. The caller of this operation must be authorized
to run the following operations. These can be set in the Amazon Web Services KMS key
policy: kms:Encrypt kms:Decrypt kms:GenerateDataKey
kms:GenerateDataKeyWithoutPlaintext kms:ReEncryptFrom kms:ReEncryptTo kms:CreateGrant
kms:DescribeKey kms:RetireGrant
- `s3_bucket_name`: The name of the Amazon S3 bucket to export the snapshot or cluster data
to.
- `source_arn`: The Amazon Resource Name (ARN) of the snapshot or cluster to export to
Amazon S3.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExportOnly"`: The data to be exported from the snapshot or cluster. If this parameter
isn't provided, all of the data is exported. Valid Values: database - Export all the
data from a specified database. database.table table-name - Export a table of the
snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and
Aurora MySQL. database.schema schema-name - Export a database schema of the snapshot or
cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
database.schema.table table-name - Export a table of the database schema. This format is
valid only for RDS for PostgreSQL and Aurora PostgreSQL.
- `"S3Prefix"`: The Amazon S3 bucket prefix to use as the file name and path of the
exported data.
"""
function start_export_task(
ExportTaskIdentifier,
IamRoleArn,
KmsKeyId,
S3BucketName,
SourceArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"StartExportTask",
Dict{String,Any}(
"ExportTaskIdentifier" => ExportTaskIdentifier,
"IamRoleArn" => IamRoleArn,
"KmsKeyId" => KmsKeyId,
"S3BucketName" => S3BucketName,
"SourceArn" => SourceArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_export_task(
ExportTaskIdentifier,
IamRoleArn,
KmsKeyId,
S3BucketName,
SourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"StartExportTask",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ExportTaskIdentifier" => ExportTaskIdentifier,
"IamRoleArn" => IamRoleArn,
"KmsKeyId" => KmsKeyId,
"S3BucketName" => S3BucketName,
"SourceArn" => SourceArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_activity_stream(resource_arn)
stop_activity_stream(resource_arn, params::Dict{String,<:Any})
Stops a database activity stream that was started using the Amazon Web Services console,
the start-activity-stream CLI command, or the StartActivityStream operation. For more
information, see Monitoring Amazon Aurora with Database Activity Streams in the Amazon
Aurora User Guide or Monitoring Amazon RDS with Database Activity Streams in the Amazon
RDS User Guide.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the DB cluster for the database
activity stream. For example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ApplyImmediately"`: Specifies whether or not the database activity stream is to stop as
soon as possible, regardless of the maintenance window for the database.
"""
function stop_activity_stream(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"StopActivityStream",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_activity_stream(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"StopActivityStream",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_dbcluster(dbcluster_identifier)
stop_dbcluster(dbcluster_identifier, params::Dict{String,<:Any})
Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB
cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains
the transaction logs so you can do a point-in-time restore if necessary. For more
information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.
This operation only applies to Aurora DB clusters.
# Arguments
- `dbcluster_identifier`: The DB cluster identifier of the Amazon Aurora DB cluster to be
stopped. This parameter is stored as a lowercase string.
"""
function stop_dbcluster(
DBClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"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 rds(
"StopDBCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBClusterIdentifier" => DBClusterIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_dbinstance(dbinstance_identifier)
stop_dbinstance(dbinstance_identifier, params::Dict{String,<:Any})
Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB
instance's metadata, including its endpoint, DB parameter group, and option group
membership. Amazon RDS also retains the transaction logs so you can do a point-in-time
restore if necessary. For more information, see Stopping an Amazon RDS DB Instance
Temporarily in the Amazon RDS User Guide. This command doesn't apply to RDS Custom,
Aurora MySQL, and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead.
# Arguments
- `dbinstance_identifier`: The user-supplied instance identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBSnapshotIdentifier"`: The user-supplied instance identifier of the DB Snapshot
created immediately before the DB instance is stopped.
"""
function stop_dbinstance(
DBInstanceIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"StopDBInstance",
Dict{String,Any}("DBInstanceIdentifier" => DBInstanceIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_dbinstance(
DBInstanceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"StopDBInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBInstanceIdentifier" => DBInstanceIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_dbinstance_automated_backups_replication(source_dbinstance_arn)
stop_dbinstance_automated_backups_replication(source_dbinstance_arn, params::Dict{String,<:Any})
Stops automated backup replication for a DB instance. This command doesn't apply to RDS
Custom, Aurora MySQL, and Aurora PostgreSQL. For more information, see Replicating
Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
# Arguments
- `source_dbinstance_arn`: The Amazon Resource Name (ARN) of the source DB instance for
which to stop replicating automate backups, for example,
arn:aws:rds:us-west-2:123456789012:db:mydatabase.
"""
function stop_dbinstance_automated_backups_replication(
SourceDBInstanceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"StopDBInstanceAutomatedBackupsReplication",
Dict{String,Any}("SourceDBInstanceArn" => SourceDBInstanceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_dbinstance_automated_backups_replication(
SourceDBInstanceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"StopDBInstanceAutomatedBackupsReplication",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("SourceDBInstanceArn" => SourceDBInstanceArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
switchover_blue_green_deployment(blue_green_deployment_identifier)
switchover_blue_green_deployment(blue_green_deployment_identifier, params::Dict{String,<:Any})
Switches over a blue/green deployment. Before you switch over, production traffic is routed
to the databases in the blue environment. After you switch over, production traffic is
routed to the databases in the green environment. For more information, see Using Amazon
RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using
Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
# Arguments
- `blue_green_deployment_identifier`: The unique identifier of the blue/green deployment.
Constraints: Must match an existing blue/green deployment identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SwitchoverTimeout"`: The amount of time, in seconds, for the switchover to complete.
Default: 300 If the switchover takes longer than the specified duration, then any changes
are rolled back, and no changes are made to the environments.
"""
function switchover_blue_green_deployment(
BlueGreenDeploymentIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"SwitchoverBlueGreenDeployment",
Dict{String,Any}("BlueGreenDeploymentIdentifier" => BlueGreenDeploymentIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function switchover_blue_green_deployment(
BlueGreenDeploymentIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"SwitchoverBlueGreenDeployment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"BlueGreenDeploymentIdentifier" => BlueGreenDeploymentIdentifier
),
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 DB cluster to be the new primary DB cluster in the
global database cluster. Switchover operations were previously called \"managed planned
failovers.\" Aurora promotes the specified secondary cluster to assume full read/write
capabilities and demotes the current primary cluster to a secondary (read-only) cluster,
maintaining the orginal replication topology. All secondary clusters are synchronized with
the primary at the beginning of the process so the new primary continues operations for the
Aurora global database without losing any data. Your database is unavailable for a short
time while the primary and selected secondary clusters are assuming their new roles. For
more information about switching over an Aurora global database, see Performing switchovers
for Amazon Aurora global databases in the Amazon Aurora User Guide. This operation is
intended for controlled environments, for operations such as \"regional rotation\" or to
fall back to the original primary after a global database failover.
# Arguments
- `global_cluster_identifier`: The identifier of the global database cluster to switch
over. This parameter isn't case-sensitive. Constraints: Must match the identifier of an
existing global database cluster (Aurora global database).
- `target_db_cluster_identifier`: The identifier of the secondary Aurora DB cluster to
promote to the new primary for the global database cluster. Use the Amazon Resource Name
(ARN) for the identifier so that Aurora can locate the cluster in its Amazon Web Services
Region.
"""
function switchover_global_cluster(
GlobalClusterIdentifier,
TargetDbClusterIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"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 rds(
"SwitchoverGlobalCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GlobalClusterIdentifier" => GlobalClusterIdentifier,
"TargetDbClusterIdentifier" => TargetDbClusterIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
switchover_read_replica(dbinstance_identifier)
switchover_read_replica(dbinstance_identifier, params::Dict{String,<:Any})
Switches over an Oracle standby database in an Oracle Data Guard environment, making it the
new primary database. Issue this command in the Region that hosts the current standby
database.
# Arguments
- `dbinstance_identifier`: The DB instance identifier of the current standby database. This
value is stored as a lowercase string. Constraints: Must match the identifier of an
existing Oracle read replica DB instance.
"""
function switchover_read_replica(
DBInstanceIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds(
"SwitchoverReadReplica",
Dict{String,Any}("DBInstanceIdentifier" => DBInstanceIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function switchover_read_replica(
DBInstanceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds(
"SwitchoverReadReplica",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBInstanceIdentifier" => DBInstanceIdentifier),
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 | 14559 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: rds_data
using AWS.Compat
using AWS.UUIDs
"""
batch_execute_statement(resource_arn, secret_arn, sql)
batch_execute_statement(resource_arn, secret_arn, sql, params::Dict{String,<:Any})
Runs a batch SQL statement over an array of data. You can run bulk update and insert
operations for multiple records using a DML statement with different parameter sets. Bulk
operations can provide a significant performance improvement over individual insert and
update operations. If a call isn't part of a transaction because it doesn't include the
transactionID parameter, changes that result from the call are committed automatically.
There isn't a fixed upper limit on the number of parameter sets. However, the maximum size
of the HTTP request submitted through the Data API is 4 MiB. If the request exceeds this
limit, the Data API returns an error and doesn't process the request. This 4-MiB limit
includes the size of the HTTP headers and the JSON notation in the request. Thus, the
number of parameter sets that you can include depends on a combination of factors, such as
the size of the SQL statement and the size of each parameter set. The response size limit
is 1 MiB. If the call returns more than 1 MiB of response data, the call is terminated.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
- `secret_arn`: The ARN of the secret that enables access to the DB cluster. Enter the
database user name and password for the credentials in the secret. For information about
creating the secret, see Create a database secret.
- `sql`: The SQL statement to run. Don't include a semicolon (;) at the end of the SQL
statement.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"database"`: The name of the database.
- `"parameterSets"`: The parameter set for the batch operation. The SQL statement is
executed as many times as the number of parameter sets provided. To execute a SQL statement
with no parameters, use one of the following options: Specify one or more empty parameter
sets. Use the ExecuteStatement operation instead of the BatchExecuteStatement operation.
Array parameters are not supported.
- `"schema"`: The name of the database schema. Currently, the schema parameter isn't
supported.
- `"transactionId"`: The identifier of a transaction that was started by using the
BeginTransaction operation. Specify the transaction ID of the transaction that you want to
include the SQL statement in. If the SQL statement is not part of a transaction, don't set
this parameter.
"""
function batch_execute_statement(
resourceArn, secretArn, sql; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds_data(
"POST",
"/BatchExecute",
Dict{String,Any}(
"resourceArn" => resourceArn, "secretArn" => secretArn, "sql" => sql
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_execute_statement(
resourceArn,
secretArn,
sql,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds_data(
"POST",
"/BatchExecute",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"resourceArn" => resourceArn, "secretArn" => secretArn, "sql" => sql
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
begin_transaction(resource_arn, secret_arn)
begin_transaction(resource_arn, secret_arn, params::Dict{String,<:Any})
Starts a SQL transaction. A transaction can run for a maximum of 24 hours. A transaction
is terminated and rolled back automatically after 24 hours. A transaction times out if no
calls use its transaction ID in three minutes. If a transaction times out before it's
committed, it's rolled back automatically. DDL statements inside a transaction cause an
implicit commit. We recommend that you run each DDL statement in a separate
ExecuteStatement call with continueAfterTimeout enabled.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
- `secret_arn`: The name or ARN of the secret that enables access to the DB cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"database"`: The name of the database.
- `"schema"`: The name of the database schema.
"""
function begin_transaction(
resourceArn, secretArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds_data(
"POST",
"/BeginTransaction",
Dict{String,Any}("resourceArn" => resourceArn, "secretArn" => secretArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function begin_transaction(
resourceArn,
secretArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds_data(
"POST",
"/BeginTransaction",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("resourceArn" => resourceArn, "secretArn" => secretArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
commit_transaction(resource_arn, secret_arn, transaction_id)
commit_transaction(resource_arn, secret_arn, transaction_id, params::Dict{String,<:Any})
Ends a SQL transaction started with the BeginTransaction operation and commits the changes.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
- `secret_arn`: The name or ARN of the secret that enables access to the DB cluster.
- `transaction_id`: The identifier of the transaction to end and commit.
"""
function commit_transaction(
resourceArn, secretArn, transactionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds_data(
"POST",
"/CommitTransaction",
Dict{String,Any}(
"resourceArn" => resourceArn,
"secretArn" => secretArn,
"transactionId" => transactionId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function commit_transaction(
resourceArn,
secretArn,
transactionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds_data(
"POST",
"/CommitTransaction",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"resourceArn" => resourceArn,
"secretArn" => secretArn,
"transactionId" => transactionId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
execute_sql(aws_secret_store_arn, db_cluster_or_instance_arn, sql_statements)
execute_sql(aws_secret_store_arn, db_cluster_or_instance_arn, sql_statements, params::Dict{String,<:Any})
Runs one or more SQL statements. This operation isn't supported for Aurora PostgreSQL
Serverless v2 and provisioned DB clusters, and for Aurora Serverless v1 DB clusters, the
operation is deprecated. Use the BatchExecuteStatement or ExecuteStatement operation.
# Arguments
- `aws_secret_store_arn`: The Amazon Resource Name (ARN) of the secret that enables access
to the DB cluster. Enter the database user name and password for the credentials in the
secret. For information about creating the secret, see Create a database secret.
- `db_cluster_or_instance_arn`: The ARN of the Aurora Serverless DB cluster.
- `sql_statements`: One or more SQL statements to run on the DB cluster. You can separate
SQL statements from each other with a semicolon (;). Any valid SQL statement is permitted,
including data definition, data manipulation, and commit statements.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"database"`: The name of the database.
- `"schema"`: The name of the database schema.
"""
function execute_sql(
awsSecretStoreArn,
dbClusterOrInstanceArn,
sqlStatements;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds_data(
"POST",
"/ExecuteSql",
Dict{String,Any}(
"awsSecretStoreArn" => awsSecretStoreArn,
"dbClusterOrInstanceArn" => dbClusterOrInstanceArn,
"sqlStatements" => sqlStatements,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function execute_sql(
awsSecretStoreArn,
dbClusterOrInstanceArn,
sqlStatements,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds_data(
"POST",
"/ExecuteSql",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"awsSecretStoreArn" => awsSecretStoreArn,
"dbClusterOrInstanceArn" => dbClusterOrInstanceArn,
"sqlStatements" => sqlStatements,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
execute_statement(resource_arn, secret_arn, sql)
execute_statement(resource_arn, secret_arn, sql, params::Dict{String,<:Any})
Runs a SQL statement against a database. If a call isn't part of a transaction because it
doesn't include the transactionID parameter, changes that result from the call are
committed automatically. If the binary response data from the database is more than 1 MB,
the call is terminated.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
- `secret_arn`: The ARN of the secret that enables access to the DB cluster. Enter the
database user name and password for the credentials in the secret. For information about
creating the secret, see Create a database secret.
- `sql`: The SQL statement to run.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"continueAfterTimeout"`: A value that indicates whether to continue running the
statement after the call times out. By default, the statement stops running when the call
times out. For DDL statements, we recommend continuing to run the statement after the call
times out. When a DDL statement terminates before it is finished running, it can result in
errors and possibly corrupted data structures.
- `"database"`: The name of the database.
- `"formatRecordsAs"`: A value that indicates whether to format the result set as a single
JSON string. This parameter only applies to SELECT statements and is ignored for other
types of statements. Allowed values are NONE and JSON. The default value is NONE. The
result is returned in the formattedRecords field. For usage information about the JSON
format for result sets, see Using the Data API in the Amazon Aurora User Guide.
- `"includeResultMetadata"`: A value that indicates whether to include metadata in the
results.
- `"parameters"`: The parameters for the SQL statement. Array parameters are not
supported.
- `"resultSetOptions"`: Options that control how the result set is returned.
- `"schema"`: The name of the database schema. Currently, the schema parameter isn't
supported.
- `"transactionId"`: The identifier of a transaction that was started by using the
BeginTransaction operation. Specify the transaction ID of the transaction that you want to
include the SQL statement in. If the SQL statement is not part of a transaction, don't set
this parameter.
"""
function execute_statement(
resourceArn, secretArn, sql; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds_data(
"POST",
"/Execute",
Dict{String,Any}(
"resourceArn" => resourceArn, "secretArn" => secretArn, "sql" => sql
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function execute_statement(
resourceArn,
secretArn,
sql,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds_data(
"POST",
"/Execute",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"resourceArn" => resourceArn, "secretArn" => secretArn, "sql" => sql
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
rollback_transaction(resource_arn, secret_arn, transaction_id)
rollback_transaction(resource_arn, secret_arn, transaction_id, params::Dict{String,<:Any})
Performs a rollback of a transaction. Rolling back a transaction cancels its changes.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
- `secret_arn`: The name or ARN of the secret that enables access to the DB cluster.
- `transaction_id`: The identifier of the transaction to roll back.
"""
function rollback_transaction(
resourceArn, secretArn, transactionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return rds_data(
"POST",
"/RollbackTransaction",
Dict{String,Any}(
"resourceArn" => resourceArn,
"secretArn" => secretArn,
"transactionId" => transactionId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function rollback_transaction(
resourceArn,
secretArn,
transactionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rds_data(
"POST",
"/RollbackTransaction",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"resourceArn" => resourceArn,
"secretArn" => secretArn,
"transactionId" => transactionId,
),
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 | 295280 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: redshift
using AWS.Compat
using AWS.UUIDs
"""
accept_reserved_node_exchange(reserved_node_id, target_reserved_node_offering_id)
accept_reserved_node_exchange(reserved_node_id, target_reserved_node_offering_id, params::Dict{String,<:Any})
Exchanges a DC1 Reserved Node for a DC2 Reserved Node with no changes to the configuration
(term, payment type, or number of nodes) and no additional costs.
# Arguments
- `reserved_node_id`: A string representing the node identifier of the DC1 Reserved Node to
be exchanged.
- `target_reserved_node_offering_id`: The unique identifier of the DC2 Reserved Node
offering to be used for the exchange. You can obtain the value for the parameter by calling
GetReservedNodeExchangeOfferings
"""
function accept_reserved_node_exchange(
ReservedNodeId,
TargetReservedNodeOfferingId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"AcceptReservedNodeExchange",
Dict{String,Any}(
"ReservedNodeId" => ReservedNodeId,
"TargetReservedNodeOfferingId" => TargetReservedNodeOfferingId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function accept_reserved_node_exchange(
ReservedNodeId,
TargetReservedNodeOfferingId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"AcceptReservedNodeExchange",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ReservedNodeId" => ReservedNodeId,
"TargetReservedNodeOfferingId" => TargetReservedNodeOfferingId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_partner(account_id, cluster_identifier, database_name, partner_name)
add_partner(account_id, cluster_identifier, database_name, partner_name, params::Dict{String,<:Any})
Adds a partner integration to a cluster. This operation authorizes a partner to push status
updates for the specified database. To complete the integration, you also set up the
integration on the partner website.
# Arguments
- `account_id`: The Amazon Web Services account ID that owns the cluster.
- `cluster_identifier`: The cluster identifier of the cluster that receives data from the
partner.
- `database_name`: The name of the database that receives data from the partner.
- `partner_name`: The name of the partner that is authorized to send data.
"""
function add_partner(
AccountId,
ClusterIdentifier,
DatabaseName,
PartnerName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"AddPartner",
Dict{String,Any}(
"AccountId" => AccountId,
"ClusterIdentifier" => ClusterIdentifier,
"DatabaseName" => DatabaseName,
"PartnerName" => PartnerName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_partner(
AccountId,
ClusterIdentifier,
DatabaseName,
PartnerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"AddPartner",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AccountId" => AccountId,
"ClusterIdentifier" => ClusterIdentifier,
"DatabaseName" => DatabaseName,
"PartnerName" => PartnerName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_data_share_consumer(data_share_arn)
associate_data_share_consumer(data_share_arn, params::Dict{String,<:Any})
From a datashare consumer account, associates a datashare with the account
(AssociateEntireAccount) or the specified namespace (ConsumerArn). If you make this
association, the consumer can consume the datashare.
# Arguments
- `data_share_arn`: The Amazon Resource Name (ARN) of the datashare that the consumer is to
use.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllowWrites"`: If set to true, allows write operations for a datashare.
- `"AssociateEntireAccount"`: A value that specifies whether the datashare is associated
with the entire account.
- `"ConsumerArn"`: The Amazon Resource Name (ARN) of the consumer namespace associated with
the datashare.
- `"ConsumerRegion"`: From a datashare consumer account, associates a datashare with all
existing and future namespaces in the specified Amazon Web Services Region.
"""
function associate_data_share_consumer(
DataShareArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"AssociateDataShareConsumer",
Dict{String,Any}("DataShareArn" => DataShareArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_data_share_consumer(
DataShareArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"AssociateDataShareConsumer",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DataShareArn" => DataShareArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
authorize_cluster_security_group_ingress(cluster_security_group_name)
authorize_cluster_security_group_ingress(cluster_security_group_name, params::Dict{String,<:Any})
Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether
the application accessing your cluster is running on the Internet or an Amazon EC2
instance, you can authorize inbound access to either a Classless Interdomain Routing
(CIDR)/Internet Protocol (IP) range or to an Amazon EC2 security group. You can add as many
as 20 ingress rules to an Amazon Redshift security group. If you authorize access to an
Amazon EC2 security group, specify EC2SecurityGroupName and EC2SecurityGroupOwnerId. The
Amazon EC2 security group and Amazon Redshift cluster must be in the same Amazon Web
Services Region. If you authorize access to a CIDR/IP address range, specify CIDRIP. For
an overview of CIDR blocks, see the Wikipedia article on Classless Inter-Domain Routing.
You must also associate the security group with a cluster so that clients running on these
IP addresses or the EC2 instance are authorized to connect to the cluster. For information
about managing security groups, go to Working with Security Groups in the Amazon Redshift
Cluster Management Guide.
# Arguments
- `cluster_security_group_name`: The name of the security group to which the ingress rule
is added.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CIDRIP"`: The IP range to be added the Amazon Redshift security group.
- `"EC2SecurityGroupName"`: The EC2 security group to be added the Amazon Redshift security
group.
- `"EC2SecurityGroupOwnerId"`: The Amazon Web Services account number of the owner of the
security group specified by the EC2SecurityGroupName parameter. The Amazon Web Services
Access Key ID is not an acceptable value. Example: 111122223333
"""
function authorize_cluster_security_group_ingress(
ClusterSecurityGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"AuthorizeClusterSecurityGroupIngress",
Dict{String,Any}("ClusterSecurityGroupName" => ClusterSecurityGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function authorize_cluster_security_group_ingress(
ClusterSecurityGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"AuthorizeClusterSecurityGroupIngress",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ClusterSecurityGroupName" => ClusterSecurityGroupName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
authorize_data_share(consumer_identifier, data_share_arn)
authorize_data_share(consumer_identifier, data_share_arn, params::Dict{String,<:Any})
From a data producer account, authorizes the sharing of a datashare with one or more
consumer accounts or managing entities. To authorize a datashare for a data consumer, the
producer account must have the correct access permissions.
# Arguments
- `consumer_identifier`: The identifier of the data consumer that is authorized to access
the datashare. This identifier is an Amazon Web Services account ID or a keyword, such as
ADX.
- `data_share_arn`: The Amazon Resource Name (ARN) of the datashare namespace that
producers are to authorize sharing for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllowWrites"`: If set to true, allows write operations for a datashare.
"""
function authorize_data_share(
ConsumerIdentifier, DataShareArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"AuthorizeDataShare",
Dict{String,Any}(
"ConsumerIdentifier" => ConsumerIdentifier, "DataShareArn" => DataShareArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function authorize_data_share(
ConsumerIdentifier,
DataShareArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"AuthorizeDataShare",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConsumerIdentifier" => ConsumerIdentifier,
"DataShareArn" => DataShareArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
authorize_endpoint_access(account)
authorize_endpoint_access(account, params::Dict{String,<:Any})
Grants access to a cluster.
# Arguments
- `account`: The Amazon Web Services account ID to grant access to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClusterIdentifier"`: The cluster identifier of the cluster to grant access to.
- `"VpcIds"`: The virtual private cloud (VPC) identifiers to grant access to.
"""
function authorize_endpoint_access(
Account; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"AuthorizeEndpointAccess",
Dict{String,Any}("Account" => Account);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function authorize_endpoint_access(
Account, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"AuthorizeEndpointAccess",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Account" => Account), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
authorize_snapshot_access(account_with_restore_access)
authorize_snapshot_access(account_with_restore_access, params::Dict{String,<:Any})
Authorizes the specified Amazon Web Services account to restore the specified snapshot.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the
Amazon Redshift Cluster Management Guide.
# Arguments
- `account_with_restore_access`: The identifier of the Amazon Web Services account
authorized to restore the specified snapshot. To share a snapshot with Amazon Web Services
Support, specify amazon-redshift-support.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SnapshotArn"`: The Amazon Resource Name (ARN) of the snapshot to authorize access to.
- `"SnapshotClusterIdentifier"`: The identifier of the cluster the snapshot was created
from. If the snapshot to access doesn't exist and the associated IAM policy doesn't
allow access to all (*) snapshots - This parameter is required. Otherwise, permissions
aren't available to check if the snapshot exists. If the snapshot to access exists -
This parameter isn't required. Redshift can retrieve the cluster identifier and use it to
validate snapshot authorization.
- `"SnapshotIdentifier"`: The identifier of the snapshot the account is authorized to
restore.
"""
function authorize_snapshot_access(
AccountWithRestoreAccess; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"AuthorizeSnapshotAccess",
Dict{String,Any}("AccountWithRestoreAccess" => AccountWithRestoreAccess);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function authorize_snapshot_access(
AccountWithRestoreAccess,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"AuthorizeSnapshotAccess",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AccountWithRestoreAccess" => AccountWithRestoreAccess),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_delete_cluster_snapshots(delete_cluster_snapshot_message)
batch_delete_cluster_snapshots(delete_cluster_snapshot_message, params::Dict{String,<:Any})
Deletes a set of cluster snapshots.
# Arguments
- `delete_cluster_snapshot_message`: A list of identifiers for the snapshots that you want
to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Identifiers"`: A list of identifiers for the snapshots that you want to delete.
"""
function batch_delete_cluster_snapshots(
DeleteClusterSnapshotMessage; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"BatchDeleteClusterSnapshots",
Dict{String,Any}("DeleteClusterSnapshotMessage" => DeleteClusterSnapshotMessage);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_delete_cluster_snapshots(
DeleteClusterSnapshotMessage,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"BatchDeleteClusterSnapshots",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DeleteClusterSnapshotMessage" => DeleteClusterSnapshotMessage
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_modify_cluster_snapshots(string)
batch_modify_cluster_snapshots(string, params::Dict{String,<:Any})
Modifies the settings for a set of cluster snapshots.
# Arguments
- `string`: A list of snapshot identifiers you want to modify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Force"`: A boolean value indicating whether to override an exception if the retention
period has passed.
- `"ManualSnapshotRetentionPeriod"`: The number of days that a manual snapshot is retained.
If you specify the value -1, the manual snapshot is retained indefinitely. The number must
be either -1 or an integer between 1 and 3,653. If you decrease the manual snapshot
retention period from its current value, existing manual snapshots that fall outside of the
new retention period will return an error. If you want to suppress the errors and delete
the snapshots, use the force option.
- `"SnapshotIdentifierList"`: A list of snapshot identifiers you want to modify.
"""
function batch_modify_cluster_snapshots(
String; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"BatchModifyClusterSnapshots",
Dict{String,Any}("String" => String);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_modify_cluster_snapshots(
String, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"BatchModifyClusterSnapshots",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("String" => String), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_resize(cluster_identifier)
cancel_resize(cluster_identifier, params::Dict{String,<:Any})
Cancels a resize operation for a cluster.
# Arguments
- `cluster_identifier`: The unique identifier for the cluster that you want to cancel a
resize operation for.
"""
function cancel_resize(ClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config())
return redshift(
"CancelResize",
Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_resize(
ClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"CancelResize",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
copy_cluster_snapshot(source_snapshot_identifier, target_snapshot_identifier)
copy_cluster_snapshot(source_snapshot_identifier, target_snapshot_identifier, params::Dict{String,<:Any})
Copies the specified automated cluster snapshot to a new manual cluster snapshot. The
source must be an automated snapshot and it must be in the available state. When you delete
a cluster, Amazon Redshift deletes any automated snapshots of the cluster. Also, when the
retention period of the snapshot expires, Amazon Redshift automatically deletes it. If you
want to keep an automated snapshot for a longer period, you can make a manual copy of the
snapshot. Manual snapshots are retained until you delete them. For more information about
working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster
Management Guide.
# Arguments
- `source_snapshot_identifier`: The identifier for the source snapshot. Constraints: Must
be the identifier for a valid automated snapshot whose state is available.
- `target_snapshot_identifier`: The identifier given to the new manual snapshot.
Constraints: Cannot be null, empty, or blank. Must contain from 1 to 255 alphanumeric
characters or hyphens. First character must be a letter. Cannot end with a hyphen or
contain two consecutive hyphens. Must be unique for the Amazon Web Services account that
is making the request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ManualSnapshotRetentionPeriod"`: The number of days that a manual snapshot is retained.
If the value is -1, the manual snapshot is retained indefinitely. The value must be either
-1 or an integer between 1 and 3,653. The default value is -1.
- `"SourceSnapshotClusterIdentifier"`: The identifier of the cluster the source snapshot
was created from. This parameter is required if your IAM user has a policy containing a
snapshot resource element that specifies anything other than * for the cluster name.
Constraints: Must be the identifier for a valid cluster.
"""
function copy_cluster_snapshot(
SourceSnapshotIdentifier,
TargetSnapshotIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"CopyClusterSnapshot",
Dict{String,Any}(
"SourceSnapshotIdentifier" => SourceSnapshotIdentifier,
"TargetSnapshotIdentifier" => TargetSnapshotIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function copy_cluster_snapshot(
SourceSnapshotIdentifier,
TargetSnapshotIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"CopyClusterSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SourceSnapshotIdentifier" => SourceSnapshotIdentifier,
"TargetSnapshotIdentifier" => TargetSnapshotIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_authentication_profile(authentication_profile_content, authentication_profile_name)
create_authentication_profile(authentication_profile_content, authentication_profile_name, params::Dict{String,<:Any})
Creates an authentication profile with the specified parameters.
# Arguments
- `authentication_profile_content`: The content of the authentication profile in JSON
format. The maximum length of the JSON string is determined by a quota for your account.
- `authentication_profile_name`: The name of the authentication profile to be created.
"""
function create_authentication_profile(
AuthenticationProfileContent,
AuthenticationProfileName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"CreateAuthenticationProfile",
Dict{String,Any}(
"AuthenticationProfileContent" => AuthenticationProfileContent,
"AuthenticationProfileName" => AuthenticationProfileName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_authentication_profile(
AuthenticationProfileContent,
AuthenticationProfileName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"CreateAuthenticationProfile",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AuthenticationProfileContent" => AuthenticationProfileContent,
"AuthenticationProfileName" => AuthenticationProfileName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_cluster(cluster_identifier, master_username, node_type)
create_cluster(cluster_identifier, master_username, node_type, params::Dict{String,<:Any})
Creates a new cluster with the specified parameters. To create a cluster in Virtual Private
Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group
identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For
more information about managing clusters, go to Amazon Redshift Clusters in the Amazon
Redshift Cluster Management Guide.
# Arguments
- `cluster_identifier`: A unique identifier for the cluster. You use this identifier to
refer to the cluster for any subsequent cluster operations such as deleting or modifying.
The identifier also appears in the Amazon Redshift console. Constraints: Must contain
from 1 to 63 alphanumeric characters or hyphens. Alphabetic characters must be lowercase.
First character must be a letter. Cannot end with a hyphen or contain two consecutive
hyphens. Must be unique for all clusters within an Amazon Web Services account.
Example: myexamplecluster
- `master_username`: The user name associated with the admin user account for the cluster
that is being created. Constraints: Must be 1 - 128 alphanumeric characters or hyphens.
The user name can't be PUBLIC. Must contain only lowercase letters, numbers, underscore,
plus sign, period (dot), at symbol (@), or hyphen. The first character must be a letter.
Must not contain a colon (:) or a slash (/). Cannot be a reserved word. A list of
reserved words can be found in Reserved Words in the Amazon Redshift Database Developer
Guide.
- `node_type`: The node type to be provisioned for the cluster. For information about node
types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide. Valid
Values: dc2.large | dc2.8xlarge | ra3.xlplus | ra3.4xlarge | ra3.16xlarge
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AdditionalInfo"`: Reserved.
- `"AllowVersionUpgrade"`: If true, major version upgrades can be applied during the
maintenance window to the Amazon Redshift engine that is running on the cluster. When a new
major version of the Amazon Redshift engine is released, you can request that the service
automatically apply upgrades during the maintenance window to the Amazon Redshift engine
that is running on your cluster. Default: true
- `"AquaConfigurationStatus"`: This parameter is retired. It does not set the AQUA
configuration status. Amazon Redshift automatically determines whether to use AQUA
(Advanced Query Accelerator).
- `"AutomatedSnapshotRetentionPeriod"`: The number of days that automated snapshots are
retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots
are disabled, you can still create manual snapshots when you want with
CreateClusterSnapshot. You can't disable automated snapshots for RA3 node types. Set the
automated retention period from 1-35 days. Default: 1 Constraints: Must be a value from 0
to 35.
- `"AvailabilityZone"`: The EC2 Availability Zone (AZ) in which you want Amazon Redshift to
provision the cluster. For example, if you have several EC2 instances running in a specific
Availability Zone, then you might want the cluster to be provisioned in the same zone in
order to decrease network latency. Default: A random, system-chosen Availability Zone in
the region that is specified by the endpoint. Example: us-east-2d Constraint: The
specified Availability Zone must be in the same region as the current endpoint.
- `"AvailabilityZoneRelocation"`: The option to enable relocation for an Amazon Redshift
cluster between Availability Zones after the cluster is created.
- `"ClusterParameterGroupName"`: The name of the parameter group to be associated with this
cluster. Default: The default Amazon Redshift cluster parameter group. For information
about the default parameter group, go to Working with Amazon Redshift Parameter Groups
Constraints: Must be 1 to 255 alphanumeric characters or hyphens. First character must
be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
- `"ClusterSecurityGroups"`: A list of security groups to be associated with this cluster.
Default: The default cluster security group for Amazon Redshift.
- `"ClusterSubnetGroupName"`: The name of a cluster subnet group to be associated with this
cluster. If this parameter is not provided the resulting cluster will be deployed outside
virtual private cloud (VPC).
- `"ClusterType"`: The type of the cluster. When cluster type is specified as
single-node, the NumberOfNodes parameter is not required. multi-node, the NumberOfNodes
parameter is required. Valid Values: multi-node | single-node Default: multi-node
- `"ClusterVersion"`: The version of the Amazon Redshift engine software that you want to
deploy on the cluster. The version selected runs on all the nodes in the cluster.
Constraints: Only version 1.0 is currently available. Example: 1.0
- `"DBName"`: The name of the first database to be created when the cluster is created. To
create additional databases after the cluster is created, connect to the cluster with a SQL
client and use SQL commands to create a database. For more information, go to Create a
Database in the Amazon Redshift Database Developer Guide. Default: dev Constraints:
Must contain 1 to 64 alphanumeric characters. Must contain only lowercase letters.
Cannot be a word that is reserved by the service. A list of reserved words can be found in
Reserved Words in the Amazon Redshift Database Developer Guide.
- `"DefaultIamRoleArn"`: The Amazon Resource Name (ARN) for the IAM role that was set as
default for the cluster when the cluster was created.
- `"ElasticIp"`: The Elastic IP (EIP) address for the cluster. Constraints: The cluster
must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. Don't
specify the Elastic IP address for a publicly accessible cluster with availability zone
relocation turned on. For more information about provisioning clusters in EC2-VPC, go to
Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
- `"Encrypted"`: If true, the data in the cluster is encrypted at rest. Default: false
- `"EnhancedVpcRouting"`: An option that specifies whether to create the cluster with
enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the
cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon
Redshift Cluster Management Guide. If this option is true, enhanced VPC routing is enabled.
Default: false
- `"HsmClientCertificateIdentifier"`: Specifies the name of the HSM client certificate the
Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
- `"HsmConfigurationIdentifier"`: Specifies the name of the HSM configuration that contains
the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
- `"IamRoles"`: A list of Identity and Access Management (IAM) roles that can be used by
the cluster to access other Amazon Web Services services. You must supply the IAM roles in
their Amazon Resource Name (ARN) format. The maximum number of IAM roles that you can
associate is subject to a quota. For more information, go to Quotas and limits in the
Amazon Redshift Cluster Management Guide.
- `"IpAddressType"`: The IP address types that the cluster supports. Possible values are
ipv4 and dualstack.
- `"KmsKeyId"`: The Key Management Service (KMS) key ID of the encryption key that you want
to use to encrypt data in the cluster.
- `"LoadSampleData"`: A flag that specifies whether to load sample data once the cluster is
created.
- `"MaintenanceTrackName"`: An optional parameter for the name of the maintenance track for
the cluster. If you don't provide a maintenance track name, the cluster is assigned to the
current track.
- `"ManageMasterPassword"`: If true, Amazon Redshift uses Secrets Manager to manage this
cluster's admin credentials. You can't use MasterUserPassword if ManageMasterPassword is
true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword
for the admin user account's password.
- `"ManualSnapshotRetentionPeriod"`: The default number of days to retain a manual
snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't
change the retention period of existing snapshots. The value must be either -1 or an
integer between 1 and 3,653.
- `"MasterPasswordSecretKmsKeyId"`: The ID of the Key Management Service (KMS) key used to
encrypt and store the cluster's admin credentials secret. You can only use this parameter
if ManageMasterPassword is true.
- `"MasterUserPassword"`: The password associated with the admin user account for the
cluster that is being created. You can't use MasterUserPassword if ManageMasterPassword is
true. Constraints: Must be between 8 and 64 characters in length. Must contain at least
one uppercase letter. Must contain at least one lowercase letter. Must contain one
number. Can be any printable ASCII character (ASCII code 33-126) except ' (single quote),
\" (double quote), , /, or @.
- `"MultiAZ"`: If true, Amazon Redshift will deploy the cluster in two Availability Zones
(AZ).
- `"NumberOfNodes"`: The number of compute nodes in the cluster. This parameter is required
when the ClusterType parameter is specified as multi-node. For information about
determining how many nodes you need, go to Working with Clusters in the Amazon Redshift
Cluster Management Guide. If you don't specify this parameter, you get a single-node
cluster. When requesting a multi-node cluster, you must specify the number of nodes that
you want in the cluster. Default: 1 Constraints: Value must be at least 1 and no more than
100.
- `"Port"`: The port number on which the cluster accepts incoming connections. The cluster
is accessible only via the JDBC and ODBC connection strings. Part of the connection string
requires the port on which the cluster will listen for incoming connections. Default: 5439
Valid Values: For clusters with ra3 nodes - Select a port within the ranges 5431-5455 or
8191-8215. (If you have an existing cluster with ra3 nodes, it isn't required that you
change the port to these ranges.) For clusters with dc2 nodes - Select a port within the
range 1150-65535.
- `"PreferredMaintenanceWindow"`: The weekly time range (in UTC) during which automated
cluster maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi Default: A 30-minute
window selected at random from an 8-hour block of time per region, occurring on a random
day of the week. For more information about the time blocks for each region, see
Maintenance Windows in Amazon Redshift Cluster Management Guide. Valid Days: Mon | Tue |
Wed | Thu | Fri | Sat | Sun Constraints: Minimum 30-minute window.
- `"PubliclyAccessible"`: If true, the cluster can be accessed from a public network.
- `"RedshiftIdcApplicationArn"`: The Amazon resource name (ARN) of the Amazon Redshift IAM
Identity Center application.
- `"SnapshotScheduleIdentifier"`: A unique identifier for the snapshot schedule.
- `"Tags"`: A list of tag instances.
- `"VpcSecurityGroupIds"`: A list of Virtual Private Cloud (VPC) security groups to be
associated with the cluster. Default: The default VPC security group is associated with the
cluster.
"""
function create_cluster(
ClusterIdentifier,
MasterUsername,
NodeType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"CreateCluster",
Dict{String,Any}(
"ClusterIdentifier" => ClusterIdentifier,
"MasterUsername" => MasterUsername,
"NodeType" => NodeType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_cluster(
ClusterIdentifier,
MasterUsername,
NodeType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"CreateCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClusterIdentifier" => ClusterIdentifier,
"MasterUsername" => MasterUsername,
"NodeType" => NodeType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_cluster_parameter_group(description, parameter_group_family, parameter_group_name)
create_cluster_parameter_group(description, parameter_group_family, parameter_group_name, params::Dict{String,<:Any})
Creates an Amazon Redshift parameter group. Creating parameter groups is independent of
creating clusters. You can associate a cluster with a parameter group when you create the
cluster. You can also associate an existing cluster with a parameter group after the
cluster is created by using ModifyCluster. Parameters in the parameter group define
specific behavior that applies to the databases you create on the cluster. For more
information about parameters and parameter groups, go to Amazon Redshift Parameter Groups
in the Amazon Redshift Cluster Management Guide.
# Arguments
- `description`: A description of the parameter group.
- `parameter_group_family`: The Amazon Redshift engine version to which the cluster
parameter group applies. The cluster engine version determines the set of parameters. To
get a list of valid parameter group family names, you can call
DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the
parameter groups that are owned by your Amazon Web Services account, including the default
parameter groups for each Amazon Redshift engine version. The parameter group family names
associated with the default parameter groups provide you the valid values. For example, a
valid family name is \"redshift-1.0\".
- `parameter_group_name`: The name of the cluster parameter group. Constraints: Must be 1
to 255 alphanumeric characters or hyphens First character must be a letter. Cannot end
with a hyphen or contain two consecutive hyphens. Must be unique withing your Amazon Web
Services account. This value is stored as a lower-case string.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: A list of tag instances.
"""
function create_cluster_parameter_group(
Description,
ParameterGroupFamily,
ParameterGroupName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"CreateClusterParameterGroup",
Dict{String,Any}(
"Description" => Description,
"ParameterGroupFamily" => ParameterGroupFamily,
"ParameterGroupName" => ParameterGroupName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_cluster_parameter_group(
Description,
ParameterGroupFamily,
ParameterGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"CreateClusterParameterGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Description" => Description,
"ParameterGroupFamily" => ParameterGroupFamily,
"ParameterGroupName" => ParameterGroupName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_cluster_security_group(cluster_security_group_name, description)
create_cluster_security_group(cluster_security_group_name, description, params::Dict{String,<:Any})
Creates a new Amazon Redshift security group. You use security groups to control access to
non-VPC clusters. For information about managing security groups, go to Amazon Redshift
Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
# Arguments
- `cluster_security_group_name`: The name for the security group. Amazon Redshift stores
the value as a lowercase string. Constraints: Must contain no more than 255 alphanumeric
characters or hyphens. Must not be \"Default\". Must be unique for all security groups
that are created by your Amazon Web Services account. Example: examplesecuritygroup
- `description`: A description for the security group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: A list of tag instances.
"""
function create_cluster_security_group(
ClusterSecurityGroupName, Description; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"CreateClusterSecurityGroup",
Dict{String,Any}(
"ClusterSecurityGroupName" => ClusterSecurityGroupName,
"Description" => Description,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_cluster_security_group(
ClusterSecurityGroupName,
Description,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"CreateClusterSecurityGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClusterSecurityGroupName" => ClusterSecurityGroupName,
"Description" => Description,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_cluster_snapshot(cluster_identifier, snapshot_identifier)
create_cluster_snapshot(cluster_identifier, snapshot_identifier, params::Dict{String,<:Any})
Creates a manual snapshot of the specified cluster. The cluster must be in the available
state. For more information about working with snapshots, go to Amazon Redshift Snapshots
in the Amazon Redshift Cluster Management Guide.
# Arguments
- `cluster_identifier`: The cluster identifier for which you want a snapshot.
- `snapshot_identifier`: A unique identifier for the snapshot that you are requesting. This
identifier must be unique for all snapshots within the Amazon Web Services account.
Constraints: Cannot be null, empty, or blank Must contain from 1 to 255 alphanumeric
characters or hyphens First character must be a letter Cannot end with a hyphen or
contain two consecutive hyphens Example: my-snapshot-id
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ManualSnapshotRetentionPeriod"`: The number of days that a manual snapshot is retained.
If the value is -1, the manual snapshot is retained indefinitely. The value must be either
-1 or an integer between 1 and 3,653. The default value is -1.
- `"Tags"`: A list of tag instances.
"""
function create_cluster_snapshot(
ClusterIdentifier, SnapshotIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"CreateClusterSnapshot",
Dict{String,Any}(
"ClusterIdentifier" => ClusterIdentifier,
"SnapshotIdentifier" => SnapshotIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_cluster_snapshot(
ClusterIdentifier,
SnapshotIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"CreateClusterSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClusterIdentifier" => ClusterIdentifier,
"SnapshotIdentifier" => SnapshotIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_cluster_subnet_group(cluster_subnet_group_name, description, subnet_identifier)
create_cluster_subnet_group(cluster_subnet_group_name, description, subnet_identifier, params::Dict{String,<:Any})
Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets
in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift
subnet group. For information about subnet groups, go to Amazon Redshift Cluster Subnet
Groups in the Amazon Redshift Cluster Management Guide.
# Arguments
- `cluster_subnet_group_name`: The name for the subnet group. Amazon Redshift stores the
value as a lowercase string. Constraints: Must contain no more than 255 alphanumeric
characters or hyphens. Must not be \"Default\". Must be unique for all subnet groups
that are created by your Amazon Web Services account. Example: examplesubnetgroup
- `description`: A description for the subnet group.
- `subnet_identifier`: An array of VPC subnet IDs. A maximum of 20 subnets can be modified
in a single request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SubnetIds"`: An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a
single request.
- `"Tags"`: A list of tag instances.
"""
function create_cluster_subnet_group(
ClusterSubnetGroupName,
Description,
SubnetIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"CreateClusterSubnetGroup",
Dict{String,Any}(
"ClusterSubnetGroupName" => ClusterSubnetGroupName,
"Description" => Description,
"SubnetIdentifier" => SubnetIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_cluster_subnet_group(
ClusterSubnetGroupName,
Description,
SubnetIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"CreateClusterSubnetGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClusterSubnetGroupName" => ClusterSubnetGroupName,
"Description" => Description,
"SubnetIdentifier" => SubnetIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_custom_domain_association(cluster_identifier, custom_domain_certificate_arn, custom_domain_name)
create_custom_domain_association(cluster_identifier, custom_domain_certificate_arn, custom_domain_name, params::Dict{String,<:Any})
Used to create a custom domain name for a cluster. Properties include the custom domain
name, the cluster the custom domain is associated with, and the certificate Amazon Resource
Name (ARN).
# Arguments
- `cluster_identifier`: The cluster identifier that the custom domain is associated with.
- `custom_domain_certificate_arn`: The certificate Amazon Resource Name (ARN) for the
custom domain name association.
- `custom_domain_name`: The custom domain name for a custom domain association.
"""
function create_custom_domain_association(
ClusterIdentifier,
CustomDomainCertificateArn,
CustomDomainName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"CreateCustomDomainAssociation",
Dict{String,Any}(
"ClusterIdentifier" => ClusterIdentifier,
"CustomDomainCertificateArn" => CustomDomainCertificateArn,
"CustomDomainName" => CustomDomainName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_custom_domain_association(
ClusterIdentifier,
CustomDomainCertificateArn,
CustomDomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"CreateCustomDomainAssociation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClusterIdentifier" => ClusterIdentifier,
"CustomDomainCertificateArn" => CustomDomainCertificateArn,
"CustomDomainName" => CustomDomainName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_endpoint_access(endpoint_name, subnet_group_name)
create_endpoint_access(endpoint_name, subnet_group_name, params::Dict{String,<:Any})
Creates a Redshift-managed VPC endpoint.
# Arguments
- `endpoint_name`: The Redshift-managed VPC endpoint name. An endpoint name must contain
1-30 characters. Valid characters are A-Z, a-z, 0-9, and hyphen(-). The first character
must be a letter. The name can't contain two consecutive hyphens or end with a hyphen.
- `subnet_group_name`: The subnet group from which Amazon Redshift chooses the subnet to
deploy the endpoint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClusterIdentifier"`: The cluster identifier of the cluster to access.
- `"ResourceOwner"`: The Amazon Web Services account ID of the owner of the cluster. This
is only required if the cluster is in another Amazon Web Services account.
- `"VpcSecurityGroupIds"`: The security group that defines the ports, protocols, and
sources for inbound traffic that you are authorizing into your endpoint.
"""
function create_endpoint_access(
EndpointName, SubnetGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"CreateEndpointAccess",
Dict{String,Any}(
"EndpointName" => EndpointName, "SubnetGroupName" => SubnetGroupName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_endpoint_access(
EndpointName,
SubnetGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"CreateEndpointAccess",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EndpointName" => EndpointName, "SubnetGroupName" => SubnetGroupName
),
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 Redshift event notification subscription. This action requires an ARN
(Amazon Resource Name) of an Amazon SNS topic created by either the Amazon Redshift
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 SNS console. You can specify the source type, and lists of Amazon Redshift source IDs,
event categories, and event severities. Notifications will be sent for all events you want
that match those criteria. For example, you can specify source type = cluster, source ID =
my-cluster-1 and mycluster2, event categories = Availability, Backup, and severity = ERROR.
The subscription will only send notifications for those ERROR events in the Availability
and Backup categories for the specified clusters. If you specify both the source type and
source IDs, such as source type = cluster and source identifier = my-cluster-1,
notifications will be sent for all the cluster events for my-cluster-1. If you specify a
source type but do not specify a source identifier, you will receive notice of the events
for the objects of that type in your Amazon Web Services account. If you do not specify
either the SourceType nor the SourceIdentifier, you will be notified of events generated
from all Amazon Redshift sources belonging to your Amazon Web Services account. You must
specify a source type if you specify a source ID.
# Arguments
- `sns_topic_arn`: The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit
the event notifications. The ARN is created by Amazon SNS when you create a topic and
subscribe to it.
- `subscription_name`: The name of the event subscription to be created. Constraints:
Cannot be null, empty, or blank. Must contain from 1 to 255 alphanumeric characters or
hyphens. First character must be a letter. 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:
- `"Enabled"`: A boolean value; set to true to activate the subscription, and set to false
to create the subscription but not activate it.
- `"EventCategories"`: Specifies the Amazon Redshift event categories to be published by
the event notification subscription. Values: configuration, management, monitoring,
security, pending
- `"Severity"`: Specifies the Amazon Redshift event severity to be published by the event
notification subscription. Values: ERROR, INFO
- `"SourceIds"`: A list of one or more identifiers of Amazon Redshift source objects. All
of the objects must be of the same type as was specified in the source type parameter. The
event subscription will return only events generated by the specified objects. If not
specified, then events are returned for all objects within the source type specified.
Example: my-cluster-1, my-cluster-2 Example: my-snapshot-20131010
- `"SourceType"`: The type of source that will be generating the events. For example, if
you want to be notified of events generated by a cluster, you would set this parameter to
cluster. If this value is not specified, events are returned for all Amazon Redshift
objects in your Amazon Web Services account. You must specify a source type in order to
specify source IDs. Valid values: cluster, cluster-parameter-group, cluster-security-group,
cluster-snapshot, and scheduled-action.
- `"Tags"`: A list of tag instances.
"""
function create_event_subscription(
SnsTopicArn, SubscriptionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"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 redshift(
"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_hsm_client_certificate(hsm_client_certificate_identifier)
create_hsm_client_certificate(hsm_client_certificate_identifier, params::Dict{String,<:Any})
Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to
the client's HSM in order to store and retrieve the keys used to encrypt the cluster
databases. The command returns a public key, which you must store in the HSM. In addition
to creating the HSM certificate, you must create an Amazon Redshift HSM configuration that
provides a cluster the information needed to store and use encryption keys in the HSM. For
more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management
Guide.
# Arguments
- `hsm_client_certificate_identifier`: The identifier to be assigned to the new HSM client
certificate that the cluster will use to connect to the HSM to use the database encryption
keys.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: A list of tag instances.
"""
function create_hsm_client_certificate(
HsmClientCertificateIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"CreateHsmClientCertificate",
Dict{String,Any}(
"HsmClientCertificateIdentifier" => HsmClientCertificateIdentifier
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_hsm_client_certificate(
HsmClientCertificateIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"CreateHsmClientCertificate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"HsmClientCertificateIdentifier" => HsmClientCertificateIdentifier
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_hsm_configuration(description, hsm_configuration_identifier, hsm_ip_address, hsm_partition_name, hsm_partition_password, hsm_server_public_certificate)
create_hsm_configuration(description, hsm_configuration_identifier, hsm_ip_address, hsm_partition_name, hsm_partition_password, hsm_server_public_certificate, params::Dict{String,<:Any})
Creates an HSM configuration that contains the information required by an Amazon Redshift
cluster to store and use database encryption keys in a Hardware Security Module (HSM).
After creating the HSM configuration, you can specify it as a parameter when creating a
cluster. The cluster will then store its encryption keys in the HSM. In addition to
creating an HSM configuration, you must also create an HSM client certificate. For more
information, go to Hardware Security Modules in the Amazon Redshift Cluster Management
Guide.
# Arguments
- `description`: A text description of the HSM configuration to be created.
- `hsm_configuration_identifier`: The identifier to be assigned to the new Amazon Redshift
HSM configuration.
- `hsm_ip_address`: The IP address that the Amazon Redshift cluster must use to access the
HSM.
- `hsm_partition_name`: The name of the partition in the HSM where the Amazon Redshift
clusters will store their database encryption keys.
- `hsm_partition_password`: The password required to access the HSM partition.
- `hsm_server_public_certificate`: The HSMs public certificate file. When using Cloud HSM,
the file name is server.pem.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: A list of tag instances.
"""
function create_hsm_configuration(
Description,
HsmConfigurationIdentifier,
HsmIpAddress,
HsmPartitionName,
HsmPartitionPassword,
HsmServerPublicCertificate;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"CreateHsmConfiguration",
Dict{String,Any}(
"Description" => Description,
"HsmConfigurationIdentifier" => HsmConfigurationIdentifier,
"HsmIpAddress" => HsmIpAddress,
"HsmPartitionName" => HsmPartitionName,
"HsmPartitionPassword" => HsmPartitionPassword,
"HsmServerPublicCertificate" => HsmServerPublicCertificate,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_hsm_configuration(
Description,
HsmConfigurationIdentifier,
HsmIpAddress,
HsmPartitionName,
HsmPartitionPassword,
HsmServerPublicCertificate,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"CreateHsmConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Description" => Description,
"HsmConfigurationIdentifier" => HsmConfigurationIdentifier,
"HsmIpAddress" => HsmIpAddress,
"HsmPartitionName" => HsmPartitionName,
"HsmPartitionPassword" => HsmPartitionPassword,
"HsmServerPublicCertificate" => HsmServerPublicCertificate,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_redshift_idc_application(iam_role_arn, idc_display_name, idc_instance_arn, redshift_idc_application_name)
create_redshift_idc_application(iam_role_arn, idc_display_name, idc_instance_arn, redshift_idc_application_name, params::Dict{String,<:Any})
Creates an Amazon Redshift application for use with IAM Identity Center.
# Arguments
- `iam_role_arn`: The IAM role ARN for the Amazon Redshift IAM Identity Center application
instance. It has the required permissions to be assumed and invoke the IDC Identity Center
API.
- `idc_display_name`: The display name for the Amazon Redshift IAM Identity Center
application instance. It appears in the console.
- `idc_instance_arn`: The Amazon resource name (ARN) of the IAM Identity Center instance
where Amazon Redshift creates a new managed application.
- `redshift_idc_application_name`: The name of the Redshift application in IAM Identity
Center.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AuthorizedTokenIssuerList"`: The token issuer list for the Amazon Redshift IAM Identity
Center application instance.
- `"IdentityNamespace"`: The namespace for the Amazon Redshift IAM Identity Center
application instance. It determines which managed application verifies the connection token.
- `"ServiceIntegrations"`: A collection of service integrations for the Redshift IAM
Identity Center application.
"""
function create_redshift_idc_application(
IamRoleArn,
IdcDisplayName,
IdcInstanceArn,
RedshiftIdcApplicationName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"CreateRedshiftIdcApplication",
Dict{String,Any}(
"IamRoleArn" => IamRoleArn,
"IdcDisplayName" => IdcDisplayName,
"IdcInstanceArn" => IdcInstanceArn,
"RedshiftIdcApplicationName" => RedshiftIdcApplicationName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_redshift_idc_application(
IamRoleArn,
IdcDisplayName,
IdcInstanceArn,
RedshiftIdcApplicationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"CreateRedshiftIdcApplication",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IamRoleArn" => IamRoleArn,
"IdcDisplayName" => IdcDisplayName,
"IdcInstanceArn" => IdcInstanceArn,
"RedshiftIdcApplicationName" => RedshiftIdcApplicationName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_scheduled_action(iam_role, schedule, scheduled_action_name, target_action)
create_scheduled_action(iam_role, schedule, scheduled_action_name, target_action, params::Dict{String,<:Any})
Creates a scheduled action. A scheduled action contains a schedule and an Amazon Redshift
API action. For example, you can create a schedule of when to run the ResizeCluster API
operation.
# Arguments
- `iam_role`: The IAM role to assume to run the target action. For more information about
this parameter, see ScheduledAction.
- `schedule`: The schedule in at( ) or cron( ) format. For more information about this
parameter, see ScheduledAction.
- `scheduled_action_name`: The name of the scheduled action. The name must be unique within
an account. For more information about this parameter, see ScheduledAction.
- `target_action`: A JSON format string of the Amazon Redshift API operation with input
parameters. For more information about this parameter, see ScheduledAction.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Enable"`: If true, the schedule is enabled. If false, the scheduled action does not
trigger. For more information about state of the scheduled action, see ScheduledAction.
- `"EndTime"`: The end time in UTC of the scheduled action. After this time, the scheduled
action does not trigger. For more information about this parameter, see ScheduledAction.
- `"ScheduledActionDescription"`: The description of the scheduled action.
- `"StartTime"`: The start time in UTC of the scheduled action. Before this time, the
scheduled action does not trigger. For more information about this parameter, see
ScheduledAction.
"""
function create_scheduled_action(
IamRole,
Schedule,
ScheduledActionName,
TargetAction;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"CreateScheduledAction",
Dict{String,Any}(
"IamRole" => IamRole,
"Schedule" => Schedule,
"ScheduledActionName" => ScheduledActionName,
"TargetAction" => TargetAction,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_scheduled_action(
IamRole,
Schedule,
ScheduledActionName,
TargetAction,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"CreateScheduledAction",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IamRole" => IamRole,
"Schedule" => Schedule,
"ScheduledActionName" => ScheduledActionName,
"TargetAction" => TargetAction,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_snapshot_copy_grant(snapshot_copy_grant_name)
create_snapshot_copy_grant(snapshot_copy_grant_name, params::Dict{String,<:Any})
Creates a snapshot copy grant that permits Amazon Redshift to use an encrypted symmetric
key from Key Management Service (KMS) to encrypt copied snapshots in a destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database
Encryption in the Amazon Redshift Cluster Management Guide.
# Arguments
- `snapshot_copy_grant_name`: The name of the snapshot copy grant. This name must be unique
in the region for the Amazon Web Services account. Constraints: Must contain from 1 to 63
alphanumeric characters or hyphens. Alphabetic characters must be lowercase. First
character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"KmsKeyId"`: The unique identifier of the encrypted symmetric key to which to grant
Amazon Redshift permission. If no key is specified, the default key is used.
- `"Tags"`: A list of tag instances.
"""
function create_snapshot_copy_grant(
SnapshotCopyGrantName; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"CreateSnapshotCopyGrant",
Dict{String,Any}("SnapshotCopyGrantName" => SnapshotCopyGrantName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_snapshot_copy_grant(
SnapshotCopyGrantName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"CreateSnapshotCopyGrant",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("SnapshotCopyGrantName" => SnapshotCopyGrantName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_snapshot_schedule()
create_snapshot_schedule(params::Dict{String,<:Any})
Create a snapshot schedule that can be associated to a cluster and which overrides the
default system backup schedule.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`:
- `"NextInvocations"`:
- `"ScheduleDefinitions"`: The definition of the snapshot schedule. The definition is made
up of schedule expressions, for example \"cron(30 12 *)\" or \"rate(12 hours)\".
- `"ScheduleDescription"`: The description of the snapshot schedule.
- `"ScheduleIdentifier"`: A unique identifier for a snapshot schedule. Only alphanumeric
characters are allowed for the identifier.
- `"Tags"`: An optional set of tags you can use to search for the schedule.
"""
function create_snapshot_schedule(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift(
"CreateSnapshotSchedule"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function create_snapshot_schedule(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"CreateSnapshotSchedule",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_tags(resource_name, tag)
create_tags(resource_name, tag, params::Dict{String,<:Any})
Adds tags to a cluster. A resource can have up to 50 tags. If you try to create more than
50 tags for a resource, you will receive an error and the attempt will fail. If you specify
a key that already exists for the resource, the value for that key will be updated with the
new value.
# Arguments
- `resource_name`: The Amazon Resource Name (ARN) to which you want to add the tag or tags.
For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.
- `tag`: One or more name/value pairs to add as tags to the specified resource. Each tag
name is passed in with the parameter Key and the corresponding value is passed in with the
parameter Value. The Key and Value parameters are separated by a comma (,). Separate
multiple tags with a space. For example, --tags \"Key\"=\"owner\",\"Value\"=\"admin\"
\"Key\"=\"environment\",\"Value\"=\"test\" \"Key\"=\"version\",\"Value\"=\"1.0\".
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: One or more name/value pairs to add as tags to the specified resource. Each tag
name is passed in with the parameter Key and the corresponding value is passed in with the
parameter Value. The Key and Value parameters are separated by a comma (,). Separate
multiple tags with a space. For example, --tags \"Key\"=\"owner\",\"Value\"=\"admin\"
\"Key\"=\"environment\",\"Value\"=\"test\" \"Key\"=\"version\",\"Value\"=\"1.0\".
"""
function create_tags(ResourceName, Tag; aws_config::AbstractAWSConfig=global_aws_config())
return redshift(
"CreateTags",
Dict{String,Any}("ResourceName" => ResourceName, "Tag" => Tag);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_tags(
ResourceName,
Tag,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"CreateTags",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceName" => ResourceName, "Tag" => Tag),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_usage_limit(amount, cluster_identifier, feature_type, limit_type)
create_usage_limit(amount, cluster_identifier, feature_type, limit_type, params::Dict{String,<:Any})
Creates a usage limit for a specified Amazon Redshift feature on a cluster. The usage limit
is identified by the returned usage limit identifier.
# Arguments
- `amount`: The limit amount. If time-based, this amount is in minutes. If data-based, this
amount is in terabytes (TB). The value must be a positive number.
- `cluster_identifier`: The identifier of the cluster that you want to limit usage.
- `feature_type`: The Amazon Redshift feature that you want to limit.
- `limit_type`: The type of limit. Depending on the feature type, this can be based on a
time duration or data size. If FeatureType is spectrum, then LimitType must be
data-scanned. If FeatureType is concurrency-scaling, then LimitType must be time. If
FeatureType is cross-region-datasharing, then LimitType must be data-scanned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BreachAction"`: The action that Amazon Redshift takes when the limit is reached. The
default is log. For more information about this parameter, see UsageLimit.
- `"Period"`: The time period that the amount applies to. A weekly period begins on Sunday.
The default is monthly.
- `"Tags"`: A list of tag instances.
"""
function create_usage_limit(
Amount,
ClusterIdentifier,
FeatureType,
LimitType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"CreateUsageLimit",
Dict{String,Any}(
"Amount" => Amount,
"ClusterIdentifier" => ClusterIdentifier,
"FeatureType" => FeatureType,
"LimitType" => LimitType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_usage_limit(
Amount,
ClusterIdentifier,
FeatureType,
LimitType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"CreateUsageLimit",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Amount" => Amount,
"ClusterIdentifier" => ClusterIdentifier,
"FeatureType" => FeatureType,
"LimitType" => LimitType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deauthorize_data_share(consumer_identifier, data_share_arn)
deauthorize_data_share(consumer_identifier, data_share_arn, params::Dict{String,<:Any})
From a datashare producer account, removes authorization from the specified datashare.
# Arguments
- `consumer_identifier`: The identifier of the data consumer that is to have authorization
removed from the datashare. This identifier is an Amazon Web Services account ID or a
keyword, such as ADX.
- `data_share_arn`: The namespace Amazon Resource Name (ARN) of the datashare to remove
authorization from.
"""
function deauthorize_data_share(
ConsumerIdentifier, DataShareArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DeauthorizeDataShare",
Dict{String,Any}(
"ConsumerIdentifier" => ConsumerIdentifier, "DataShareArn" => DataShareArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deauthorize_data_share(
ConsumerIdentifier,
DataShareArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"DeauthorizeDataShare",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConsumerIdentifier" => ConsumerIdentifier,
"DataShareArn" => DataShareArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_authentication_profile(authentication_profile_name)
delete_authentication_profile(authentication_profile_name, params::Dict{String,<:Any})
Deletes an authentication profile.
# Arguments
- `authentication_profile_name`: The name of the authentication profile to delete.
"""
function delete_authentication_profile(
AuthenticationProfileName; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DeleteAuthenticationProfile",
Dict{String,Any}("AuthenticationProfileName" => AuthenticationProfileName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_authentication_profile(
AuthenticationProfileName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"DeleteAuthenticationProfile",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AuthenticationProfileName" => AuthenticationProfileName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_cluster(cluster_identifier)
delete_cluster(cluster_identifier, params::Dict{String,<:Any})
Deletes a previously provisioned cluster without its final snapshot being created. A
successful response from the web service indicates that the request was received correctly.
Use DescribeClusters to monitor the status of the deletion. The delete operation cannot be
canceled or reverted once submitted. For more information about managing clusters, go to
Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. If you want to
shut down the cluster and retain it for future use, set SkipFinalClusterSnapshot to false
and specify a name for FinalClusterSnapshotIdentifier. You can later restore this snapshot
to resume using the cluster. If a final cluster snapshot is requested, the status of the
cluster will be \"final-snapshot\" while the snapshot is being taken, then it's
\"deleting\" once Amazon Redshift begins deleting the cluster. For more information about
managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management
Guide.
# Arguments
- `cluster_identifier`: The identifier of the cluster to be deleted. Constraints: Must
contain lowercase characters. Must contain from 1 to 63 alphanumeric characters or
hyphens. First character must be a letter. 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:
- `"FinalClusterSnapshotIdentifier"`: The identifier of the final snapshot that is to be
created immediately before deleting the cluster. If this parameter is provided,
SkipFinalClusterSnapshot must be false. Constraints: Must be 1 to 255 alphanumeric
characters. First character must be a letter. Cannot end with a hyphen or contain two
consecutive hyphens.
- `"FinalClusterSnapshotRetentionPeriod"`: The number of days that a manual snapshot is
retained. If the value is -1, the manual snapshot is retained indefinitely. The value must
be either -1 or an integer between 1 and 3,653. The default value is -1.
- `"SkipFinalClusterSnapshot"`: Determines whether a final snapshot of the cluster is
created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is
not created. If false, a final cluster snapshot is created before the cluster is deleted.
The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot
is false. Default: false
"""
function delete_cluster(
ClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DeleteCluster",
Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_cluster(
ClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"DeleteCluster",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_cluster_parameter_group(parameter_group_name)
delete_cluster_parameter_group(parameter_group_name, params::Dict{String,<:Any})
Deletes a specified Amazon Redshift parameter group. You cannot delete a parameter group
if it is associated with a cluster.
# Arguments
- `parameter_group_name`: The name of the parameter group to be deleted. Constraints:
Must be the name of an existing cluster parameter group. Cannot delete a default cluster
parameter group.
"""
function delete_cluster_parameter_group(
ParameterGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DeleteClusterParameterGroup",
Dict{String,Any}("ParameterGroupName" => ParameterGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_cluster_parameter_group(
ParameterGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"DeleteClusterParameterGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ParameterGroupName" => ParameterGroupName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_cluster_security_group(cluster_security_group_name)
delete_cluster_security_group(cluster_security_group_name, params::Dict{String,<:Any})
Deletes an Amazon Redshift security group. You cannot delete a security group that is
associated with any clusters. You cannot delete the default security group. For
information about managing security groups, go to Amazon Redshift Cluster Security Groups
in the Amazon Redshift Cluster Management Guide.
# Arguments
- `cluster_security_group_name`: The name of the cluster security group to be deleted.
"""
function delete_cluster_security_group(
ClusterSecurityGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DeleteClusterSecurityGroup",
Dict{String,Any}("ClusterSecurityGroupName" => ClusterSecurityGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_cluster_security_group(
ClusterSecurityGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"DeleteClusterSecurityGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ClusterSecurityGroupName" => ClusterSecurityGroupName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_cluster_snapshot(snapshot_identifier)
delete_cluster_snapshot(snapshot_identifier, params::Dict{String,<:Any})
Deletes the specified manual snapshot. The snapshot must be in the available state, with no
other users authorized to access the snapshot. Unlike automated snapshots, manual
snapshots are retained even after you delete your cluster. Amazon Redshift does not delete
your manual snapshots. You must delete manual snapshot explicitly to avoid getting charged.
If other accounts are authorized to access the snapshot, you must revoke all of the
authorizations before you can delete the snapshot.
# Arguments
- `snapshot_identifier`: The unique identifier of the manual snapshot to be deleted.
Constraints: Must be the name of an existing snapshot that is in the available, failed, or
cancelled state.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SnapshotClusterIdentifier"`: The unique identifier of the cluster the snapshot was
created from. This parameter is required if your IAM user has a policy containing a
snapshot resource element that specifies anything other than * for the cluster name.
Constraints: Must be the name of valid cluster.
"""
function delete_cluster_snapshot(
SnapshotIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DeleteClusterSnapshot",
Dict{String,Any}("SnapshotIdentifier" => SnapshotIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_cluster_snapshot(
SnapshotIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"DeleteClusterSnapshot",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("SnapshotIdentifier" => SnapshotIdentifier), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_cluster_subnet_group(cluster_subnet_group_name)
delete_cluster_subnet_group(cluster_subnet_group_name, params::Dict{String,<:Any})
Deletes the specified cluster subnet group.
# Arguments
- `cluster_subnet_group_name`: The name of the cluster subnet group name to be deleted.
"""
function delete_cluster_subnet_group(
ClusterSubnetGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DeleteClusterSubnetGroup",
Dict{String,Any}("ClusterSubnetGroupName" => ClusterSubnetGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_cluster_subnet_group(
ClusterSubnetGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"DeleteClusterSubnetGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ClusterSubnetGroupName" => ClusterSubnetGroupName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_custom_domain_association(cluster_identifier, custom_domain_name)
delete_custom_domain_association(cluster_identifier, custom_domain_name, params::Dict{String,<:Any})
Contains information about deleting a custom domain association for a cluster.
# Arguments
- `cluster_identifier`: The identifier of the cluster to delete a custom domain association
for.
- `custom_domain_name`: The custom domain name for the custom domain association.
"""
function delete_custom_domain_association(
ClusterIdentifier, CustomDomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DeleteCustomDomainAssociation",
Dict{String,Any}(
"ClusterIdentifier" => ClusterIdentifier, "CustomDomainName" => CustomDomainName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_custom_domain_association(
ClusterIdentifier,
CustomDomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"DeleteCustomDomainAssociation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClusterIdentifier" => ClusterIdentifier,
"CustomDomainName" => CustomDomainName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_endpoint_access(endpoint_name)
delete_endpoint_access(endpoint_name, params::Dict{String,<:Any})
Deletes a Redshift-managed VPC endpoint.
# Arguments
- `endpoint_name`: The Redshift-managed VPC endpoint to delete.
"""
function delete_endpoint_access(
EndpointName; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DeleteEndpointAccess",
Dict{String,Any}("EndpointName" => EndpointName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_endpoint_access(
EndpointName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"DeleteEndpointAccess",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EndpointName" => EndpointName), 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 Redshift event notification subscription.
# Arguments
- `subscription_name`: The name of the Amazon Redshift event notification subscription to
be deleted.
"""
function delete_event_subscription(
SubscriptionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"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 redshift(
"DeleteEventSubscription",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("SubscriptionName" => SubscriptionName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_hsm_client_certificate(hsm_client_certificate_identifier)
delete_hsm_client_certificate(hsm_client_certificate_identifier, params::Dict{String,<:Any})
Deletes the specified HSM client certificate.
# Arguments
- `hsm_client_certificate_identifier`: The identifier of the HSM client certificate to be
deleted.
"""
function delete_hsm_client_certificate(
HsmClientCertificateIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DeleteHsmClientCertificate",
Dict{String,Any}(
"HsmClientCertificateIdentifier" => HsmClientCertificateIdentifier
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_hsm_client_certificate(
HsmClientCertificateIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"DeleteHsmClientCertificate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"HsmClientCertificateIdentifier" => HsmClientCertificateIdentifier
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_hsm_configuration(hsm_configuration_identifier)
delete_hsm_configuration(hsm_configuration_identifier, params::Dict{String,<:Any})
Deletes the specified Amazon Redshift HSM configuration.
# Arguments
- `hsm_configuration_identifier`: The identifier of the Amazon Redshift HSM configuration
to be deleted.
"""
function delete_hsm_configuration(
HsmConfigurationIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DeleteHsmConfiguration",
Dict{String,Any}("HsmConfigurationIdentifier" => HsmConfigurationIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_hsm_configuration(
HsmConfigurationIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"DeleteHsmConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"HsmConfigurationIdentifier" => HsmConfigurationIdentifier
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_partner(account_id, cluster_identifier, database_name, partner_name)
delete_partner(account_id, cluster_identifier, database_name, partner_name, params::Dict{String,<:Any})
Deletes a partner integration from a cluster. Data can still flow to the cluster until the
integration is deleted at the partner's website.
# Arguments
- `account_id`: The Amazon Web Services account ID that owns the cluster.
- `cluster_identifier`: The cluster identifier of the cluster that receives data from the
partner.
- `database_name`: The name of the database that receives data from the partner.
- `partner_name`: The name of the partner that is authorized to send data.
"""
function delete_partner(
AccountId,
ClusterIdentifier,
DatabaseName,
PartnerName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"DeletePartner",
Dict{String,Any}(
"AccountId" => AccountId,
"ClusterIdentifier" => ClusterIdentifier,
"DatabaseName" => DatabaseName,
"PartnerName" => PartnerName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_partner(
AccountId,
ClusterIdentifier,
DatabaseName,
PartnerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"DeletePartner",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AccountId" => AccountId,
"ClusterIdentifier" => ClusterIdentifier,
"DatabaseName" => DatabaseName,
"PartnerName" => PartnerName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_redshift_idc_application(redshift_idc_application_arn)
delete_redshift_idc_application(redshift_idc_application_arn, params::Dict{String,<:Any})
Deletes an Amazon Redshift IAM Identity Center application.
# Arguments
- `redshift_idc_application_arn`: The ARN for a deleted Amazon Redshift IAM Identity Center
application.
"""
function delete_redshift_idc_application(
RedshiftIdcApplicationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DeleteRedshiftIdcApplication",
Dict{String,Any}("RedshiftIdcApplicationArn" => RedshiftIdcApplicationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_redshift_idc_application(
RedshiftIdcApplicationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"DeleteRedshiftIdcApplication",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("RedshiftIdcApplicationArn" => RedshiftIdcApplicationArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_resource_policy(resource_arn)
delete_resource_policy(resource_arn, params::Dict{String,<:Any})
Deletes the resource policy for a specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource of which its resource
policy is deleted.
"""
function delete_resource_policy(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"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 redshift(
"DeleteResourcePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_scheduled_action(scheduled_action_name)
delete_scheduled_action(scheduled_action_name, params::Dict{String,<:Any})
Deletes a scheduled action.
# Arguments
- `scheduled_action_name`: The name of the scheduled action to delete.
"""
function delete_scheduled_action(
ScheduledActionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DeleteScheduledAction",
Dict{String,Any}("ScheduledActionName" => ScheduledActionName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_scheduled_action(
ScheduledActionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"DeleteScheduledAction",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ScheduledActionName" => ScheduledActionName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_snapshot_copy_grant(snapshot_copy_grant_name)
delete_snapshot_copy_grant(snapshot_copy_grant_name, params::Dict{String,<:Any})
Deletes the specified snapshot copy grant.
# Arguments
- `snapshot_copy_grant_name`: The name of the snapshot copy grant to delete.
"""
function delete_snapshot_copy_grant(
SnapshotCopyGrantName; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DeleteSnapshotCopyGrant",
Dict{String,Any}("SnapshotCopyGrantName" => SnapshotCopyGrantName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_snapshot_copy_grant(
SnapshotCopyGrantName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"DeleteSnapshotCopyGrant",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("SnapshotCopyGrantName" => SnapshotCopyGrantName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_snapshot_schedule(schedule_identifier)
delete_snapshot_schedule(schedule_identifier, params::Dict{String,<:Any})
Deletes a snapshot schedule.
# Arguments
- `schedule_identifier`: A unique identifier of the snapshot schedule to delete.
"""
function delete_snapshot_schedule(
ScheduleIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DeleteSnapshotSchedule",
Dict{String,Any}("ScheduleIdentifier" => ScheduleIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_snapshot_schedule(
ScheduleIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"DeleteSnapshotSchedule",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ScheduleIdentifier" => ScheduleIdentifier), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_tags(resource_name, tag_key)
delete_tags(resource_name, tag_key, params::Dict{String,<:Any})
Deletes tags from a resource. You must provide the ARN of the resource from which you want
to delete the tag or tags.
# Arguments
- `resource_name`: The Amazon Resource Name (ARN) from which you want to remove the tag or
tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.
- `tag_key`: The tag key that you want to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"TagKeys"`: The tag key that you want to delete.
"""
function delete_tags(
ResourceName, TagKey; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DeleteTags",
Dict{String,Any}("ResourceName" => ResourceName, "TagKey" => TagKey);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_tags(
ResourceName,
TagKey,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"DeleteTags",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceName" => ResourceName, "TagKey" => TagKey),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_usage_limit(usage_limit_id)
delete_usage_limit(usage_limit_id, params::Dict{String,<:Any})
Deletes a usage limit from a cluster.
# Arguments
- `usage_limit_id`: The identifier of the usage limit to delete.
"""
function delete_usage_limit(UsageLimitId; aws_config::AbstractAWSConfig=global_aws_config())
return redshift(
"DeleteUsageLimit",
Dict{String,Any}("UsageLimitId" => UsageLimitId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_usage_limit(
UsageLimitId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"DeleteUsageLimit",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UsageLimitId" => UsageLimitId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_account_attributes()
describe_account_attributes(params::Dict{String,<:Any})
Returns a list of attributes attached to an account
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AttributeNames"`: A list of attribute names.
"""
function describe_account_attributes(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift(
"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 redshift(
"DescribeAccountAttributes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_authentication_profiles()
describe_authentication_profiles(params::Dict{String,<:Any})
Describes an authentication profile.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AuthenticationProfileName"`: The name of the authentication profile to describe. If not
specified then all authentication profiles owned by the account are listed.
"""
function describe_authentication_profiles(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeAuthenticationProfiles";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_authentication_profiles(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeAuthenticationProfiles",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_cluster_db_revisions()
describe_cluster_db_revisions(params::Dict{String,<:Any})
Returns an array of ClusterDbRevision objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClusterIdentifier"`: A unique identifier for a cluster whose ClusterDbRevisions you are
requesting. This parameter is case sensitive. All clusters defined for an account are
returned by default.
- `"Marker"`: An optional parameter that specifies the starting point for returning a set
of response records. When the results of a DescribeClusterDbRevisions request exceed the
value specified in MaxRecords, Amazon Redshift returns a value in the marker field of the
response. You can retrieve the next set of response records by providing the returned
marker value in the marker parameter and retrying the request. Constraints: You can
specify either the ClusterIdentifier parameter, or the marker parameter, but not both.
- `"MaxRecords"`: The maximum number of response records to return in each call. If the
number of remaining response records exceeds the specified MaxRecords value, a value is
returned in the marker field of the response. You can retrieve the next set of response
records by providing the returned marker value in the marker parameter and retrying the
request. Default: 100 Constraints: minimum 20, maximum 100.
"""
function describe_cluster_db_revisions(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift(
"DescribeClusterDbRevisions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_cluster_db_revisions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeClusterDbRevisions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_cluster_parameter_groups()
describe_cluster_parameter_groups(params::Dict{String,<:Any})
Returns a list of Amazon Redshift parameter groups, including parameter groups you created
and the default parameter group. For each parameter group, the response includes the
parameter group name, description, and parameter group family name. You can optionally
specify a name to retrieve the description of a specific parameter group. For more
information about parameters and parameter groups, go to Amazon Redshift Parameter Groups
in the Amazon Redshift Cluster Management Guide. If you specify both tag keys and tag
values in the same request, Amazon Redshift returns all parameter groups that match any
combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all parameter groups that have
any combination of those values are returned. If both tag keys and values are omitted from
the request, parameter groups are returned regardless of whether they have tag keys or
values associated with them.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: An optional parameter that specifies the starting point to return a set of
response records. When the results of a DescribeClusterParameterGroups request exceed the
value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of
the response. You can retrieve the next set of response records by providing the returned
marker value in the Marker parameter and retrying the request.
- `"MaxRecords"`: The maximum number of response records to return in each call. If the
number of remaining response records exceeds the specified MaxRecords value, a value is
returned in a marker field of the response. You can retrieve the next set of records by
retrying the command with the returned marker value. Default: 100 Constraints: minimum
20, maximum 100.
- `"ParameterGroupName"`: The name of a specific parameter group for which to return
details. By default, details about all parameter groups and the default parameter group are
returned.
- `"TagKeys"`: A tag key or keys for which you want to return all matching cluster
parameter groups that are associated with the specified key or keys. For example, suppose
that you have parameter groups that are tagged with keys called owner and environment. If
you specify both of these tag keys in the request, Amazon Redshift returns a response with
the parameter groups that have either or both of these tag keys associated with them.
- `"TagValues"`: A tag value or values for which you want to return all matching cluster
parameter groups that are associated with the specified tag value or values. For example,
suppose that you have parameter groups that are tagged with values called admin and test.
If you specify both of these tag values in the request, Amazon Redshift returns a response
with the parameter groups that have either or both of these tag values associated with them.
"""
function describe_cluster_parameter_groups(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeClusterParameterGroups";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_cluster_parameter_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeClusterParameterGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_cluster_parameters(parameter_group_name)
describe_cluster_parameters(parameter_group_name, params::Dict{String,<:Any})
Returns a detailed list of parameters contained within the specified Amazon Redshift
parameter group. For each parameter the response includes information such as parameter
name, description, data type, value, whether the parameter value is modifiable, and so on.
You can specify source filter to retrieve parameters of only specific type. For example, to
retrieve parameters that were modified by a user action such as from
ModifyClusterParameterGroup, you can specify source equal to user. For more information
about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon
Redshift Cluster Management Guide.
# Arguments
- `parameter_group_name`: The name of a cluster parameter group for which to return details.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: An optional parameter that specifies the starting point to return a set of
response records. When the results of a DescribeClusterParameters request exceed the value
specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the
response. You can retrieve the next set of response records by providing the returned
marker value in the Marker parameter and retrying the request.
- `"MaxRecords"`: The maximum number of response records to return in each call. If the
number of remaining response records exceeds the specified MaxRecords value, a value is
returned in a marker field of the response. You can retrieve the next set of records by
retrying the command with the returned marker value. Default: 100 Constraints: minimum
20, maximum 100.
- `"Source"`: The parameter types to return. Specify user to show parameters that are
different form the default. Similarly, specify engine-default to show parameters that are
the same as the default parameter group. Default: All parameter types returned. Valid
Values: user | engine-default
"""
function describe_cluster_parameters(
ParameterGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeClusterParameters",
Dict{String,Any}("ParameterGroupName" => ParameterGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_cluster_parameters(
ParameterGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"DescribeClusterParameters",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ParameterGroupName" => ParameterGroupName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_cluster_security_groups()
describe_cluster_security_groups(params::Dict{String,<:Any})
Returns information about Amazon Redshift security groups. If the name of a security group
is specified, the response will contain only information about only that security group.
For information about managing security groups, go to Amazon Redshift Cluster Security
Groups in the Amazon Redshift Cluster Management Guide. If you specify both tag keys and
tag values in the same request, Amazon Redshift returns all security groups that match any
combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all security groups that have
any combination of those values are returned. If both tag keys and values are omitted from
the request, security groups are returned regardless of whether they have tag keys or
values associated with them.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClusterSecurityGroupName"`: The name of a cluster security group for which you are
requesting details. You must specify either the Marker parameter or a
ClusterSecurityGroupName parameter, but not both. Example: securitygroup1
- `"Marker"`: An optional parameter that specifies the starting point to return a set of
response records. When the results of a DescribeClusterSecurityGroups request exceed the
value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of
the response. You can retrieve the next set of response records by providing the returned
marker value in the Marker parameter and retrying the request. Constraints: You must
specify either the ClusterSecurityGroupName parameter or the Marker parameter, but not
both.
- `"MaxRecords"`: The maximum number of response records to return in each call. If the
number of remaining response records exceeds the specified MaxRecords value, a value is
returned in a marker field of the response. You can retrieve the next set of records by
retrying the command with the returned marker value. Default: 100 Constraints: minimum
20, maximum 100.
- `"TagKeys"`: A tag key or keys for which you want to return all matching cluster security
groups that are associated with the specified key or keys. For example, suppose that you
have security groups that are tagged with keys called owner and environment. If you specify
both of these tag keys in the request, Amazon Redshift returns a response with the security
groups that have either or both of these tag keys associated with them.
- `"TagValues"`: A tag value or values for which you want to return all matching cluster
security groups that are associated with the specified tag value or values. For example,
suppose that you have security groups that are tagged with values called admin and test. If
you specify both of these tag values in the request, Amazon Redshift returns a response
with the security groups that have either or both of these tag values associated with them.
"""
function describe_cluster_security_groups(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeClusterSecurityGroups";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_cluster_security_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeClusterSecurityGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_cluster_snapshots()
describe_cluster_snapshots(params::Dict{String,<:Any})
Returns one or more snapshot objects, which contain metadata about your cluster snapshots.
By default, this operation returns information about all snapshots of all clusters that are
owned by your Amazon Web Services account. No information is returned for snapshots owned
by inactive Amazon Web Services accounts. If you specify both tag keys and tag values in
the same request, Amazon Redshift returns all snapshots that match any combination of the
specified keys and values. For example, if you have owner and environment for tag keys, and
admin and test for tag values, all snapshots that have any combination of those values are
returned. Only snapshots that you own are returned in the response; shared snapshots are
not returned with the tag key and tag value request parameters. If both tag keys and values
are omitted from the request, snapshots are returned regardless of whether they have tag
keys or values associated with them.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClusterExists"`: A value that indicates whether to return snapshots only for an
existing cluster. You can perform table-level restore only by using a snapshot of an
existing cluster, that is, a cluster that has not been deleted. Values for this parameter
work as follows: If ClusterExists is set to true, ClusterIdentifier is required. If
ClusterExists is set to false and ClusterIdentifier isn't specified, all snapshots
associated with deleted clusters (orphaned snapshots) are returned. If ClusterExists is
set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated
with that cluster are returned. If ClusterExists is set to false and ClusterIdentifier is
specified for an existing cluster, no snapshots are returned.
- `"ClusterIdentifier"`: The identifier of the cluster which generated the requested
snapshots.
- `"EndTime"`: A time value that requests only snapshots created at or before the specified
time. The time value is specified in ISO 8601 format. For more information about ISO 8601,
go to the ISO8601 Wikipedia page. Example: 2012-07-16T18:00:00Z
- `"Marker"`: An optional parameter that specifies the starting point to return a set of
response records. When the results of a DescribeClusterSnapshots request exceed the value
specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the
response. You can retrieve the next set of response records by providing the returned
marker value in the Marker parameter and retrying the request.
- `"MaxRecords"`: The maximum number of response records to return in each call. If the
number of remaining response records exceeds the specified MaxRecords value, a value is
returned in a marker field of the response. You can retrieve the next set of records by
retrying the command with the returned marker value. Default: 100 Constraints: minimum
20, maximum 100.
- `"OwnerAccount"`: The Amazon Web Services account used to create or copy the snapshot.
Use this field to filter the results to snapshots owned by a particular account. To
describe snapshots you own, either specify your Amazon Web Services account, or do not
specify the parameter.
- `"SnapshotArn"`: The Amazon Resource Name (ARN) of the snapshot associated with the
message to describe cluster snapshots.
- `"SnapshotIdentifier"`: The snapshot identifier of the snapshot about which to return
information.
- `"SnapshotType"`: The type of snapshots for which you are requesting information. By
default, snapshots of all types are returned. Valid Values: automated | manual
- `"SortingEntities"`:
- `"StartTime"`: A value that requests only snapshots created at or after the specified
time. The time value is specified in ISO 8601 format. For more information about ISO 8601,
go to the ISO8601 Wikipedia page. Example: 2012-07-16T18:00:00Z
- `"TagKeys"`: A tag key or keys for which you want to return all matching cluster
snapshots that are associated with the specified key or keys. For example, suppose that you
have snapshots that are tagged with keys called owner and environment. If you specify both
of these tag keys in the request, Amazon Redshift returns a response with the snapshots
that have either or both of these tag keys associated with them.
- `"TagValues"`: A tag value or values for which you want to return all matching cluster
snapshots that are associated with the specified tag value or values. For example, suppose
that you have snapshots that are tagged with values called admin and test. If you specify
both of these tag values in the request, Amazon Redshift returns a response with the
snapshots that have either or both of these tag values associated with them.
"""
function describe_cluster_snapshots(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift(
"DescribeClusterSnapshots"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_cluster_snapshots(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeClusterSnapshots",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_cluster_subnet_groups()
describe_cluster_subnet_groups(params::Dict{String,<:Any})
Returns one or more cluster subnet group objects, which contain metadata about your cluster
subnet groups. By default, this operation returns information about all cluster subnet
groups that are defined in your Amazon Web Services account. If you specify both tag keys
and tag values in the same request, Amazon Redshift returns all subnet groups that match
any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all subnet groups that have
any combination of those values are returned. If both tag keys and values are omitted from
the request, subnet groups are returned regardless of whether they have tag keys or values
associated with them.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClusterSubnetGroupName"`: The name of the cluster subnet group for which information is
requested.
- `"Marker"`: An optional parameter that specifies the starting point to return a set of
response records. When the results of a DescribeClusterSubnetGroups request exceed the
value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of
the response. You can retrieve the next set of response records by providing the returned
marker value in the Marker parameter and retrying the request.
- `"MaxRecords"`: The maximum number of response records to return in each call. If the
number of remaining response records exceeds the specified MaxRecords value, a value is
returned in a marker field of the response. You can retrieve the next set of records by
retrying the command with the returned marker value. Default: 100 Constraints: minimum
20, maximum 100.
- `"TagKeys"`: A tag key or keys for which you want to return all matching cluster subnet
groups that are associated with the specified key or keys. For example, suppose that you
have subnet groups that are tagged with keys called owner and environment. If you specify
both of these tag keys in the request, Amazon Redshift returns a response with the subnet
groups that have either or both of these tag keys associated with them.
- `"TagValues"`: A tag value or values for which you want to return all matching cluster
subnet groups that are associated with the specified tag value or values. For example,
suppose that you have subnet groups that are tagged with values called admin and test. If
you specify both of these tag values in the request, Amazon Redshift returns a response
with the subnet groups that have either or both of these tag values associated with them.
"""
function describe_cluster_subnet_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift(
"DescribeClusterSubnetGroups";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_cluster_subnet_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeClusterSubnetGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_cluster_tracks()
describe_cluster_tracks(params::Dict{String,<:Any})
Returns a list of all the available maintenance tracks.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaintenanceTrackName"`: The name of the maintenance track.
- `"Marker"`: An optional parameter that specifies the starting point to return a set of
response records. When the results of a DescribeClusterTracks request exceed the value
specified in MaxRecords, Amazon Redshift returns a value in the Marker field of the
response. You can retrieve the next set of response records by providing the returned
marker value in the Marker parameter and retrying the request.
- `"MaxRecords"`: An integer value for the maximum number of maintenance tracks to return.
"""
function describe_cluster_tracks(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift(
"DescribeClusterTracks"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_cluster_tracks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeClusterTracks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_cluster_versions()
describe_cluster_versions(params::Dict{String,<:Any})
Returns descriptions of the available Amazon Redshift cluster versions. You can call this
operation even before creating any clusters to learn more about the Amazon Redshift
versions. For more information about managing clusters, go to Amazon Redshift Clusters in
the Amazon Redshift Cluster Management Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClusterParameterGroupFamily"`: The name of a specific cluster parameter group family to
return details for. Constraints: Must be 1 to 255 alphanumeric characters First
character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
- `"ClusterVersion"`: The specific cluster version to return. Example: 1.0
- `"Marker"`: An optional parameter that specifies the starting point to return a set of
response records. When the results of a DescribeClusterVersions request exceed the value
specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the
response. You can retrieve the next set of response records by providing the returned
marker value in the Marker parameter and retrying the request.
- `"MaxRecords"`: The maximum number of response records to return in each call. If the
number of remaining response records exceeds the specified MaxRecords value, a value is
returned in a marker field of the response. You can retrieve the next set of records by
retrying the command with the returned marker value. Default: 100 Constraints: minimum
20, maximum 100.
"""
function describe_cluster_versions(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift(
"DescribeClusterVersions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_cluster_versions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeClusterVersions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_clusters()
describe_clusters(params::Dict{String,<:Any})
Returns properties of provisioned clusters including general cluster properties, cluster
database properties, maintenance and backup properties, and security and access properties.
This operation supports pagination. For more information about managing clusters, go to
Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. If you specify
both tag keys and tag values in the same request, Amazon Redshift returns all clusters that
match any combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all clusters that have any
combination of those values are returned. If both tag keys and values are omitted from the
request, clusters are returned regardless of whether they have tag keys or values
associated with them.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClusterIdentifier"`: The unique identifier of a cluster whose properties you are
requesting. This parameter is case sensitive. The default is that all clusters defined for
an account are returned.
- `"Marker"`: An optional parameter that specifies the starting point to return a set of
response records. When the results of a DescribeClusters request exceed the value specified
in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You
can retrieve the next set of response records by providing the returned marker value in the
Marker parameter and retrying the request. Constraints: You can specify either the
ClusterIdentifier parameter or the Marker parameter, but not both.
- `"MaxRecords"`: The maximum number of response records to return in each call. If the
number of remaining response records exceeds the specified MaxRecords value, a value is
returned in a marker field of the response. You can retrieve the next set of records by
retrying the command with the returned marker value. Default: 100 Constraints: minimum
20, maximum 100.
- `"TagKeys"`: A tag key or keys for which you want to return all matching clusters that
are associated with the specified key or keys. For example, suppose that you have clusters
that are tagged with keys called owner and environment. If you specify both of these tag
keys in the request, Amazon Redshift returns a response with the clusters that have either
or both of these tag keys associated with them.
- `"TagValues"`: A tag value or values for which you want to return all matching clusters
that are associated with the specified tag value or values. For example, suppose that you
have clusters that are tagged with values called admin and test. If you specify both of
these tag values in the request, Amazon Redshift returns a response with the clusters that
have either or both of these tag values associated with them.
"""
function describe_clusters(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift(
"DescribeClusters"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_clusters(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeClusters", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_custom_domain_associations()
describe_custom_domain_associations(params::Dict{String,<:Any})
Contains information about custom domain associations for a cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CustomDomainCertificateArn"`: The certificate Amazon Resource Name (ARN) for the custom
domain association.
- `"CustomDomainName"`: The custom domain name for the custom domain association.
- `"Marker"`: The marker for the custom domain association.
- `"MaxRecords"`: The maximum records setting for the associated custom domain.
"""
function describe_custom_domain_associations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeCustomDomainAssociations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_custom_domain_associations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeCustomDomainAssociations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_data_shares()
describe_data_shares(params::Dict{String,<:Any})
Shows the status of any inbound or outbound datashares available in the specified account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataShareArn"`: The Amazon resource name (ARN) of the datashare to describe details of.
- `"Marker"`: An optional parameter that specifies the starting point to return a set of
response records. When the results of a DescribeDataShares request exceed the value
specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the
response. You can retrieve the next set of response records by providing the returned
marker value in the Marker parameter and retrying the request.
- `"MaxRecords"`: The maximum number of response records to return in each call. If the
number of remaining response records exceeds the specified MaxRecords value, a value is
returned in a marker field of the response. You can retrieve the next set of records by
retrying the command with the returned marker value.
"""
function describe_data_shares(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift(
"DescribeDataShares"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_data_shares(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeDataShares", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_data_shares_for_consumer()
describe_data_shares_for_consumer(params::Dict{String,<:Any})
Returns a list of datashares where the account identifier being called is a consumer
account identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConsumerArn"`: The Amazon Resource Name (ARN) of the consumer namespace that returns in
the list of datashares.
- `"Marker"`: An optional parameter that specifies the starting point to return a set of
response records. When the results of a DescribeDataSharesForConsumer request exceed the
value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of
the response. You can retrieve the next set of response records by providing the returned
marker value in the Marker parameter and retrying the request.
- `"MaxRecords"`: The maximum number of response records to return in each call. If the
number of remaining response records exceeds the specified MaxRecords value, a value is
returned in a marker field of the response. You can retrieve the next set of records by
retrying the command with the returned marker value.
- `"Status"`: An identifier giving the status of a datashare in the consumer cluster. If
this field is specified, Amazon Redshift returns the list of datashares that have the
specified status.
"""
function describe_data_shares_for_consumer(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeDataSharesForConsumer";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_data_shares_for_consumer(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeDataSharesForConsumer",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_data_shares_for_producer()
describe_data_shares_for_producer(params::Dict{String,<:Any})
Returns a list of datashares when the account identifier being called is a producer account
identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: An optional parameter that specifies the starting point to return a set of
response records. When the results of a DescribeDataSharesForProducer request exceed the
value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of
the response. You can retrieve the next set of response records by providing the returned
marker value in the Marker parameter and retrying the request.
- `"MaxRecords"`: The maximum number of response records to return in each call. If the
number of remaining response records exceeds the specified MaxRecords value, a value is
returned in a marker field of the response. You can retrieve the next set of records by
retrying the command with the returned marker value.
- `"ProducerArn"`: The Amazon Resource Name (ARN) of the producer namespace that returns in
the list of datashares.
- `"Status"`: An identifier giving the status of a datashare in the producer. If this field
is specified, Amazon Redshift returns the list of datashares that have the specified status.
"""
function describe_data_shares_for_producer(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeDataSharesForProducer";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_data_shares_for_producer(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeDataSharesForProducer",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_default_cluster_parameters(parameter_group_family)
describe_default_cluster_parameters(parameter_group_family, params::Dict{String,<:Any})
Returns a list of parameter settings for the specified parameter group family. For more
information about parameters and parameter groups, go to Amazon Redshift Parameter Groups
in the Amazon Redshift Cluster Management Guide.
# Arguments
- `parameter_group_family`: The name of the cluster parameter group family.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: An optional parameter that specifies the starting point to return a set of
response records. When the results of a DescribeDefaultClusterParameters request exceed the
value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of
the response. You can retrieve the next set of response records by providing the returned
marker value in the Marker parameter and retrying the request.
- `"MaxRecords"`: The maximum number of response records to return in each call. If the
number of remaining response records exceeds the specified MaxRecords value, a value is
returned in a marker field of the response. You can retrieve the next set of records by
retrying the command with the returned marker value. Default: 100 Constraints: minimum
20, maximum 100.
"""
function describe_default_cluster_parameters(
ParameterGroupFamily; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeDefaultClusterParameters",
Dict{String,Any}("ParameterGroupFamily" => ParameterGroupFamily);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_default_cluster_parameters(
ParameterGroupFamily,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"DescribeDefaultClusterParameters",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ParameterGroupFamily" => ParameterGroupFamily),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_endpoint_access()
describe_endpoint_access(params::Dict{String,<:Any})
Describes a Redshift-managed VPC endpoint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClusterIdentifier"`: The cluster identifier associated with the described endpoint.
- `"EndpointName"`: The name of the endpoint to be described.
- `"Marker"`: An optional pagination token provided by a previous DescribeEndpointAccess
request. If this parameter is specified, the response includes only records beyond the
marker, up to the value specified by the MaxRecords parameter.
- `"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.
- `"ResourceOwner"`: The Amazon Web Services account ID of the owner of the cluster.
- `"VpcId"`: The virtual private cloud (VPC) identifier with access to the cluster.
"""
function describe_endpoint_access(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift(
"DescribeEndpointAccess"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_endpoint_access(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeEndpointAccess",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_endpoint_authorization()
describe_endpoint_authorization(params::Dict{String,<:Any})
Describes an endpoint authorization.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Account"`: The Amazon Web Services account ID of either the cluster owner (grantor) or
grantee. If Grantee parameter is true, then the Account value is of the grantor.
- `"ClusterIdentifier"`: The cluster identifier of the cluster to access.
- `"Grantee"`: Indicates whether to check authorization from a grantor or grantee point of
view. If true, Amazon Redshift returns endpoint authorizations that you've been granted. If
false (default), checks authorization from a grantor point of view.
- `"Marker"`: An optional pagination token provided by a previous
DescribeEndpointAuthorization request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by the MaxRecords
parameter.
- `"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_authorization(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeEndpointAuthorization";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_endpoint_authorization(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeEndpointAuthorization",
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 event categories for all event source types, or for a specified source
type. For a list of the event categories and source types, go to Amazon Redshift Event
Notifications.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SourceType"`: The source type, such as cluster or parameter group, to which the
described event categories apply. Valid values: cluster, cluster-snapshot,
cluster-parameter-group, cluster-security-group, and scheduled-action.
"""
function describe_event_categories(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift(
"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 redshift(
"DescribeEventCategories",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_event_subscriptions()
describe_event_subscriptions(params::Dict{String,<:Any})
Lists descriptions of all the Amazon Redshift event notification subscriptions for a
customer account. If you specify a subscription name, lists the description for that
subscription. If you specify both tag keys and tag values in the same request, Amazon
Redshift returns all event notification subscriptions that match any combination of the
specified keys and values. For example, if you have owner and environment for tag keys, and
admin and test for tag values, all subscriptions that have any combination of those values
are returned. If both tag keys and values are omitted from the request, subscriptions are
returned regardless of whether they have tag keys or values associated with them.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: An optional parameter that specifies the starting point to return a set of
response records. When the results of a DescribeEventSubscriptions request exceed the value
specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the
response. You can retrieve the next set of response records by providing the returned
marker value in the Marker parameter and retrying the request.
- `"MaxRecords"`: The maximum number of response records to return in each call. If the
number of remaining response records exceeds the specified MaxRecords value, a value is
returned in a marker field of the response. You can retrieve the next set of records by
retrying the command with the returned marker value. Default: 100 Constraints: minimum
20, maximum 100.
- `"SubscriptionName"`: The name of the Amazon Redshift event notification subscription to
be described.
- `"TagKeys"`: A tag key or keys for which you want to return all matching event
notification subscriptions that are associated with the specified key or keys. For example,
suppose that you have subscriptions that are tagged with keys called owner and environment.
If you specify both of these tag keys in the request, Amazon Redshift returns a response
with the subscriptions that have either or both of these tag keys associated with them.
- `"TagValues"`: A tag value or values for which you want to return all matching event
notification subscriptions that are associated with the specified tag value or values. For
example, suppose that you have subscriptions that are tagged with values called admin and
test. If you specify both of these tag values in the request, Amazon Redshift returns a
response with the subscriptions that have either or both of these tag values associated
with them.
"""
function describe_event_subscriptions(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift(
"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 redshift(
"DescribeEventSubscriptions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_events()
describe_events(params::Dict{String,<:Any})
Returns events related to clusters, security groups, snapshots, and parameter groups for
the past 14 days. Events specific to a particular cluster, security group, snapshot or
parameter group can be obtained by providing the name as a parameter. By default, the past
hour of events are returned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Duration"`: The number of minutes prior to the time of the request for which to
retrieve events. For example, if the request is sent at 18:00 and you specify a duration of
60, then only events which have occurred after 17:00 will be returned. Default: 60
- `"EndTime"`: The end of the time interval for which to retrieve events, specified in ISO
8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
- `"Marker"`: An optional parameter that specifies the starting point to return a set of
response records. When the results of a DescribeEvents request exceed the value specified
in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You
can retrieve the next set of response records by providing the returned marker value in the
Marker parameter and retrying the request.
- `"MaxRecords"`: The maximum number of response records to return in each call. If the
number of remaining response records exceeds the specified MaxRecords value, a value is
returned in a marker field of the response. You can retrieve the next set of records by
retrying the command with the returned marker value. Default: 100 Constraints: minimum
20, maximum 100.
- `"SourceIdentifier"`: The identifier of the event source for which events will be
returned. If this parameter is not specified, then all sources are included in the
response. Constraints: If SourceIdentifier is supplied, SourceType must also be provided.
Specify a cluster identifier when SourceType is cluster. Specify a cluster security group
name when SourceType is cluster-security-group. Specify a cluster parameter group name
when SourceType is cluster-parameter-group. Specify a cluster snapshot identifier when
SourceType is cluster-snapshot.
- `"SourceType"`: The event source to retrieve events for. If no value is specified, all
events are returned. Constraints: If SourceType is supplied, SourceIdentifier must also be
provided. Specify cluster when SourceIdentifier is a cluster identifier. Specify
cluster-security-group when SourceIdentifier is a cluster security group name. Specify
cluster-parameter-group when SourceIdentifier is a cluster parameter group name. Specify
cluster-snapshot when SourceIdentifier is a cluster snapshot identifier.
- `"StartTime"`: The beginning of the time interval to retrieve events for, specified in
ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
"""
function describe_events(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift(
"DescribeEvents"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_events(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeEvents", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_hsm_client_certificates()
describe_hsm_client_certificates(params::Dict{String,<:Any})
Returns information about the specified HSM client certificate. If no certificate ID is
specified, returns information about all the HSM certificates owned by your Amazon Web
Services account. If you specify both tag keys and tag values in the same request, Amazon
Redshift returns all HSM client certificates that match any combination of the specified
keys and values. For example, if you have owner and environment for tag keys, and admin and
test for tag values, all HSM client certificates that have any combination of those values
are returned. If both tag keys and values are omitted from the request, HSM client
certificates are returned regardless of whether they have tag keys or values associated
with them.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"HsmClientCertificateIdentifier"`: The identifier of a specific HSM client certificate
for which you want information. If no identifier is specified, information is returned for
all HSM client certificates owned by your Amazon Web Services account.
- `"Marker"`: An optional parameter that specifies the starting point to return a set of
response records. When the results of a DescribeHsmClientCertificates request exceed the
value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of
the response. You can retrieve the next set of response records by providing the returned
marker value in the Marker parameter and retrying the request.
- `"MaxRecords"`: The maximum number of response records to return in each call. If the
number of remaining response records exceeds the specified MaxRecords value, a value is
returned in a marker field of the response. You can retrieve the next set of records by
retrying the command with the returned marker value. Default: 100 Constraints: minimum
20, maximum 100.
- `"TagKeys"`: A tag key or keys for which you want to return all matching HSM client
certificates that are associated with the specified key or keys. For example, suppose that
you have HSM client certificates that are tagged with keys called owner and environment. If
you specify both of these tag keys in the request, Amazon Redshift returns a response with
the HSM client certificates that have either or both of these tag keys associated with them.
- `"TagValues"`: A tag value or values for which you want to return all matching HSM client
certificates that are associated with the specified tag value or values. For example,
suppose that you have HSM client certificates that are tagged with values called admin and
test. If you specify both of these tag values in the request, Amazon Redshift returns a
response with the HSM client certificates that have either or both of these tag values
associated with them.
"""
function describe_hsm_client_certificates(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeHsmClientCertificates";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_hsm_client_certificates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeHsmClientCertificates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_hsm_configurations()
describe_hsm_configurations(params::Dict{String,<:Any})
Returns information about the specified Amazon Redshift HSM configuration. If no
configuration ID is specified, returns information about all the HSM configurations owned
by your Amazon Web Services account. If you specify both tag keys and tag values in the
same request, Amazon Redshift returns all HSM connections that match any combination of the
specified keys and values. For example, if you have owner and environment for tag keys, and
admin and test for tag values, all HSM connections that have any combination of those
values are returned. If both tag keys and values are omitted from the request, HSM
connections are returned regardless of whether they have tag keys or values associated with
them.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"HsmConfigurationIdentifier"`: The identifier of a specific Amazon Redshift HSM
configuration to be described. If no identifier is specified, information is returned for
all HSM configurations owned by your Amazon Web Services account.
- `"Marker"`: An optional parameter that specifies the starting point to return a set of
response records. When the results of a DescribeHsmConfigurations request exceed the value
specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the
response. You can retrieve the next set of response records by providing the returned
marker value in the Marker parameter and retrying the request.
- `"MaxRecords"`: The maximum number of response records to return in each call. If the
number of remaining response records exceeds the specified MaxRecords value, a value is
returned in a marker field of the response. You can retrieve the next set of records by
retrying the command with the returned marker value. Default: 100 Constraints: minimum
20, maximum 100.
- `"TagKeys"`: A tag key or keys for which you want to return all matching HSM
configurations that are associated with the specified key or keys. For example, suppose
that you have HSM configurations that are tagged with keys called owner and environment. If
you specify both of these tag keys in the request, Amazon Redshift returns a response with
the HSM configurations that have either or both of these tag keys associated with them.
- `"TagValues"`: A tag value or values for which you want to return all matching HSM
configurations that are associated with the specified tag value or values. For example,
suppose that you have HSM configurations that are tagged with values called admin and test.
If you specify both of these tag values in the request, Amazon Redshift returns a response
with the HSM configurations that have either or both of these tag values associated with
them.
"""
function describe_hsm_configurations(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift(
"DescribeHsmConfigurations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_hsm_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeHsmConfigurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_inbound_integrations()
describe_inbound_integrations(params::Dict{String,<:Any})
Returns a list of inbound integrations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IntegrationArn"`: The Amazon Resource Name (ARN) of the inbound integration.
- `"Marker"`: An optional parameter that specifies the starting point to return a set of
response records. When the results of a DescribeInboundIntegrations request exceed the
value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of
the response. You can retrieve the next set of response records by providing the returned
marker value in the Marker parameter and retrying the request.
- `"MaxRecords"`: The maximum number of response records to return in each call. If the
number of remaining response records exceeds the specified MaxRecords value, a value is
returned in a marker field of the response. You can retrieve the next set of records by
retrying the command with the returned marker value. Default: 100 Constraints: minimum
20, maximum 100.
- `"TargetArn"`: The Amazon Resource Name (ARN) of the target of an inbound integration.
"""
function describe_inbound_integrations(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift(
"DescribeInboundIntegrations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_inbound_integrations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeInboundIntegrations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_logging_status(cluster_identifier)
describe_logging_status(cluster_identifier, params::Dict{String,<:Any})
Describes whether information, such as queries and connection attempts, is being logged for
the specified Amazon Redshift cluster.
# Arguments
- `cluster_identifier`: The identifier of the cluster from which to get the logging status.
Example: examplecluster
"""
function describe_logging_status(
ClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeLoggingStatus",
Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_logging_status(
ClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"DescribeLoggingStatus",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_node_configuration_options(action_type)
describe_node_configuration_options(action_type, params::Dict{String,<:Any})
Returns properties of possible node configurations such as node type, number of nodes, and
disk usage for the specified action type.
# Arguments
- `action_type`: The action type to evaluate for possible node configurations. Specify
\"restore-cluster\" to get configuration combinations based on an existing snapshot.
Specify \"recommend-node-config\" to get configuration recommendations based on an existing
cluster or snapshot. Specify \"resize-cluster\" to get configuration combinations for
elastic resize based on an existing cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClusterIdentifier"`: The identifier of the cluster to evaluate for possible node
configurations.
- `"Filter"`: A set of name, operator, and value items to filter the results.
- `"Marker"`: An optional parameter that specifies the starting point to return a set of
response records. When the results of a DescribeNodeConfigurationOptions request exceed the
value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of
the response. You can retrieve the next set of response records by providing the returned
marker value in the Marker parameter and retrying the request.
- `"MaxRecords"`: The maximum number of response records to return in each call. If the
number of remaining response records exceeds the specified MaxRecords value, a value is
returned in a marker field of the response. You can retrieve the next set of records by
retrying the command with the returned marker value. Default: 500 Constraints: minimum
100, maximum 500.
- `"OwnerAccount"`: The Amazon Web Services account used to create or copy the snapshot.
Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
- `"SnapshotArn"`: The Amazon Resource Name (ARN) of the snapshot associated with the
message to describe node configuration.
- `"SnapshotIdentifier"`: The identifier of the snapshot to evaluate for possible node
configurations.
"""
function describe_node_configuration_options(
ActionType; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeNodeConfigurationOptions",
Dict{String,Any}("ActionType" => ActionType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_node_configuration_options(
ActionType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"DescribeNodeConfigurationOptions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ActionType" => ActionType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_orderable_cluster_options()
describe_orderable_cluster_options(params::Dict{String,<:Any})
Returns a list of orderable cluster options. Before you create a new cluster you can use
this operation to find what options are available, such as the EC2 Availability Zones (AZ)
in the specific Amazon Web Services Region that you can specify, and the node types you can
request. The node types differ by available storage, memory, CPU and price. With the cost
involved you might want to obtain a list of cluster options in the specific region and
specify values when creating a cluster. For more information about managing clusters, go to
Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClusterVersion"`: The version filter value. Specify this parameter to show only the
available offerings matching the specified version. Default: All versions. Constraints:
Must be one of the version returned from DescribeClusterVersions.
- `"Marker"`: An optional parameter that specifies the starting point to return a set of
response records. When the results of a DescribeOrderableClusterOptions request exceed the
value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of
the response. You can retrieve the next set of response records by providing the returned
marker value in the Marker parameter and retrying the request.
- `"MaxRecords"`: The maximum number of response records to return in each call. If the
number of remaining response records exceeds the specified MaxRecords value, a value is
returned in a marker field of the response. You can retrieve the next set of records by
retrying the command with the returned marker value. Default: 100 Constraints: minimum
20, maximum 100.
- `"NodeType"`: The node type filter value. Specify this parameter to show only the
available offerings matching the specified node type.
"""
function describe_orderable_cluster_options(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeOrderableClusterOptions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_orderable_cluster_options(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeOrderableClusterOptions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_partners(account_id, cluster_identifier)
describe_partners(account_id, cluster_identifier, params::Dict{String,<:Any})
Returns information about the partner integrations defined for a cluster.
# Arguments
- `account_id`: The Amazon Web Services account ID that owns the cluster.
- `cluster_identifier`: The cluster identifier of the cluster whose partner integration is
being described.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DatabaseName"`: The name of the database whose partner integration is being described.
If database name is not specified, then all databases in the cluster are described.
- `"PartnerName"`: The name of the partner that is being described. If partner name is not
specified, then all partner integrations are described.
"""
function describe_partners(
AccountId, ClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribePartners",
Dict{String,Any}(
"AccountId" => AccountId, "ClusterIdentifier" => ClusterIdentifier
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_partners(
AccountId,
ClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"DescribePartners",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AccountId" => AccountId, "ClusterIdentifier" => ClusterIdentifier
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_redshift_idc_applications()
describe_redshift_idc_applications(params::Dict{String,<:Any})
Lists the Amazon Redshift IAM Identity Center applications.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: A value that indicates the starting point for the next set of response
records in a subsequent request. If a value is returned in a response, you can retrieve the
next set of records by providing this returned marker value in the Marker parameter and
retrying the command. If the Marker field is empty, all response records have been
retrieved for the request.
- `"MaxRecords"`: The maximum number of response records to return in each call. If the
number of remaining response records exceeds the specified MaxRecords value, a value is
returned in a marker field of the response. You can retrieve the next set of records by
retrying the command with the returned marker value.
- `"RedshiftIdcApplicationArn"`: The ARN for the Redshift application that integrates with
IAM Identity Center.
"""
function describe_redshift_idc_applications(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeRedshiftIdcApplications";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_redshift_idc_applications(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeRedshiftIdcApplications",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_reserved_node_exchange_status()
describe_reserved_node_exchange_status(params::Dict{String,<:Any})
Returns exchange status details and associated metadata for a reserved-node exchange.
Statuses include such values as in progress and requested.
# 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
DescribeReservedNodeExchangeStatus request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by the MaxRecords
parameter. You can retrieve the next set of response records by providing the returned
marker value in the Marker parameter and retrying the request.
- `"MaxRecords"`: The maximum number of response records to return in each call. If the
number of remaining response records exceeds the specified MaxRecords value, a value is
returned in a Marker field of the response. You can retrieve the next set of records by
retrying the command with the returned marker value.
- `"ReservedNodeExchangeRequestId"`: The identifier of the reserved-node exchange request.
- `"ReservedNodeId"`: The identifier of the source reserved node in a reserved-node
exchange request.
"""
function describe_reserved_node_exchange_status(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeReservedNodeExchangeStatus";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_reserved_node_exchange_status(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeReservedNodeExchangeStatus",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_reserved_node_offerings()
describe_reserved_node_offerings(params::Dict{String,<:Any})
Returns a list of the available reserved node offerings by Amazon Redshift with their
descriptions including the node type, the fixed and recurring costs of reserving the node
and duration the node will be reserved for you. These descriptions help you determine which
reserve node offering you want to purchase. You then use the unique offering ID in you call
to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift
cluster. For more information about reserved node offerings, go to Purchasing Reserved
Nodes in the Amazon Redshift Cluster Management Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: An optional parameter that specifies the starting point to return a set of
response records. When the results of a DescribeReservedNodeOfferings request exceed the
value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of
the response. You can retrieve the next set of response records by providing the returned
marker value in the Marker parameter and retrying the request.
- `"MaxRecords"`: The maximum number of response records to return in each call. If the
number of remaining response records exceeds the specified MaxRecords value, a value is
returned in a marker field of the response. You can retrieve the next set of records by
retrying the command with the returned marker value. Default: 100 Constraints: minimum
20, maximum 100.
- `"ReservedNodeOfferingId"`: The unique identifier for the offering.
"""
function describe_reserved_node_offerings(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeReservedNodeOfferings";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_reserved_node_offerings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeReservedNodeOfferings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_reserved_nodes()
describe_reserved_nodes(params::Dict{String,<:Any})
Returns the descriptions of the reserved nodes.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: An optional parameter that specifies the starting point to return a set of
response records. When the results of a DescribeReservedNodes request exceed the value
specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the
response. You can retrieve the next set of response records by providing the returned
marker value in the Marker parameter and retrying the request.
- `"MaxRecords"`: The maximum number of response records to return in each call. If the
number of remaining response records exceeds the specified MaxRecords value, a value is
returned in a marker field of the response. You can retrieve the next set of records by
retrying the command with the returned marker value. Default: 100 Constraints: minimum
20, maximum 100.
- `"ReservedNodeId"`: Identifier for the node reservation.
"""
function describe_reserved_nodes(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift(
"DescribeReservedNodes"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_reserved_nodes(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeReservedNodes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_resize(cluster_identifier)
describe_resize(cluster_identifier, params::Dict{String,<:Any})
Returns information about the last resize operation for the specified cluster. If no resize
operation has ever been initiated for the specified cluster, a HTTP 404 error is returned.
If a resize operation was initiated and completed, the status of the resize remains as
SUCCEEDED until the next resize. A resize operation can be requested using ModifyCluster
and specifying a different number or type of nodes for the cluster.
# Arguments
- `cluster_identifier`: The unique identifier of a cluster whose resize progress you are
requesting. This parameter is case-sensitive. By default, resize operations for all
clusters defined for an Amazon Web Services account are returned.
"""
function describe_resize(
ClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeResize",
Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_resize(
ClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"DescribeResize",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_scheduled_actions()
describe_scheduled_actions(params::Dict{String,<:Any})
Describes properties of scheduled actions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Active"`: If true, retrieve only active scheduled actions. If false, retrieve only
disabled scheduled actions.
- `"EndTime"`: The end time in UTC of the scheduled action to retrieve. Only active
scheduled actions that have invocations before this time are retrieved.
- `"Filters"`: List of scheduled action filters.
- `"Marker"`: An optional parameter that specifies the starting point to return a set of
response records. When the results of a DescribeScheduledActions request exceed the value
specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the
response. You can retrieve the next set of response records by providing the returned
marker value in the Marker parameter and retrying the request.
- `"MaxRecords"`: The maximum number of response records to return in each call. If the
number of remaining response records exceeds the specified MaxRecords value, a value is
returned in a marker field of the response. You can retrieve the next set of records by
retrying the command with the returned marker value. Default: 100 Constraints: minimum
20, maximum 100.
- `"ScheduledActionName"`: The name of the scheduled action to retrieve.
- `"StartTime"`: The start time in UTC of the scheduled actions to retrieve. Only active
scheduled actions that have invocations after this time are retrieved.
- `"TargetActionType"`: The type of the scheduled actions to retrieve.
"""
function describe_scheduled_actions(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift(
"DescribeScheduledActions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_scheduled_actions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeScheduledActions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_snapshot_copy_grants()
describe_snapshot_copy_grants(params::Dict{String,<:Any})
Returns a list of snapshot copy grants owned by the Amazon Web Services account in the
destination region. For more information about managing snapshot copy grants, go to Amazon
Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: An optional parameter that specifies the starting point to return a set of
response records. When the results of a DescribeSnapshotCopyGrant request exceed the value
specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the
response. You can retrieve the next set of response records by providing the returned
marker value in the Marker parameter and retrying the request. Constraints: You can
specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.
- `"MaxRecords"`: The maximum number of response records to return in each call. If the
number of remaining response records exceeds the specified MaxRecords value, a value is
returned in a marker field of the response. You can retrieve the next set of records by
retrying the command with the returned marker value. Default: 100 Constraints: minimum
20, maximum 100.
- `"SnapshotCopyGrantName"`: The name of the snapshot copy grant.
- `"TagKeys"`: A tag key or keys for which you want to return all matching resources that
are associated with the specified key or keys. For example, suppose that you have resources
tagged with keys called owner and environment. If you specify both of these tag keys in the
request, Amazon Redshift returns a response with all resources that have either or both of
these tag keys associated with them.
- `"TagValues"`: A tag value or values for which you want to return all matching resources
that are associated with the specified value or values. For example, suppose that you have
resources tagged with values called admin and test. If you specify both of these tag values
in the request, Amazon Redshift returns a response with all resources that have either or
both of these tag values associated with them.
"""
function describe_snapshot_copy_grants(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift(
"DescribeSnapshotCopyGrants"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_snapshot_copy_grants(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeSnapshotCopyGrants",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_snapshot_schedules()
describe_snapshot_schedules(params::Dict{String,<:Any})
Returns a list of snapshot schedules.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClusterIdentifier"`: The unique identifier for the cluster whose snapshot schedules you
want to view.
- `"Marker"`: A value that indicates the starting point for the next set of response
records in a subsequent request. If a value is returned in a response, you can retrieve the
next set of records by providing this returned marker value in the marker parameter and
retrying the command. If the marker field is empty, all response records have been
retrieved for the request.
- `"MaxRecords"`: The maximum number or response records to return in each call. If the
number of remaining response records exceeds the specified MaxRecords value, a value is
returned in a marker field of the response. You can retrieve the next set of records by
retrying the command with the returned marker value.
- `"ScheduleIdentifier"`: A unique identifier for a snapshot schedule.
- `"TagKeys"`: The key value for a snapshot schedule tag.
- `"TagValues"`: The value corresponding to the key of the snapshot schedule tag.
"""
function describe_snapshot_schedules(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift(
"DescribeSnapshotSchedules"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_snapshot_schedules(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeSnapshotSchedules",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_storage()
describe_storage(params::Dict{String,<:Any})
Returns account level backups storage size and provisional storage.
"""
function describe_storage(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift(
"DescribeStorage"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_storage(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeStorage", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_table_restore_status()
describe_table_restore_status(params::Dict{String,<:Any})
Lists the status of one or more table restore requests made using the
RestoreTableFromClusterSnapshot API action. If you don't specify a value for the
TableRestoreRequestId parameter, then DescribeTableRestoreStatus returns the status of all
table restore requests ordered by the date and time of the request in ascending order.
Otherwise DescribeTableRestoreStatus returns the status of the table specified by
TableRestoreRequestId.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClusterIdentifier"`: The Amazon Redshift cluster that the table is being restored to.
- `"Marker"`: An optional pagination token provided by a previous
DescribeTableRestoreStatus request. If this parameter is specified, the response includes
only records beyond the marker, up to the value specified by the MaxRecords parameter.
- `"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.
- `"TableRestoreRequestId"`: The identifier of the table restore request to return status
for. If you don't specify a TableRestoreRequestId value, then DescribeTableRestoreStatus
returns the status of all in-progress table restore requests.
"""
function describe_table_restore_status(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift(
"DescribeTableRestoreStatus"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_table_restore_status(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeTableRestoreStatus",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_tags()
describe_tags(params::Dict{String,<:Any})
Returns a list of tags. You can return tags from a specific resource by specifying an ARN,
or you can return all tags for a given type of resource, such as clusters, snapshots, and
so on. The following are limitations for DescribeTags: You cannot specify an ARN and a
resource-type value together in the same request. You cannot use the MaxRecords and
Marker parameters together with the ARN parameter. The MaxRecords parameter can be a
range from 10 to 50 results to return in a request. If you specify both tag keys and tag
values in the same request, Amazon Redshift returns all resources that match any
combination of the specified keys and values. For example, if you have owner and
environment for tag keys, and admin and test for tag values, all resources that have any
combination of those values are returned. If both tag keys and values are omitted from the
request, resources are returned regardless of whether they have tag keys or values
associated with them.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: A value that indicates the starting point for the next set of response
records in a subsequent request. If a value is returned in a response, you can retrieve the
next set of records by providing this returned marker value in the marker parameter and
retrying the command. If the marker field is empty, all response records have been
retrieved for the request.
- `"MaxRecords"`: The maximum number or response records to return in each call. If the
number of remaining response records exceeds the specified MaxRecords value, a value is
returned in a marker field of the response. You can retrieve the next set of records by
retrying the command with the returned marker value.
- `"ResourceName"`: The Amazon Resource Name (ARN) for which you want to describe the tag
or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.
- `"ResourceType"`: The type of resource with which you want to view tags. Valid resource
types are: Cluster CIDR/IP EC2 security group Snapshot Cluster security group
Subnet group HSM connection HSM certificate Parameter group Snapshot copy grant
For more information about Amazon Redshift resource types and constructing ARNs, go to
Specifying Policy Elements: Actions, Effects, Resources, and Principals in the Amazon
Redshift Cluster Management Guide.
- `"TagKeys"`: A tag key or keys for which you want to return all matching resources that
are associated with the specified key or keys. For example, suppose that you have resources
tagged with keys called owner and environment. If you specify both of these tag keys in the
request, Amazon Redshift returns a response with all resources that have either or both of
these tag keys associated with them.
- `"TagValues"`: A tag value or values for which you want to return all matching resources
that are associated with the specified value or values. For example, suppose that you have
resources tagged with values called admin and test. If you specify both of these tag values
in the request, Amazon Redshift returns a response with all resources that have either or
both of these tag values associated with them.
"""
function describe_tags(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift("DescribeTags"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_tags(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeTags", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_usage_limits()
describe_usage_limits(params::Dict{String,<:Any})
Shows usage limits on a cluster. Results are filtered based on the combination of input
usage limit identifier, cluster identifier, and feature type parameters: If usage limit
identifier, cluster identifier, and feature type are not provided, then all usage limit
objects for the current account in the current region are returned. If usage limit
identifier is provided, then the corresponding usage limit object is returned. If cluster
identifier is provided, then all usage limit objects for the specified cluster are
returned. If cluster identifier and feature type are provided, then all usage limit
objects for the combination of cluster and feature are returned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClusterIdentifier"`: The identifier of the cluster for which you want to describe usage
limits.
- `"FeatureType"`: The feature type for which you want to describe usage limits.
- `"Marker"`: An optional parameter that specifies the starting point to return a set of
response records. When the results of a DescribeUsageLimits request exceed the value
specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the
response. You can retrieve the next set of response records by providing the returned
marker value in the Marker parameter and retrying the request.
- `"MaxRecords"`: The maximum number of response records to return in each call. If the
number of remaining response records exceeds the specified MaxRecords value, a value is
returned in a marker field of the response. You can retrieve the next set of records by
retrying the command with the returned marker value. Default: 100 Constraints: minimum
20, maximum 100.
- `"TagKeys"`: A tag key or keys for which you want to return all matching usage limit
objects that are associated with the specified key or keys. For example, suppose that you
have parameter groups that are tagged with keys called owner and environment. If you
specify both of these tag keys in the request, Amazon Redshift returns a response with the
usage limit objects have either or both of these tag keys associated with them.
- `"TagValues"`: A tag value or values for which you want to return all matching usage
limit objects that are associated with the specified tag value or values. For example,
suppose that you have parameter groups that are tagged with values called admin and test.
If you specify both of these tag values in the request, Amazon Redshift returns a response
with the usage limit objects that have either or both of these tag values associated with
them.
- `"UsageLimitId"`: The identifier of the usage limit to describe.
"""
function describe_usage_limits(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift(
"DescribeUsageLimits"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_usage_limits(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DescribeUsageLimits",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_logging(cluster_identifier)
disable_logging(cluster_identifier, params::Dict{String,<:Any})
Stops logging information, such as queries and connection attempts, for the specified
Amazon Redshift cluster.
# Arguments
- `cluster_identifier`: The identifier of the cluster on which logging is to be stopped.
Example: examplecluster
"""
function disable_logging(
ClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DisableLogging",
Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_logging(
ClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"DisableLogging",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_snapshot_copy(cluster_identifier)
disable_snapshot_copy(cluster_identifier, params::Dict{String,<:Any})
Disables the automatic copying of snapshots from one region to another region for a
specified cluster. If your cluster and its snapshots are encrypted using an encrypted
symmetric key from Key Management Service, use DeleteSnapshotCopyGrant to delete the grant
that grants Amazon Redshift permission to the key in the destination region.
# Arguments
- `cluster_identifier`: The unique identifier of the source cluster that you want to
disable copying of snapshots to a destination region. Constraints: Must be the valid name
of an existing cluster that has cross-region snapshot copy enabled.
"""
function disable_snapshot_copy(
ClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DisableSnapshotCopy",
Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_snapshot_copy(
ClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"DisableSnapshotCopy",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_data_share_consumer(data_share_arn)
disassociate_data_share_consumer(data_share_arn, params::Dict{String,<:Any})
From a datashare consumer account, remove association for the specified datashare.
# Arguments
- `data_share_arn`: The Amazon Resource Name (ARN) of the datashare to remove association
for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConsumerArn"`: The Amazon Resource Name (ARN) of the consumer namespace that
association for the datashare is removed from.
- `"ConsumerRegion"`: From a datashare consumer account, removes association of a datashare
from all the existing and future namespaces in the specified Amazon Web Services Region.
- `"DisassociateEntireAccount"`: A value that specifies whether association for the
datashare is removed from the entire account.
"""
function disassociate_data_share_consumer(
DataShareArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"DisassociateDataShareConsumer",
Dict{String,Any}("DataShareArn" => DataShareArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_data_share_consumer(
DataShareArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"DisassociateDataShareConsumer",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DataShareArn" => DataShareArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_logging(cluster_identifier)
enable_logging(cluster_identifier, params::Dict{String,<:Any})
Starts logging information, such as queries and connection attempts, for the specified
Amazon Redshift cluster.
# Arguments
- `cluster_identifier`: The identifier of the cluster on which logging is to be started.
Example: examplecluster
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BucketName"`: The name of an existing S3 bucket where the log files are to be stored.
Constraints: Must be in the same region as the cluster The cluster must have read
bucket and put object permissions
- `"LogDestinationType"`: The log destination type. An enum with possible values of s3 and
cloudwatch.
- `"LogExports"`: The collection of exported log types. Possible values are connectionlog,
useractivitylog, and userlog.
- `"S3KeyPrefix"`: The prefix applied to the log file names. Constraints: Cannot exceed
512 characters Cannot contain spaces( ), double quotes (\"), single quotes ('), a
backslash (), or control characters. The hexadecimal codes for invalid characters are:
x00 to x20 x22 x27 x5c x7f or larger
"""
function enable_logging(
ClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"EnableLogging",
Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_logging(
ClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"EnableLogging",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_snapshot_copy(cluster_identifier, destination_region)
enable_snapshot_copy(cluster_identifier, destination_region, params::Dict{String,<:Any})
Enables the automatic copy of snapshots from one region to another region for a specified
cluster.
# Arguments
- `cluster_identifier`: The unique identifier of the source cluster to copy snapshots from.
Constraints: Must be the valid name of an existing cluster that does not already have
cross-region snapshot copy enabled.
- `destination_region`: The destination Amazon Web Services Region that you want to copy
snapshots to. Constraints: Must be the name of a valid Amazon Web Services Region. For more
information, see Regions and Endpoints in the Amazon Web Services General Reference.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ManualSnapshotRetentionPeriod"`: The number of days to retain newly copied snapshots in
the destination Amazon Web Services Region after they are copied from the source Amazon Web
Services Region. If the value is -1, the manual snapshot is retained indefinitely. The
value must be either -1 or an integer between 1 and 3,653.
- `"RetentionPeriod"`: The number of days to retain automated snapshots in the destination
region after they are copied from the source region. Default: 7. Constraints: Must be at
least 1 and no more than 35.
- `"SnapshotCopyGrantName"`: The name of the snapshot copy grant to use when snapshots of
an Amazon Web Services KMS-encrypted cluster are copied to the destination region.
"""
function enable_snapshot_copy(
ClusterIdentifier, DestinationRegion; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"EnableSnapshotCopy",
Dict{String,Any}(
"ClusterIdentifier" => ClusterIdentifier,
"DestinationRegion" => DestinationRegion,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_snapshot_copy(
ClusterIdentifier,
DestinationRegion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"EnableSnapshotCopy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClusterIdentifier" => ClusterIdentifier,
"DestinationRegion" => DestinationRegion,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
failover_primary_compute(cluster_identifier)
failover_primary_compute(cluster_identifier, params::Dict{String,<:Any})
Fails over the primary compute unit of the specified Multi-AZ cluster to another
Availability Zone.
# Arguments
- `cluster_identifier`: The unique identifier of the cluster for which the primary compute
unit will be failed over to another Availability Zone.
"""
function failover_primary_compute(
ClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"FailoverPrimaryCompute",
Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function failover_primary_compute(
ClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"FailoverPrimaryCompute",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_cluster_credentials(db_user)
get_cluster_credentials(db_user, params::Dict{String,<:Any})
Returns a database user name and temporary password with temporary authorization to log on
to an Amazon Redshift database. The action returns the database user name prefixed with
IAM: if AutoCreate is False or IAMA: if AutoCreate is True. You can optionally specify one
or more database user groups that the user will join at log on. By default, the temporary
credentials expire in 900 seconds. You can optionally specify a duration between 900
seconds (15 minutes) and 3600 seconds (60 minutes). For more information, see Using IAM
Authentication to Generate Database User Credentials in the Amazon Redshift Cluster
Management Guide. The Identity and Access Management (IAM) user or role that runs
GetClusterCredentials must have an IAM policy attached that allows access to all necessary
actions and resources. For more information about permissions, see Resource Policies for
GetClusterCredentials in the Amazon Redshift Cluster Management Guide. If the DbGroups
parameter is specified, the IAM policy must allow the redshift:JoinGroup action with access
to the listed dbgroups. In addition, if the AutoCreate parameter is set to True, then the
policy must include the redshift:CreateClusterUser permission. If the DbName parameter is
specified, the IAM policy must allow access to the resource dbname for the specified
database name.
# Arguments
- `db_user`: The name of a database user. If a user name matching DbUser exists in the
database, the temporary user credentials have the same permissions as the existing user. If
DbUser doesn't exist in the database and Autocreate is True, a new user is created using
the value for DbUser with PUBLIC permissions. If a database user matching the value for
DbUser doesn't exist and Autocreate is False, then the command succeeds but the connection
attempt will fail because the user doesn't exist in the database. For more information, see
CREATE USER in the Amazon Redshift Database Developer Guide. Constraints: Must be 1 to
64 alphanumeric characters or hyphens. The user name can't be PUBLIC. Must contain
uppercase or lowercase letters, numbers, underscore, plus sign, period (dot), at symbol
(@), or hyphen. First character must be a letter. Must not contain a colon ( : ) or
slash ( / ). Cannot be a reserved word. A list of reserved words can be found in
Reserved Words in the Amazon Redshift Database Developer Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AutoCreate"`: Create a database user with the name specified for the user named in
DbUser if one does not exist.
- `"ClusterIdentifier"`: The unique identifier of the cluster that contains the database
for which you are requesting credentials. This parameter is case sensitive.
- `"CustomDomainName"`: The custom domain name for the cluster credentials.
- `"DbGroups"`: A list of the names of existing database groups that the user named in
DbUser will join for the current session, in addition to any group memberships for an
existing user. If not specified, a new user is added only to PUBLIC. Database group name
constraints Must be 1 to 64 alphanumeric characters or hyphens Must contain only
lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
First character must be a letter. Must not contain a colon ( : ) or slash ( / ).
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the
Amazon Redshift Database Developer Guide.
- `"DbName"`: The name of a database that DbUser is authorized to log on to. If DbName is
not specified, DbUser can log on to any existing database. Constraints: Must be 1 to 64
alphanumeric characters or hyphens Must contain uppercase or lowercase letters, numbers,
underscore, plus sign, period (dot), at symbol (@), or hyphen. First character must be a
letter. Must not contain a colon ( : ) or slash ( / ). Cannot be a reserved word. A
list of reserved words can be found in Reserved Words in the Amazon Redshift Database
Developer Guide.
- `"DurationSeconds"`: The number of seconds until the returned temporary password expires.
Constraint: minimum 900, maximum 3600. Default: 900
"""
function get_cluster_credentials(DbUser; aws_config::AbstractAWSConfig=global_aws_config())
return redshift(
"GetClusterCredentials",
Dict{String,Any}("DbUser" => DbUser);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_cluster_credentials(
DbUser, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"GetClusterCredentials",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("DbUser" => DbUser), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_cluster_credentials_with_iam()
get_cluster_credentials_with_iam(params::Dict{String,<:Any})
Returns a database user name and temporary password with temporary authorization to log in
to an Amazon Redshift database. The database user is mapped 1:1 to the source Identity and
Access Management (IAM) identity. For more information about IAM identities, see IAM
Identities (users, user groups, and roles) in the Amazon Web Services Identity and Access
Management User Guide. The Identity and Access Management (IAM) identity that runs this
operation must have an IAM policy attached that allows access to all necessary actions and
resources. For more information about permissions, see Using identity-based policies (IAM
policies) in the Amazon Redshift Cluster Management Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClusterIdentifier"`: The unique identifier of the cluster that contains the database
for which you are requesting credentials.
- `"CustomDomainName"`: The custom domain name for the IAM message cluster credentials.
- `"DbName"`: The name of the database for which you are requesting credentials. If the
database name is specified, the IAM policy must allow access to the resource dbname for the
specified database name. If the database name is not specified, access to all databases is
allowed.
- `"DurationSeconds"`: The number of seconds until the returned temporary password expires.
Range: 900-3600. Default: 900.
"""
function get_cluster_credentials_with_iam(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"GetClusterCredentialsWithIAM";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_cluster_credentials_with_iam(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"GetClusterCredentialsWithIAM",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_reserved_node_exchange_configuration_options(action_type)
get_reserved_node_exchange_configuration_options(action_type, params::Dict{String,<:Any})
Gets the configuration options for the reserved-node exchange. These options include
information about the source reserved node and target reserved node offering. Details
include the node type, the price, the node count, and the offering type.
# Arguments
- `action_type`: The action type of the reserved-node configuration. The action type can be
an exchange initiated from either a snapshot or a resize.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClusterIdentifier"`: The identifier for the cluster that is the source for a
reserved-node exchange.
- `"Marker"`: An optional pagination token provided by a previous
GetReservedNodeExchangeConfigurationOptions request. If this parameter is specified, the
response includes only records beyond the marker, up to the value specified by the
MaxRecords parameter. You can retrieve the next set of response records by providing the
returned marker value in the Marker parameter and retrying the request.
- `"MaxRecords"`: The maximum number of response records to return in each call. If the
number of remaining response records exceeds the specified MaxRecords value, a value is
returned in a Marker field of the response. You can retrieve the next set of records by
retrying the command with the returned marker value.
- `"SnapshotIdentifier"`: The identifier for the snapshot that is the source for the
reserved-node exchange.
"""
function get_reserved_node_exchange_configuration_options(
ActionType; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"GetReservedNodeExchangeConfigurationOptions",
Dict{String,Any}("ActionType" => ActionType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_reserved_node_exchange_configuration_options(
ActionType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"GetReservedNodeExchangeConfigurationOptions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ActionType" => ActionType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_reserved_node_exchange_offerings(reserved_node_id)
get_reserved_node_exchange_offerings(reserved_node_id, params::Dict{String,<:Any})
Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and
usage price of the given DC1 reserved node.
# Arguments
- `reserved_node_id`: A string representing the node identifier for the DC1 Reserved Node
to be exchanged.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: A value that indicates the starting point for the next set of
ReservedNodeOfferings.
- `"MaxRecords"`: An integer setting the maximum number of ReservedNodeOfferings to
retrieve.
"""
function get_reserved_node_exchange_offerings(
ReservedNodeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"GetReservedNodeExchangeOfferings",
Dict{String,Any}("ReservedNodeId" => ReservedNodeId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_reserved_node_exchange_offerings(
ReservedNodeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"GetReservedNodeExchangeOfferings",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ReservedNodeId" => ReservedNodeId), 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})
Get the resource policy for a specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource of which its resource
policy is fetched.
"""
function get_resource_policy(ResourceArn; aws_config::AbstractAWSConfig=global_aws_config())
return redshift(
"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 redshift(
"GetResourcePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_recommendations()
list_recommendations(params::Dict{String,<:Any})
List the Amazon Redshift Advisor recommendations for one or multiple Amazon Redshift
clusters in an Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClusterIdentifier"`: The unique identifier of the Amazon Redshift cluster for which the
list of Advisor recommendations is returned. If the neither the cluster identifier and the
cluster namespace ARN parameters are specified, then recommendations for all clusters in
the account are returned.
- `"Marker"`: A value that indicates the starting point for the next set of response
records in a subsequent request. If a value is returned in a response, you can retrieve the
next set of records by providing this returned marker value in the Marker parameter and
retrying the command. If the Marker field is empty, all response records have been
retrieved for the request.
- `"MaxRecords"`: The maximum number of response records to return in each call. If the
number of remaining response records exceeds the specified MaxRecords value, a value is
returned in a marker field of the response. You can retrieve the next set of records by
retrying the command with the returned marker value.
- `"NamespaceArn"`: The Amazon Redshift cluster namespace Amazon Resource Name (ARN) for
which the list of Advisor recommendations is returned. If the neither the cluster
identifier and the cluster namespace ARN parameters are specified, then recommendations for
all clusters in the account are returned.
"""
function list_recommendations(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift(
"ListRecommendations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_recommendations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"ListRecommendations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_aqua_configuration(cluster_identifier)
modify_aqua_configuration(cluster_identifier, params::Dict{String,<:Any})
This operation is retired. Calling this operation does not change AQUA configuration.
Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
# Arguments
- `cluster_identifier`: The identifier of the cluster to be modified.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AquaConfigurationStatus"`: This parameter is retired. Amazon Redshift automatically
determines whether to use AQUA (Advanced Query Accelerator).
"""
function modify_aqua_configuration(
ClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"ModifyAquaConfiguration",
Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_aqua_configuration(
ClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"ModifyAquaConfiguration",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_authentication_profile(authentication_profile_content, authentication_profile_name)
modify_authentication_profile(authentication_profile_content, authentication_profile_name, params::Dict{String,<:Any})
Modifies an authentication profile.
# Arguments
- `authentication_profile_content`: The new content of the authentication profile in JSON
format. The maximum length of the JSON string is determined by a quota for your account.
- `authentication_profile_name`: The name of the authentication profile to replace.
"""
function modify_authentication_profile(
AuthenticationProfileContent,
AuthenticationProfileName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"ModifyAuthenticationProfile",
Dict{String,Any}(
"AuthenticationProfileContent" => AuthenticationProfileContent,
"AuthenticationProfileName" => AuthenticationProfileName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_authentication_profile(
AuthenticationProfileContent,
AuthenticationProfileName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"ModifyAuthenticationProfile",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AuthenticationProfileContent" => AuthenticationProfileContent,
"AuthenticationProfileName" => AuthenticationProfileName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_cluster(cluster_identifier)
modify_cluster(cluster_identifier, params::Dict{String,<:Any})
Modifies the settings for a cluster. You can also change node type and the number of nodes
to scale up or down the cluster. When resizing a cluster, you must specify both the number
of nodes and the node type even if one of the parameters does not change. You can add
another security or parameter group, or change the admin user password. Resetting a cluster
password or modifying the security groups associated with a cluster do not need a reboot.
However, modifying a parameter group requires a reboot for parameters to take effect. For
more information about managing clusters, go to Amazon Redshift Clusters in the Amazon
Redshift Cluster Management Guide.
# Arguments
- `cluster_identifier`: The unique identifier of the cluster to be modified. Example:
examplecluster
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllowVersionUpgrade"`: If true, major version upgrades will be applied automatically to
the cluster during the maintenance window. Default: false
- `"AutomatedSnapshotRetentionPeriod"`: The number of days that automated snapshots are
retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots
are disabled, you can still create manual snapshots when you want with
CreateClusterSnapshot. If you decrease the automated snapshot retention period from its
current value, existing automated snapshots that fall outside of the new retention period
will be immediately deleted. You can't disable automated snapshots for RA3 node types. Set
the automated retention period from 1-35 days. Default: Uses existing setting. Constraints:
Must be a value from 0 to 35.
- `"AvailabilityZone"`: The option to initiate relocation for an Amazon Redshift cluster to
the target Availability Zone.
- `"AvailabilityZoneRelocation"`: The option to enable relocation for an Amazon Redshift
cluster between Availability Zones after the cluster modification is complete.
- `"ClusterParameterGroupName"`: The name of the cluster parameter group to apply to this
cluster. This change is applied only after the cluster is rebooted. To reboot a cluster use
RebootCluster. Default: Uses existing setting. Constraints: The cluster parameter group
must be in the same parameter group family that matches the cluster version.
- `"ClusterSecurityGroups"`: A list of cluster security groups to be authorized on this
cluster. This change is asynchronously applied as soon as possible. Security groups
currently associated with the cluster, and not in the list of groups to apply, will be
revoked from the cluster. Constraints: Must be 1 to 255 alphanumeric characters or
hyphens First character must be a letter Cannot end with a hyphen or contain two
consecutive hyphens
- `"ClusterType"`: The new cluster type. When you submit your cluster resize request, your
existing cluster goes into a read-only mode. After Amazon Redshift provisions a new cluster
based on your resize requirements, there will be outage for a period while the old cluster
is deleted and your connection is switched to the new cluster. You can use DescribeResize
to track the progress of the resize request. Valid Values: multi-node | single-node
- `"ClusterVersion"`: The new version number of the Amazon Redshift engine to upgrade to.
For major version upgrades, if a non-default cluster parameter group is currently in use, a
new cluster parameter group in the cluster parameter group family for the new version must
be specified. The new cluster parameter group can be the default for that cluster parameter
group family. For more information about parameters and parameter groups, go to Amazon
Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide. Example: 1.0
- `"ElasticIp"`: The Elastic IP (EIP) address for the cluster. Constraints: The cluster
must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For
more information about provisioning clusters in EC2-VPC, go to Supported Platforms to
Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
- `"Encrypted"`: Indicates whether the cluster is encrypted. If the value is encrypted
(true) and you provide a value for the KmsKeyId parameter, we encrypt the cluster with the
provided KmsKeyId. If you don't provide a KmsKeyId, we encrypt with the default key. If
the value is not encrypted (false), then the cluster is decrypted.
- `"EnhancedVpcRouting"`: An option that specifies whether to create the cluster with
enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the
cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon
Redshift Cluster Management Guide. If this option is true, enhanced VPC routing is enabled.
Default: false
- `"HsmClientCertificateIdentifier"`: Specifies the name of the HSM client certificate the
Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
- `"HsmConfigurationIdentifier"`: Specifies the name of the HSM configuration that contains
the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
- `"IpAddressType"`: The IP address types that the cluster supports. Possible values are
ipv4 and dualstack.
- `"KmsKeyId"`: The Key Management Service (KMS) key ID of the encryption key that you want
to use to encrypt data in the cluster.
- `"MaintenanceTrackName"`: The name for the maintenance track that you want to assign for
the cluster. This name change is asynchronous. The new track name stays in the
PendingModifiedValues for the cluster until the next maintenance window. When the
maintenance track changes, the cluster is switched to the latest cluster release available
for the maintenance track. At this point, the maintenance track name is applied.
- `"ManageMasterPassword"`: If true, Amazon Redshift uses Secrets Manager to manage this
cluster's admin credentials. You can't use MasterUserPassword if ManageMasterPassword is
true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword
for the admin user account's password.
- `"ManualSnapshotRetentionPeriod"`: The default for number of days that a newly created
manual snapshot is retained. If the value is -1, the manual snapshot is retained
indefinitely. This value doesn't retroactively change the retention periods of existing
manual snapshots. The value must be either -1 or an integer between 1 and 3,653. The
default value is -1.
- `"MasterPasswordSecretKmsKeyId"`: The ID of the Key Management Service (KMS) key used to
encrypt and store the cluster's admin credentials secret. You can only use this parameter
if ManageMasterPassword is true.
- `"MasterUserPassword"`: The new password for the cluster admin user. This change is
asynchronously applied as soon as possible. Between the time of the request and the
completion of the request, the MasterUserPassword element exists in the
PendingModifiedValues element of the operation response. You can't use MasterUserPassword
if ManageMasterPassword is true. Operations never return the password, so this operation
provides a way to regain access to the admin user account for a cluster if the password is
lost. Default: Uses existing setting. Constraints: Must be between 8 and 64 characters
in length. Must contain at least one uppercase letter. Must contain at least one
lowercase letter. Must contain one number. Can be any printable ASCII character (ASCII
code 33-126) except ' (single quote), \" (double quote), , /, or @.
- `"MultiAZ"`: If true and the cluster is currently only deployed in a single Availability
Zone, the cluster will be modified to be deployed in two Availability Zones.
- `"NewClusterIdentifier"`: The new identifier for the cluster. Constraints: Must contain
from 1 to 63 alphanumeric characters or hyphens. Alphabetic characters must be lowercase.
First character must be a letter. Cannot end with a hyphen or contain two consecutive
hyphens. Must be unique for all clusters within an Amazon Web Services account.
Example: examplecluster
- `"NodeType"`: The new node type of the cluster. If you specify a new node type, you must
also specify the number of nodes parameter. For more information about resizing clusters,
go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
Valid Values: dc2.large | dc2.8xlarge | ra3.xlplus | ra3.4xlarge | ra3.16xlarge
- `"NumberOfNodes"`: The new number of nodes of the cluster. If you specify a new number of
nodes, you must also specify the node type parameter. For more information about resizing
clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster
Management Guide. Valid Values: Integer greater than 0.
- `"Port"`: The option to change the port of an Amazon Redshift cluster. Valid Values:
For clusters with ra3 nodes - Select a port within the ranges 5431-5455 or 8191-8215. (If
you have an existing cluster with ra3 nodes, it isn't required that you change the port to
these ranges.) For clusters with dc2 nodes - Select a port within the range 1150-65535.
- `"PreferredMaintenanceWindow"`: The weekly time range (in UTC) during which system
maintenance can occur, if necessary. If system maintenance is necessary during the window,
it may result in an outage. This maintenance window change is made immediately. If the new
maintenance window indicates the current time, there must be at least 120 minutes between
the current time and end of the window in order to ensure that pending changes are applied.
Default: Uses existing setting. Format: ddd:hh24:mi-ddd:hh24:mi, for example
wed:07:30-wed:08:00. Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Must
be at least 30 minutes.
- `"PubliclyAccessible"`: If true, the cluster can be accessed from a public network. Only
clusters in VPCs can be set to be publicly available.
- `"VpcSecurityGroupIds"`: A list of virtual private cloud (VPC) security groups to be
associated with the cluster. This change is asynchronously applied as soon as possible.
"""
function modify_cluster(
ClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"ModifyCluster",
Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_cluster(
ClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"ModifyCluster",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_cluster_db_revision(cluster_identifier, revision_target)
modify_cluster_db_revision(cluster_identifier, revision_target, params::Dict{String,<:Any})
Modifies the database revision of a cluster. The database revision is a unique revision of
the database running in a cluster.
# Arguments
- `cluster_identifier`: The unique identifier of a cluster whose database revision you want
to modify. Example: examplecluster
- `revision_target`: The identifier of the database revision. You can retrieve this value
from the response to the DescribeClusterDbRevisions request.
"""
function modify_cluster_db_revision(
ClusterIdentifier, RevisionTarget; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"ModifyClusterDbRevision",
Dict{String,Any}(
"ClusterIdentifier" => ClusterIdentifier, "RevisionTarget" => RevisionTarget
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_cluster_db_revision(
ClusterIdentifier,
RevisionTarget,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"ModifyClusterDbRevision",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClusterIdentifier" => ClusterIdentifier,
"RevisionTarget" => RevisionTarget,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_cluster_iam_roles(cluster_identifier)
modify_cluster_iam_roles(cluster_identifier, params::Dict{String,<:Any})
Modifies the list of Identity and Access Management (IAM) roles that can be used by the
cluster to access other Amazon Web Services services. The maximum number of IAM roles that
you can associate is subject to a quota. For more information, go to Quotas and limits in
the Amazon Redshift Cluster Management Guide.
# Arguments
- `cluster_identifier`: The unique identifier of the cluster for which you want to
associate or disassociate IAM roles.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AddIamRoles"`: Zero or more IAM roles to associate with the cluster. The roles must be
in their Amazon Resource Name (ARN) format.
- `"DefaultIamRoleArn"`: The Amazon Resource Name (ARN) for the IAM role that was set as
default for the cluster when the cluster was last modified.
- `"RemoveIamRoles"`: Zero or more IAM roles in ARN format to disassociate from the
cluster.
"""
function modify_cluster_iam_roles(
ClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"ModifyClusterIamRoles",
Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_cluster_iam_roles(
ClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"ModifyClusterIamRoles",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_cluster_maintenance(cluster_identifier)
modify_cluster_maintenance(cluster_identifier, params::Dict{String,<:Any})
Modifies the maintenance settings of a cluster.
# Arguments
- `cluster_identifier`: A unique identifier for the cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeferMaintenance"`: A boolean indicating whether to enable the deferred maintenance
window.
- `"DeferMaintenanceDuration"`: An integer indicating the duration of the maintenance
window in days. If you specify a duration, you can't specify an end time. The duration must
be 45 days or less.
- `"DeferMaintenanceEndTime"`: A timestamp indicating end time for the deferred maintenance
window. If you specify an end time, you can't specify a duration.
- `"DeferMaintenanceIdentifier"`: A unique identifier for the deferred maintenance window.
- `"DeferMaintenanceStartTime"`: A timestamp indicating the start time for the deferred
maintenance window.
"""
function modify_cluster_maintenance(
ClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"ModifyClusterMaintenance",
Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_cluster_maintenance(
ClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"ModifyClusterMaintenance",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_cluster_parameter_group(parameter, parameter_group_name)
modify_cluster_parameter_group(parameter, parameter_group_name, params::Dict{String,<:Any})
Modifies the parameters of a parameter group. For the parameters parameter, it can't
contain ASCII characters. For more information about parameters and parameter groups, go
to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
# Arguments
- `parameter`: An array of parameters to be modified. A maximum of 20 parameters can be
modified in a single request. For each parameter to be modified, you must supply at least
the parameter name and parameter value; other name-value pairs of the parameter are
optional. For the workload management (WLM) configuration, you must supply all the
name-value pairs in the wlm_json_configuration parameter.
- `parameter_group_name`: The name of the parameter group to be modified.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Parameters"`: An array of parameters to be modified. A maximum of 20 parameters can be
modified in a single request. For each parameter to be modified, you must supply at least
the parameter name and parameter value; other name-value pairs of the parameter are
optional. For the workload management (WLM) configuration, you must supply all the
name-value pairs in the wlm_json_configuration parameter.
"""
function modify_cluster_parameter_group(
Parameter, ParameterGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"ModifyClusterParameterGroup",
Dict{String,Any}(
"Parameter" => Parameter, "ParameterGroupName" => ParameterGroupName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_cluster_parameter_group(
Parameter,
ParameterGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"ModifyClusterParameterGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Parameter" => Parameter, "ParameterGroupName" => ParameterGroupName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_cluster_snapshot(snapshot_identifier)
modify_cluster_snapshot(snapshot_identifier, params::Dict{String,<:Any})
Modifies the settings for a snapshot. This exanmple modifies the manual retention period
setting for a cluster snapshot.
# Arguments
- `snapshot_identifier`: The identifier of the snapshot whose setting you want to modify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Force"`: A Boolean option to override an exception if the retention period has already
passed.
- `"ManualSnapshotRetentionPeriod"`: The number of days that a manual snapshot is retained.
If the value is -1, the manual snapshot is retained indefinitely. If the manual snapshot
falls outside of the new retention period, you can specify the force option to immediately
delete the snapshot. The value must be either -1 or an integer between 1 and 3,653.
"""
function modify_cluster_snapshot(
SnapshotIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"ModifyClusterSnapshot",
Dict{String,Any}("SnapshotIdentifier" => SnapshotIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_cluster_snapshot(
SnapshotIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"ModifyClusterSnapshot",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("SnapshotIdentifier" => SnapshotIdentifier), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_cluster_snapshot_schedule(cluster_identifier)
modify_cluster_snapshot_schedule(cluster_identifier, params::Dict{String,<:Any})
Modifies a snapshot schedule for a cluster.
# Arguments
- `cluster_identifier`: A unique identifier for the cluster whose snapshot schedule you
want to modify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DisassociateSchedule"`: A boolean to indicate whether to remove the assoiciation
between the cluster and the schedule.
- `"ScheduleIdentifier"`: A unique alphanumeric identifier for the schedule that you want
to associate with the cluster.
"""
function modify_cluster_snapshot_schedule(
ClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"ModifyClusterSnapshotSchedule",
Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_cluster_snapshot_schedule(
ClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"ModifyClusterSnapshotSchedule",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_cluster_subnet_group(cluster_subnet_group_name, subnet_identifier)
modify_cluster_subnet_group(cluster_subnet_group_name, subnet_identifier, params::Dict{String,<:Any})
Modifies a cluster subnet group to include the specified list of VPC subnets. The operation
replaces the existing list of subnets with the new list of subnets.
# Arguments
- `cluster_subnet_group_name`: The name of the subnet group to be modified.
- `subnet_identifier`: An array of VPC subnet IDs. A maximum of 20 subnets can be modified
in a single request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A text description of the subnet group to be modified.
- `"SubnetIds"`: An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a
single request.
"""
function modify_cluster_subnet_group(
ClusterSubnetGroupName,
SubnetIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"ModifyClusterSubnetGroup",
Dict{String,Any}(
"ClusterSubnetGroupName" => ClusterSubnetGroupName,
"SubnetIdentifier" => SubnetIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_cluster_subnet_group(
ClusterSubnetGroupName,
SubnetIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"ModifyClusterSubnetGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClusterSubnetGroupName" => ClusterSubnetGroupName,
"SubnetIdentifier" => SubnetIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_custom_domain_association(cluster_identifier, custom_domain_certificate_arn, custom_domain_name)
modify_custom_domain_association(cluster_identifier, custom_domain_certificate_arn, custom_domain_name, params::Dict{String,<:Any})
Contains information for changing a custom domain association.
# Arguments
- `cluster_identifier`: The identifier of the cluster to change a custom domain association
for.
- `custom_domain_certificate_arn`: The certificate Amazon Resource Name (ARN) for the
changed custom domain association.
- `custom_domain_name`: The custom domain name for a changed custom domain association.
"""
function modify_custom_domain_association(
ClusterIdentifier,
CustomDomainCertificateArn,
CustomDomainName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"ModifyCustomDomainAssociation",
Dict{String,Any}(
"ClusterIdentifier" => ClusterIdentifier,
"CustomDomainCertificateArn" => CustomDomainCertificateArn,
"CustomDomainName" => CustomDomainName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_custom_domain_association(
ClusterIdentifier,
CustomDomainCertificateArn,
CustomDomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"ModifyCustomDomainAssociation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClusterIdentifier" => ClusterIdentifier,
"CustomDomainCertificateArn" => CustomDomainCertificateArn,
"CustomDomainName" => CustomDomainName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_endpoint_access(endpoint_name)
modify_endpoint_access(endpoint_name, params::Dict{String,<:Any})
Modifies a Redshift-managed VPC endpoint.
# Arguments
- `endpoint_name`: The endpoint to be modified.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"VpcSecurityGroupIds"`: The complete list of VPC security groups associated with the
endpoint after the endpoint is modified.
"""
function modify_endpoint_access(
EndpointName; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"ModifyEndpointAccess",
Dict{String,Any}("EndpointName" => EndpointName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_endpoint_access(
EndpointName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"ModifyEndpointAccess",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EndpointName" => EndpointName), 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 Redshift event notification subscription.
# Arguments
- `subscription_name`: The name of the modified Amazon Redshift event notification
subscription.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Enabled"`: A Boolean value indicating if the subscription is enabled. true indicates
the subscription is enabled
- `"EventCategories"`: Specifies the Amazon Redshift event categories to be published by
the event notification subscription. Values: configuration, management, monitoring,
security, pending
- `"Severity"`: Specifies the Amazon Redshift event severity to be published by the event
notification subscription. Values: ERROR, INFO
- `"SnsTopicArn"`: The Amazon Resource Name (ARN) of the SNS topic to be used by the event
notification subscription.
- `"SourceIds"`: A list of one or more identifiers of Amazon Redshift source objects. All
of the objects must be of the same type as was specified in the source type parameter. The
event subscription will return only events generated by the specified objects. If not
specified, then events are returned for all objects within the source type specified.
Example: my-cluster-1, my-cluster-2 Example: my-snapshot-20131010
- `"SourceType"`: The type of source that will be generating the events. For example, if
you want to be notified of events generated by a cluster, you would set this parameter to
cluster. If this value is not specified, events are returned for all Amazon Redshift
objects in your Amazon Web Services account. You must specify a source type in order to
specify source IDs. Valid values: cluster, cluster-parameter-group, cluster-security-group,
cluster-snapshot, and scheduled-action.
"""
function modify_event_subscription(
SubscriptionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"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 redshift(
"ModifyEventSubscription",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("SubscriptionName" => SubscriptionName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_redshift_idc_application(redshift_idc_application_arn)
modify_redshift_idc_application(redshift_idc_application_arn, params::Dict{String,<:Any})
Changes an existing Amazon Redshift IAM Identity Center application.
# Arguments
- `redshift_idc_application_arn`: The ARN for the Redshift application that integrates with
IAM Identity Center.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AuthorizedTokenIssuerList"`: The authorized token issuer list for the Amazon Redshift
IAM Identity Center application to change.
- `"IamRoleArn"`: The IAM role ARN associated with the Amazon Redshift IAM Identity Center
application to change. It has the required permissions to be assumed and invoke the IDC
Identity Center API.
- `"IdcDisplayName"`: The display name for the Amazon Redshift IAM Identity Center
application to change. It appears on the console.
- `"IdentityNamespace"`: The namespace for the Amazon Redshift IAM Identity Center
application to change. It determines which managed application verifies the connection
token.
- `"ServiceIntegrations"`: A collection of service integrations associated with the
application.
"""
function modify_redshift_idc_application(
RedshiftIdcApplicationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"ModifyRedshiftIdcApplication",
Dict{String,Any}("RedshiftIdcApplicationArn" => RedshiftIdcApplicationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_redshift_idc_application(
RedshiftIdcApplicationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"ModifyRedshiftIdcApplication",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("RedshiftIdcApplicationArn" => RedshiftIdcApplicationArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_scheduled_action(scheduled_action_name)
modify_scheduled_action(scheduled_action_name, params::Dict{String,<:Any})
Modifies a scheduled action.
# Arguments
- `scheduled_action_name`: The name of the scheduled action to modify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Enable"`: A modified enable flag of the scheduled action. If true, the scheduled action
is active. If false, the scheduled action is disabled.
- `"EndTime"`: A modified end time of the scheduled action. For more information about this
parameter, see ScheduledAction.
- `"IamRole"`: A different IAM role to assume to run the target action. For more
information about this parameter, see ScheduledAction.
- `"Schedule"`: A modified schedule in either at( ) or cron( ) format. For more information
about this parameter, see ScheduledAction.
- `"ScheduledActionDescription"`: A modified description of the scheduled action.
- `"StartTime"`: A modified start time of the scheduled action. For more information about
this parameter, see ScheduledAction.
- `"TargetAction"`: A modified JSON format of the scheduled action. For more information
about this parameter, see ScheduledAction.
"""
function modify_scheduled_action(
ScheduledActionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"ModifyScheduledAction",
Dict{String,Any}("ScheduledActionName" => ScheduledActionName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_scheduled_action(
ScheduledActionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"ModifyScheduledAction",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ScheduledActionName" => ScheduledActionName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_snapshot_copy_retention_period(cluster_identifier, retention_period)
modify_snapshot_copy_retention_period(cluster_identifier, retention_period, params::Dict{String,<:Any})
Modifies the number of days to retain snapshots in the destination Amazon Web Services
Region after they are copied from the source Amazon Web Services Region. By default, this
operation only changes the retention period of copied automated snapshots. The retention
periods for both new and existing copied automated snapshots are updated with the new
retention period. You can set the manual option to change only the retention periods of
copied manual snapshots. If you set this option, only newly copied manual snapshots have
the new retention period.
# Arguments
- `cluster_identifier`: The unique identifier of the cluster for which you want to change
the retention period for either automated or manual snapshots that are copied to a
destination Amazon Web Services Region. Constraints: Must be the valid name of an existing
cluster that has cross-region snapshot copy enabled.
- `retention_period`: The number of days to retain automated snapshots in the destination
Amazon Web Services Region after they are copied from the source Amazon Web Services
Region. By default, this only changes the retention period of copied automated snapshots.
If you decrease the retention period for automated snapshots that are copied to a
destination Amazon Web Services Region, Amazon Redshift deletes any existing automated
snapshots that were copied to the destination Amazon Web Services Region and that fall
outside of the new retention period. Constraints: Must be at least 1 and no more than 35
for automated snapshots. If you specify the manual option, only newly copied manual
snapshots will have the new retention period. If you specify the value of -1 newly copied
manual snapshots are retained indefinitely. Constraints: The number of days must be either
-1 or an integer between 1 and 3,653 for manual snapshots.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Manual"`: Indicates whether to apply the snapshot retention period to newly copied
manual snapshots instead of automated snapshots.
"""
function modify_snapshot_copy_retention_period(
ClusterIdentifier, RetentionPeriod; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"ModifySnapshotCopyRetentionPeriod",
Dict{String,Any}(
"ClusterIdentifier" => ClusterIdentifier, "RetentionPeriod" => RetentionPeriod
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_snapshot_copy_retention_period(
ClusterIdentifier,
RetentionPeriod,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"ModifySnapshotCopyRetentionPeriod",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClusterIdentifier" => ClusterIdentifier,
"RetentionPeriod" => RetentionPeriod,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_snapshot_schedule(schedule_definition, schedule_identifier)
modify_snapshot_schedule(schedule_definition, schedule_identifier, params::Dict{String,<:Any})
Modifies a snapshot schedule. Any schedule associated with a cluster is modified
asynchronously.
# Arguments
- `schedule_definition`: An updated list of schedule definitions. A schedule definition is
made up of schedule expressions, for example, \"cron(30 12 *)\" or \"rate(12 hours)\".
- `schedule_identifier`: A unique alphanumeric identifier of the schedule to modify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ScheduleDefinitions"`: An updated list of schedule definitions. A schedule definition
is made up of schedule expressions, for example, \"cron(30 12 *)\" or \"rate(12 hours)\".
"""
function modify_snapshot_schedule(
ScheduleDefinition,
ScheduleIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"ModifySnapshotSchedule",
Dict{String,Any}(
"ScheduleDefinition" => ScheduleDefinition,
"ScheduleIdentifier" => ScheduleIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_snapshot_schedule(
ScheduleDefinition,
ScheduleIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"ModifySnapshotSchedule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ScheduleDefinition" => ScheduleDefinition,
"ScheduleIdentifier" => ScheduleIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_usage_limit(usage_limit_id)
modify_usage_limit(usage_limit_id, params::Dict{String,<:Any})
Modifies a usage limit in a cluster. You can't modify the feature type or period of a usage
limit.
# Arguments
- `usage_limit_id`: The identifier of the usage limit to modify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Amount"`: The new limit amount. For more information about this parameter, see
UsageLimit.
- `"BreachAction"`: The new action that Amazon Redshift takes when the limit is reached.
For more information about this parameter, see UsageLimit.
"""
function modify_usage_limit(UsageLimitId; aws_config::AbstractAWSConfig=global_aws_config())
return redshift(
"ModifyUsageLimit",
Dict{String,Any}("UsageLimitId" => UsageLimitId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_usage_limit(
UsageLimitId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"ModifyUsageLimit",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UsageLimitId" => UsageLimitId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
pause_cluster(cluster_identifier)
pause_cluster(cluster_identifier, params::Dict{String,<:Any})
Pauses a cluster.
# Arguments
- `cluster_identifier`: The identifier of the cluster to be paused.
"""
function pause_cluster(ClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config())
return redshift(
"PauseCluster",
Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function pause_cluster(
ClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"PauseCluster",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
purchase_reserved_node_offering(reserved_node_offering_id)
purchase_reserved_node_offering(reserved_node_offering_id, params::Dict{String,<:Any})
Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved
node offerings. You can purchase one or more of the offerings. You can call the
DescribeReservedNodeOfferings API to obtain the available reserved node offerings. You can
call this API by providing a specific reserved node offering and the number of nodes you
want to reserve. For more information about reserved node offerings, go to Purchasing
Reserved Nodes in the Amazon Redshift Cluster Management Guide.
# Arguments
- `reserved_node_offering_id`: The unique identifier of the reserved node offering you want
to purchase.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NodeCount"`: The number of reserved nodes that you want to purchase. Default: 1
"""
function purchase_reserved_node_offering(
ReservedNodeOfferingId; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"PurchaseReservedNodeOffering",
Dict{String,Any}("ReservedNodeOfferingId" => ReservedNodeOfferingId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function purchase_reserved_node_offering(
ReservedNodeOfferingId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"PurchaseReservedNodeOffering",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ReservedNodeOfferingId" => ReservedNodeOfferingId),
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})
Updates the resource policy for a specified resource.
# Arguments
- `policy`: The content of the resource policy being updated.
- `resource_arn`: The Amazon Resource Name (ARN) of the resource of which its resource
policy is updated.
"""
function put_resource_policy(
Policy, ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"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 redshift(
"PutResourcePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Policy" => Policy, "ResourceArn" => ResourceArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reboot_cluster(cluster_identifier)
reboot_cluster(cluster_identifier, params::Dict{String,<:Any})
Reboots a cluster. This action is taken as soon as possible. It results in a momentary
outage to the cluster, during which the cluster status is set to rebooting. A cluster event
is created when the reboot is completed. Any pending cluster modifications (see
ModifyCluster) are applied at this reboot. For more information about managing clusters, go
to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
# Arguments
- `cluster_identifier`: The cluster identifier.
"""
function reboot_cluster(
ClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"RebootCluster",
Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reboot_cluster(
ClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"RebootCluster",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reject_data_share(data_share_arn)
reject_data_share(data_share_arn, params::Dict{String,<:Any})
From a datashare consumer account, rejects the specified datashare.
# Arguments
- `data_share_arn`: The Amazon Resource Name (ARN) of the datashare to reject.
"""
function reject_data_share(DataShareArn; aws_config::AbstractAWSConfig=global_aws_config())
return redshift(
"RejectDataShare",
Dict{String,Any}("DataShareArn" => DataShareArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reject_data_share(
DataShareArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"RejectDataShare",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DataShareArn" => DataShareArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reset_cluster_parameter_group(parameter_group_name)
reset_cluster_parameter_group(parameter_group_name, params::Dict{String,<:Any})
Sets one or more parameters of the specified parameter group to their default values and
sets the source values of the parameters to \"engine-default\". To reset the entire
parameter group specify the ResetAllParameters parameter. For parameter changes to take
effect you must reboot any associated clusters.
# Arguments
- `parameter_group_name`: The name of the cluster parameter group to be reset.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Parameters"`: An array of names of parameters to be reset. If ResetAllParameters option
is not used, then at least one parameter name must be supplied. Constraints: A maximum of
20 parameters can be reset in a single request.
- `"ResetAllParameters"`: If true, all parameters in the specified parameter group will be
reset to their default values. Default: true
"""
function reset_cluster_parameter_group(
ParameterGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"ResetClusterParameterGroup",
Dict{String,Any}("ParameterGroupName" => ParameterGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reset_cluster_parameter_group(
ParameterGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"ResetClusterParameterGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ParameterGroupName" => ParameterGroupName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
resize_cluster(cluster_identifier)
resize_cluster(cluster_identifier, params::Dict{String,<:Any})
Changes the size of the cluster. You can change the cluster's type, or change the number or
type of nodes. The default behavior is to use the elastic resize method. With an elastic
resize, your cluster is available for read and write operations more quickly than with the
classic resize method. Elastic resize operations have the following restrictions: You
can only resize clusters of the following types: dc2.large dc2.8xlarge ra3.xlplus
ra3.4xlarge ra3.16xlarge The type of nodes that you add must match the node type for
the cluster.
# Arguments
- `cluster_identifier`: The unique identifier for the cluster to resize.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Classic"`: A boolean value indicating whether the resize operation is using the classic
resize process. If you don't provide this parameter or set the value to false, the resize
type is elastic.
- `"ClusterType"`: The new cluster type for the specified cluster.
- `"NodeType"`: The new node type for the nodes you are adding. If not specified, the
cluster's current node type is used.
- `"NumberOfNodes"`: The new number of nodes for the cluster. If not specified, the
cluster's current number of nodes is used.
- `"ReservedNodeId"`: The identifier of the reserved node.
- `"TargetReservedNodeOfferingId"`: The identifier of the target reserved node offering.
"""
function resize_cluster(
ClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"ResizeCluster",
Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function resize_cluster(
ClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"ResizeCluster",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restore_from_cluster_snapshot(cluster_identifier)
restore_from_cluster_snapshot(cluster_identifier, params::Dict{String,<:Any})
Creates a new cluster from a snapshot. By default, Amazon Redshift creates the resulting
cluster with the same configuration as the original cluster from which the snapshot was
created, except that the new cluster is created with the default cluster security and
parameter groups. After Amazon Redshift creates the cluster, you can use the ModifyCluster
API to associate a different security group and different parameter group with the restored
cluster. If you are using a DS node type, you can also choose to change to another DS node
type of the same size during restore. If you restore a cluster into a VPC, you must provide
a cluster subnet group where you want the cluster restored. For more information about
working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster
Management Guide.
# Arguments
- `cluster_identifier`: The identifier of the cluster that will be created from restoring
the snapshot. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase. First character must be a letter. Cannot end
with a hyphen or contain two consecutive hyphens. Must be unique for all clusters within
an Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AdditionalInfo"`: Reserved.
- `"AllowVersionUpgrade"`: If true, major version upgrades can be applied during the
maintenance window to the Amazon Redshift engine that is running on the cluster. Default:
true
- `"AquaConfigurationStatus"`: This parameter is retired. It does not set the AQUA
configuration status. Amazon Redshift automatically determines whether to use AQUA
(Advanced Query Accelerator).
- `"AutomatedSnapshotRetentionPeriod"`: The number of days that automated snapshots are
retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots
are disabled, you can still create manual snapshots when you want with
CreateClusterSnapshot. You can't disable automated snapshots for RA3 node types. Set the
automated retention period from 1-35 days. Default: The value selected for the cluster from
which the snapshot was taken. Constraints: Must be a value from 0 to 35.
- `"AvailabilityZone"`: The Amazon EC2 Availability Zone in which to restore the cluster.
Default: A random, system-chosen Availability Zone. Example: us-east-2a
- `"AvailabilityZoneRelocation"`: The option to enable relocation for an Amazon Redshift
cluster between Availability Zones after the cluster is restored.
- `"ClusterParameterGroupName"`: The name of the parameter group to be associated with this
cluster. Default: The default Amazon Redshift cluster parameter group. For information
about the default parameter group, go to Working with Amazon Redshift Parameter Groups.
Constraints: Must be 1 to 255 alphanumeric characters or hyphens. First character must
be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
- `"ClusterSecurityGroups"`: A list of security groups to be associated with this cluster.
Default: The default cluster security group for Amazon Redshift. Cluster security groups
only apply to clusters outside of VPCs.
- `"ClusterSubnetGroupName"`: The name of the subnet group where you want to cluster
restored. A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must
provide subnet group name where you want the cluster restored.
- `"DefaultIamRoleArn"`: The Amazon Resource Name (ARN) for the IAM role that was set as
default for the cluster when the cluster was last modified while it was restored from a
snapshot.
- `"ElasticIp"`: The Elastic IP (EIP) address for the cluster. Don't specify the Elastic IP
address for a publicly accessible cluster with availability zone relocation turned on.
- `"Encrypted"`: Enables support for restoring an unencrypted snapshot to a cluster
encrypted with Key Management Service (KMS) and a customer managed key.
- `"EnhancedVpcRouting"`: An option that specifies whether to create the cluster with
enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the
cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon
Redshift Cluster Management Guide. If this option is true, enhanced VPC routing is enabled.
Default: false
- `"HsmClientCertificateIdentifier"`: Specifies the name of the HSM client certificate the
Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
- `"HsmConfigurationIdentifier"`: Specifies the name of the HSM configuration that contains
the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
- `"IamRoles"`: A list of Identity and Access Management (IAM) roles that can be used by
the cluster to access other Amazon Web Services services. You must supply the IAM roles in
their Amazon Resource Name (ARN) format. The maximum number of IAM roles that you can
associate is subject to a quota. For more information, go to Quotas and limits in the
Amazon Redshift Cluster Management Guide.
- `"IpAddressType"`: The IP address type for the cluster. Possible values are ipv4 and
dualstack.
- `"KmsKeyId"`: The Key Management Service (KMS) key ID of the encryption key that encrypts
data in the cluster restored from a shared snapshot. You can also provide the key ID when
you restore from an unencrypted snapshot to an encrypted cluster in the same account.
Additionally, you can specify a new KMS key ID when you restore from an encrypted snapshot
in the same account in order to change it. In that case, the restored cluster is encrypted
with the new KMS key ID.
- `"MaintenanceTrackName"`: The name of the maintenance track for the restored cluster.
When you take a snapshot, the snapshot inherits the MaintenanceTrack value from the
cluster. The snapshot might be on a different track than the cluster that was the source
for the snapshot. For example, suppose that you take a snapshot of a cluster that is on the
current track and then change the cluster to be on the trailing track. In this case, the
snapshot and the source cluster are on different tracks.
- `"ManageMasterPassword"`: If true, Amazon Redshift uses Secrets Manager to manage the
restored cluster's admin credentials. If ManageMasterPassword is false or not set, Amazon
Redshift uses the admin credentials the cluster had at the time the snapshot was taken.
- `"ManualSnapshotRetentionPeriod"`: The default number of days to retain a manual
snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't
change the retention period of existing snapshots. The value must be either -1 or an
integer between 1 and 3,653.
- `"MasterPasswordSecretKmsKeyId"`: The ID of the Key Management Service (KMS) key used to
encrypt and store the cluster's admin credentials secret. You can only use this parameter
if ManageMasterPassword is true.
- `"MultiAZ"`: If true, the snapshot will be restored to a cluster deployed in two
Availability Zones.
- `"NodeType"`: The node type that the restored cluster will be provisioned with. If you
have a DC instance type, you must restore into that same instance type and size. In other
words, you can only restore a dc2.large node type into another dc2 type. For more
information about node types, see About Clusters and Nodes in the Amazon Redshift Cluster
Management Guide.
- `"NumberOfNodes"`: The number of nodes specified when provisioning the restored cluster.
- `"OwnerAccount"`: The Amazon Web Services account used to create or copy the snapshot.
Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
- `"Port"`: The port number on which the cluster accepts connections. Default: The same
port as the original cluster. Valid values: For clusters with DC2 nodes, must be within the
range 1150-65535. For clusters with ra3 nodes, must be within the ranges 5431-5455 or
8191-8215.
- `"PreferredMaintenanceWindow"`: The weekly time range (in UTC) during which automated
cluster maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi Default: The value
selected for the cluster from which the snapshot was taken. For more information about the
time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management
Guide. Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Minimum 30-minute
window.
- `"PubliclyAccessible"`: If true, the cluster can be accessed from a public network.
- `"ReservedNodeId"`: The identifier of the target reserved node offering.
- `"SnapshotArn"`: The Amazon Resource Name (ARN) of the snapshot associated with the
message to restore from a cluster. You must specify this parameter or snapshotIdentifier,
but not both.
- `"SnapshotClusterIdentifier"`: The name of the cluster the source snapshot was created
from. This parameter is required if your IAM user has a policy containing a snapshot
resource element that specifies anything other than * for the cluster name.
- `"SnapshotIdentifier"`: The name of the snapshot from which to create the new cluster.
This parameter isn't case sensitive. You must specify this parameter or snapshotArn, but
not both. Example: my-snapshot-id
- `"SnapshotScheduleIdentifier"`: A unique identifier for the snapshot schedule.
- `"TargetReservedNodeOfferingId"`: The identifier of the target reserved node offering.
- `"VpcSecurityGroupIds"`: A list of Virtual Private Cloud (VPC) security groups to be
associated with the cluster. Default: The default VPC security group is associated with the
cluster. VPC security groups only apply to clusters in VPCs.
"""
function restore_from_cluster_snapshot(
ClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"RestoreFromClusterSnapshot",
Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function restore_from_cluster_snapshot(
ClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"RestoreFromClusterSnapshot",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restore_table_from_cluster_snapshot(cluster_identifier, new_table_name, snapshot_identifier, source_database_name, source_table_name)
restore_table_from_cluster_snapshot(cluster_identifier, new_table_name, snapshot_identifier, source_database_name, source_table_name, params::Dict{String,<:Any})
Creates a new table from a table in an Amazon Redshift cluster snapshot. You must create
the new table within the Amazon Redshift cluster that the snapshot was taken from. You
cannot use RestoreTableFromClusterSnapshot to restore a table with the same name as an
existing table in an Amazon Redshift cluster. That is, you cannot overwrite an existing
table in a cluster with a restored table. If you want to replace your original table with a
new, restored table, then rename or drop your original table before you call
RestoreTableFromClusterSnapshot. When you have renamed your original table, then you can
pass the original name of the table as the NewTableName parameter value in the call to
RestoreTableFromClusterSnapshot. This way, you can replace the original table with the
table created from the snapshot. You can't use this operation to restore tables with
interleaved sort keys.
# Arguments
- `cluster_identifier`: The identifier of the Amazon Redshift cluster to restore the table
to.
- `new_table_name`: The name of the table to create as a result of the current request.
- `snapshot_identifier`: The identifier of the snapshot to restore the table from. This
snapshot must have been created from the Amazon Redshift cluster specified by the
ClusterIdentifier parameter.
- `source_database_name`: The name of the source database that contains the table to
restore from.
- `source_table_name`: The name of the source table to restore from.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EnableCaseSensitiveIdentifier"`: Indicates whether name identifiers for database,
schema, and table are case sensitive. If true, the names are case sensitive. If false
(default), the names are not case sensitive.
- `"SourceSchemaName"`: The name of the source schema that contains the table to restore
from. If you do not specify a SourceSchemaName value, the default is public.
- `"TargetDatabaseName"`: The name of the database to restore the table to.
- `"TargetSchemaName"`: The name of the schema to restore the table to.
"""
function restore_table_from_cluster_snapshot(
ClusterIdentifier,
NewTableName,
SnapshotIdentifier,
SourceDatabaseName,
SourceTableName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"RestoreTableFromClusterSnapshot",
Dict{String,Any}(
"ClusterIdentifier" => ClusterIdentifier,
"NewTableName" => NewTableName,
"SnapshotIdentifier" => SnapshotIdentifier,
"SourceDatabaseName" => SourceDatabaseName,
"SourceTableName" => SourceTableName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function restore_table_from_cluster_snapshot(
ClusterIdentifier,
NewTableName,
SnapshotIdentifier,
SourceDatabaseName,
SourceTableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"RestoreTableFromClusterSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClusterIdentifier" => ClusterIdentifier,
"NewTableName" => NewTableName,
"SnapshotIdentifier" => SnapshotIdentifier,
"SourceDatabaseName" => SourceDatabaseName,
"SourceTableName" => SourceTableName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
resume_cluster(cluster_identifier)
resume_cluster(cluster_identifier, params::Dict{String,<:Any})
Resumes a paused cluster.
# Arguments
- `cluster_identifier`: The identifier of the cluster to be resumed.
"""
function resume_cluster(
ClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"ResumeCluster",
Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function resume_cluster(
ClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"ResumeCluster",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
revoke_cluster_security_group_ingress(cluster_security_group_name)
revoke_cluster_security_group_ingress(cluster_security_group_name, params::Dict{String,<:Any})
Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP
range or Amazon EC2 security group. To add an ingress rule, see
AuthorizeClusterSecurityGroupIngress. For information about managing security groups, go to
Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
# Arguments
- `cluster_security_group_name`: The name of the security Group from which to revoke the
ingress rule.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CIDRIP"`: The IP range for which to revoke access. This range must be a valid Classless
Inter-Domain Routing (CIDR) block of IP addresses. If CIDRIP is specified,
EC2SecurityGroupName and EC2SecurityGroupOwnerId cannot be provided.
- `"EC2SecurityGroupName"`: The name of the EC2 Security Group whose access is to be
revoked. If EC2SecurityGroupName is specified, EC2SecurityGroupOwnerId must also be
provided and CIDRIP cannot be provided.
- `"EC2SecurityGroupOwnerId"`: The Amazon Web Services account number of the owner of the
security group specified in the EC2SecurityGroupName parameter. The Amazon Web Services
access key ID is not an acceptable value. If EC2SecurityGroupOwnerId is specified,
EC2SecurityGroupName must also be provided. and CIDRIP cannot be provided. Example:
111122223333
"""
function revoke_cluster_security_group_ingress(
ClusterSecurityGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"RevokeClusterSecurityGroupIngress",
Dict{String,Any}("ClusterSecurityGroupName" => ClusterSecurityGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function revoke_cluster_security_group_ingress(
ClusterSecurityGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"RevokeClusterSecurityGroupIngress",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ClusterSecurityGroupName" => ClusterSecurityGroupName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
revoke_endpoint_access()
revoke_endpoint_access(params::Dict{String,<:Any})
Revokes access to a cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Account"`: The Amazon Web Services account ID whose access is to be revoked.
- `"ClusterIdentifier"`: The cluster to revoke access from.
- `"Force"`: Indicates whether to force the revoke action. If true, the Redshift-managed
VPC endpoints associated with the endpoint authorization are also deleted.
- `"VpcIds"`: The virtual private cloud (VPC) identifiers for which access is to be revoked.
"""
function revoke_endpoint_access(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift(
"RevokeEndpointAccess"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function revoke_endpoint_access(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"RevokeEndpointAccess",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
revoke_snapshot_access(account_with_restore_access)
revoke_snapshot_access(account_with_restore_access, params::Dict{String,<:Any})
Removes the ability of the specified Amazon Web Services account to restore the specified
snapshot. If the account is currently restoring the snapshot, the restore will run to
completion. For more information about working with snapshots, go to Amazon Redshift
Snapshots in the Amazon Redshift Cluster Management Guide.
# Arguments
- `account_with_restore_access`: The identifier of the Amazon Web Services account that can
no longer restore the specified snapshot.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SnapshotArn"`: The Amazon Resource Name (ARN) of the snapshot associated with the
message to revoke access.
- `"SnapshotClusterIdentifier"`: The identifier of the cluster the snapshot was created
from. This parameter is required if your IAM user has a policy containing a snapshot
resource element that specifies anything other than * for the cluster name.
- `"SnapshotIdentifier"`: The identifier of the snapshot that the account can no longer
access.
"""
function revoke_snapshot_access(
AccountWithRestoreAccess; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"RevokeSnapshotAccess",
Dict{String,Any}("AccountWithRestoreAccess" => AccountWithRestoreAccess);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function revoke_snapshot_access(
AccountWithRestoreAccess,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"RevokeSnapshotAccess",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AccountWithRestoreAccess" => AccountWithRestoreAccess),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
rotate_encryption_key(cluster_identifier)
rotate_encryption_key(cluster_identifier, params::Dict{String,<:Any})
Rotates the encryption keys for a cluster.
# Arguments
- `cluster_identifier`: The unique identifier of the cluster that you want to rotate the
encryption keys for. Constraints: Must be the name of valid cluster that has encryption
enabled.
"""
function rotate_encryption_key(
ClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift(
"RotateEncryptionKey",
Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function rotate_encryption_key(
ClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"RotateEncryptionKey",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ClusterIdentifier" => ClusterIdentifier), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_partner_status(account_id, cluster_identifier, database_name, partner_name, status)
update_partner_status(account_id, cluster_identifier, database_name, partner_name, status, params::Dict{String,<:Any})
Updates the status of a partner integration.
# Arguments
- `account_id`: The Amazon Web Services account ID that owns the cluster.
- `cluster_identifier`: The cluster identifier of the cluster whose partner integration
status is being updated.
- `database_name`: The name of the database whose partner integration status is being
updated.
- `partner_name`: The name of the partner whose integration status is being updated.
- `status`: The value of the updated status.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"StatusMessage"`: The status message provided by the partner.
"""
function update_partner_status(
AccountId,
ClusterIdentifier,
DatabaseName,
PartnerName,
Status;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"UpdatePartnerStatus",
Dict{String,Any}(
"AccountId" => AccountId,
"ClusterIdentifier" => ClusterIdentifier,
"DatabaseName" => DatabaseName,
"PartnerName" => PartnerName,
"Status" => Status,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_partner_status(
AccountId,
ClusterIdentifier,
DatabaseName,
PartnerName,
Status,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift(
"UpdatePartnerStatus",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AccountId" => AccountId,
"ClusterIdentifier" => ClusterIdentifier,
"DatabaseName" => DatabaseName,
"PartnerName" => PartnerName,
"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 | 35200 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: redshift_data
using AWS.Compat
using AWS.UUIDs
"""
batch_execute_statement(database, sqls)
batch_execute_statement(database, sqls, params::Dict{String,<:Any})
Runs one or more SQL statements, which can be data manipulation language (DML) or data
definition language (DDL). Depending on the authorization method, use one of the following
combinations of request parameters: Secrets Manager - when connecting to a cluster,
provide the secret-arn of a secret stored in Secrets Manager which has username and
password. The specified secret contains credentials to connect to the database you specify.
When you are connecting to a cluster, you also supply the database name, If you provide a
cluster identifier (dbClusterIdentifier), it must match the cluster identifier stored in
the secret. When you are connecting to a serverless workgroup, you also supply the database
name. Temporary credentials - when connecting to your data warehouse, choose one of the
following options: When connecting to a serverless workgroup, specify the workgroup name
and database name. The database user name is derived from the IAM identity. For example,
arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call
the redshift-serverless:GetCredentials operation is required. When connecting to a
cluster as an IAM identity, specify the cluster identifier and the database name. The
database user name is derived from the IAM identity. For example,
arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call
the redshift:GetClusterCredentialsWithIAM operation is required. When connecting to a
cluster as a database user, specify the cluster identifier, the database name, and the
database user name. Also, permission to call the redshift:GetClusterCredentials operation
is required. For more information about the Amazon Redshift Data API and CLI usage
examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.
# Arguments
- `database`: The name of the database. This parameter is required when authenticating
using either Secrets Manager or temporary credentials.
- `sqls`: One or more SQL statements to run. The SQL statements are run as a single
transaction. They run serially in the order of the array. Subsequent SQL statements don't
start until the previous statement in the array completes. If any SQL statement fails, then
because they are run as one transaction, all work is rolled back.</p>
# 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.
- `"ClusterIdentifier"`: The cluster identifier. This parameter is required when connecting
to a cluster and authenticating using either Secrets Manager or temporary credentials.
- `"DbUser"`: The database user name. This parameter is required when connecting to a
cluster as a database user and authenticating using temporary credentials.
- `"SecretArn"`: The name or ARN of the secret that enables access to the database. This
parameter is required when authenticating using Secrets Manager.
- `"StatementName"`: The name of the SQL statements. You can name the SQL statements when
you create them to identify the query.
- `"WithEvent"`: A value that indicates whether to send an event to the Amazon EventBridge
event bus after the SQL statements run.
- `"WorkgroupName"`: The serverless workgroup name or Amazon Resource Name (ARN). This
parameter is required when connecting to a serverless workgroup and authenticating using
either Secrets Manager or temporary credentials.
"""
function batch_execute_statement(
Database, Sqls; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_data(
"BatchExecuteStatement",
Dict{String,Any}(
"Database" => Database, "Sqls" => Sqls, "ClientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_execute_statement(
Database,
Sqls,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_data(
"BatchExecuteStatement",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Database" => Database, "Sqls" => Sqls, "ClientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_statement(id)
cancel_statement(id, params::Dict{String,<:Any})
Cancels a running query. To be canceled, a query must be running. For more information
about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift
Data API in the Amazon Redshift Management Guide.
# Arguments
- `id`: The identifier of the SQL statement to cancel. This value is a universally unique
identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by
BatchExecuteStatment, ExecuteStatment, and ListStatements.
"""
function cancel_statement(Id; aws_config::AbstractAWSConfig=global_aws_config())
return redshift_data(
"CancelStatement",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_statement(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_data(
"CancelStatement",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_statement(id)
describe_statement(id, params::Dict{String,<:Any})
Describes the details about a specific instance when a query was run by the Amazon Redshift
Data API. The information includes when the query started, when it finished, the query
status, the number of rows returned, and the SQL statement. For more information about the
Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in
the Amazon Redshift Management Guide.
# Arguments
- `id`: The identifier of the SQL statement to describe. This value is a universally unique
identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates the number of
the SQL statement. For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2
that indicates the second SQL statement of a batch query. This identifier is returned by
BatchExecuteStatment, ExecuteStatement, and ListStatements.
"""
function describe_statement(Id; aws_config::AbstractAWSConfig=global_aws_config())
return redshift_data(
"DescribeStatement",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_statement(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_data(
"DescribeStatement",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_table(database)
describe_table(database, params::Dict{String,<:Any})
Describes the detailed information about a table from metadata in the cluster. The
information includes its columns. A token is returned to page through the column list.
Depending on the authorization method, use one of the following combinations of request
parameters: Secrets Manager - when connecting to a cluster, provide the secret-arn of a
secret stored in Secrets Manager which has username and password. The specified secret
contains credentials to connect to the database you specify. When you are connecting to a
cluster, you also supply the database name, If you provide a cluster identifier
(dbClusterIdentifier), it must match the cluster identifier stored in the secret. When you
are connecting to a serverless workgroup, you also supply the database name. Temporary
credentials - when connecting to your data warehouse, choose one of the following options:
When connecting to a serverless workgroup, specify the workgroup name and database name.
The database user name is derived from the IAM identity. For example,
arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call
the redshift-serverless:GetCredentials operation is required. When connecting to a
cluster as an IAM identity, specify the cluster identifier and the database name. The
database user name is derived from the IAM identity. For example,
arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call
the redshift:GetClusterCredentialsWithIAM operation is required. When connecting to a
cluster as a database user, specify the cluster identifier, the database name, and the
database user name. Also, permission to call the redshift:GetClusterCredentials operation
is required. For more information about the Amazon Redshift Data API and CLI usage
examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.
# Arguments
- `database`: The name of the database that contains the tables to be described. If
ConnectedDatabase is not specified, this is also the database to connect to with your
authentication credentials.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClusterIdentifier"`: The cluster identifier. This parameter is required when connecting
to a cluster and authenticating using either Secrets Manager or temporary credentials.
- `"ConnectedDatabase"`: A database name. The connected database is specified when you
connect with your authentication credentials.
- `"DbUser"`: The database user name. This parameter is required when connecting to a
cluster as a database user and authenticating using temporary credentials.
- `"MaxResults"`: The maximum number of tables to return in the response. If more tables
exist than fit in one response, then NextToken is returned to page through the results.
- `"NextToken"`: A value that indicates the starting point for the next set of response
records in a subsequent request. If a value is returned in a response, you can retrieve the
next set of records by providing this returned NextToken value in the next NextToken
parameter and retrying the command. If the NextToken field is empty, all response records
have been retrieved for the request.
- `"Schema"`: The schema that contains the table. If no schema is specified, then matching
tables for all schemas are returned.
- `"SecretArn"`: The name or ARN of the secret that enables access to the database. This
parameter is required when authenticating using Secrets Manager.
- `"Table"`: The table name. If no table is specified, then all tables for all matching
schemas are returned. If no table and no schema is specified, then all tables for all
schemas in the database are returned
- `"WorkgroupName"`: The serverless workgroup name or Amazon Resource Name (ARN). This
parameter is required when connecting to a serverless workgroup and authenticating using
either Secrets Manager or temporary credentials.
"""
function describe_table(Database; aws_config::AbstractAWSConfig=global_aws_config())
return redshift_data(
"DescribeTable",
Dict{String,Any}("Database" => Database);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_table(
Database,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_data(
"DescribeTable",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Database" => Database), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
execute_statement(database, sql)
execute_statement(database, sql, params::Dict{String,<:Any})
Runs an SQL statement, which can be data manipulation language (DML) or data definition
language (DDL). This statement must be a single SQL statement. Depending on the
authorization method, use one of the following combinations of request parameters:
Secrets Manager - when connecting to a cluster, provide the secret-arn of a secret stored
in Secrets Manager which has username and password. The specified secret contains
credentials to connect to the database you specify. When you are connecting to a cluster,
you also supply the database name, If you provide a cluster identifier
(dbClusterIdentifier), it must match the cluster identifier stored in the secret. When you
are connecting to a serverless workgroup, you also supply the database name. Temporary
credentials - when connecting to your data warehouse, choose one of the following options:
When connecting to a serverless workgroup, specify the workgroup name and database name.
The database user name is derived from the IAM identity. For example,
arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call
the redshift-serverless:GetCredentials operation is required. When connecting to a
cluster as an IAM identity, specify the cluster identifier and the database name. The
database user name is derived from the IAM identity. For example,
arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call
the redshift:GetClusterCredentialsWithIAM operation is required. When connecting to a
cluster as a database user, specify the cluster identifier, the database name, and the
database user name. Also, permission to call the redshift:GetClusterCredentials operation
is required. For more information about the Amazon Redshift Data API and CLI usage
examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.
# Arguments
- `database`: The name of the database. This parameter is required when authenticating
using either Secrets Manager or temporary credentials.
- `sql`: The SQL statement text to run.
# 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.
- `"ClusterIdentifier"`: The cluster identifier. This parameter is required when connecting
to a cluster and authenticating using either Secrets Manager or temporary credentials.
- `"DbUser"`: The database user name. This parameter is required when connecting to a
cluster as a database user and authenticating using temporary credentials.
- `"Parameters"`: The parameters for the SQL statement.
- `"SecretArn"`: The name or ARN of the secret that enables access to the database. This
parameter is required when authenticating using Secrets Manager.
- `"StatementName"`: The name of the SQL statement. You can name the SQL statement when you
create it to identify the query.
- `"WithEvent"`: A value that indicates whether to send an event to the Amazon EventBridge
event bus after the SQL statement runs.
- `"WorkgroupName"`: The serverless workgroup name or Amazon Resource Name (ARN). This
parameter is required when connecting to a serverless workgroup and authenticating using
either Secrets Manager or temporary credentials.
"""
function execute_statement(Database, Sql; aws_config::AbstractAWSConfig=global_aws_config())
return redshift_data(
"ExecuteStatement",
Dict{String,Any}(
"Database" => Database, "Sql" => Sql, "ClientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function execute_statement(
Database,
Sql,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_data(
"ExecuteStatement",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Database" => Database, "Sql" => Sql, "ClientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_statement_result(id)
get_statement_result(id, params::Dict{String,<:Any})
Fetches the temporarily cached result of an SQL statement. A token is returned to page
through the statement results. For more information about the Amazon Redshift Data API and
CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift
Management Guide.
# Arguments
- `id`: The identifier of the SQL statement whose results are to be fetched. This value is
a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix
indicates then number of the SQL statement. For example,
d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the second SQL
statement of a batch query. This identifier is returned by BatchExecuteStatment,
ExecuteStatment, and ListStatements.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: A value that indicates the starting point for the next set of response
records in a subsequent request. If a value is returned in a response, you can retrieve the
next set of records by providing this returned NextToken value in the next NextToken
parameter and retrying the command. If the NextToken field is empty, all response records
have been retrieved for the request.
"""
function get_statement_result(Id; aws_config::AbstractAWSConfig=global_aws_config())
return redshift_data(
"GetStatementResult",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_statement_result(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_data(
"GetStatementResult",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_databases(database)
list_databases(database, params::Dict{String,<:Any})
List the databases in a cluster. A token is returned to page through the database list.
Depending on the authorization method, use one of the following combinations of request
parameters: Secrets Manager - when connecting to a cluster, provide the secret-arn of a
secret stored in Secrets Manager which has username and password. The specified secret
contains credentials to connect to the database you specify. When you are connecting to a
cluster, you also supply the database name, If you provide a cluster identifier
(dbClusterIdentifier), it must match the cluster identifier stored in the secret. When you
are connecting to a serverless workgroup, you also supply the database name. Temporary
credentials - when connecting to your data warehouse, choose one of the following options:
When connecting to a serverless workgroup, specify the workgroup name and database name.
The database user name is derived from the IAM identity. For example,
arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call
the redshift-serverless:GetCredentials operation is required. When connecting to a
cluster as an IAM identity, specify the cluster identifier and the database name. The
database user name is derived from the IAM identity. For example,
arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call
the redshift:GetClusterCredentialsWithIAM operation is required. When connecting to a
cluster as a database user, specify the cluster identifier, the database name, and the
database user name. Also, permission to call the redshift:GetClusterCredentials operation
is required. For more information about the Amazon Redshift Data API and CLI usage
examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.
# Arguments
- `database`: The name of the database. This parameter is required when authenticating
using either Secrets Manager or temporary credentials.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClusterIdentifier"`: The cluster identifier. This parameter is required when connecting
to a cluster and authenticating using either Secrets Manager or temporary credentials.
- `"DbUser"`: The database user name. This parameter is required when connecting to a
cluster as a database user and authenticating using temporary credentials.
- `"MaxResults"`: The maximum number of databases to return in the response. If more
databases exist than fit in one response, then NextToken is returned to page through the
results.
- `"NextToken"`: A value that indicates the starting point for the next set of response
records in a subsequent request. If a value is returned in a response, you can retrieve the
next set of records by providing this returned NextToken value in the next NextToken
parameter and retrying the command. If the NextToken field is empty, all response records
have been retrieved for the request.
- `"SecretArn"`: The name or ARN of the secret that enables access to the database. This
parameter is required when authenticating using Secrets Manager.
- `"WorkgroupName"`: The serverless workgroup name or Amazon Resource Name (ARN). This
parameter is required when connecting to a serverless workgroup and authenticating using
either Secrets Manager or temporary credentials.
"""
function list_databases(Database; aws_config::AbstractAWSConfig=global_aws_config())
return redshift_data(
"ListDatabases",
Dict{String,Any}("Database" => Database);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_databases(
Database,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_data(
"ListDatabases",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Database" => Database), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_schemas(database)
list_schemas(database, params::Dict{String,<:Any})
Lists the schemas in a database. A token is returned to page through the schema list.
Depending on the authorization method, use one of the following combinations of request
parameters: Secrets Manager - when connecting to a cluster, provide the secret-arn of a
secret stored in Secrets Manager which has username and password. The specified secret
contains credentials to connect to the database you specify. When you are connecting to a
cluster, you also supply the database name, If you provide a cluster identifier
(dbClusterIdentifier), it must match the cluster identifier stored in the secret. When you
are connecting to a serverless workgroup, you also supply the database name. Temporary
credentials - when connecting to your data warehouse, choose one of the following options:
When connecting to a serverless workgroup, specify the workgroup name and database name.
The database user name is derived from the IAM identity. For example,
arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call
the redshift-serverless:GetCredentials operation is required. When connecting to a
cluster as an IAM identity, specify the cluster identifier and the database name. The
database user name is derived from the IAM identity. For example,
arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call
the redshift:GetClusterCredentialsWithIAM operation is required. When connecting to a
cluster as a database user, specify the cluster identifier, the database name, and the
database user name. Also, permission to call the redshift:GetClusterCredentials operation
is required. For more information about the Amazon Redshift Data API and CLI usage
examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.
# Arguments
- `database`: The name of the database that contains the schemas to list. If
ConnectedDatabase is not specified, this is also the database to connect to with your
authentication credentials.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClusterIdentifier"`: The cluster identifier. This parameter is required when connecting
to a cluster and authenticating using either Secrets Manager or temporary credentials.
- `"ConnectedDatabase"`: A database name. The connected database is specified when you
connect with your authentication credentials.
- `"DbUser"`: The database user name. This parameter is required when connecting to a
cluster as a database user and authenticating using temporary credentials.
- `"MaxResults"`: The maximum number of schemas to return in the response. If more schemas
exist than fit in one response, then NextToken is returned to page through the results.
- `"NextToken"`: A value that indicates the starting point for the next set of response
records in a subsequent request. If a value is returned in a response, you can retrieve the
next set of records by providing this returned NextToken value in the next NextToken
parameter and retrying the command. If the NextToken field is empty, all response records
have been retrieved for the request.
- `"SchemaPattern"`: A pattern to filter results by schema name. Within a schema pattern,
\"%\" means match any substring of 0 or more characters and \"_\" means match any one
character. Only schema name entries matching the search pattern are returned.
- `"SecretArn"`: The name or ARN of the secret that enables access to the database. This
parameter is required when authenticating using Secrets Manager.
- `"WorkgroupName"`: The serverless workgroup name or Amazon Resource Name (ARN). This
parameter is required when connecting to a serverless workgroup and authenticating using
either Secrets Manager or temporary credentials.
"""
function list_schemas(Database; aws_config::AbstractAWSConfig=global_aws_config())
return redshift_data(
"ListSchemas",
Dict{String,Any}("Database" => Database);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_schemas(
Database,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_data(
"ListSchemas",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Database" => Database), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_statements()
list_statements(params::Dict{String,<:Any})
List of SQL statements. By default, only finished statements are shown. A token is returned
to page through the statement list. For more information about the Amazon Redshift Data
API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift
Management Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of SQL statements to return in the response. If more
SQL statements exist than fit in one response, then NextToken is returned to page through
the results.
- `"NextToken"`: A value that indicates the starting point for the next set of response
records in a subsequent request. If a value is returned in a response, you can retrieve the
next set of records by providing this returned NextToken value in the next NextToken
parameter and retrying the command. If the NextToken field is empty, all response records
have been retrieved for the request.
- `"RoleLevel"`: A value that filters which statements to return in the response. If true,
all statements run by the caller's IAM role are returned. If false, only statements run by
the caller's IAM role in the current IAM session are returned. The default is true.
- `"StatementName"`: The name of the SQL statement specified as input to
BatchExecuteStatement or ExecuteStatement to identify the query. You can list multiple
statements by providing a prefix that matches the beginning of the statement name. For
example, to list myStatement1, myStatement2, myStatement3, and so on, then provide the a
value of myStatement. Data API does a case-sensitive match of SQL statement names to the
prefix value you provide.
- `"Status"`: The status of the SQL statement to list. Status values are defined as
follows: ABORTED - The query run was stopped by the user. ALL - A status value that
includes all query statuses. This value can be used to filter results. FAILED - The
query run failed. FINISHED - The query has finished running. PICKED - The query has
been chosen to be run. STARTED - The query run has started. SUBMITTED - The query was
submitted, but not yet processed.
"""
function list_statements(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift_data(
"ListStatements"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_statements(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_data(
"ListStatements", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tables(database)
list_tables(database, params::Dict{String,<:Any})
List the tables in a database. If neither SchemaPattern nor TablePattern are specified,
then all tables in the database are returned. A token is returned to page through the table
list. Depending on the authorization method, use one of the following combinations of
request parameters: Secrets Manager - when connecting to a cluster, provide the
secret-arn of a secret stored in Secrets Manager which has username and password. The
specified secret contains credentials to connect to the database you specify. When you are
connecting to a cluster, you also supply the database name, If you provide a cluster
identifier (dbClusterIdentifier), it must match the cluster identifier stored in the
secret. When you are connecting to a serverless workgroup, you also supply the database
name. Temporary credentials - when connecting to your data warehouse, choose one of the
following options: When connecting to a serverless workgroup, specify the workgroup name
and database name. The database user name is derived from the IAM identity. For example,
arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call
the redshift-serverless:GetCredentials operation is required. When connecting to a
cluster as an IAM identity, specify the cluster identifier and the database name. The
database user name is derived from the IAM identity. For example,
arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call
the redshift:GetClusterCredentialsWithIAM operation is required. When connecting to a
cluster as a database user, specify the cluster identifier, the database name, and the
database user name. Also, permission to call the redshift:GetClusterCredentials operation
is required. For more information about the Amazon Redshift Data API and CLI usage
examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.
# Arguments
- `database`: The name of the database that contains the tables to list. If
ConnectedDatabase is not specified, this is also the database to connect to with your
authentication credentials.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClusterIdentifier"`: The cluster identifier. This parameter is required when connecting
to a cluster and authenticating using either Secrets Manager or temporary credentials.
- `"ConnectedDatabase"`: A database name. The connected database is specified when you
connect with your authentication credentials.
- `"DbUser"`: The database user name. This parameter is required when connecting to a
cluster as a database user and authenticating using temporary credentials.
- `"MaxResults"`: The maximum number of tables to return in the response. If more tables
exist than fit in one response, then NextToken is returned to page through the results.
- `"NextToken"`: A value that indicates the starting point for the next set of response
records in a subsequent request. If a value is returned in a response, you can retrieve the
next set of records by providing this returned NextToken value in the next NextToken
parameter and retrying the command. If the NextToken field is empty, all response records
have been retrieved for the request.
- `"SchemaPattern"`: A pattern to filter results by schema name. Within a schema pattern,
\"%\" means match any substring of 0 or more characters and \"_\" means match any one
character. Only schema name entries matching the search pattern are returned. If
SchemaPattern is not specified, then all tables that match TablePattern are returned. If
neither SchemaPattern or TablePattern are specified, then all tables are returned.
- `"SecretArn"`: The name or ARN of the secret that enables access to the database. This
parameter is required when authenticating using Secrets Manager.
- `"TablePattern"`: A pattern to filter results by table name. Within a table pattern,
\"%\" means match any substring of 0 or more characters and \"_\" means match any one
character. Only table name entries matching the search pattern are returned. If
TablePattern is not specified, then all tables that match SchemaPatternare returned. If
neither SchemaPattern or TablePattern are specified, then all tables are returned.
- `"WorkgroupName"`: The serverless workgroup name or Amazon Resource Name (ARN). This
parameter is required when connecting to a serverless workgroup and authenticating using
either Secrets Manager or temporary credentials.
"""
function list_tables(Database; aws_config::AbstractAWSConfig=global_aws_config())
return redshift_data(
"ListTables",
Dict{String,Any}("Database" => Database);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tables(
Database,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_data(
"ListTables",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Database" => Database), 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 | 85950 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: redshift_serverless
using AWS.Compat
using AWS.UUIDs
"""
convert_recovery_point_to_snapshot(recovery_point_id, snapshot_name)
convert_recovery_point_to_snapshot(recovery_point_id, snapshot_name, params::Dict{String,<:Any})
Converts a recovery point to a snapshot. For more information about recovery points and
snapshots, see Working with snapshots and recovery points.
# Arguments
- `recovery_point_id`: The unique identifier of the recovery point.
- `snapshot_name`: The name of the snapshot.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"retentionPeriod"`: How long to retain the snapshot.
- `"tags"`: An array of Tag objects to associate with the created snapshot.
"""
function convert_recovery_point_to_snapshot(
recoveryPointId, snapshotName; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"ConvertRecoveryPointToSnapshot",
Dict{String,Any}(
"recoveryPointId" => recoveryPointId, "snapshotName" => snapshotName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function convert_recovery_point_to_snapshot(
recoveryPointId,
snapshotName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"ConvertRecoveryPointToSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"recoveryPointId" => recoveryPointId, "snapshotName" => snapshotName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_custom_domain_association(custom_domain_certificate_arn, custom_domain_name, workgroup_name)
create_custom_domain_association(custom_domain_certificate_arn, custom_domain_name, workgroup_name, params::Dict{String,<:Any})
Creates a custom domain association for Amazon Redshift Serverless.
# Arguments
- `custom_domain_certificate_arn`: The custom domain name’s certificate Amazon resource
name (ARN).
- `custom_domain_name`: The custom domain name to associate with the workgroup.
- `workgroup_name`: The name of the workgroup associated with the database.
"""
function create_custom_domain_association(
customDomainCertificateArn,
customDomainName,
workgroupName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"CreateCustomDomainAssociation",
Dict{String,Any}(
"customDomainCertificateArn" => customDomainCertificateArn,
"customDomainName" => customDomainName,
"workgroupName" => workgroupName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_custom_domain_association(
customDomainCertificateArn,
customDomainName,
workgroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"CreateCustomDomainAssociation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"customDomainCertificateArn" => customDomainCertificateArn,
"customDomainName" => customDomainName,
"workgroupName" => workgroupName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_endpoint_access(endpoint_name, subnet_ids, workgroup_name)
create_endpoint_access(endpoint_name, subnet_ids, workgroup_name, params::Dict{String,<:Any})
Creates an Amazon Redshift Serverless managed VPC endpoint.
# Arguments
- `endpoint_name`: The name of the VPC endpoint. An endpoint name must contain 1-30
characters. Valid characters are A-Z, a-z, 0-9, and hyphen(-). The first character must be
a letter. The name can't contain two consecutive hyphens or end with a hyphen.
- `subnet_ids`: The unique identifers of subnets from which Amazon Redshift Serverless
chooses one to deploy a VPC endpoint.
- `workgroup_name`: The name of the workgroup to associate with the VPC endpoint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ownerAccount"`: The owner Amazon Web Services account for the Amazon Redshift
Serverless workgroup.
- `"vpcSecurityGroupIds"`: The unique identifiers of the security group that defines the
ports, protocols, and sources for inbound traffic that you are authorizing into your
endpoint.
"""
function create_endpoint_access(
endpointName,
subnetIds,
workgroupName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"CreateEndpointAccess",
Dict{String,Any}(
"endpointName" => endpointName,
"subnetIds" => subnetIds,
"workgroupName" => workgroupName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_endpoint_access(
endpointName,
subnetIds,
workgroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"CreateEndpointAccess",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"endpointName" => endpointName,
"subnetIds" => subnetIds,
"workgroupName" => workgroupName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_namespace(namespace_name)
create_namespace(namespace_name, params::Dict{String,<:Any})
Creates a namespace in Amazon Redshift Serverless.
# Arguments
- `namespace_name`: The name of the namespace.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"adminPasswordSecretKmsKeyId"`: The ID of the Key Management Service (KMS) key used to
encrypt and store the namespace's admin credentials secret. You can only use this parameter
if manageAdminPassword is true.
- `"adminUserPassword"`: The password of the administrator for the first database created
in the namespace. You can't use adminUserPassword if manageAdminPassword is true.
- `"adminUsername"`: The username of the administrator for the first database created in
the namespace.
- `"dbName"`: The name of the first database created in the namespace.
- `"defaultIamRoleArn"`: The Amazon Resource Name (ARN) of the IAM role to set as a default
in the namespace.
- `"iamRoles"`: A list of IAM roles to associate with the namespace.
- `"kmsKeyId"`: The ID of the Amazon Web Services Key Management Service key used to
encrypt your data.
- `"logExports"`: The types of logs the namespace can export. Available export types are
userlog, connectionlog, and useractivitylog.
- `"manageAdminPassword"`: If true, Amazon Redshift uses Secrets Manager to manage the
namespace's admin credentials. You can't use adminUserPassword if manageAdminPassword is
true. If manageAdminPassword is false or not set, Amazon Redshift uses adminUserPassword
for the admin user account's password.
- `"redshiftIdcApplicationArn"`: The ARN for the Redshift application that integrates with
IAM Identity Center.
- `"tags"`: A list of tag instances.
"""
function create_namespace(namespaceName; aws_config::AbstractAWSConfig=global_aws_config())
return redshift_serverless(
"CreateNamespace",
Dict{String,Any}("namespaceName" => namespaceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_namespace(
namespaceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"CreateNamespace",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("namespaceName" => namespaceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_scheduled_action(namespace_name, role_arn, schedule, scheduled_action_name, target_action)
create_scheduled_action(namespace_name, role_arn, schedule, scheduled_action_name, target_action, params::Dict{String,<:Any})
Creates a scheduled action. A scheduled action contains a schedule and an Amazon Redshift
API action. For example, you can create a schedule of when to run the CreateSnapshot API
operation.
# Arguments
- `namespace_name`: The name of the namespace for which to create a scheduled action.
- `role_arn`: The ARN of the IAM role to assume to run the scheduled action. This IAM role
must have permission to run the Amazon Redshift Serverless API operation in the scheduled
action. This IAM role must allow the Amazon Redshift scheduler to schedule creating
snapshots. (Principal scheduler.redshift.amazonaws.com) to assume permissions on your
behalf. For more information about the IAM role to use with the Amazon Redshift scheduler,
see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster
Management Guide
- `schedule`: The schedule for a one-time (at timestamp format) or recurring (cron format)
scheduled action. Schedule invocations must be separated by at least one hour. Times are in
UTC. Format of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.
Format of cron expression is (Minutes Hours Day-of-month Month Day-of-week Year). For
example, \"(0 10 ? * MON *)\". For more information, see Cron Expressions in the Amazon
CloudWatch Events User Guide.
- `scheduled_action_name`: The name of the scheduled action.
- `target_action`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"enabled"`: Indicates whether the schedule is enabled. If false, the scheduled action
does not trigger. For more information about state of the scheduled action, see
ScheduledAction.
- `"endTime"`: The end time in UTC when the schedule is no longer active. After this time,
the scheduled action does not trigger.
- `"scheduledActionDescription"`: The description of the scheduled action.
- `"startTime"`: The start time in UTC when the schedule is active. Before this time, the
scheduled action does not trigger.
"""
function create_scheduled_action(
namespaceName,
roleArn,
schedule,
scheduledActionName,
targetAction;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"CreateScheduledAction",
Dict{String,Any}(
"namespaceName" => namespaceName,
"roleArn" => roleArn,
"schedule" => schedule,
"scheduledActionName" => scheduledActionName,
"targetAction" => targetAction,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_scheduled_action(
namespaceName,
roleArn,
schedule,
scheduledActionName,
targetAction,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"CreateScheduledAction",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"namespaceName" => namespaceName,
"roleArn" => roleArn,
"schedule" => schedule,
"scheduledActionName" => scheduledActionName,
"targetAction" => targetAction,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_snapshot(namespace_name, snapshot_name)
create_snapshot(namespace_name, snapshot_name, params::Dict{String,<:Any})
Creates a snapshot of all databases in a namespace. For more information about snapshots,
see Working with snapshots and recovery points.
# Arguments
- `namespace_name`: The namespace to create a snapshot for.
- `snapshot_name`: The name of the snapshot.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"retentionPeriod"`: How long to retain the created snapshot.
- `"tags"`: An array of Tag objects to associate with the snapshot.
"""
function create_snapshot(
namespaceName, snapshotName; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"CreateSnapshot",
Dict{String,Any}("namespaceName" => namespaceName, "snapshotName" => snapshotName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_snapshot(
namespaceName,
snapshotName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"CreateSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"namespaceName" => namespaceName, "snapshotName" => snapshotName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_snapshot_copy_configuration(destination_region, namespace_name)
create_snapshot_copy_configuration(destination_region, namespace_name, params::Dict{String,<:Any})
Creates a snapshot copy configuration that lets you copy snapshots to another Amazon Web
Services Region.
# Arguments
- `destination_region`: The destination Amazon Web Services Region that you want to copy
snapshots to.
- `namespace_name`: The name of the namespace to copy snapshots from.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"destinationKmsKeyId"`: The KMS key to use to encrypt your snapshots in the destination
Amazon Web Services Region.
- `"snapshotRetentionPeriod"`: The retention period of the snapshots that you copy to the
destination Amazon Web Services Region.
"""
function create_snapshot_copy_configuration(
destinationRegion, namespaceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"CreateSnapshotCopyConfiguration",
Dict{String,Any}(
"destinationRegion" => destinationRegion, "namespaceName" => namespaceName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_snapshot_copy_configuration(
destinationRegion,
namespaceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"CreateSnapshotCopyConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"destinationRegion" => destinationRegion,
"namespaceName" => namespaceName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_usage_limit(amount, resource_arn, usage_type)
create_usage_limit(amount, resource_arn, usage_type, params::Dict{String,<:Any})
Creates a usage limit for a specified Amazon Redshift Serverless usage type. The usage
limit is identified by the returned usage limit identifier.
# Arguments
- `amount`: The limit amount. If time-based, this amount is in Redshift Processing Units
(RPU) consumed per hour. If data-based, this amount is in terabytes (TB) of data
transferred between Regions in cross-account sharing. The value must be a positive number.
- `resource_arn`: The Amazon Resource Name (ARN) of the Amazon Redshift Serverless resource
to create the usage limit for.
- `usage_type`: The type of Amazon Redshift Serverless usage to create a usage limit for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"breachAction"`: The action that Amazon Redshift Serverless takes when the limit is
reached. The default is log.
- `"period"`: The time period that the amount applies to. A weekly period begins on Sunday.
The default is monthly.
"""
function create_usage_limit(
amount, resourceArn, usageType; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"CreateUsageLimit",
Dict{String,Any}(
"amount" => amount, "resourceArn" => resourceArn, "usageType" => usageType
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_usage_limit(
amount,
resourceArn,
usageType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"CreateUsageLimit",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"amount" => amount,
"resourceArn" => resourceArn,
"usageType" => usageType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_workgroup(namespace_name, workgroup_name)
create_workgroup(namespace_name, workgroup_name, params::Dict{String,<:Any})
Creates an workgroup in Amazon Redshift Serverless.
# Arguments
- `namespace_name`: The name of the namespace to associate with the workgroup.
- `workgroup_name`: The name of the created workgroup.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"baseCapacity"`: The base data warehouse capacity of the workgroup in Redshift
Processing Units (RPUs).
- `"configParameters"`: An array of parameters to set for advanced control over a database.
The options are auto_mv, datestyle, enable_case_sensitive_identifier,
enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, and
query monitoring metrics that let you define performance boundaries. For more information
about query monitoring rules and available metrics, see Query monitoring metrics for
Amazon Redshift Serverless.
- `"enhancedVpcRouting"`: The value that specifies whether to turn on enhanced virtual
private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic
through your VPC instead of over the internet.
- `"maxCapacity"`: The maximum data-warehouse capacity Amazon Redshift Serverless uses to
serve queries. The max capacity is specified in RPUs.
- `"port"`: The custom port to use when connecting to a workgroup. Valid port ranges are
5431-5455 and 8191-8215. The default is 5439.
- `"publiclyAccessible"`: A value that specifies whether the workgroup can be accessed from
a public network.
- `"securityGroupIds"`: An array of security group IDs to associate with the workgroup.
- `"subnetIds"`: An array of VPC subnet IDs to associate with the workgroup.
- `"tags"`: A array of tag instances.
"""
function create_workgroup(
namespaceName, workgroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"CreateWorkgroup",
Dict{String,Any}(
"namespaceName" => namespaceName, "workgroupName" => workgroupName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_workgroup(
namespaceName,
workgroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"CreateWorkgroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"namespaceName" => namespaceName, "workgroupName" => workgroupName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_custom_domain_association(custom_domain_name, workgroup_name)
delete_custom_domain_association(custom_domain_name, workgroup_name, params::Dict{String,<:Any})
Deletes a custom domain association for Amazon Redshift Serverless.
# Arguments
- `custom_domain_name`: The custom domain name associated with the workgroup.
- `workgroup_name`: The name of the workgroup associated with the database.
"""
function delete_custom_domain_association(
customDomainName, workgroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"DeleteCustomDomainAssociation",
Dict{String,Any}(
"customDomainName" => customDomainName, "workgroupName" => workgroupName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_custom_domain_association(
customDomainName,
workgroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"DeleteCustomDomainAssociation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"customDomainName" => customDomainName, "workgroupName" => workgroupName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_endpoint_access(endpoint_name)
delete_endpoint_access(endpoint_name, params::Dict{String,<:Any})
Deletes an Amazon Redshift Serverless managed VPC endpoint.
# Arguments
- `endpoint_name`: The name of the VPC endpoint to delete.
"""
function delete_endpoint_access(
endpointName; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"DeleteEndpointAccess",
Dict{String,Any}("endpointName" => endpointName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_endpoint_access(
endpointName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"DeleteEndpointAccess",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("endpointName" => endpointName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_namespace(namespace_name)
delete_namespace(namespace_name, params::Dict{String,<:Any})
Deletes a namespace from Amazon Redshift Serverless. Before you delete the namespace, you
can create a final snapshot that has all of the data within the namespace.
# Arguments
- `namespace_name`: The name of the namespace to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"finalSnapshotName"`: The name of the snapshot to be created before the namespace is
deleted.
- `"finalSnapshotRetentionPeriod"`: How long to retain the final snapshot.
"""
function delete_namespace(namespaceName; aws_config::AbstractAWSConfig=global_aws_config())
return redshift_serverless(
"DeleteNamespace",
Dict{String,Any}("namespaceName" => namespaceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_namespace(
namespaceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"DeleteNamespace",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("namespaceName" => namespaceName), 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 specified resource policy.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the policy to delete.
"""
function delete_resource_policy(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"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 redshift_serverless(
"DeleteResourcePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_scheduled_action(scheduled_action_name)
delete_scheduled_action(scheduled_action_name, params::Dict{String,<:Any})
Deletes a scheduled action.
# Arguments
- `scheduled_action_name`: The name of the scheduled action to delete.
"""
function delete_scheduled_action(
scheduledActionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"DeleteScheduledAction",
Dict{String,Any}("scheduledActionName" => scheduledActionName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_scheduled_action(
scheduledActionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"DeleteScheduledAction",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("scheduledActionName" => scheduledActionName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_snapshot(snapshot_name)
delete_snapshot(snapshot_name, params::Dict{String,<:Any})
Deletes a snapshot from Amazon Redshift Serverless.
# Arguments
- `snapshot_name`: The name of the snapshot to be deleted.
"""
function delete_snapshot(snapshotName; aws_config::AbstractAWSConfig=global_aws_config())
return redshift_serverless(
"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 redshift_serverless(
"DeleteSnapshot",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("snapshotName" => snapshotName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_snapshot_copy_configuration(snapshot_copy_configuration_id)
delete_snapshot_copy_configuration(snapshot_copy_configuration_id, params::Dict{String,<:Any})
Deletes a snapshot copy configuration
# Arguments
- `snapshot_copy_configuration_id`: The ID of the snapshot copy configuration to delete.
"""
function delete_snapshot_copy_configuration(
snapshotCopyConfigurationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"DeleteSnapshotCopyConfiguration",
Dict{String,Any}("snapshotCopyConfigurationId" => snapshotCopyConfigurationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_snapshot_copy_configuration(
snapshotCopyConfigurationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"DeleteSnapshotCopyConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"snapshotCopyConfigurationId" => snapshotCopyConfigurationId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_usage_limit(usage_limit_id)
delete_usage_limit(usage_limit_id, params::Dict{String,<:Any})
Deletes a usage limit from Amazon Redshift Serverless.
# Arguments
- `usage_limit_id`: The unique identifier of the usage limit to delete.
"""
function delete_usage_limit(usageLimitId; aws_config::AbstractAWSConfig=global_aws_config())
return redshift_serverless(
"DeleteUsageLimit",
Dict{String,Any}("usageLimitId" => usageLimitId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_usage_limit(
usageLimitId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"DeleteUsageLimit",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("usageLimitId" => usageLimitId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_workgroup(workgroup_name)
delete_workgroup(workgroup_name, params::Dict{String,<:Any})
Deletes a workgroup.
# Arguments
- `workgroup_name`: The name of the workgroup to be deleted.
"""
function delete_workgroup(workgroupName; aws_config::AbstractAWSConfig=global_aws_config())
return redshift_serverless(
"DeleteWorkgroup",
Dict{String,Any}("workgroupName" => workgroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_workgroup(
workgroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"DeleteWorkgroup",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("workgroupName" => workgroupName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_credentials()
get_credentials(params::Dict{String,<:Any})
Returns a database user name and temporary password with temporary authorization to log in
to Amazon Redshift Serverless. By default, the temporary credentials expire in 900 seconds.
You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60
minutes). <p>The Identity and Access Management (IAM) user or role that runs
GetCredentials must have an IAM policy attached that allows access to all necessary actions
and resources.</p> <p>If the <code>DbName</code> parameter is
specified, the IAM policy must allow access to the resource dbname for the specified
database name.</p>
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"customDomainName"`: The custom domain name associated with the workgroup. The custom
domain name or the workgroup name must be included in the request.
- `"dbName"`: The name of the database to get temporary authorization to log on to.
Constraints: Must be 1 to 64 alphanumeric characters or hyphens. Must contain only
uppercase or lowercase letters, numbers, underscore, plus sign, period (dot), at symbol
(@), or hyphen. The first character must be a letter. Must not contain a colon ( : ) or
slash ( / ). Cannot be a reserved word. A list of reserved words can be found in Reserved
Words in the Amazon Redshift Database Developer Guide
- `"durationSeconds"`: The number of seconds until the returned temporary password expires.
The minimum is 900 seconds, and the maximum is 3600 seconds.
- `"workgroupName"`: The name of the workgroup associated with the database.
"""
function get_credentials(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift_serverless(
"GetCredentials"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_credentials(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"GetCredentials", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_custom_domain_association(custom_domain_name, workgroup_name)
get_custom_domain_association(custom_domain_name, workgroup_name, params::Dict{String,<:Any})
Gets information about a specific custom domain association.
# Arguments
- `custom_domain_name`: The custom domain name associated with the workgroup.
- `workgroup_name`: The name of the workgroup associated with the database.
"""
function get_custom_domain_association(
customDomainName, workgroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"GetCustomDomainAssociation",
Dict{String,Any}(
"customDomainName" => customDomainName, "workgroupName" => workgroupName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_custom_domain_association(
customDomainName,
workgroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"GetCustomDomainAssociation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"customDomainName" => customDomainName, "workgroupName" => workgroupName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_endpoint_access(endpoint_name)
get_endpoint_access(endpoint_name, params::Dict{String,<:Any})
Returns information, such as the name, about a VPC endpoint.
# Arguments
- `endpoint_name`: The name of the VPC endpoint to return information for.
"""
function get_endpoint_access(
endpointName; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"GetEndpointAccess",
Dict{String,Any}("endpointName" => endpointName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_endpoint_access(
endpointName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"GetEndpointAccess",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("endpointName" => endpointName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_namespace(namespace_name)
get_namespace(namespace_name, params::Dict{String,<:Any})
Returns information about a namespace in Amazon Redshift Serverless.
# Arguments
- `namespace_name`: The name of the namespace to retrieve information for.
"""
function get_namespace(namespaceName; aws_config::AbstractAWSConfig=global_aws_config())
return redshift_serverless(
"GetNamespace",
Dict{String,Any}("namespaceName" => namespaceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_namespace(
namespaceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"GetNamespace",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("namespaceName" => namespaceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_recovery_point(recovery_point_id)
get_recovery_point(recovery_point_id, params::Dict{String,<:Any})
Returns information about a recovery point.
# Arguments
- `recovery_point_id`: The unique identifier of the recovery point to return information
for.
"""
function get_recovery_point(
recoveryPointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"GetRecoveryPoint",
Dict{String,Any}("recoveryPointId" => recoveryPointId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_recovery_point(
recoveryPointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"GetRecoveryPoint",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("recoveryPointId" => recoveryPointId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resource_policy(resource_arn)
get_resource_policy(resource_arn, params::Dict{String,<:Any})
Returns a resource policy.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource to return.
"""
function get_resource_policy(resourceArn; aws_config::AbstractAWSConfig=global_aws_config())
return redshift_serverless(
"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 redshift_serverless(
"GetResourcePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_scheduled_action(scheduled_action_name)
get_scheduled_action(scheduled_action_name, params::Dict{String,<:Any})
Returns information about a scheduled action.
# Arguments
- `scheduled_action_name`: The name of the scheduled action.
"""
function get_scheduled_action(
scheduledActionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"GetScheduledAction",
Dict{String,Any}("scheduledActionName" => scheduledActionName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_scheduled_action(
scheduledActionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"GetScheduledAction",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("scheduledActionName" => scheduledActionName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_snapshot()
get_snapshot(params::Dict{String,<:Any})
Returns information about a specific snapshot.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ownerAccount"`: The owner Amazon Web Services account of a snapshot shared with another
user.
- `"snapshotArn"`: The Amazon Resource Name (ARN) of the snapshot to return.
- `"snapshotName"`: The name of the snapshot to return.
"""
function get_snapshot(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift_serverless(
"GetSnapshot"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_snapshot(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"GetSnapshot", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_table_restore_status(table_restore_request_id)
get_table_restore_status(table_restore_request_id, params::Dict{String,<:Any})
Returns information about a TableRestoreStatus object.
# Arguments
- `table_restore_request_id`: The ID of the RestoreTableFromSnapshot request to return
status for.
"""
function get_table_restore_status(
tableRestoreRequestId; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"GetTableRestoreStatus",
Dict{String,Any}("tableRestoreRequestId" => tableRestoreRequestId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_table_restore_status(
tableRestoreRequestId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"GetTableRestoreStatus",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("tableRestoreRequestId" => tableRestoreRequestId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_usage_limit(usage_limit_id)
get_usage_limit(usage_limit_id, params::Dict{String,<:Any})
Returns information about a usage limit.
# Arguments
- `usage_limit_id`: The unique identifier of the usage limit to return information for.
"""
function get_usage_limit(usageLimitId; aws_config::AbstractAWSConfig=global_aws_config())
return redshift_serverless(
"GetUsageLimit",
Dict{String,Any}("usageLimitId" => usageLimitId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_usage_limit(
usageLimitId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"GetUsageLimit",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("usageLimitId" => usageLimitId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_workgroup(workgroup_name)
get_workgroup(workgroup_name, params::Dict{String,<:Any})
Returns information about a specific workgroup.
# Arguments
- `workgroup_name`: The name of the workgroup to return information for.
"""
function get_workgroup(workgroupName; aws_config::AbstractAWSConfig=global_aws_config())
return redshift_serverless(
"GetWorkgroup",
Dict{String,Any}("workgroupName" => workgroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_workgroup(
workgroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"GetWorkgroup",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("workgroupName" => workgroupName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_custom_domain_associations()
list_custom_domain_associations(params::Dict{String,<:Any})
Lists custom domain associations for Amazon Redshift Serverless.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"customDomainCertificateArn"`: The custom domain name’s certificate Amazon resource
name (ARN).
- `"customDomainName"`: The custom domain name associated with the workgroup.
- `"maxResults"`: An optional parameter that specifies the maximum number of results to
return. You can use nextToken to display the next page of results.
- `"nextToken"`: When 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.
"""
function list_custom_domain_associations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"ListCustomDomainAssociations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_custom_domain_associations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"ListCustomDomainAssociations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_endpoint_access()
list_endpoint_access(params::Dict{String,<:Any})
Returns an array of EndpointAccess objects and relevant information.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: An optional parameter that specifies the maximum number of results to
return. You can use nextToken to display the next page of results.
- `"nextToken"`: If your initial ListEndpointAccess operation returns a nextToken, you can
include the returned nextToken in following ListEndpointAccess operations, which returns
results in the next page.
- `"ownerAccount"`: The owner Amazon Web Services account for the Amazon Redshift
Serverless workgroup.
- `"vpcId"`: The unique identifier of the virtual private cloud with access to Amazon
Redshift Serverless.
- `"workgroupName"`: The name of the workgroup associated with the VPC endpoint to return.
"""
function list_endpoint_access(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift_serverless(
"ListEndpointAccess"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_endpoint_access(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"ListEndpointAccess", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_namespaces()
list_namespaces(params::Dict{String,<:Any})
Returns information about a list of specified namespaces.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: An optional parameter that specifies the maximum number of results to
return. You can use nextToken to display the next page of results.
- `"nextToken"`: If your initial ListNamespaces operation returns a nextToken, you can
include the returned nextToken in following ListNamespaces operations, which returns
results in the next page.
"""
function list_namespaces(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift_serverless(
"ListNamespaces"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_namespaces(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"ListNamespaces", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_recovery_points()
list_recovery_points(params::Dict{String,<:Any})
Returns an array of recovery points.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"endTime"`: The time when creation of the recovery point finished.
- `"maxResults"`: An optional parameter that specifies the maximum number of results to
return. You can use nextToken to display the next page of results.
- `"namespaceArn"`: The Amazon Resource Name (ARN) of the namespace from which to list
recovery points.
- `"namespaceName"`: The name of the namespace to list recovery points for.
- `"nextToken"`: If your initial ListRecoveryPoints operation returns a nextToken, you can
include the returned nextToken in following ListRecoveryPoints operations, which returns
results in the next page.
- `"startTime"`: The time when the recovery point's creation was initiated.
"""
function list_recovery_points(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift_serverless(
"ListRecoveryPoints"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_recovery_points(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"ListRecoveryPoints", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_scheduled_actions()
list_scheduled_actions(params::Dict{String,<:Any})
Returns a list of scheduled actions. You can use the flags to filter the list of returned
scheduled actions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: An optional parameter that specifies the maximum number of results to
return. Use nextToken to display the next page of results.
- `"namespaceName"`: The name of namespace associated with the scheduled action to retrieve.
- `"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.
"""
function list_scheduled_actions(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift_serverless(
"ListScheduledActions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_scheduled_actions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"ListScheduledActions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_snapshot_copy_configurations()
list_snapshot_copy_configurations(params::Dict{String,<:Any})
Returns a list of snapshot copy configurations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: An optional parameter that specifies the maximum number of results to
return. You can use nextToken to display the next page of results.
- `"namespaceName"`: The namespace from which to list all snapshot copy configurations.
- `"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.
"""
function list_snapshot_copy_configurations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"ListSnapshotCopyConfigurations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_snapshot_copy_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"ListSnapshotCopyConfigurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_snapshots()
list_snapshots(params::Dict{String,<:Any})
Returns a list of snapshots.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"endTime"`: The timestamp showing when the snapshot creation finished.
- `"maxResults"`: An optional parameter that specifies the maximum number of results to
return. You can use nextToken to display the next page of results.
- `"namespaceArn"`: The Amazon Resource Name (ARN) of the namespace from which to list all
snapshots.
- `"namespaceName"`: The namespace from which to list all snapshots.
- `"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.
- `"ownerAccount"`: The owner Amazon Web Services account of the snapshot.
- `"startTime"`: The time when the creation of the snapshot was initiated.
"""
function list_snapshots(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift_serverless(
"ListSnapshots"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_snapshots(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"ListSnapshots", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_table_restore_status()
list_table_restore_status(params::Dict{String,<:Any})
Returns information about an array of TableRestoreStatus objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: An optional parameter that specifies the maximum number of results to
return. You can use nextToken to display the next page of results.
- `"namespaceName"`: The namespace from which to list all of the statuses of
RestoreTableFromSnapshot operations .
- `"nextToken"`: If your initial ListTableRestoreStatus operation returns a nextToken, you
can include the returned nextToken in following ListTableRestoreStatus operations. This
will return results on the next page.
- `"workgroupName"`: The workgroup from which to list all of the statuses of
RestoreTableFromSnapshot operations.
"""
function list_table_restore_status(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift_serverless(
"ListTableRestoreStatus"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_table_restore_status(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"ListTableRestoreStatus",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Lists the tags assigned to a resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource to list tags for.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"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 redshift_serverless(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_usage_limits()
list_usage_limits(params::Dict{String,<:Any})
Lists all usage limits within Amazon Redshift Serverless.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: An optional parameter that specifies the maximum number of results to
return. You can use nextToken to get the next page of results. The default is 100.
- `"nextToken"`: If your initial ListUsageLimits operation returns a nextToken, you can
include the returned nextToken in following ListUsageLimits operations, which returns
results in the next page.
- `"resourceArn"`: The Amazon Resource Name (ARN) associated with the resource whose usage
limits you want to list.
- `"usageType"`: The Amazon Redshift Serverless feature whose limits you want to see.
"""
function list_usage_limits(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift_serverless(
"ListUsageLimits"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_usage_limits(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"ListUsageLimits", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_workgroups()
list_workgroups(params::Dict{String,<:Any})
Returns information about a list of specified workgroups.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: An optional parameter that specifies the maximum number of results to
return. You can use nextToken to display the next page of results.
- `"nextToken"`: If your initial ListWorkgroups operation returns a nextToken, you can
include the returned nextToken in following ListNamespaces operations, which returns
results in the next page.
- `"ownerAccount"`: The owner Amazon Web Services account for the Amazon Redshift
Serverless workgroup.
"""
function list_workgroups(; aws_config::AbstractAWSConfig=global_aws_config())
return redshift_serverless(
"ListWorkgroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_workgroups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"ListWorkgroups", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
put_resource_policy(policy, resource_arn)
put_resource_policy(policy, resource_arn, params::Dict{String,<:Any})
Creates or updates a resource policy. Currently, you can use policies to share snapshots
across Amazon Web Services accounts.
# Arguments
- `policy`: The policy to create or update. For example, the following policy grants a user
authorization to restore a snapshot. \"{\"Version\": \"2012-10-17\", \"Statement\" : [{
\"Sid\": \"AllowUserRestoreFromSnapshot\", \"Principal\":{\"AWS\": [\"739247239426\"]},
\"Action\": [\"redshift-serverless:RestoreFromSnapshot\"] , \"Effect\": \"Allow\" }]}\"
- `resource_arn`: The Amazon Resource Name (ARN) of the account to create or update a
resource policy for.
"""
function put_resource_policy(
policy, resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"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 redshift_serverless(
"PutResourcePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("policy" => policy, "resourceArn" => resourceArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restore_from_recovery_point(namespace_name, recovery_point_id, workgroup_name)
restore_from_recovery_point(namespace_name, recovery_point_id, workgroup_name, params::Dict{String,<:Any})
Restore the data from a recovery point.
# Arguments
- `namespace_name`: The name of the namespace to restore data into.
- `recovery_point_id`: The unique identifier of the recovery point to restore from.
- `workgroup_name`: The name of the workgroup used to restore data.
"""
function restore_from_recovery_point(
namespaceName,
recoveryPointId,
workgroupName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"RestoreFromRecoveryPoint",
Dict{String,Any}(
"namespaceName" => namespaceName,
"recoveryPointId" => recoveryPointId,
"workgroupName" => workgroupName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function restore_from_recovery_point(
namespaceName,
recoveryPointId,
workgroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"RestoreFromRecoveryPoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"namespaceName" => namespaceName,
"recoveryPointId" => recoveryPointId,
"workgroupName" => workgroupName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restore_from_snapshot(namespace_name, workgroup_name)
restore_from_snapshot(namespace_name, workgroup_name, params::Dict{String,<:Any})
Restores a namespace from a snapshot.
# Arguments
- `namespace_name`: The name of the namespace to restore the snapshot to.
- `workgroup_name`: The name of the workgroup used to restore the snapshot.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"adminPasswordSecretKmsKeyId"`: The ID of the Key Management Service (KMS) key used to
encrypt and store the namespace's admin credentials secret.
- `"manageAdminPassword"`: If true, Amazon Redshift uses Secrets Manager to manage the
restored snapshot's admin credentials. If MmanageAdminPassword is false or not set, Amazon
Redshift uses the admin credentials that the namespace or cluster had at the time the
snapshot was taken.
- `"ownerAccount"`: The Amazon Web Services account that owns the snapshot.
- `"snapshotArn"`: The Amazon Resource Name (ARN) of the snapshot to restore from. Required
if restoring from Amazon Redshift Serverless to a provisioned cluster. Must not be
specified at the same time as snapshotName. The format of the ARN is
arn:aws:redshift:<region>:<account_id>:snapshot:<cluster_identifier>/<s
napshot_identifier>.
- `"snapshotName"`: The name of the snapshot to restore from. Must not be specified at the
same time as snapshotArn.
"""
function restore_from_snapshot(
namespaceName, workgroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"RestoreFromSnapshot",
Dict{String,Any}(
"namespaceName" => namespaceName, "workgroupName" => workgroupName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function restore_from_snapshot(
namespaceName,
workgroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"RestoreFromSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"namespaceName" => namespaceName, "workgroupName" => workgroupName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restore_table_from_recovery_point(namespace_name, new_table_name, recovery_point_id, source_database_name, source_table_name, workgroup_name)
restore_table_from_recovery_point(namespace_name, new_table_name, recovery_point_id, source_database_name, source_table_name, workgroup_name, params::Dict{String,<:Any})
Restores a table from a recovery point to your Amazon Redshift Serverless instance. You
can't use this operation to restore tables with interleaved sort keys.
# Arguments
- `namespace_name`: Namespace of the recovery point to restore from.
- `new_table_name`: The name of the table to create from the restore operation.
- `recovery_point_id`: The ID of the recovery point to restore the table from.
- `source_database_name`: The name of the source database that contains the table being
restored.
- `source_table_name`: The name of the source table being restored.
- `workgroup_name`: The workgroup to restore the table to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"activateCaseSensitiveIdentifier"`: Indicates whether name identifiers for database,
schema, and table are case sensitive. If true, the names are case sensitive. If false, the
names are not case sensitive. The default is false.
- `"sourceSchemaName"`: The name of the source schema that contains the table being
restored.
- `"targetDatabaseName"`: The name of the database to restore the table to.
- `"targetSchemaName"`: The name of the schema to restore the table to.
"""
function restore_table_from_recovery_point(
namespaceName,
newTableName,
recoveryPointId,
sourceDatabaseName,
sourceTableName,
workgroupName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"RestoreTableFromRecoveryPoint",
Dict{String,Any}(
"namespaceName" => namespaceName,
"newTableName" => newTableName,
"recoveryPointId" => recoveryPointId,
"sourceDatabaseName" => sourceDatabaseName,
"sourceTableName" => sourceTableName,
"workgroupName" => workgroupName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function restore_table_from_recovery_point(
namespaceName,
newTableName,
recoveryPointId,
sourceDatabaseName,
sourceTableName,
workgroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"RestoreTableFromRecoveryPoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"namespaceName" => namespaceName,
"newTableName" => newTableName,
"recoveryPointId" => recoveryPointId,
"sourceDatabaseName" => sourceDatabaseName,
"sourceTableName" => sourceTableName,
"workgroupName" => workgroupName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restore_table_from_snapshot(namespace_name, new_table_name, snapshot_name, source_database_name, source_table_name, workgroup_name)
restore_table_from_snapshot(namespace_name, new_table_name, snapshot_name, source_database_name, source_table_name, workgroup_name, params::Dict{String,<:Any})
Restores a table from a snapshot to your Amazon Redshift Serverless instance. You can't use
this operation to restore tables with interleaved sort keys.
# Arguments
- `namespace_name`: The namespace of the snapshot to restore from.
- `new_table_name`: The name of the table to create from the restore operation.
- `snapshot_name`: The name of the snapshot to restore the table from.
- `source_database_name`: The name of the source database that contains the table being
restored.
- `source_table_name`: The name of the source table being restored.
- `workgroup_name`: The workgroup to restore the table to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"activateCaseSensitiveIdentifier"`: Indicates whether name identifiers for database,
schema, and table are case sensitive. If true, the names are case sensitive. If false, the
names are not case sensitive. The default is false.
- `"sourceSchemaName"`: The name of the source schema that contains the table being
restored.
- `"targetDatabaseName"`: The name of the database to restore the table to.
- `"targetSchemaName"`: The name of the schema to restore the table to.
"""
function restore_table_from_snapshot(
namespaceName,
newTableName,
snapshotName,
sourceDatabaseName,
sourceTableName,
workgroupName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"RestoreTableFromSnapshot",
Dict{String,Any}(
"namespaceName" => namespaceName,
"newTableName" => newTableName,
"snapshotName" => snapshotName,
"sourceDatabaseName" => sourceDatabaseName,
"sourceTableName" => sourceTableName,
"workgroupName" => workgroupName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function restore_table_from_snapshot(
namespaceName,
newTableName,
snapshotName,
sourceDatabaseName,
sourceTableName,
workgroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"RestoreTableFromSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"namespaceName" => namespaceName,
"newTableName" => newTableName,
"snapshotName" => snapshotName,
"sourceDatabaseName" => sourceDatabaseName,
"sourceTableName" => sourceTableName,
"workgroupName" => workgroupName,
),
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 to a resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource to tag.
- `tags`: The map of the key-value pairs used to tag the resource.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return redshift_serverless(
"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 redshift_serverless(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("resourceArn" => resourceArn, "tags" => tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes a tag or set of tags from a resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource to remove tags from.
- `tag_keys`: The tag or set of tags to remove from the resource.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"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 redshift_serverless(
"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_custom_domain_association(custom_domain_certificate_arn, custom_domain_name, workgroup_name)
update_custom_domain_association(custom_domain_certificate_arn, custom_domain_name, workgroup_name, params::Dict{String,<:Any})
Updates an Amazon Redshift Serverless certificate associated with a custom domain.
# Arguments
- `custom_domain_certificate_arn`: The custom domain name’s certificate Amazon resource
name (ARN). This is optional.
- `custom_domain_name`: The custom domain name associated with the workgroup.
- `workgroup_name`: The name of the workgroup associated with the database.
"""
function update_custom_domain_association(
customDomainCertificateArn,
customDomainName,
workgroupName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"UpdateCustomDomainAssociation",
Dict{String,Any}(
"customDomainCertificateArn" => customDomainCertificateArn,
"customDomainName" => customDomainName,
"workgroupName" => workgroupName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_custom_domain_association(
customDomainCertificateArn,
customDomainName,
workgroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"UpdateCustomDomainAssociation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"customDomainCertificateArn" => customDomainCertificateArn,
"customDomainName" => customDomainName,
"workgroupName" => workgroupName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_endpoint_access(endpoint_name)
update_endpoint_access(endpoint_name, params::Dict{String,<:Any})
Updates an Amazon Redshift Serverless managed endpoint.
# Arguments
- `endpoint_name`: The name of the VPC endpoint to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"vpcSecurityGroupIds"`: The list of VPC security groups associated with the endpoint
after the endpoint is modified.
"""
function update_endpoint_access(
endpointName; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"UpdateEndpointAccess",
Dict{String,Any}("endpointName" => endpointName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_endpoint_access(
endpointName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"UpdateEndpointAccess",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("endpointName" => endpointName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_namespace(namespace_name)
update_namespace(namespace_name, params::Dict{String,<:Any})
Updates a namespace with the specified settings. Unless required, you can't update multiple
parameters in one request. For example, you must specify both adminUsername and
adminUserPassword to update either field, but you can't update both kmsKeyId and logExports
in a single request.
# Arguments
- `namespace_name`: The name of the namespace to update. You can't update the name of a
namespace once it is created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"adminPasswordSecretKmsKeyId"`: The ID of the Key Management Service (KMS) key used to
encrypt and store the namespace's admin credentials secret. You can only use this parameter
if manageAdminPassword is true.
- `"adminUserPassword"`: The password of the administrator for the first database created
in the namespace. This parameter must be updated together with adminUsername. You can't use
adminUserPassword if manageAdminPassword is true.
- `"adminUsername"`: The username of the administrator for the first database created in
the namespace. This parameter must be updated together with adminUserPassword.
- `"defaultIamRoleArn"`: The Amazon Resource Name (ARN) of the IAM role to set as a default
in the namespace. This parameter must be updated together with iamRoles.
- `"iamRoles"`: A list of IAM roles to associate with the namespace. This parameter must be
updated together with defaultIamRoleArn.
- `"kmsKeyId"`: The ID of the Amazon Web Services Key Management Service key used to
encrypt your data.
- `"logExports"`: The types of logs the namespace can export. The export types are userlog,
connectionlog, and useractivitylog.
- `"manageAdminPassword"`: If true, Amazon Redshift uses Secrets Manager to manage the
namespace's admin credentials. You can't use adminUserPassword if manageAdminPassword is
true. If manageAdminPassword is false or not set, Amazon Redshift uses adminUserPassword
for the admin user account's password.
"""
function update_namespace(namespaceName; aws_config::AbstractAWSConfig=global_aws_config())
return redshift_serverless(
"UpdateNamespace",
Dict{String,Any}("namespaceName" => namespaceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_namespace(
namespaceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"UpdateNamespace",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("namespaceName" => namespaceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_scheduled_action(scheduled_action_name)
update_scheduled_action(scheduled_action_name, params::Dict{String,<:Any})
Updates a scheduled action.
# Arguments
- `scheduled_action_name`: The name of the scheduled action to update to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"enabled"`: Specifies whether to enable the scheduled action.
- `"endTime"`: The end time in UTC of the scheduled action to update.
- `"roleArn"`: The ARN of the IAM role to assume to run the scheduled action. This IAM role
must have permission to run the Amazon Redshift Serverless API operation in the scheduled
action. This IAM role must allow the Amazon Redshift scheduler to schedule creating
snapshots (Principal scheduler.redshift.amazonaws.com) to assume permissions on your
behalf. For more information about the IAM role to use with the Amazon Redshift scheduler,
see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster
Management Guide
- `"schedule"`: The schedule for a one-time (at timestamp format) or recurring (cron
format) scheduled action. Schedule invocations must be separated by at least one hour.
Times are in UTC. Format of at timestamp is yyyy-mm-ddThh:mm:ss. For example,
2016-03-04T17:27:00. Format of cron expression is (Minutes Hours Day-of-month Month
Day-of-week Year). For example, \"(0 10 ? * MON *)\". For more information, see Cron
Expressions in the Amazon CloudWatch Events User Guide.
- `"scheduledActionDescription"`: The descripion of the scheduled action to update to.
- `"startTime"`: The start time in UTC of the scheduled action to update to.
- `"targetAction"`:
"""
function update_scheduled_action(
scheduledActionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"UpdateScheduledAction",
Dict{String,Any}("scheduledActionName" => scheduledActionName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_scheduled_action(
scheduledActionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"UpdateScheduledAction",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("scheduledActionName" => scheduledActionName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_snapshot(snapshot_name)
update_snapshot(snapshot_name, params::Dict{String,<:Any})
Updates a snapshot.
# Arguments
- `snapshot_name`: The name of the snapshot.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"retentionPeriod"`: The new retention period of the snapshot.
"""
function update_snapshot(snapshotName; aws_config::AbstractAWSConfig=global_aws_config())
return redshift_serverless(
"UpdateSnapshot",
Dict{String,Any}("snapshotName" => snapshotName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_snapshot(
snapshotName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"UpdateSnapshot",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("snapshotName" => snapshotName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_snapshot_copy_configuration(snapshot_copy_configuration_id)
update_snapshot_copy_configuration(snapshot_copy_configuration_id, params::Dict{String,<:Any})
Updates a snapshot copy configuration.
# Arguments
- `snapshot_copy_configuration_id`: The ID of the snapshot copy configuration to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"snapshotRetentionPeriod"`: The new retention period of how long to keep a snapshot in
the destination Amazon Web Services Region.
"""
function update_snapshot_copy_configuration(
snapshotCopyConfigurationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return redshift_serverless(
"UpdateSnapshotCopyConfiguration",
Dict{String,Any}("snapshotCopyConfigurationId" => snapshotCopyConfigurationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_snapshot_copy_configuration(
snapshotCopyConfigurationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"UpdateSnapshotCopyConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"snapshotCopyConfigurationId" => snapshotCopyConfigurationId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_usage_limit(usage_limit_id)
update_usage_limit(usage_limit_id, params::Dict{String,<:Any})
Update a usage limit in Amazon Redshift Serverless. You can't update the usage type or
period of a usage limit.
# Arguments
- `usage_limit_id`: The identifier of the usage limit to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"amount"`: The new limit amount. If time-based, this amount is in Redshift Processing
Units (RPU) consumed per hour. If data-based, this amount is in terabytes (TB) of data
transferred between Regions in cross-account sharing. The value must be a positive number.
- `"breachAction"`: The new action that Amazon Redshift Serverless takes when the limit is
reached.
"""
function update_usage_limit(usageLimitId; aws_config::AbstractAWSConfig=global_aws_config())
return redshift_serverless(
"UpdateUsageLimit",
Dict{String,Any}("usageLimitId" => usageLimitId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_usage_limit(
usageLimitId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"UpdateUsageLimit",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("usageLimitId" => usageLimitId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_workgroup(workgroup_name)
update_workgroup(workgroup_name, params::Dict{String,<:Any})
Updates a workgroup with the specified configuration settings. You can't update multiple
parameters in one request. For example, you can update baseCapacity or port in a single
request, but you can't update both in the same request.
# Arguments
- `workgroup_name`: The name of the workgroup to update. You can't update the name of a
workgroup once it is created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"baseCapacity"`: The new base data warehouse capacity in Redshift Processing Units
(RPUs).
- `"configParameters"`: An array of parameters to set for advanced control over a database.
The options are auto_mv, datestyle, enable_case_sensitive_identifier,
enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, and
query monitoring metrics that let you define performance boundaries. For more information
about query monitoring rules and available metrics, see Query monitoring metrics for
Amazon Redshift Serverless.
- `"enhancedVpcRouting"`: The value that specifies whether to turn on enhanced virtual
private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic
through your VPC.
- `"maxCapacity"`: The maximum data-warehouse capacity Amazon Redshift Serverless uses to
serve queries. The max capacity is specified in RPUs.
- `"port"`: The custom port to use when connecting to a workgroup. Valid port ranges are
5431-5455 and 8191-8215. The default is 5439.
- `"publiclyAccessible"`: A value that specifies whether the workgroup can be accessible
from a public network.
- `"securityGroupIds"`: An array of security group IDs to associate with the workgroup.
- `"subnetIds"`: An array of VPC subnet IDs to associate with the workgroup.
"""
function update_workgroup(workgroupName; aws_config::AbstractAWSConfig=global_aws_config())
return redshift_serverless(
"UpdateWorkgroup",
Dict{String,Any}("workgroupName" => workgroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_workgroup(
workgroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return redshift_serverless(
"UpdateWorkgroup",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("workgroupName" => workgroupName), 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 | 196110 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: rekognition
using AWS.Compat
using AWS.UUIDs
"""
associate_faces(collection_id, face_ids, user_id)
associate_faces(collection_id, face_ids, user_id, params::Dict{String,<:Any})
Associates one or more faces with an existing UserID. Takes an array of FaceIds. Each
FaceId that are present in the FaceIds list is associated with the provided UserID. The
maximum number of total FaceIds per UserID is 100. The UserMatchThreshold parameter
specifies the minimum user match confidence required for the face to be associated with a
UserID that has at least one FaceID already associated. This ensures that the FaceIds are
associated with the right UserID. The value ranges from 0-100 and default value is 75. If
successful, an array of AssociatedFace objects containing the associated FaceIds is
returned. If a given face is already associated with the given UserID, it will be ignored
and will not be returned in the response. If a given face is already associated to a
different UserID, isn't found in the collection, doesn’t meet the UserMatchThreshold, or
there are already 100 faces associated with the UserID, it will be returned as part of an
array of UnsuccessfulFaceAssociations. The UserStatus reflects the status of an operation
which updates a UserID representation with a list of given faces. The UserStatus can be:
ACTIVE - All associations or disassociations of FaceID(s) for a UserID are complete.
CREATED - A UserID has been created, but has no FaceID(s) associated with it. UPDATING -
A UserID is being updated and there are current associations or disassociations of
FaceID(s) taking place.
# Arguments
- `collection_id`: The ID of an existing collection containing the UserID.
- `face_ids`: An array of FaceIDs to associate with the UserID.
- `user_id`: The ID for the existing UserID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: Idempotent token used to identify the request to AssociateFaces.
If you use the same token with multiple AssociateFaces requests, the same response is
returned. Use ClientRequestToken to prevent the same request from being processed more than
once.
- `"UserMatchThreshold"`: An optional value specifying the minimum confidence in the UserID
match to return. The default value is 75.
"""
function associate_faces(
CollectionId, FaceIds, UserId; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"AssociateFaces",
Dict{String,Any}(
"CollectionId" => CollectionId,
"FaceIds" => FaceIds,
"UserId" => UserId,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_faces(
CollectionId,
FaceIds,
UserId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"AssociateFaces",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CollectionId" => CollectionId,
"FaceIds" => FaceIds,
"UserId" => UserId,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
compare_faces(source_image, target_image)
compare_faces(source_image, target_image, params::Dict{String,<:Any})
Compares a face in the source input image with each of the 100 largest faces detected in
the target input image. If the source image contains multiple faces, the service detects
the largest face and compares it with each face detected in the target image.
CompareFaces uses machine learning algorithms, which are probabilistic. A false negative is
an incorrect prediction that a face in the target image has a low similarity confidence
score when compared to the face in the source image. To reduce the probability of false
negatives, we recommend that you compare the target image against multiple source images.
If you plan to use CompareFaces to make a decision that impacts an individual's rights,
privacy, or access to services, we recommend that you pass the result to a human for review
and further validation before taking action. You pass the input and target images either
as base64-encoded image bytes or as references to images in an Amazon S3 bucket. If you use
the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The
image must be formatted as a PNG or JPEG file. In response, the operation returns an array
of face matches ordered by similarity score in descending order. For each face match, the
response provides a bounding box of the face, facial landmarks, pose details (pitch, roll,
and yaw), quality (brightness and sharpness), and confidence value (indicating the level of
confidence that the bounding box contains a face). The response also provides a similarity
score, which indicates how closely the faces match. By default, only faces with a
similarity score of greater than or equal to 80% are returned in the response. You can
change this value by specifying the SimilarityThreshold parameter. CompareFaces also
returns an array of faces that don't match the source image. For each face, it returns a
bounding box, confidence value, landmarks, pose details, and quality. The response also
returns information about the face in the source image, including the bounding box of the
face and confidence value. The QualityFilter input parameter allows you to filter out
detected faces that don’t meet a required quality bar. The quality bar is based on a
variety of common use cases. Use QualityFilter to set the quality bar by specifying LOW,
MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE. The default
value is NONE. If the image doesn't contain Exif metadata, CompareFaces returns
orientation information for the source and target images. Use these values to display the
images with the correct image orientation. If no faces are detected in the source or target
images, CompareFaces returns an InvalidParameterException error. This is a stateless API
operation. That is, data returned by this operation doesn't persist. For an example, see
Comparing Faces in Images in the Amazon Rekognition Developer Guide. This operation
requires permissions to perform the rekognition:CompareFaces action.
# Arguments
- `source_image`: The input image as base64-encoded bytes or an S3 object. If you use the
AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not
supported. If you are using an AWS SDK to call Amazon Rekognition, you might not need to
base64-encode image bytes passed using the Bytes field. For more information, see Images in
the Amazon Rekognition developer guide.
- `target_image`: The target image as base64-encoded bytes or an S3 object. If you use the
AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not
supported. If you are using an AWS SDK to call Amazon Rekognition, you might not need to
base64-encode image bytes passed using the Bytes field. For more information, see Images in
the Amazon Rekognition developer guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"QualityFilter"`: A filter that specifies a quality bar for how much filtering is done
to identify faces. Filtered faces aren't compared. If you specify AUTO, Amazon Rekognition
chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces
that don’t meet the chosen quality bar. The quality bar is based on a variety of common
use cases. Low-quality detections can occur for a number of reasons. Some examples are an
object that's misidentified as a face, a face that's too blurry, or a face with a pose
that's too extreme to use. If you specify NONE, no filtering is performed. The default
value is NONE. To use quality filtering, the collection you are using must be associated
with version 3 of the face model or higher.
- `"SimilarityThreshold"`: The minimum level of confidence in the face matches that a match
must meet to be included in the FaceMatches array.
"""
function compare_faces(
SourceImage, TargetImage; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"CompareFaces",
Dict{String,Any}("SourceImage" => SourceImage, "TargetImage" => TargetImage);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function compare_faces(
SourceImage,
TargetImage,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"CompareFaces",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SourceImage" => SourceImage, "TargetImage" => TargetImage
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
copy_project_version(destination_project_arn, output_config, source_project_arn, source_project_version_arn, version_name)
copy_project_version(destination_project_arn, output_config, source_project_arn, source_project_version_arn, version_name, params::Dict{String,<:Any})
This operation applies only to Amazon Rekognition Custom Labels. Copies a version of an
Amazon Rekognition Custom Labels model from a source project to a destination project. The
source and destination projects can be in different AWS accounts but must be in the same
AWS Region. You can't copy a model to another AWS service. To copy a model version to a
different AWS account, you need to create a resource-based policy known as a project
policy. You attach the project policy to the source project by calling PutProjectPolicy.
The project policy gives permission to copy the model version from a trusting AWS account
to a trusted account. For more information creating and attaching a project policy, see
Attaching a project policy (SDK) in the Amazon Rekognition Custom Labels Developer Guide.
If you are copying a model version to a project in the same AWS account, you don't need to
create a project policy. Copying project versions is supported only for Custom Labels
models. To copy a model, the destination project, source project, and source model version
must already exist. Copying a model version takes a while to complete. To get the current
status, call DescribeProjectVersions and check the value of Status in the
ProjectVersionDescription object. The copy operation has finished when the value of Status
is COPYING_COMPLETED. This operation requires permissions to perform the
rekognition:CopyProjectVersion action.
# Arguments
- `destination_project_arn`: The ARN of the project in the trusted AWS account that you
want to copy the model version to.
- `output_config`: The S3 bucket and folder location where the training output for the
source model version is placed.
- `source_project_arn`: The ARN of the source project in the trusting AWS account.
- `source_project_version_arn`: The ARN of the model version in the source project that you
want to copy to a destination project.
- `version_name`: A name for the version of the model that's copied to the destination
project.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"KmsKeyId"`: The identifier for your AWS Key Management Service key (AWS KMS key). You
can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias
for your KMS key, or an alias ARN. The key is used to encrypt training results and manifest
files written to the output Amazon S3 bucket (OutputConfig). If you choose to use your own
KMS key, you need the following permissions on the KMS key. kms:CreateGrant
kms:DescribeKey kms:GenerateDataKey kms:Decrypt If you don't specify a value for
KmsKeyId, images copied into the service are encrypted using a key that AWS owns and
manages.
- `"Tags"`: The key-value tags to assign to the model version.
"""
function copy_project_version(
DestinationProjectArn,
OutputConfig,
SourceProjectArn,
SourceProjectVersionArn,
VersionName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"CopyProjectVersion",
Dict{String,Any}(
"DestinationProjectArn" => DestinationProjectArn,
"OutputConfig" => OutputConfig,
"SourceProjectArn" => SourceProjectArn,
"SourceProjectVersionArn" => SourceProjectVersionArn,
"VersionName" => VersionName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function copy_project_version(
DestinationProjectArn,
OutputConfig,
SourceProjectArn,
SourceProjectVersionArn,
VersionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"CopyProjectVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DestinationProjectArn" => DestinationProjectArn,
"OutputConfig" => OutputConfig,
"SourceProjectArn" => SourceProjectArn,
"SourceProjectVersionArn" => SourceProjectVersionArn,
"VersionName" => VersionName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_collection(collection_id)
create_collection(collection_id, params::Dict{String,<:Any})
Creates a collection in an AWS Region. You can add faces to the collection using the
IndexFaces operation. For example, you might create collections, one for each of your
application users. A user can then index faces using the IndexFaces operation and persist
results in a specific collection. Then, a user can search the collection for faces in the
user-specific container. When you create a collection, it is associated with the latest
version of the face model version. Collection names are case-sensitive. This operation
requires permissions to perform the rekognition:CreateCollection action. If you want to tag
your collection, you also require permission to perform the rekognition:TagResource
operation.
# Arguments
- `collection_id`: ID for the collection that you are creating.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: A set of tags (key-value pairs) that you want to attach to the collection.
"""
function create_collection(CollectionId; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"CreateCollection",
Dict{String,Any}("CollectionId" => CollectionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_collection(
CollectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"CreateCollection",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("CollectionId" => CollectionId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dataset(dataset_type, project_arn)
create_dataset(dataset_type, project_arn, params::Dict{String,<:Any})
This operation applies only to Amazon Rekognition Custom Labels. Creates a new Amazon
Rekognition Custom Labels dataset. You can create a dataset by using an Amazon Sagemaker
format manifest file or by copying an existing Amazon Rekognition Custom Labels dataset. To
create a training dataset for a project, specify TRAIN for the value of DatasetType. To
create the test dataset for a project, specify TEST for the value of DatasetType. The
response from CreateDataset is the Amazon Resource Name (ARN) for the dataset. Creating a
dataset takes a while to complete. Use DescribeDataset to check the current status. The
dataset created successfully if the value of Status is CREATE_COMPLETE. To check if any
non-terminal errors occurred, call ListDatasetEntries and check for the presence of errors
lists in the JSON Lines. Dataset creation fails if a terminal error occurs (Status =
CREATE_FAILED). Currently, you can't access the terminal error information. For more
information, see Creating dataset in the Amazon Rekognition Custom Labels Developer Guide.
This operation requires permissions to perform the rekognition:CreateDataset action. If you
want to copy an existing dataset, you also require permission to perform the
rekognition:ListDatasetEntries action.
# Arguments
- `dataset_type`: The type of the dataset. Specify TRAIN to create a training dataset.
Specify TEST to create a test dataset.
- `project_arn`: The ARN of the Amazon Rekognition Custom Labels project to which you want
to asssign the dataset.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DatasetSource"`: The source files for the dataset. You can specify the ARN of an
existing dataset or specify the Amazon S3 bucket location of an Amazon Sagemaker format
manifest file. If you don't specify datasetSource, an empty dataset is created. To add
labeled images to the dataset, You can use the console or call UpdateDatasetEntries.
"""
function create_dataset(
DatasetType, ProjectArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"CreateDataset",
Dict{String,Any}("DatasetType" => DatasetType, "ProjectArn" => ProjectArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dataset(
DatasetType,
ProjectArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"CreateDataset",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DatasetType" => DatasetType, "ProjectArn" => ProjectArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_face_liveness_session()
create_face_liveness_session(params::Dict{String,<:Any})
This API operation initiates a Face Liveness session. It returns a SessionId, which you can
use to start streaming Face Liveness video and get the results for a Face Liveness session.
You can use the OutputConfig option in the Settings parameter to provide an Amazon S3
bucket location. The Amazon S3 bucket stores reference images and audit images. If no
Amazon S3 bucket is defined, raw bytes are sent instead. You can use AuditImagesLimit to
limit the number of audit images returned when GetFaceLivenessSessionResults is called.
This number is between 0 and 4. By default, it is set to 0. The limit is best effort and
based on the duration of the selfie-video.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: Idempotent token is used to recognize the Face Liveness request.
If the same token is used with multiple CreateFaceLivenessSession requests, the same
session is returned. This token is employed to avoid unintentionally creating the same
session multiple times.
- `"KmsKeyId"`: The identifier for your AWS Key Management Service key (AWS KMS key). Used
to encrypt audit images and reference images.
- `"Settings"`: A session settings object. It contains settings for the operation to be
performed. For Face Liveness, it accepts OutputConfig and AuditImagesLimit.
"""
function create_face_liveness_session(; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"CreateFaceLivenessSession"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function create_face_liveness_session(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"CreateFaceLivenessSession",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_project(project_name)
create_project(project_name, params::Dict{String,<:Any})
Creates a new Amazon Rekognition project. A project is a group of resources (datasets,
model versions) that you use to create and manage a Amazon Rekognition Custom Labels Model
or custom adapter. You can specify a feature to create the project with, if no feature is
specified then Custom Labels is used by default. For adapters, you can also choose whether
or not to have the project auto update by using the AutoUpdate argument. This operation
requires permissions to perform the rekognition:CreateProject action.
# 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:
- `"AutoUpdate"`: Specifies whether automatic retraining should be attempted for the
versions of the project. Automatic retraining is done as a best effort. Required argument
for Content Moderation. Applicable only to adapters.
- `"Feature"`: Specifies feature that is being customized. If no value is provided
CUSTOM_LABELS is used as a default.
"""
function create_project(ProjectName; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"CreateProject",
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 rekognition(
"CreateProject",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ProjectName" => ProjectName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_project_version(output_config, project_arn, version_name)
create_project_version(output_config, project_arn, version_name, params::Dict{String,<:Any})
Creates a new version of Amazon Rekognition project (like a Custom Labels model or a custom
adapter) and begins training. Models and adapters are managed as part of a Rekognition
project. The response from CreateProjectVersion is an Amazon Resource Name (ARN) for the
project version. The FeatureConfig operation argument allows you to configure specific
model or adapter settings. You can provide a description to the project version by using
the VersionDescription argment. Training can take a while to complete. You can get the
current status by calling DescribeProjectVersions. Training completed successfully if the
value of the Status field is TRAINING_COMPLETED. Once training has successfully completed,
call DescribeProjectVersions to get the training results and evaluate the model. This
operation requires permissions to perform the rekognition:CreateProjectVersion action.
The following applies only to projects with Amazon Rekognition Custom Labels as the chosen
feature: You can train a model in a project that doesn't have associated datasets by
specifying manifest files in the TrainingData and TestingData fields. If you open the
console after training a model with manifest files, Amazon Rekognition Custom Labels
creates the datasets for you using the most recent manifest files. You can no longer train
a model version for the project by specifying manifest files. Instead of training with a
project without associated datasets, we recommend that you use the manifest files to create
training and test datasets for the project.
# Arguments
- `output_config`: The Amazon S3 bucket location to store the results of training. The
bucket can be any S3 bucket in your AWS account. You need s3:PutObject permission on the
bucket.
- `project_arn`: The ARN of the Amazon Rekognition project that will manage the project
version you want to train.
- `version_name`: A name for the version of the project version. This value must be unique.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FeatureConfig"`: Feature-specific configuration of the training job. If the job
configuration does not match the feature type associated with the project, an
InvalidParameterException is returned.
- `"KmsKeyId"`: The identifier for your AWS Key Management Service key (AWS KMS key). You
can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias
for your KMS key, or an alias ARN. The key is used to encrypt training images, test images,
and manifest files copied into the service for the project version. Your source images are
unaffected. The key is also used to encrypt training results and manifest files written to
the output Amazon S3 bucket (OutputConfig). If you choose to use your own KMS key, you need
the following permissions on the KMS key. kms:CreateGrant kms:DescribeKey
kms:GenerateDataKey kms:Decrypt If you don't specify a value for KmsKeyId, images
copied into the service are encrypted using a key that AWS owns and manages.
- `"Tags"`: A set of tags (key-value pairs) that you want to attach to the project
version.
- `"TestingData"`: Specifies an external manifest that the service uses to test the project
version. If you specify TestingData you must also specify TrainingData. The project must
not have any associated datasets.
- `"TrainingData"`: Specifies an external manifest that the services uses to train the
project version. If you specify TrainingData you must also specify TestingData. The project
must not have any associated datasets.
- `"VersionDescription"`: A description applied to the project version being created.
"""
function create_project_version(
OutputConfig, ProjectArn, VersionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"CreateProjectVersion",
Dict{String,Any}(
"OutputConfig" => OutputConfig,
"ProjectArn" => ProjectArn,
"VersionName" => VersionName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_project_version(
OutputConfig,
ProjectArn,
VersionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"CreateProjectVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"OutputConfig" => OutputConfig,
"ProjectArn" => ProjectArn,
"VersionName" => VersionName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_stream_processor(input, name, output, role_arn, settings)
create_stream_processor(input, name, output, role_arn, settings, params::Dict{String,<:Any})
Creates an Amazon Rekognition stream processor that you can use to detect and recognize
faces or to detect labels in a streaming video. Amazon Rekognition Video is a consumer of
live video from Amazon Kinesis Video Streams. There are two different settings for stream
processors in Amazon Rekognition: detecting faces and detecting labels. If you are
creating a stream processor for detecting faces, you provide as input a Kinesis video
stream (Input) and a Kinesis data stream (Output) stream for receiving the output. You must
use the FaceSearch option in Settings, specifying the collection that contains the faces
you want to recognize. After you have finished analyzing a streaming video, use
StopStreamProcessor to stop processing. If you are creating a stream processor to detect
labels, you provide as input a Kinesis video stream (Input), Amazon S3 bucket information
(Output), and an Amazon SNS topic ARN (NotificationChannel). You can also provide a KMS key
ID to encrypt the data sent to your Amazon S3 bucket. You specify what you want to detect
by using the ConnectedHome option in settings, and selecting one of the following: PERSON,
PET, PACKAGE, ALL You can also specify where in the frame you want Amazon Rekognition to
monitor with RegionsOfInterest. When you run the StartStreamProcessor operation on a label
detection stream processor, you input start and stop information to determine the length of
the processing time. Use Name to assign an identifier for the stream processor. You use
Name to manage the stream processor. For example, you can start processing the source video
by calling StartStreamProcessor with the Name field. This operation requires permissions
to perform the rekognition:CreateStreamProcessor action. If you want to tag your stream
processor, you also require permission to perform the rekognition:TagResource operation.
# Arguments
- `input`: Kinesis video stream stream that provides the source streaming video. If you are
using the AWS CLI, the parameter name is StreamProcessorInput. This is required for both
face search and label detection stream processors.
- `name`: An identifier you assign to the stream processor. You can use Name to manage the
stream processor. For example, you can get the current status of the stream processor by
calling DescribeStreamProcessor. Name is idempotent. This is required for both face search
and label detection stream processors.
- `output`: Kinesis data stream stream or Amazon S3 bucket location to which Amazon
Rekognition Video puts the analysis results. If you are using the AWS CLI, the parameter
name is StreamProcessorOutput. This must be a S3Destination of an Amazon S3 bucket that you
own for a label detection stream processor or a Kinesis data stream ARN for a face search
stream processor.
- `role_arn`: The Amazon Resource Number (ARN) of the IAM role that allows access to the
stream processor. The IAM role provides Rekognition read permissions for a Kinesis stream.
It also provides write permissions to an Amazon S3 bucket and Amazon Simple Notification
Service topic for a label detection stream processor. This is required for both face search
and label detection stream processors.
- `settings`: Input parameters used in a streaming video analyzed by a stream processor.
You can use FaceSearch to recognize faces in a streaming video, or you can use
ConnectedHome to detect labels.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataSharingPreference"`: Shows whether you are sharing data with Rekognition to
improve model performance. You can choose this option at the account level or on a
per-stream basis. Note that if you opt out at the account level this setting is ignored on
individual streams.
- `"KmsKeyId"`: The identifier for your AWS Key Management Service key (AWS KMS key). This
is an optional parameter for label detection stream processors and should not be used to
create a face search stream processor. You can supply the Amazon Resource Name (ARN) of
your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. The key
is used to encrypt results and data published to your Amazon S3 bucket, which includes
image frames and hero images. Your source images are unaffected.
- `"NotificationChannel"`:
- `"RegionsOfInterest"`: Specifies locations in the frames where Amazon Rekognition checks
for objects or people. You can specify up to 10 regions of interest, and each region has
either a polygon or a bounding box. This is an optional parameter for label detection
stream processors and should not be used to create a face search stream processor.
- `"Tags"`: A set of tags (key-value pairs) that you want to attach to the stream
processor.
"""
function create_stream_processor(
Input,
Name,
Output,
RoleArn,
Settings;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"CreateStreamProcessor",
Dict{String,Any}(
"Input" => Input,
"Name" => Name,
"Output" => Output,
"RoleArn" => RoleArn,
"Settings" => Settings,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_stream_processor(
Input,
Name,
Output,
RoleArn,
Settings,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"CreateStreamProcessor",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Input" => Input,
"Name" => Name,
"Output" => Output,
"RoleArn" => RoleArn,
"Settings" => Settings,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_user(collection_id, user_id)
create_user(collection_id, user_id, params::Dict{String,<:Any})
Creates a new User within a collection specified by CollectionId. Takes UserId as a
parameter, which is a user provided ID which should be unique within the collection. The
provided UserId will alias the system generated UUID to make the UserId more user friendly.
Uses a ClientToken, an idempotency token that ensures a call to CreateUser completes only
once. If the value is not supplied, the AWS SDK generates an idempotency token for the
requests. This prevents retries after a network error results from making multiple
CreateUser calls.
# Arguments
- `collection_id`: The ID of an existing collection to which the new UserID needs to be
created.
- `user_id`: ID for the UserID to be created. This ID needs to be unique within the
collection.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: Idempotent token used to identify the request to CreateUser. If
you use the same token with multiple CreateUser requests, the same response is returned.
Use ClientRequestToken to prevent the same request from being processed more than once.
"""
function create_user(
CollectionId, UserId; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"CreateUser",
Dict{String,Any}(
"CollectionId" => CollectionId,
"UserId" => UserId,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_user(
CollectionId,
UserId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"CreateUser",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CollectionId" => CollectionId,
"UserId" => UserId,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_collection(collection_id)
delete_collection(collection_id, params::Dict{String,<:Any})
Deletes the specified collection. Note that this operation removes all faces in the
collection. For an example, see Deleting a collection. This operation requires permissions
to perform the rekognition:DeleteCollection action.
# Arguments
- `collection_id`: ID of the collection to delete.
"""
function delete_collection(CollectionId; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"DeleteCollection",
Dict{String,Any}("CollectionId" => CollectionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_collection(
CollectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"DeleteCollection",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("CollectionId" => CollectionId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dataset(dataset_arn)
delete_dataset(dataset_arn, params::Dict{String,<:Any})
This operation applies only to Amazon Rekognition Custom Labels. Deletes an existing
Amazon Rekognition Custom Labels dataset. Deleting a dataset might take while. Use
DescribeDataset to check the current status. The dataset is still deleting if the value of
Status is DELETE_IN_PROGRESS. If you try to access the dataset after it is deleted, you get
a ResourceNotFoundException exception. You can't delete a dataset while it is creating
(Status = CREATE_IN_PROGRESS) or if the dataset is updating (Status = UPDATE_IN_PROGRESS).
This operation requires permissions to perform the rekognition:DeleteDataset action.
# Arguments
- `dataset_arn`: The ARN of the Amazon Rekognition Custom Labels dataset that you want to
delete.
"""
function delete_dataset(DatasetArn; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"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 rekognition(
"DeleteDataset",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DatasetArn" => DatasetArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_faces(collection_id, face_ids)
delete_faces(collection_id, face_ids, params::Dict{String,<:Any})
Deletes faces from a collection. You specify a collection ID and an array of face IDs to
remove from the collection. This operation requires permissions to perform the
rekognition:DeleteFaces action.
# Arguments
- `collection_id`: Collection from which to remove the specific faces.
- `face_ids`: An array of face IDs to delete.
"""
function delete_faces(
CollectionId, FaceIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"DeleteFaces",
Dict{String,Any}("CollectionId" => CollectionId, "FaceIds" => FaceIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_faces(
CollectionId,
FaceIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"DeleteFaces",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CollectionId" => CollectionId, "FaceIds" => FaceIds),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_project(project_arn)
delete_project(project_arn, params::Dict{String,<:Any})
Deletes a Amazon Rekognition project. To delete a project you must first delete all models
or adapters associated with the project. To delete a model or adapter, see
DeleteProjectVersion. DeleteProject is an asynchronous operation. To check if the project
is deleted, call DescribeProjects. The project is deleted when the project no longer
appears in the response. Be aware that deleting a given project will also delete any
ProjectPolicies associated with that project. This operation requires permissions to
perform the rekognition:DeleteProject action.
# Arguments
- `project_arn`: The Amazon Resource Name (ARN) of the project that you want to delete.
"""
function delete_project(ProjectArn; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"DeleteProject",
Dict{String,Any}("ProjectArn" => ProjectArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_project(
ProjectArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"DeleteProject",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ProjectArn" => ProjectArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_project_policy(policy_name, project_arn)
delete_project_policy(policy_name, project_arn, params::Dict{String,<:Any})
This operation applies only to Amazon Rekognition Custom Labels. Deletes an existing
project policy. To get a list of project policies attached to a project, call
ListProjectPolicies. To attach a project policy to a project, call PutProjectPolicy. This
operation requires permissions to perform the rekognition:DeleteProjectPolicy action.
# Arguments
- `policy_name`: The name of the policy that you want to delete.
- `project_arn`: The Amazon Resource Name (ARN) of the project that the project policy you
want to delete is attached to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PolicyRevisionId"`: The ID of the project policy revision that you want to delete.
"""
function delete_project_policy(
PolicyName, ProjectArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"DeleteProjectPolicy",
Dict{String,Any}("PolicyName" => PolicyName, "ProjectArn" => ProjectArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_project_policy(
PolicyName,
ProjectArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"DeleteProjectPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("PolicyName" => PolicyName, "ProjectArn" => ProjectArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_project_version(project_version_arn)
delete_project_version(project_version_arn, params::Dict{String,<:Any})
Deletes a Rekognition project model or project version, like a Amazon Rekognition Custom
Labels model or a custom adapter. You can't delete a project version if it is running or if
it is training. To check the status of a project version, use the Status field returned
from DescribeProjectVersions. To stop a project version call StopProjectVersion. If the
project version is training, wait until it finishes. This operation requires permissions to
perform the rekognition:DeleteProjectVersion action.
# Arguments
- `project_version_arn`: The Amazon Resource Name (ARN) of the project version that you
want to delete.
"""
function delete_project_version(
ProjectVersionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"DeleteProjectVersion",
Dict{String,Any}("ProjectVersionArn" => ProjectVersionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_project_version(
ProjectVersionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"DeleteProjectVersion",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ProjectVersionArn" => ProjectVersionArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_stream_processor(name)
delete_stream_processor(name, params::Dict{String,<:Any})
Deletes the stream processor identified by Name. You assign the value for Name when you
create the stream processor with CreateStreamProcessor. You might not be able to use the
same name for a stream processor for a few seconds after calling DeleteStreamProcessor.
# Arguments
- `name`: The name of the stream processor you want to delete.
"""
function delete_stream_processor(Name; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"DeleteStreamProcessor",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_stream_processor(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"DeleteStreamProcessor",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_user(collection_id, user_id)
delete_user(collection_id, user_id, params::Dict{String,<:Any})
Deletes the specified UserID within the collection. Faces that are associated with the
UserID are disassociated from the UserID before deleting the specified UserID. If the
specified Collection or UserID is already deleted or not found, a ResourceNotFoundException
will be thrown. If the action is successful with a 200 response, an empty HTTP body is
returned.
# Arguments
- `collection_id`: The ID of an existing collection from which the UserID needs to be
deleted.
- `user_id`: ID for the UserID to be deleted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: Idempotent token used to identify the request to DeleteUser. If
you use the same token with multiple DeleteUser requests, the same response is returned.
Use ClientRequestToken to prevent the same request from being processed more than once.
"""
function delete_user(
CollectionId, UserId; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"DeleteUser",
Dict{String,Any}(
"CollectionId" => CollectionId,
"UserId" => UserId,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_user(
CollectionId,
UserId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"DeleteUser",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CollectionId" => CollectionId,
"UserId" => UserId,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_collection(collection_id)
describe_collection(collection_id, params::Dict{String,<:Any})
Describes the specified collection. You can use DescribeCollection to get information, such
as the number of faces indexed into a collection and the version of the model used by the
collection for face detection. For more information, see Describing a Collection in the
Amazon Rekognition Developer Guide.
# Arguments
- `collection_id`: The ID of the collection to describe.
"""
function describe_collection(
CollectionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"DescribeCollection",
Dict{String,Any}("CollectionId" => CollectionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_collection(
CollectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"DescribeCollection",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("CollectionId" => CollectionId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dataset(dataset_arn)
describe_dataset(dataset_arn, params::Dict{String,<:Any})
This operation applies only to Amazon Rekognition Custom Labels. Describes an Amazon
Rekognition Custom Labels dataset. You can get information such as the current status of a
dataset and statistics about the images and labels in a dataset. This operation requires
permissions to perform the rekognition:DescribeDataset action.
# Arguments
- `dataset_arn`: The Amazon Resource Name (ARN) of the dataset that you want to describe.
"""
function describe_dataset(DatasetArn; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"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 rekognition(
"DescribeDataset",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DatasetArn" => DatasetArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_project_versions(project_arn)
describe_project_versions(project_arn, params::Dict{String,<:Any})
Lists and describes the versions of an Amazon Rekognition project. You can specify up to 10
model or adapter versions in ProjectVersionArns. If you don't specify a value, descriptions
for all model/adapter versions in the project are returned. This operation requires
permissions to perform the rekognition:DescribeProjectVersions action.
# Arguments
- `project_arn`: The Amazon Resource Name (ARN) of the project that contains the
model/adapter you want to describe.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to return per paginated call. The largest
value you can specify is 100. If you specify a value greater than 100, a
ValidationException error occurs. The default value is 100.
- `"NextToken"`: If the previous response was incomplete (because there is more results to
retrieve), Amazon Rekognition returns a pagination token in the response. You can use this
pagination token to retrieve the next set of results.
- `"VersionNames"`: A list of model or project version names that you want to describe. You
can add up to 10 model or project version names to the list. If you don't specify a value,
all project version descriptions are returned. A version name is part of a project version
ARN. For example, my-model.2020-01-21T09.10.15 is the version name in the following ARN.
arn:aws:rekognition:us-east-1:123456789012:project/getting-started/version/my-model.2020-01
-21T09.10.15/1234567890123.
"""
function describe_project_versions(
ProjectArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"DescribeProjectVersions",
Dict{String,Any}("ProjectArn" => ProjectArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_project_versions(
ProjectArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"DescribeProjectVersions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ProjectArn" => ProjectArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_projects()
describe_projects(params::Dict{String,<:Any})
Gets information about your Rekognition projects. This operation requires permissions to
perform the rekognition:DescribeProjects action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Features"`: Specifies the type of customization to filter projects by. If no value is
specified, CUSTOM_LABELS is used as a default.
- `"MaxResults"`: The maximum number of results to return per paginated call. The largest
value you can specify is 100. If you specify a value greater than 100, a
ValidationException error occurs. The default value is 100.
- `"NextToken"`: If the previous response was incomplete (because there is more results to
retrieve), Rekognition returns a pagination token in the response. You can use this
pagination token to retrieve the next set of results.
- `"ProjectNames"`: A list of the projects that you want Rekognition to describe. If you
don't specify a value, the response includes descriptions for all the projects in your AWS
account.
"""
function describe_projects(; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"DescribeProjects"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_projects(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"DescribeProjects", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_stream_processor(name)
describe_stream_processor(name, params::Dict{String,<:Any})
Provides information about a stream processor created by CreateStreamProcessor. You can get
information about the input and output streams, the input parameters for the face
recognition being performed, and the current status of the stream processor.
# Arguments
- `name`: Name of the stream processor for which you want information.
"""
function describe_stream_processor(Name; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"DescribeStreamProcessor",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_stream_processor(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"DescribeStreamProcessor",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detect_custom_labels(image, project_version_arn)
detect_custom_labels(image, project_version_arn, params::Dict{String,<:Any})
This operation applies only to Amazon Rekognition Custom Labels. Detects custom labels in
a supplied image by using an Amazon Rekognition Custom Labels model. You specify which
version of a model version to use by using the ProjectVersionArn input parameter. You pass
the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3
bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes
is not supported. The image must be either a PNG or JPEG formatted file. For each object
that the model version detects on an image, the API returns a (CustomLabel) object in an
array (CustomLabels). Each CustomLabel object provides the label name (Name), the level of
confidence that the image contains the object (Confidence), and object location
information, if it exists, for the label on the image (Geometry). Note that for the
DetectCustomLabelsLabels operation, Polygons are not returned in the Geometry section of
the response. To filter labels that are returned, specify a value for MinConfidence.
DetectCustomLabelsLabels only returns labels with a confidence that's higher than the
specified value. The value of MinConfidence maps to the assumed threshold values created
during training. For more information, see Assumed threshold in the Amazon Rekognition
Custom Labels Developer Guide. Amazon Rekognition Custom Labels metrics expresses an
assumed threshold as a floating point value between 0-1. The range of MinConfidence
normalizes the threshold value to a percentage value (0-100). Confidence responses from
DetectCustomLabels are also returned as a percentage. You can use MinConfidence to change
the precision and recall or your model. For more information, see Analyzing an image in the
Amazon Rekognition Custom Labels Developer Guide. If you don't specify a value for
MinConfidence, DetectCustomLabels returns labels based on the assumed threshold of each
label. This is a stateless API operation. That is, the operation does not persist any data.
This operation requires permissions to perform the rekognition:DetectCustomLabels action.
For more information, see Analyzing an image in the Amazon Rekognition Custom Labels
Developer Guide.
# Arguments
- `image`:
- `project_version_arn`: The ARN of the model version that you want to use. Only models
associated with Custom Labels projects accepted by the operation. If a provided ARN refers
to a model version associated with a project for a different feature type, then an
InvalidParameterException is returned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Maximum number of results you want the service to return in the response.
The service returns the specified number of highest confidence labels ranked from highest
confidence to lowest.
- `"MinConfidence"`: Specifies the minimum confidence level for the labels to return.
DetectCustomLabels doesn't return any labels with a confidence value that's lower than this
specified value. If you specify a value of 0, DetectCustomLabels returns all labels,
regardless of the assumed threshold applied to each label. If you don't specify a value for
MinConfidence, DetectCustomLabels returns labels based on the assumed threshold of each
label.
"""
function detect_custom_labels(
Image, ProjectVersionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"DetectCustomLabels",
Dict{String,Any}("Image" => Image, "ProjectVersionArn" => ProjectVersionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detect_custom_labels(
Image,
ProjectVersionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"DetectCustomLabels",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Image" => Image, "ProjectVersionArn" => ProjectVersionArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detect_faces(image)
detect_faces(image, params::Dict{String,<:Any})
Detects faces within an image that is provided as input. DetectFaces detects the 100
largest faces in the image. For each face detected, the operation returns face details.
These details include a bounding box of the face, a confidence value (that the bounding box
contains a face), and a fixed set of attributes such as facial landmarks (for example,
coordinates of eye and mouth), pose, presence of facial occlusion, and so on. The
face-detection algorithm is most effective on frontal faces. For non-frontal or obscured
faces, the algorithm might not detect the faces or might detect faces with lower
confidence. You pass the input image either as base64-encoded image bytes or as a
reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon
Rekognition operations, passing image bytes is not supported. The image must be either a
PNG or JPEG formatted file. This is a stateless API operation. That is, the operation
does not persist any data. This operation requires permissions to perform the
rekognition:DetectFaces action.
# Arguments
- `image`: The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI
to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
If you are using an AWS SDK to call Amazon Rekognition, you might not need to
base64-encode image bytes passed using the Bytes field. For more information, see Images in
the Amazon Rekognition developer guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Attributes"`: An array of facial attributes you want to be returned. A DEFAULT subset
of facial attributes - BoundingBox, Confidence, Pose, Quality, and Landmarks - will always
be returned. You can request for specific facial attributes (in addition to the default
list) - by using [\"DEFAULT\", \"FACE_OCCLUDED\"] or just [\"FACE_OCCLUDED\"]. You can
request for all facial attributes by using [\"ALL\"]. Requesting more attributes may
increase response time. If you provide both, [\"ALL\", \"DEFAULT\"], the service uses a
logical \"AND\" operator to determine which attributes to return (in this case, all
attributes). Note that while the FaceOccluded and EyeDirection attributes are supported
when using DetectFaces, they aren't supported when analyzing videos with StartFaceDetection
and GetFaceDetection.
"""
function detect_faces(Image; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"DetectFaces",
Dict{String,Any}("Image" => Image);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detect_faces(
Image, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"DetectFaces",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Image" => Image), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detect_labels(image)
detect_labels(image, params::Dict{String,<:Any})
Detects instances of real-world entities within an image (JPEG or PNG) provided as input.
This includes objects like flower, tree, and table; events like wedding, graduation, and
birthday party; and concepts like landscape, evening, and nature. For an example, see
Analyzing images stored in an Amazon S3 bucket in the Amazon Rekognition Developer Guide.
You pass the input image as base64-encoded image bytes or as a reference to an image in an
Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing
image bytes is not supported. The image must be either a PNG or JPEG formatted file.
Optional Parameters You can specify one or both of the GENERAL_LABELS and IMAGE_PROPERTIES
feature types when calling the DetectLabels API. Including GENERAL_LABELS will ensure the
response includes the labels detected in the input image, while including IMAGE_PROPERTIES
will ensure the response includes information about the image quality and color. When using
GENERAL_LABELS and/or IMAGE_PROPERTIES you can provide filtering criteria to the Settings
parameter. You can filter with sets of individual labels or with label categories. You can
specify inclusive filters, exclusive filters, or a combination of inclusive and exclusive
filters. For more information on filtering see Detecting Labels in an Image. When getting
labels, you can specify MinConfidence to control the confidence threshold for the labels
returned. The default is 55%. You can also add the MaxLabels parameter to limit the number
of labels returned. The default and upper limit is 1000 labels. These arguments are only
valid when supplying GENERAL_LABELS as a feature type. Response Elements For each
object, scene, and concept the API returns one or more labels. The API returns the
following types of information about labels: Name - The name of the detected label.
Confidence - The level of confidence in the label assigned to a detected object.
Parents - The ancestor labels for a detected label. DetectLabels returns a hierarchical
taxonomy of detected labels. For example, a detected car might be assigned the label car.
The label car has two parent labels: Vehicle (its parent) and Transportation (its
grandparent). The response includes the all ancestors for a label, where every ancestor is
a unique label. In the previous example, Car, Vehicle, and Transportation are returned as
unique labels in the response. Aliases - Possible Aliases for the label. Categories
- The label categories that the detected label belongs to. BoundingBox — Bounding
boxes are described for all instances of detected common object labels, returned in an
array of Instance objects. An Instance object contains a BoundingBox object, describing the
location of the label on the input image. It also includes the confidence for the accuracy
of the detected bounding box. The API returns the following information regarding the
image, as part of the ImageProperties structure: Quality - Information about the
Sharpness, Brightness, and Contrast of the input image, scored between 0 to 100. Image
quality is returned for the entire image, as well as the background and the foreground.
Dominant Color - An array of the dominant colors in the image. Foreground - Information
about the sharpness, brightness, and dominant colors of the input image’s foreground.
Background - Information about the sharpness, brightness, and dominant colors of the input
image’s background. The list of returned labels will include at least one label for
every detected object, along with information about that label. In the following example,
suppose the input image has a lighthouse, the sea, and a rock. The response includes all
three labels, one for each object, as well as the confidence in the label: {Name:
lighthouse, Confidence: 98.4629} {Name: rock,Confidence: 79.2097} {Name:
sea,Confidence: 75.061} The list of labels can include multiple labels for the same
object. For example, if the input image shows a flower (for example, a tulip), the
operation might return the following three labels. {Name: flower,Confidence: 99.0562}
{Name: plant,Confidence: 99.0562} {Name: tulip,Confidence: 99.0562} In this example, the
detection algorithm more precisely identifies the flower as a tulip. If the object
detected is a person, the operation doesn't provide the same facial details that the
DetectFaces operation provides. This is a stateless API operation that doesn't return any
data. This operation requires permissions to perform the rekognition:DetectLabels action.
# Arguments
- `image`: The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI
to call Amazon Rekognition operations, passing image bytes is not supported. Images stored
in an S3 Bucket do not need to be base64-encoded. If you are using an AWS SDK to call
Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes
field. For more information, see Images in the Amazon Rekognition developer guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Features"`: A list of the types of analysis to perform. Specifying GENERAL_LABELS uses
the label detection feature, while specifying IMAGE_PROPERTIES returns information
regarding image color and quality. If no option is specified GENERAL_LABELS is used by
default.
- `"MaxLabels"`: Maximum number of labels you want the service to return in the response.
The service returns the specified number of highest confidence labels. Only valid when
GENERAL_LABELS is specified as a feature type in the Feature input parameter.
- `"MinConfidence"`: Specifies the minimum confidence level for the labels to return.
Amazon Rekognition doesn't return any labels with confidence lower than this specified
value. If MinConfidence is not specified, the operation returns labels with a confidence
values greater than or equal to 55 percent. Only valid when GENERAL_LABELS is specified as
a feature type in the Feature input parameter.
- `"Settings"`: A list of the filters to be applied to returned detected labels and image
properties. Specified filters can be inclusive, exclusive, or a combination of both.
Filters can be used for individual labels or label categories. The exact label names or
label categories must be supplied. For a full list of labels and label categories, see
Detecting labels.
"""
function detect_labels(Image; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"DetectLabels",
Dict{String,Any}("Image" => Image);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detect_labels(
Image, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"DetectLabels",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Image" => Image), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detect_moderation_labels(image)
detect_moderation_labels(image, params::Dict{String,<:Any})
Detects unsafe content in a specified JPEG or PNG format image. Use DetectModerationLabels
to moderate images depending on your requirements. For example, you might want to filter
images that contain nudity, but not images containing suggestive content. To filter images,
use the labels returned by DetectModerationLabels to determine which types of content are
appropriate. For information about moderation labels, see Detecting Unsafe Content in the
Amazon Rekognition Developer Guide. You pass the input image either as base64-encoded image
bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call
Amazon Rekognition operations, passing image bytes is not supported. The image must be
either a PNG or JPEG formatted file. You can specify an adapter to use when retrieving
label predictions by providing a ProjectVersionArn to the ProjectVersion argument.
# Arguments
- `image`: The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI
to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
If you are using an AWS SDK to call Amazon Rekognition, you might not need to
base64-encode image bytes passed using the Bytes field. For more information, see Images in
the Amazon Rekognition developer guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"HumanLoopConfig"`: Sets up the configuration for human evaluation, including the
FlowDefinition the image will be sent to.
- `"MinConfidence"`: Specifies the minimum confidence level for the labels to return.
Amazon Rekognition doesn't return any labels with a confidence level lower than this
specified value. If you don't specify MinConfidence, the operation returns labels with
confidence values greater than or equal to 50 percent.
- `"ProjectVersion"`: Identifier for the custom adapter. Expects the ProjectVersionArn as a
value. Use the CreateProject or CreateProjectVersion APIs to create a custom adapter.
"""
function detect_moderation_labels(Image; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"DetectModerationLabels",
Dict{String,Any}("Image" => Image);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detect_moderation_labels(
Image, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"DetectModerationLabels",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Image" => Image), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detect_protective_equipment(image)
detect_protective_equipment(image, params::Dict{String,<:Any})
Detects Personal Protective Equipment (PPE) worn by people detected in an image. Amazon
Rekognition can detect the following types of PPE. Face cover Hand cover Head cover
You pass the input image as base64-encoded image bytes or as a reference to an image in an
Amazon S3 bucket. The image must be either a PNG or JPG formatted file.
DetectProtectiveEquipment detects PPE worn by up to 15 persons detected in an image. For
each person detected in the image the API returns an array of body parts (face, head,
left-hand, right-hand). For each body part, an array of detected items of PPE is returned,
including an indicator of whether or not the PPE covers the body part. The API returns the
confidence it has in each detection (person, PPE, body part and body part coverage). It
also returns a bounding box (BoundingBox) for each detected person and each detected item
of PPE. You can optionally request a summary of detected PPE items with the
SummarizationAttributes input parameter. The summary provides the following information.
The persons detected as wearing all of the types of PPE that you specify. The persons
detected as not wearing all of the types PPE that you specify. The persons detected where
PPE adornment could not be determined. This is a stateless API operation. That is, the
operation does not persist any data. This operation requires permissions to perform the
rekognition:DetectProtectiveEquipment action.
# Arguments
- `image`: The image in which you want to detect PPE on detected persons. The image can be
passed as image bytes or you can reference an image stored in an Amazon S3 bucket.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SummarizationAttributes"`: An array of PPE types that you want to summarize.
"""
function detect_protective_equipment(
Image; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"DetectProtectiveEquipment",
Dict{String,Any}("Image" => Image);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detect_protective_equipment(
Image, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"DetectProtectiveEquipment",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Image" => Image), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detect_text(image)
detect_text(image, params::Dict{String,<:Any})
Detects text in the input image and converts it into machine-readable text. Pass the input
image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket.
If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a
reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not
supported. The image must be either a .png or .jpeg formatted file. The DetectText
operation returns text in an array of TextDetection elements, TextDetections. Each
TextDetection element provides information about a single word or line of text that was
detected in the image. A word is one or more script characters that are not separated by
spaces. DetectText can detect up to 100 words in an image. A line is a string of equally
spaced words. A line isn't necessarily a complete sentence. For example, a driver's license
number is detected as a line. A line ends when there is no aligned text after it. Also, a
line ends when there is a large gap between words, relative to the length of the words.
This means, depending on the gap between words, Amazon Rekognition may detect multiple
lines in text aligned in the same direction. Periods don't represent the end of a line. If
a sentence spans multiple lines, the DetectText operation returns multiple lines. To
determine whether a TextDetection element is a line of text or a word, use the
TextDetection object Type field. To be detected, text must be within +/- 90 degrees
orientation of the horizontal axis. For more information, see Detecting text in the Amazon
Rekognition Developer Guide.
# Arguments
- `image`: The input image as base64-encoded bytes or an Amazon S3 object. If you use the
AWS CLI to call Amazon Rekognition operations, you can't pass image bytes. If you are
using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image
bytes passed using the Bytes field. For more information, see Images in the Amazon
Rekognition developer guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Optional parameters that let you set the criteria that the text must meet to
be included in your response.
"""
function detect_text(Image; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"DetectText",
Dict{String,Any}("Image" => Image);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detect_text(
Image, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"DetectText",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Image" => Image), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_faces(collection_id, face_ids, user_id)
disassociate_faces(collection_id, face_ids, user_id, params::Dict{String,<:Any})
Removes the association between a Face supplied in an array of FaceIds and the User. If the
User is not present already, then a ResourceNotFound exception is thrown. If successful, an
array of faces that are disassociated from the User is returned. If a given face is already
disassociated from the given UserID, it will be ignored and not be returned in the
response. If a given face is already associated with a different User or not found in the
collection it will be returned as part of UnsuccessfulDisassociations. You can remove 1 -
100 face IDs from a user at one time.
# Arguments
- `collection_id`: The ID of an existing collection containing the UserID.
- `face_ids`: An array of face IDs to disassociate from the UserID.
- `user_id`: ID for the existing UserID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: Idempotent token used to identify the request to
DisassociateFaces. If you use the same token with multiple DisassociateFaces requests, the
same response is returned. Use ClientRequestToken to prevent the same request from being
processed more than once.
"""
function disassociate_faces(
CollectionId, FaceIds, UserId; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"DisassociateFaces",
Dict{String,Any}(
"CollectionId" => CollectionId,
"FaceIds" => FaceIds,
"UserId" => UserId,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_faces(
CollectionId,
FaceIds,
UserId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"DisassociateFaces",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CollectionId" => CollectionId,
"FaceIds" => FaceIds,
"UserId" => UserId,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
distribute_dataset_entries(datasets)
distribute_dataset_entries(datasets, params::Dict{String,<:Any})
This operation applies only to Amazon Rekognition Custom Labels. Distributes the entries
(images) in a training dataset across the training dataset and the test dataset for a
project. DistributeDatasetEntries moves 20% of the training dataset images to the test
dataset. An entry is a JSON Line that describes an image. You supply the Amazon Resource
Names (ARN) of a project's training dataset and test dataset. The training dataset must
contain the images that you want to split. The test dataset must be empty. The datasets
must belong to the same project. To create training and test datasets for a project, call
CreateDataset. Distributing a dataset takes a while to complete. To check the status call
DescribeDataset. The operation is complete when the Status field for the training dataset
and the test dataset is UPDATE_COMPLETE. If the dataset split fails, the value of Status is
UPDATE_FAILED. This operation requires permissions to perform the
rekognition:DistributeDatasetEntries action.
# Arguments
- `datasets`: The ARNS for the training dataset and test dataset that you want to use. The
datasets must belong to the same project. The test dataset must be empty.
"""
function distribute_dataset_entries(
Datasets; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"DistributeDatasetEntries",
Dict{String,Any}("Datasets" => Datasets);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function distribute_dataset_entries(
Datasets,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"DistributeDatasetEntries",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Datasets" => Datasets), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_celebrity_info(id)
get_celebrity_info(id, params::Dict{String,<:Any})
Gets the name and additional information about a celebrity based on their Amazon
Rekognition ID. The additional information is returned as an array of URLs. If there is no
additional information about the celebrity, this list is empty. For more information, see
Getting information about a celebrity in the Amazon Rekognition Developer Guide. This
operation requires permissions to perform the rekognition:GetCelebrityInfo action.
# Arguments
- `id`: The ID for the celebrity. You get the celebrity ID from a call to the
RecognizeCelebrities operation, which recognizes celebrities in an image.
"""
function get_celebrity_info(Id; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"GetCelebrityInfo",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_celebrity_info(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"GetCelebrityInfo",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_celebrity_recognition(job_id)
get_celebrity_recognition(job_id, params::Dict{String,<:Any})
Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by
StartCelebrityRecognition. Celebrity recognition in a video is an asynchronous operation.
Analysis is started by a call to StartCelebrityRecognition which returns a job identifier
(JobId). When the celebrity recognition operation finishes, Amazon Rekognition Video
publishes a completion status to the Amazon Simple Notification Service topic registered in
the initial call to StartCelebrityRecognition. To get the results of the celebrity
recognition analysis, first check that the status value published to the Amazon SNS topic
is SUCCEEDED. If so, call GetCelebrityDetection and pass the job identifier (JobId) from
the initial call to StartCelebrityDetection. For more information, see Working With Stored
Videos in the Amazon Rekognition Developer Guide. GetCelebrityRecognition returns detected
celebrities and the time(s) they are detected in an array (Celebrities) of
CelebrityRecognition objects. Each CelebrityRecognition contains information about the
celebrity in a CelebrityDetail object and the time, Timestamp, the celebrity was detected.
This CelebrityDetail object stores information about the detected celebrity's face
attributes, a face bounding box, known gender, the celebrity's name, and a confidence
estimate. GetCelebrityRecognition only returns the default facial attributes
(BoundingBox, Confidence, Landmarks, Pose, and Quality). The BoundingBox field only applies
to the detected face instance. The other facial attributes listed in the Face object of the
following response syntax are not returned. For more information, see FaceDetail in the
Amazon Rekognition Developer Guide. By default, the Celebrities array is sorted by time
(milliseconds from the start of the video). You can also sort the array by celebrity by
specifying the value ID in the SortBy input parameter. The CelebrityDetail object includes
the celebrity identifer and additional information urls. If you don't store the additional
information urls, you can get them later by calling GetCelebrityInfo with the celebrity
identifer. No information is returned for faces not recognized as celebrities. Use
MaxResults parameter to limit the number of labels returned. If there are more results than
specified in MaxResults, the value of NextToken in the operation response contains a
pagination token for getting the next set of results. To get the next page of results, call
GetCelebrityDetection and populate the NextToken request parameter with the token value
returned from the previous call to GetCelebrityRecognition.
# Arguments
- `job_id`: Job identifier for the required celebrity recognition analysis. You can get the
job identifer from a call to StartCelebrityRecognition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Maximum number of results to return per paginated call. The largest value
you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000
results is returned. The default value is 1000.
- `"NextToken"`: If the previous response was incomplete (because there is more recognized
celebrities to retrieve), Amazon Rekognition Video returns a pagination token in the
response. You can use this pagination token to retrieve the next set of celebrities.
- `"SortBy"`: Sort to use for celebrities returned in Celebrities field. Specify ID to sort
by the celebrity identifier, specify TIMESTAMP to sort by the time the celebrity was
recognized.
"""
function get_celebrity_recognition(JobId; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"GetCelebrityRecognition",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_celebrity_recognition(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"GetCelebrityRecognition",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_content_moderation(job_id)
get_content_moderation(job_id, params::Dict{String,<:Any})
Gets the inappropriate, unwanted, or offensive content analysis results for a Amazon
Rekognition Video analysis started by StartContentModeration. For a list of moderation
labels in Amazon Rekognition, see Using the image and video moderation APIs. Amazon
Rekognition Video inappropriate or offensive content detection in a stored video is an
asynchronous operation. You start analysis by calling StartContentModeration which returns
a job identifier (JobId). When analysis finishes, Amazon Rekognition Video publishes a
completion status to the Amazon Simple Notification Service topic registered in the initial
call to StartContentModeration. To get the results of the content analysis, first check
that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call
GetContentModeration and pass the job identifier (JobId) from the initial call to
StartContentModeration. For more information, see Working with Stored Videos in the Amazon
Rekognition Devlopers Guide. GetContentModeration returns detected inappropriate,
unwanted, or offensive content moderation labels, and the time they are detected, in an
array, ModerationLabels, of ContentModerationDetection objects. By default, the moderated
labels are returned sorted by time, in milliseconds from the start of the video. You can
also sort them by moderated label by specifying NAME for the SortBy input parameter. Since
video analysis can return a large number of results, use the MaxResults parameter to limit
the number of labels returned in a single call to GetContentModeration. If there are more
results than specified in MaxResults, the value of NextToken in the operation response
contains a pagination token for getting the next set of results. To get the next page of
results, call GetContentModeration and populate the NextToken request parameter with the
value of NextToken returned from the previous call to GetContentModeration. For more
information, see moderating content in the Amazon Rekognition Developer Guide.
# Arguments
- `job_id`: The identifier for the inappropriate, unwanted, or offensive content moderation
job. Use JobId to identify the job in a subsequent call to GetContentModeration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AggregateBy"`: Defines how to aggregate results of the StartContentModeration request.
Default aggregation option is TIMESTAMPS. SEGMENTS mode aggregates moderation labels over
time.
- `"MaxResults"`: Maximum number of results to return per paginated call. The largest value
you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000
results is returned. The default value is 1000.
- `"NextToken"`: If the previous response was incomplete (because there is more data to
retrieve), Amazon Rekognition returns a pagination token in the response. You can use this
pagination token to retrieve the next set of content moderation labels.
- `"SortBy"`: Sort to use for elements in the ModerationLabelDetections array. Use
TIMESTAMP to sort array elements by the time labels are detected. Use NAME to
alphabetically group elements for a label together. Within each label group, the array
element are sorted by detection confidence. The default sort is by TIMESTAMP.
"""
function get_content_moderation(JobId; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"GetContentModeration",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_content_moderation(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"GetContentModeration",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_face_detection(job_id)
get_face_detection(job_id, params::Dict{String,<:Any})
Gets face detection results for a Amazon Rekognition Video analysis started by
StartFaceDetection. Face detection with Amazon Rekognition Video is an asynchronous
operation. You start face detection by calling StartFaceDetection which returns a job
identifier (JobId). When the face detection operation finishes, Amazon Rekognition Video
publishes a completion status to the Amazon Simple Notification Service topic registered in
the initial call to StartFaceDetection. To get the results of the face detection operation,
first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so,
call GetFaceDetection and pass the job identifier (JobId) from the initial call to
StartFaceDetection. GetFaceDetection returns an array of detected faces (Faces) sorted by
the time the faces were detected. Use MaxResults parameter to limit the number of labels
returned. If there are more results than specified in MaxResults, the value of NextToken in
the operation response contains a pagination token for getting the next set of results. To
get the next page of results, call GetFaceDetection and populate the NextToken request
parameter with the token value returned from the previous call to GetFaceDetection. Note
that for the GetFaceDetection operation, the returned values for FaceOccluded and
EyeDirection will always be \"null\".
# Arguments
- `job_id`: Unique identifier for the face detection job. The JobId is returned from
StartFaceDetection.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Maximum number of results to return per paginated call. The largest value
you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000
results is returned. The default value is 1000.
- `"NextToken"`: If the previous response was incomplete (because there are more faces to
retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use
this pagination token to retrieve the next set of faces.
"""
function get_face_detection(JobId; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"GetFaceDetection",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_face_detection(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"GetFaceDetection",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_face_liveness_session_results(session_id)
get_face_liveness_session_results(session_id, params::Dict{String,<:Any})
Retrieves the results of a specific Face Liveness session. It requires the sessionId as
input, which was created using CreateFaceLivenessSession. Returns the corresponding Face
Liveness confidence score, a reference image that includes a face bounding box, and audit
images that also contain face bounding boxes. The Face Liveness confidence score ranges
from 0 to 100. The number of audit images returned by GetFaceLivenessSessionResults is
defined by the AuditImagesLimit paramater when calling CreateFaceLivenessSession. Reference
images are always returned when possible.
# Arguments
- `session_id`: A unique 128-bit UUID. This is used to uniquely identify the session and
also acts as an idempotency token for all operations associated with the session.
"""
function get_face_liveness_session_results(
SessionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"GetFaceLivenessSessionResults",
Dict{String,Any}("SessionId" => SessionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_face_liveness_session_results(
SessionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"GetFaceLivenessSessionResults",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SessionId" => SessionId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_face_search(job_id)
get_face_search(job_id, params::Dict{String,<:Any})
Gets the face search results for Amazon Rekognition Video face search started by
StartFaceSearch. The search returns faces in a collection that match the faces of persons
detected in a video. It also includes the time(s) that faces are matched in the video. Face
search in a video is an asynchronous operation. You start face search by calling to
StartFaceSearch which returns a job identifier (JobId). When the search operation finishes,
Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification
Service topic registered in the initial call to StartFaceSearch. To get the search results,
first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so,
call GetFaceSearch and pass the job identifier (JobId) from the initial call to
StartFaceSearch. For more information, see Searching Faces in a Collection in the Amazon
Rekognition Developer Guide. The search results are retured in an array, Persons, of
PersonMatch objects. EachPersonMatch element contains details about the matching faces in
the input collection, person information (facial attributes, bounding boxes, and person
identifer) for the matched person, and the time the person was matched in the video.
GetFaceSearch only returns the default facial attributes (BoundingBox, Confidence,
Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the
following response syntax are not returned. For more information, see FaceDetail in the
Amazon Rekognition Developer Guide. By default, the Persons array is sorted by the time,
in milliseconds from the start of the video, persons are matched. You can also sort by
persons by specifying INDEX for the SORTBY input parameter.
# Arguments
- `job_id`: The job identifer for the search request. You get the job identifier from an
initial call to StartFaceSearch.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Maximum number of results to return per paginated call. The largest value
you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000
results is returned. The default value is 1000.
- `"NextToken"`: If the previous response was incomplete (because there is more search
results to retrieve), Amazon Rekognition Video returns a pagination token in the response.
You can use this pagination token to retrieve the next set of search results.
- `"SortBy"`: Sort to use for grouping faces in the response. Use TIMESTAMP to group faces
by the time that they are recognized. Use INDEX to sort by recognized faces.
"""
function get_face_search(JobId; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"GetFaceSearch",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_face_search(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"GetFaceSearch",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_label_detection(job_id)
get_label_detection(job_id, params::Dict{String,<:Any})
Gets the label detection results of a Amazon Rekognition Video analysis started by
StartLabelDetection. The label detection operation is started by a call to
StartLabelDetection which returns a job identifier (JobId). When the label detection
operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple
Notification Service topic registered in the initial call to StartlabelDetection. To get
the results of the label detection operation, first check that the status value published
to the Amazon SNS topic is SUCCEEDED. If so, call GetLabelDetection and pass the job
identifier (JobId) from the initial call to StartLabelDetection. GetLabelDetection returns
an array of detected labels (Labels) sorted by the time the labels were detected. You can
also sort by the label name by specifying NAME for the SortBy input parameter. If there is
no NAME specified, the default sort is by timestamp. You can select how results are
aggregated by using the AggregateBy input parameter. The default aggregation method is
TIMESTAMPS. You can also aggregate by SEGMENTS, which aggregates all instances of labels
detected in a given segment. The returned Labels array may include the following
attributes: Name - The name of the detected label. Confidence - The level of confidence
in the label assigned to a detected object. Parents - The ancestor labels for a detected
label. GetLabelDetection returns a hierarchical taxonomy of detected labels. For example, a
detected car might be assigned the label car. The label car has two parent labels: Vehicle
(its parent) and Transportation (its grandparent). The response includes the all ancestors
for a label, where every ancestor is a unique label. In the previous example, Car, Vehicle,
and Transportation are returned as unique labels in the response. Aliases - Possible
Aliases for the label. Categories - The label categories that the detected label belongs
to. BoundingBox — Bounding boxes are described for all instances of detected common
object labels, returned in an array of Instance objects. An Instance object contains a
BoundingBox object, describing the location of the label on the input image. It also
includes the confidence for the accuracy of the detected bounding box. Timestamp - Time,
in milliseconds from the start of the video, that the label was detected. For aggregation
by SEGMENTS, the StartTimestampMillis, EndTimestampMillis, and DurationMillis structures
are what define a segment. Although the “Timestamp” structure is still returned with
each label, its value is set to be the same as StartTimestampMillis. Timestamp and
Bounding box information are returned for detected Instances, only if aggregation is done
by TIMESTAMPS. If aggregating by SEGMENTS, information about detected instances isn’t
returned. The version of the label model used for the detection is also returned. Note
DominantColors isn't returned for Instances, although it is shown as part of the response
in the sample seen below. Use MaxResults parameter to limit the number of labels returned.
If there are more results than specified in MaxResults, the value of NextToken in the
operation response contains a pagination token for getting the next set of results. To get
the next page of results, call GetlabelDetection and populate the NextToken request
parameter with the token value returned from the previous call to GetLabelDetection.
# Arguments
- `job_id`: Job identifier for the label detection operation for which you want results
returned. You get the job identifer from an initial call to StartlabelDetection.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AggregateBy"`: Defines how to aggregate the returned results. Results can be aggregated
by timestamps or segments.
- `"MaxResults"`: Maximum number of results to return per paginated call. The largest value
you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000
results is returned. The default value is 1000.
- `"NextToken"`: If the previous response was incomplete (because there are more labels to
retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use
this pagination token to retrieve the next set of labels.
- `"SortBy"`: Sort to use for elements in the Labels array. Use TIMESTAMP to sort array
elements by the time labels are detected. Use NAME to alphabetically group elements for a
label together. Within each label group, the array element are sorted by detection
confidence. The default sort is by TIMESTAMP.
"""
function get_label_detection(JobId; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"GetLabelDetection",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_label_detection(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"GetLabelDetection",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_media_analysis_job(job_id)
get_media_analysis_job(job_id, params::Dict{String,<:Any})
Retrieves the results for a given media analysis job. Takes a JobId returned by
StartMediaAnalysisJob.
# Arguments
- `job_id`: Unique identifier for the media analysis job for which you want to retrieve
results.
"""
function get_media_analysis_job(JobId; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"GetMediaAnalysisJob",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_media_analysis_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"GetMediaAnalysisJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_person_tracking(job_id)
get_person_tracking(job_id, params::Dict{String,<:Any})
Gets the path tracking results of a Amazon Rekognition Video analysis started by
StartPersonTracking. The person path tracking operation is started by a call to
StartPersonTracking which returns a job identifier (JobId). When the operation finishes,
Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification
Service topic registered in the initial call to StartPersonTracking. To get the results of
the person path tracking operation, first check that the status value published to the
Amazon SNS topic is SUCCEEDED. If so, call GetPersonTracking and pass the job identifier
(JobId) from the initial call to StartPersonTracking. GetPersonTracking returns an array,
Persons, of tracked persons and the time(s) their paths were tracked in the video.
GetPersonTracking only returns the default facial attributes (BoundingBox, Confidence,
Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the
following response syntax are not returned. For more information, see FaceDetail in the
Amazon Rekognition Developer Guide. By default, the array is sorted by the time(s) a
person's path is tracked in the video. You can sort by tracked persons by specifying INDEX
for the SortBy input parameter. Use the MaxResults parameter to limit the number of items
returned. If there are more results than specified in MaxResults, the value of NextToken in
the operation response contains a pagination token for getting the next set of results. To
get the next page of results, call GetPersonTracking and populate the NextToken request
parameter with the token value returned from the previous call to GetPersonTracking.
# Arguments
- `job_id`: The identifier for a job that tracks persons in a video. You get the JobId from
a call to StartPersonTracking.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Maximum number of results to return per paginated call. The largest value
you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000
results is returned. The default value is 1000.
- `"NextToken"`: If the previous response was incomplete (because there are more persons to
retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use
this pagination token to retrieve the next set of persons.
- `"SortBy"`: Sort to use for elements in the Persons array. Use TIMESTAMP to sort array
elements by the time persons are detected. Use INDEX to sort by the tracked persons. If you
sort by INDEX, the array elements for each person are sorted by detection confidence. The
default sort is by TIMESTAMP.
"""
function get_person_tracking(JobId; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"GetPersonTracking",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_person_tracking(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"GetPersonTracking",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_segment_detection(job_id)
get_segment_detection(job_id, params::Dict{String,<:Any})
Gets the segment detection results of a Amazon Rekognition Video analysis started by
StartSegmentDetection. Segment detection with Amazon Rekognition Video is an asynchronous
operation. You start segment detection by calling StartSegmentDetection which returns a job
identifier (JobId). When the segment detection operation finishes, Amazon Rekognition
publishes a completion status to the Amazon Simple Notification Service topic registered in
the initial call to StartSegmentDetection. To get the results of the segment detection
operation, first check that the status value published to the Amazon SNS topic is
SUCCEEDED. if so, call GetSegmentDetection and pass the job identifier (JobId) from the
initial call of StartSegmentDetection. GetSegmentDetection returns detected segments in an
array (Segments) of SegmentDetection objects. Segments is sorted by the segment types
specified in the SegmentTypes input parameter of StartSegmentDetection. Each element of the
array includes the detected segment, the precentage confidence in the acuracy of the
detected segment, the type of the segment, and the frame in which the segment was detected.
Use SelectedSegmentTypes to find out the type of segment detection requested in the call to
StartSegmentDetection. Use the MaxResults parameter to limit the number of segment
detections returned. If there are more results than specified in MaxResults, the value of
NextToken in the operation response contains a pagination token for getting the next set of
results. To get the next page of results, call GetSegmentDetection and populate the
NextToken request parameter with the token value returned from the previous call to
GetSegmentDetection. For more information, see Detecting video segments in stored video in
the Amazon Rekognition Developer Guide.
# Arguments
- `job_id`: Job identifier for the text detection operation for which you want results
returned. You get the job identifer from an initial call to StartSegmentDetection.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Maximum number of results to return per paginated call. The largest value
you can specify is 1000.
- `"NextToken"`: If the response is truncated, Amazon Rekognition Video returns this token
that you can use in the subsequent request to retrieve the next set of text.
"""
function get_segment_detection(JobId; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"GetSegmentDetection",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_segment_detection(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"GetSegmentDetection",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_text_detection(job_id)
get_text_detection(job_id, params::Dict{String,<:Any})
Gets the text detection results of a Amazon Rekognition Video analysis started by
StartTextDetection. Text detection with Amazon Rekognition Video is an asynchronous
operation. You start text detection by calling StartTextDetection which returns a job
identifier (JobId) When the text detection operation finishes, Amazon Rekognition publishes
a completion status to the Amazon Simple Notification Service topic registered in the
initial call to StartTextDetection. To get the results of the text detection operation,
first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so,
call GetTextDetection and pass the job identifier (JobId) from the initial call of
StartLabelDetection. GetTextDetection returns an array of detected text (TextDetections)
sorted by the time the text was detected, up to 100 words per frame of video. Each element
of the array includes the detected text, the precentage confidence in the acuracy of the
detected text, the time the text was detected, bounding box information for where the text
was located, and unique identifiers for words and their lines. Use MaxResults parameter to
limit the number of text detections returned. If there are more results than specified in
MaxResults, the value of NextToken in the operation response contains a pagination token
for getting the next set of results. To get the next page of results, call GetTextDetection
and populate the NextToken request parameter with the token value returned from the
previous call to GetTextDetection.
# Arguments
- `job_id`: Job identifier for the text detection operation for which you want results
returned. You get the job identifer from an initial call to StartTextDetection.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Maximum number of results to return per paginated call. The largest value
you can specify is 1000.
- `"NextToken"`: If the previous response was incomplete (because there are more labels to
retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use
this pagination token to retrieve the next set of text.
"""
function get_text_detection(JobId; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"GetTextDetection",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_text_detection(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"GetTextDetection",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
index_faces(collection_id, image)
index_faces(collection_id, image, params::Dict{String,<:Any})
Detects faces in the input image and adds them to the specified collection. Amazon
Rekognition doesn't save the actual faces that are detected. Instead, the underlying
detection algorithm first detects the faces in the input image. For each face, the
algorithm extracts facial features into a feature vector, and stores it in the backend
database. Amazon Rekognition uses feature vectors when it performs face match and search
operations using the SearchFaces and SearchFacesByImage operations. For more information,
see Adding faces to a collection in the Amazon Rekognition Developer Guide. To get the
number of faces in a collection, call DescribeCollection. If you're using version 1.0 of
the face detection model, IndexFaces indexes the 15 largest faces in the input image. Later
versions of the face detection model index the 100 largest faces in the input image. If
you're using version 4 or later of the face model, image orientation information is not
returned in the OrientationCorrection field. To determine which version of the model
you're using, call DescribeCollection and supply the collection ID. You can also get the
model version from the value of FaceModelVersion in the response from IndexFaces For more
information, see Model Versioning in the Amazon Rekognition Developer Guide. If you provide
the optional ExternalImageId for the input image you provided, Amazon Rekognition
associates this ID with all faces that it detects. When you call the ListFaces operation,
the response returns the external ID. You can use this external image ID to create a
client-side index to associate the faces with each image. You can then use the index to
find all faces in an image. You can specify the maximum number of faces to index with the
MaxFaces input parameter. This is useful when you want to index the largest faces in an
image and don't want to index smaller faces, such as those belonging to people standing in
the background. The QualityFilter input parameter allows you to filter out detected faces
that don’t meet a required quality bar. The quality bar is based on a variety of common
use cases. By default, IndexFaces chooses the quality bar that's used to filter faces. You
can also explicitly choose the quality bar. Use QualityFilter, to set the quality bar by
specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE.
To use quality filtering, you need a collection associated with version 3 of the face
model or higher. To get the version of the face model associated with a collection, call
DescribeCollection. Information about faces detected in an image, but not indexed, is
returned in an array of UnindexedFace objects, UnindexedFaces. Faces aren't indexed for
reasons such as: The number of faces detected exceeds the value of the MaxFaces request
parameter. The face is too small compared to the image dimensions. The face is too
blurry. The image is too dark. The face has an extreme pose. The face doesn’t have
enough detail to be suitable for face search. In response, the IndexFaces operation
returns an array of metadata for all detected faces, FaceRecords. This includes: The
bounding box, BoundingBox, of the detected face. A confidence value, Confidence, which
indicates the confidence that the bounding box contains a face. A face ID, FaceId,
assigned by the service for each face that's detected and stored. An image ID, ImageId,
assigned by the service for the input image. If you request ALL or specific facial
attributes (e.g., FACE_OCCLUDED) by using the detectionAttributes parameter, Amazon
Rekognition returns detailed facial attributes, such as facial landmarks (for example,
location of eye and mouth), facial occlusion, and other facial attributes. If you provide
the same image, specify the same collection, and use the same external ID in the IndexFaces
operation, Amazon Rekognition doesn't save duplicate face metadata. The input image is
passed either as base64-encoded image bytes, or as a reference to an image in an Amazon S3
bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes
isn't supported. The image must be formatted as a PNG or JPEG file. This operation
requires permissions to perform the rekognition:IndexFaces action.
# Arguments
- `collection_id`: The ID of an existing collection to which you want to add the faces that
are detected in the input images.
- `image`: The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI
to call Amazon Rekognition operations, passing base64-encoded image bytes isn't supported.
If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode
image bytes passed using the Bytes field. For more information, see Images in the Amazon
Rekognition developer guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DetectionAttributes"`: An array of facial attributes you want to be returned. A DEFAULT
subset of facial attributes - BoundingBox, Confidence, Pose, Quality, and Landmarks - will
always be returned. You can request for specific facial attributes (in addition to the
default list) - by using [\"DEFAULT\", \"FACE_OCCLUDED\"] or just [\"FACE_OCCLUDED\"]. You
can request for all facial attributes by using [\"ALL\"]. Requesting more attributes may
increase response time. If you provide both, [\"ALL\", \"DEFAULT\"], the service uses a
logical AND operator to determine which attributes to return (in this case, all
attributes).
- `"ExternalImageId"`: The ID you want to assign to all the faces detected in the image.
- `"MaxFaces"`: The maximum number of faces to index. The value of MaxFaces must be greater
than or equal to 1. IndexFaces returns no more than 100 detected faces in an image, even if
you specify a larger value for MaxFaces. If IndexFaces detects more faces than the value of
MaxFaces, the faces with the lowest quality are filtered out first. If there are still more
faces than the value of MaxFaces, the faces with the smallest bounding boxes are filtered
out (up to the number that's needed to satisfy the value of MaxFaces). Information about
the unindexed faces is available in the UnindexedFaces array. The faces that are returned
by IndexFaces are sorted by the largest face bounding box size to the smallest size, in
descending order. MaxFaces can be used with a collection associated with any version of
the face model.
- `"QualityFilter"`: A filter that specifies a quality bar for how much filtering is done
to identify faces. Filtered faces aren't indexed. If you specify AUTO, Amazon Rekognition
chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces
that don’t meet the chosen quality bar. The default value is AUTO. The quality bar is
based on a variety of common use cases. Low-quality detections can occur for a number of
reasons. Some examples are an object that's misidentified as a face, a face that's too
blurry, or a face with a pose that's too extreme to use. If you specify NONE, no filtering
is performed. To use quality filtering, the collection you are using must be associated
with version 3 of the face model or higher.
"""
function index_faces(CollectionId, Image; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"IndexFaces",
Dict{String,Any}("CollectionId" => CollectionId, "Image" => Image);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function index_faces(
CollectionId,
Image,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"IndexFaces",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CollectionId" => CollectionId, "Image" => Image),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_collections()
list_collections(params::Dict{String,<:Any})
Returns list of collection IDs in your account. If the result is truncated, the response
also provides a NextToken that you can use in the subsequent request to fetch the next set
of collection IDs. For an example, see Listing collections in the Amazon Rekognition
Developer Guide. This operation requires permissions to perform the
rekognition:ListCollections action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Maximum number of collection IDs to return.
- `"NextToken"`: Pagination token from the previous response.
"""
function list_collections(; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"ListCollections"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_collections(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"ListCollections", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_dataset_entries(dataset_arn)
list_dataset_entries(dataset_arn, params::Dict{String,<:Any})
This operation applies only to Amazon Rekognition Custom Labels. Lists the entries
(images) within a dataset. An entry is a JSON Line that contains the information for a
single image, including the image location, assigned labels, and object location bounding
boxes. For more information, see Creating a manifest file. JSON Lines in the response
include information about non-terminal errors found in the dataset. Non terminal errors are
reported in errors lists within each JSON Line. The same information is reported in the
training and testing validation result manifests that Amazon Rekognition Custom Labels
creates during model training. You can filter the response in variety of ways, such as
choosing which labels to return and returning JSON Lines created after a specific date.
This operation requires permissions to perform the rekognition:ListDatasetEntries action.
# Arguments
- `dataset_arn`: The Amazon Resource Name (ARN) for the dataset that you want to use.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ContainsLabels"`: Specifies a label filter for the response. The response includes an
entry only if one or more of the labels in ContainsLabels exist in the entry.
- `"HasErrors"`: Specifies an error filter for the response. Specify True to only include
entries that have errors.
- `"Labeled"`: Specify true to get only the JSON Lines where the image is labeled. Specify
false to get only the JSON Lines where the image isn't labeled. If you don't specify
Labeled, ListDatasetEntries returns JSON Lines for labeled and unlabeled images.
- `"MaxResults"`: The maximum number of results to return per paginated call. The largest
value you can specify is 100. If you specify a value greater than 100, a
ValidationException error occurs. The default value is 100.
- `"NextToken"`: If the previous response was incomplete (because there is more results to
retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You
can use this pagination token to retrieve the next set of results.
- `"SourceRefContains"`: If specified, ListDatasetEntries only returns JSON Lines where the
value of SourceRefContains is part of the source-ref field. The source-ref field contains
the Amazon S3 location of the image. You can use SouceRefContains for tasks such as getting
the JSON Line for a single image, or gettting JSON Lines for all images within a specific
folder.
"""
function list_dataset_entries(DatasetArn; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"ListDatasetEntries",
Dict{String,Any}("DatasetArn" => DatasetArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_dataset_entries(
DatasetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"ListDatasetEntries",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DatasetArn" => DatasetArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_dataset_labels(dataset_arn)
list_dataset_labels(dataset_arn, params::Dict{String,<:Any})
This operation applies only to Amazon Rekognition Custom Labels. Lists the labels in a
dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more
information, see Labeling images. Lists the labels in a dataset. Amazon Rekognition
Custom Labels uses labels to describe images. For more information, see Labeling images in
the Amazon Rekognition Custom Labels Developer Guide.
# Arguments
- `dataset_arn`: The Amazon Resource Name (ARN) of the dataset that you want to use.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to return per paginated call. The largest
value you can specify is 100. If you specify a value greater than 100, a
ValidationException error occurs. The default value is 100.
- `"NextToken"`: If the previous response was incomplete (because there is more results to
retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You
can use this pagination token to retrieve the next set of results.
"""
function list_dataset_labels(DatasetArn; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"ListDatasetLabels",
Dict{String,Any}("DatasetArn" => DatasetArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_dataset_labels(
DatasetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"ListDatasetLabels",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DatasetArn" => DatasetArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_faces(collection_id)
list_faces(collection_id, params::Dict{String,<:Any})
Returns metadata for faces in the specified collection. This metadata includes information
such as the bounding box coordinates, the confidence (that the bounding box contains a
face), and face ID. For an example, see Listing Faces in a Collection in the Amazon
Rekognition Developer Guide. This operation requires permissions to perform the
rekognition:ListFaces action.
# Arguments
- `collection_id`: ID of the collection from which to list the faces.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FaceIds"`: An array of face IDs to filter results with when listing faces in a
collection.
- `"MaxResults"`: Maximum number of faces to return.
- `"NextToken"`: If the previous response was incomplete (because there is more data to
retrieve), Amazon Rekognition returns a pagination token in the response. You can use this
pagination token to retrieve the next set of faces.
- `"UserId"`: An array of user IDs to filter results with when listing faces in a
collection.
"""
function list_faces(CollectionId; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"ListFaces",
Dict{String,Any}("CollectionId" => CollectionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_faces(
CollectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"ListFaces",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("CollectionId" => CollectionId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_media_analysis_jobs()
list_media_analysis_jobs(params::Dict{String,<:Any})
Returns a list of media analysis jobs. Results are sorted by CreationTimestamp in
descending order.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to return per paginated call. The largest
value user can specify is 100. If user specifies a value greater than 100, an
InvalidParameterException error occurs. The default value is 100.
- `"NextToken"`: Pagination token, if the previous response was incomplete.
"""
function list_media_analysis_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"ListMediaAnalysisJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_media_analysis_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"ListMediaAnalysisJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_project_policies(project_arn)
list_project_policies(project_arn, params::Dict{String,<:Any})
This operation applies only to Amazon Rekognition Custom Labels. Gets a list of the
project policies attached to a project. To attach a project policy to a project, call
PutProjectPolicy. To remove a project policy from a project, call DeleteProjectPolicy. This
operation requires permissions to perform the rekognition:ListProjectPolicies action.
# Arguments
- `project_arn`: The ARN of the project for which you want to list the project policies.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to return per paginated call. The largest
value you can specify is 5. If you specify a value greater than 5, a ValidationException
error occurs. The default value is 5.
- `"NextToken"`: If the previous response was incomplete (because there is more results to
retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You
can use this pagination token to retrieve the next set of results.
"""
function list_project_policies(
ProjectArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"ListProjectPolicies",
Dict{String,Any}("ProjectArn" => ProjectArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_project_policies(
ProjectArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"ListProjectPolicies",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ProjectArn" => ProjectArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_stream_processors()
list_stream_processors(params::Dict{String,<:Any})
Gets a list of stream processors that you have created with CreateStreamProcessor.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Maximum number of stream processors you want Amazon Rekognition Video to
return in the response. The default is 1000.
- `"NextToken"`: If the previous response was incomplete (because there are more stream
processors to retrieve), Amazon Rekognition Video returns a pagination token in the
response. You can use this pagination token to retrieve the next set of stream processors.
"""
function list_stream_processors(; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"ListStreamProcessors"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_stream_processors(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"ListStreamProcessors",
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 in an Amazon Rekognition collection, stream processor, or Custom
Labels model. This operation requires permissions to perform the
rekognition:ListTagsForResource action.
# Arguments
- `resource_arn`: Amazon Resource Name (ARN) of the model, collection, or stream processor
that contains the tags that you want a list of.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"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 rekognition(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_users(collection_id)
list_users(collection_id, params::Dict{String,<:Any})
Returns metadata of the User such as UserID in the specified collection. Anonymous User (to
reserve faces without any identity) is not returned as part of this request. The results
are sorted by system generated primary key ID. If the response is truncated, NextToken is
returned in the response that can be used in the subsequent request to retrieve the next
set of identities.
# Arguments
- `collection_id`: The ID of an existing collection.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Maximum number of UsersID to return.
- `"NextToken"`: Pagingation token to receive the next set of UsersID.
"""
function list_users(CollectionId; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"ListUsers",
Dict{String,Any}("CollectionId" => CollectionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_users(
CollectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"ListUsers",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("CollectionId" => CollectionId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_project_policy(policy_document, policy_name, project_arn)
put_project_policy(policy_document, policy_name, project_arn, params::Dict{String,<:Any})
This operation applies only to Amazon Rekognition Custom Labels. Attaches a project
policy to a Amazon Rekognition Custom Labels project in a trusting AWS account. A project
policy specifies that a trusted AWS account can copy a model version from a trusting AWS
account to a project in the trusted AWS account. To copy a model version you use the
CopyProjectVersion operation. Only applies to Custom Labels projects. For more information
about the format of a project policy document, see Attaching a project policy (SDK) in the
Amazon Rekognition Custom Labels Developer Guide. The response from PutProjectPolicy is a
revision ID for the project policy. You can attach multiple project policies to a project.
You can also update an existing project policy by specifying the policy revision ID of the
existing policy. To remove a project policy from a project, call DeleteProjectPolicy. To
get a list of project policies attached to a project, call ListProjectPolicies. You copy a
model version by calling CopyProjectVersion. This operation requires permissions to perform
the rekognition:PutProjectPolicy action.
# Arguments
- `policy_document`: A resource policy to add to the model. The policy is a JSON structure
that contains one or more statements that define the policy. The policy must follow the IAM
syntax. For more information about the contents of a JSON policy document, see IAM JSON
policy reference.
- `policy_name`: A name for the policy.
- `project_arn`: The Amazon Resource Name (ARN) of the project that the project policy is
attached to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PolicyRevisionId"`: The revision ID for the Project Policy. Each time you modify a
policy, Amazon Rekognition Custom Labels generates and assigns a new PolicyRevisionId and
then deletes the previous version of the policy.
"""
function put_project_policy(
PolicyDocument,
PolicyName,
ProjectArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"PutProjectPolicy",
Dict{String,Any}(
"PolicyDocument" => PolicyDocument,
"PolicyName" => PolicyName,
"ProjectArn" => ProjectArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_project_policy(
PolicyDocument,
PolicyName,
ProjectArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"PutProjectPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PolicyDocument" => PolicyDocument,
"PolicyName" => PolicyName,
"ProjectArn" => ProjectArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
recognize_celebrities(image)
recognize_celebrities(image, params::Dict{String,<:Any})
Returns an array of celebrities recognized in the input image. For more information, see
Recognizing celebrities in the Amazon Rekognition Developer Guide. RecognizeCelebrities
returns the 64 largest faces in the image. It lists the recognized celebrities in the
CelebrityFaces array and any unrecognized faces in the UnrecognizedFaces array.
RecognizeCelebrities doesn't return celebrities whose faces aren't among the largest 64
faces in the image. For each celebrity recognized, RecognizeCelebrities returns a Celebrity
object. The Celebrity object contains the celebrity name, ID, URL links to additional
information, match confidence, and a ComparedFace object that you can use to locate the
celebrity's face on the image. Amazon Rekognition doesn't retain information about which
images a celebrity has been recognized in. Your application must store this information and
use the Celebrity ID property as a unique identifier for the celebrity. If you don't store
the celebrity name or additional information URLs returned by RecognizeCelebrities, you
will need the ID to identify the celebrity in a call to the GetCelebrityInfo operation. You
pass the input image either as base64-encoded image bytes or as a reference to an image in
an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing
image bytes is not supported. The image must be either a PNG or JPEG formatted file. For
an example, see Recognizing celebrities in an image in the Amazon Rekognition Developer
Guide. This operation requires permissions to perform the rekognition:RecognizeCelebrities
operation.
# Arguments
- `image`: The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI
to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
If you are using an AWS SDK to call Amazon Rekognition, you might not need to
base64-encode image bytes passed using the Bytes field. For more information, see Images in
the Amazon Rekognition developer guide.
"""
function recognize_celebrities(Image; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"RecognizeCelebrities",
Dict{String,Any}("Image" => Image);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function recognize_celebrities(
Image, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"RecognizeCelebrities",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Image" => Image), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_faces(collection_id, face_id)
search_faces(collection_id, face_id, params::Dict{String,<:Any})
For a given input face ID, searches for matching faces in the collection the face belongs
to. You get a face ID when you add a face to the collection using the IndexFaces operation.
The operation compares the features of the input face with faces in the specified
collection. You can also search faces without indexing faces by using the
SearchFacesByImage operation. The operation response returns an array of faces that
match, ordered by similarity score with the highest similarity first. More specifically, it
is an array of metadata for each face match that is found. Along with the metadata, the
response also includes a confidence value for each face match, indicating the confidence
that the specific face matches the input face. For an example, see Searching for a face
using its face ID in the Amazon Rekognition Developer Guide. This operation requires
permissions to perform the rekognition:SearchFaces action.
# Arguments
- `collection_id`: ID of the collection the face belongs to.
- `face_id`: ID of a face to find matches for in the collection.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FaceMatchThreshold"`: Optional value specifying the minimum confidence in the face
match to return. For example, don't return any matches where confidence in matches is less
than 70%. The default value is 80%.
- `"MaxFaces"`: Maximum number of faces to return. The operation returns the maximum number
of faces with the highest confidence in the match.
"""
function search_faces(
CollectionId, FaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"SearchFaces",
Dict{String,Any}("CollectionId" => CollectionId, "FaceId" => FaceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_faces(
CollectionId,
FaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"SearchFaces",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CollectionId" => CollectionId, "FaceId" => FaceId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_faces_by_image(collection_id, image)
search_faces_by_image(collection_id, image, params::Dict{String,<:Any})
For a given input image, first detects the largest face in the image, and then searches the
specified collection for matching faces. The operation compares the features of the input
face with faces in the specified collection. To search for all faces in an input image,
you might first call the IndexFaces operation, and then use the face IDs returned in
subsequent calls to the SearchFaces operation. You can also call the DetectFaces
operation and use the bounding boxes in the response to make face crops, which then you can
pass in to the SearchFacesByImage operation. You pass the input image either as
base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use
the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported.
The image must be either a PNG or JPEG formatted file. The response returns an array of
faces that match, ordered by similarity score with the highest similarity first. More
specifically, it is an array of metadata for each face match found. Along with the
metadata, the response also includes a similarity indicating how similar the face is to the
input face. In the response, the operation also returns the bounding box (and a confidence
level that the bounding box contains a face) of the face that Amazon Rekognition used for
the input image. If no faces are detected in the input image, SearchFacesByImage returns
an InvalidParameterException error. For an example, Searching for a Face Using an Image in
the Amazon Rekognition Developer Guide. The QualityFilter input parameter allows you to
filter out detected faces that don’t meet a required quality bar. The quality bar is
based on a variety of common use cases. Use QualityFilter to set the quality bar for
filtering by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces,
specify NONE. The default value is NONE. To use quality filtering, you need a collection
associated with version 3 of the face model or higher. To get the version of the face model
associated with a collection, call DescribeCollection. This operation requires
permissions to perform the rekognition:SearchFacesByImage action.
# Arguments
- `collection_id`: ID of the collection to search.
- `image`: The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI
to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
If you are using an AWS SDK to call Amazon Rekognition, you might not need to
base64-encode image bytes passed using the Bytes field. For more information, see Images in
the Amazon Rekognition developer guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FaceMatchThreshold"`: (Optional) Specifies the minimum confidence in the face match to
return. For example, don't return any matches where confidence in matches is less than 70%.
The default value is 80%.
- `"MaxFaces"`: Maximum number of faces to return. The operation returns the maximum number
of faces with the highest confidence in the match.
- `"QualityFilter"`: A filter that specifies a quality bar for how much filtering is done
to identify faces. Filtered faces aren't searched for in the collection. If you specify
AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH,
filtering removes all faces that don’t meet the chosen quality bar. The quality bar is
based on a variety of common use cases. Low-quality detections can occur for a number of
reasons. Some examples are an object that's misidentified as a face, a face that's too
blurry, or a face with a pose that's too extreme to use. If you specify NONE, no filtering
is performed. The default value is NONE. To use quality filtering, the collection you are
using must be associated with version 3 of the face model or higher.
"""
function search_faces_by_image(
CollectionId, Image; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"SearchFacesByImage",
Dict{String,Any}("CollectionId" => CollectionId, "Image" => Image);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_faces_by_image(
CollectionId,
Image,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"SearchFacesByImage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CollectionId" => CollectionId, "Image" => Image),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_users(collection_id)
search_users(collection_id, params::Dict{String,<:Any})
Searches for UserIDs within a collection based on a FaceId or UserId. This API can be used
to find the closest UserID (with a highest similarity) to associate a face. The request
must be provided with either FaceId or UserId. The operation returns an array of UserID
that match the FaceId or UserId, ordered by similarity score with the highest similarity
first.
# Arguments
- `collection_id`: The ID of an existing collection containing the UserID, used with a
UserId or FaceId. If a FaceId is provided, UserId isn’t required to be present in the
Collection.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FaceId"`: ID for the existing face.
- `"MaxUsers"`: Maximum number of identities to return.
- `"UserId"`: ID for the existing User.
- `"UserMatchThreshold"`: Optional value that specifies the minimum confidence in the
matched UserID to return. Default value of 80.
"""
function search_users(CollectionId; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"SearchUsers",
Dict{String,Any}("CollectionId" => CollectionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_users(
CollectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"SearchUsers",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("CollectionId" => CollectionId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_users_by_image(collection_id, image)
search_users_by_image(collection_id, image, params::Dict{String,<:Any})
Searches for UserIDs using a supplied image. It first detects the largest face in the
image, and then searches a specified collection for matching UserIDs. The operation
returns an array of UserIDs that match the face in the supplied image, ordered by
similarity score with the highest similarity first. It also returns a bounding box for the
face found in the input image. Information about faces detected in the supplied image, but
not used for the search, is returned in an array of UnsearchedFace objects. If no valid
face is detected in the image, the response will contain an empty UserMatches list and no
SearchedFace object.
# Arguments
- `collection_id`: The ID of an existing collection containing the UserID.
- `image`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxUsers"`: Maximum number of UserIDs to return.
- `"QualityFilter"`: A filter that specifies a quality bar for how much filtering is done
to identify faces. Filtered faces aren't searched for in the collection. The default value
is NONE.
- `"UserMatchThreshold"`: Specifies the minimum confidence in the UserID match to return.
Default value is 80.
"""
function search_users_by_image(
CollectionId, Image; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"SearchUsersByImage",
Dict{String,Any}("CollectionId" => CollectionId, "Image" => Image);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_users_by_image(
CollectionId,
Image,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"SearchUsersByImage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CollectionId" => CollectionId, "Image" => Image),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_celebrity_recognition(video)
start_celebrity_recognition(video, params::Dict{String,<:Any})
Starts asynchronous recognition of celebrities in a stored video. Amazon Rekognition Video
can detect celebrities in a video must be stored in an Amazon S3 bucket. Use Video to
specify the bucket name and the filename of the video. StartCelebrityRecognition returns a
job identifier (JobId) which you use to get the results of the analysis. When celebrity
recognition analysis is finished, Amazon Rekognition Video publishes a completion status to
the Amazon Simple Notification Service topic that you specify in NotificationChannel. To
get the results of the celebrity recognition analysis, first check that the status value
published to the Amazon SNS topic is SUCCEEDED. If so, call GetCelebrityRecognition and
pass the job identifier (JobId) from the initial call to StartCelebrityRecognition. For
more information, see Recognizing celebrities in the Amazon Rekognition Developer Guide.
# Arguments
- `video`: The video in which you want to recognize celebrities. The video must be stored
in an Amazon S3 bucket.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: Idempotent token used to identify the start request. If you use
the same token with multiple StartCelebrityRecognition requests, the same JobId is
returned. Use ClientRequestToken to prevent the same job from being accidently started more
than once.
- `"JobTag"`: An identifier you specify that's returned in the completion notification
that's published to your Amazon Simple Notification Service topic. For example, you can use
JobTag to group related jobs and identify them in the completion notification.
- `"NotificationChannel"`: The Amazon SNS topic ARN that you want Amazon Rekognition Video
to publish the completion status of the celebrity recognition analysis to. The Amazon SNS
topic must have a topic name that begins with AmazonRekognition if you are using the
AmazonRekognitionServiceRole permissions policy.
"""
function start_celebrity_recognition(
Video; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"StartCelebrityRecognition",
Dict{String,Any}("Video" => Video);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_celebrity_recognition(
Video, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"StartCelebrityRecognition",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Video" => Video), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_content_moderation(video)
start_content_moderation(video, params::Dict{String,<:Any})
Starts asynchronous detection of inappropriate, unwanted, or offensive content in a stored
video. For a list of moderation labels in Amazon Rekognition, see Using the image and video
moderation APIs. Amazon Rekognition Video can moderate content in a video stored in an
Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video.
StartContentModeration returns a job identifier (JobId) which you use to get the results of
the analysis. When content analysis is finished, Amazon Rekognition Video publishes a
completion status to the Amazon Simple Notification Service topic that you specify in
NotificationChannel. To get the results of the content analysis, first check that the
status value published to the Amazon SNS topic is SUCCEEDED. If so, call
GetContentModeration and pass the job identifier (JobId) from the initial call to
StartContentModeration. For more information, see Moderating content in the Amazon
Rekognition Developer Guide.
# Arguments
- `video`: The video in which you want to detect inappropriate, unwanted, or offensive
content. The video must be stored in an Amazon S3 bucket.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: Idempotent token used to identify the start request. If you use
the same token with multiple StartContentModeration requests, the same JobId is returned.
Use ClientRequestToken to prevent the same job from being accidently started more than
once.
- `"JobTag"`: An identifier you specify that's returned in the completion notification
that's published to your Amazon Simple Notification Service topic. For example, you can use
JobTag to group related jobs and identify them in the completion notification.
- `"MinConfidence"`: Specifies the minimum confidence that Amazon Rekognition must have in
order to return a moderated content label. Confidence represents how certain Amazon
Rekognition is that the moderated content is correctly identified. 0 is the lowest
confidence. 100 is the highest confidence. Amazon Rekognition doesn't return any moderated
content labels with a confidence level lower than this specified value. If you don't
specify MinConfidence, GetContentModeration returns labels with confidence values greater
than or equal to 50 percent.
- `"NotificationChannel"`: The Amazon SNS topic ARN that you want Amazon Rekognition Video
to publish the completion status of the content analysis to. The Amazon SNS topic must have
a topic name that begins with AmazonRekognition if you are using the
AmazonRekognitionServiceRole permissions policy to access the topic.
"""
function start_content_moderation(Video; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"StartContentModeration",
Dict{String,Any}("Video" => Video);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_content_moderation(
Video, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"StartContentModeration",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Video" => Video), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_face_detection(video)
start_face_detection(video, params::Dict{String,<:Any})
Starts asynchronous detection of faces in a stored video. Amazon Rekognition Video can
detect faces in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name
and the filename of the video. StartFaceDetection returns a job identifier (JobId) that you
use to get the results of the operation. When face detection is finished, Amazon
Rekognition Video publishes a completion status to the Amazon Simple Notification Service
topic that you specify in NotificationChannel. To get the results of the face detection
operation, first check that the status value published to the Amazon SNS topic is
SUCCEEDED. If so, call GetFaceDetection and pass the job identifier (JobId) from the
initial call to StartFaceDetection. For more information, see Detecting faces in a stored
video in the Amazon Rekognition Developer Guide.
# Arguments
- `video`: The video in which you want to detect faces. The video must be stored in an
Amazon S3 bucket.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: Idempotent token used to identify the start request. If you use
the same token with multiple StartFaceDetection requests, the same JobId is returned. Use
ClientRequestToken to prevent the same job from being accidently started more than once.
- `"FaceAttributes"`: The face attributes you want returned. DEFAULT - The following
subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and
Landmarks. ALL - All facial attributes are returned.
- `"JobTag"`: An identifier you specify that's returned in the completion notification
that's published to your Amazon Simple Notification Service topic. For example, you can use
JobTag to group related jobs and identify them in the completion notification.
- `"NotificationChannel"`: The ARN of the Amazon SNS topic to which you want Amazon
Rekognition Video to publish the completion status of the face detection operation. The
Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using
the AmazonRekognitionServiceRole permissions policy.
"""
function start_face_detection(Video; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"StartFaceDetection",
Dict{String,Any}("Video" => Video);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_face_detection(
Video, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"StartFaceDetection",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Video" => Video), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_face_search(collection_id, video)
start_face_search(collection_id, video, params::Dict{String,<:Any})
Starts the asynchronous search for faces in a collection that match the faces of persons
detected in a stored video. The video must be stored in an Amazon S3 bucket. Use Video to
specify the bucket name and the filename of the video. StartFaceSearch returns a job
identifier (JobId) which you use to get the search results once the search has completed.
When searching is finished, Amazon Rekognition Video publishes a completion status to the
Amazon Simple Notification Service topic that you specify in NotificationChannel. To get
the search results, first check that the status value published to the Amazon SNS topic is
SUCCEEDED. If so, call GetFaceSearch and pass the job identifier (JobId) from the initial
call to StartFaceSearch. For more information, see Searching stored videos for faces.
# Arguments
- `collection_id`: ID of the collection that contains the faces you want to search for.
- `video`: The video you want to search. The video must be stored in an Amazon S3 bucket.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: Idempotent token used to identify the start request. If you use
the same token with multiple StartFaceSearch requests, the same JobId is returned. Use
ClientRequestToken to prevent the same job from being accidently started more than once.
- `"FaceMatchThreshold"`: The minimum confidence in the person match to return. For
example, don't return any matches where confidence in matches is less than 70%. The default
value is 80%.
- `"JobTag"`: An identifier you specify that's returned in the completion notification
that's published to your Amazon Simple Notification Service topic. For example, you can use
JobTag to group related jobs and identify them in the completion notification.
- `"NotificationChannel"`: The ARN of the Amazon SNS topic to which you want Amazon
Rekognition Video to publish the completion status of the search. The Amazon SNS topic must
have a topic name that begins with AmazonRekognition if you are using the
AmazonRekognitionServiceRole permissions policy to access the topic.
"""
function start_face_search(
CollectionId, Video; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"StartFaceSearch",
Dict{String,Any}("CollectionId" => CollectionId, "Video" => Video);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_face_search(
CollectionId,
Video,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"StartFaceSearch",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CollectionId" => CollectionId, "Video" => Video),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_label_detection(video)
start_label_detection(video, params::Dict{String,<:Any})
Starts asynchronous detection of labels in a stored video. Amazon Rekognition Video can
detect labels in a video. Labels are instances of real-world entities. This includes
objects like flower, tree, and table; events like wedding, graduation, and birthday party;
concepts like landscape, evening, and nature; and activities like a person getting out of a
car or a person skiing. The video must be stored in an Amazon S3 bucket. Use Video to
specify the bucket name and the filename of the video. StartLabelDetection returns a job
identifier (JobId) which you use to get the results of the operation. When label detection
is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple
Notification Service topic that you specify in NotificationChannel. To get the results of
the label detection operation, first check that the status value published to the Amazon
SNS topic is SUCCEEDED. If so, call GetLabelDetection and pass the job identifier (JobId)
from the initial call to StartLabelDetection. Optional Parameters StartLabelDetection
has the GENERAL_LABELS Feature applied by default. This feature allows you to provide
filtering criteria to the Settings parameter. You can filter with sets of individual labels
or with label categories. You can specify inclusive filters, exclusive filters, or a
combination of inclusive and exclusive filters. For more information on filtering, see
Detecting labels in a video. You can specify MinConfidence to control the confidence
threshold for the labels returned. The default is 50.
# Arguments
- `video`: The video in which you want to detect labels. The video must be stored in an
Amazon S3 bucket.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: Idempotent token used to identify the start request. If you use
the same token with multiple StartLabelDetection requests, the same JobId is returned. Use
ClientRequestToken to prevent the same job from being accidently started more than once.
- `"Features"`: The features to return after video analysis. You can specify that
GENERAL_LABELS are returned.
- `"JobTag"`: An identifier you specify that's returned in the completion notification
that's published to your Amazon Simple Notification Service topic. For example, you can use
JobTag to group related jobs and identify them in the completion notification.
- `"MinConfidence"`: Specifies the minimum confidence that Amazon Rekognition Video must
have in order to return a detected label. Confidence represents how certain Amazon
Rekognition is that a label is correctly identified.0 is the lowest confidence. 100 is the
highest confidence. Amazon Rekognition Video doesn't return any labels with a confidence
level lower than this specified value. If you don't specify MinConfidence, the operation
returns labels and bounding boxes (if detected) with confidence values greater than or
equal to 50 percent.
- `"NotificationChannel"`: The Amazon SNS topic ARN you want Amazon Rekognition Video to
publish the completion status of the label detection operation to. The Amazon SNS topic
must have a topic name that begins with AmazonRekognition if you are using the
AmazonRekognitionServiceRole permissions policy.
- `"Settings"`: The settings for a StartLabelDetection request.Contains the specified
parameters for the label detection request of an asynchronous label analysis operation.
Settings can include filters for GENERAL_LABELS.
"""
function start_label_detection(Video; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"StartLabelDetection",
Dict{String,Any}("Video" => Video);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_label_detection(
Video, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"StartLabelDetection",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Video" => Video), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_media_analysis_job(input, operations_config, output_config)
start_media_analysis_job(input, operations_config, output_config, params::Dict{String,<:Any})
Initiates a new media analysis job. Accepts a manifest file in an Amazon S3 bucket. The
output is a manifest file and a summary of the manifest stored in the Amazon S3 bucket.
# Arguments
- `input`: Input data to be analyzed by the job.
- `operations_config`: Configuration options for the media analysis job to be created.
- `output_config`: The Amazon S3 bucket location to store the results.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: Idempotency token used to prevent the accidental creation of
duplicate versions. If you use the same token with multiple StartMediaAnalysisJobRequest
requests, the same response is returned. Use ClientRequestToken to prevent the same request
from being processed more than once.
- `"JobName"`: The name of the job. Does not have to be unique.
- `"KmsKeyId"`: The identifier of customer managed AWS KMS key (name or ARN). The key is
used to encrypt images copied into the service. The key is also used to encrypt results and
manifest files written to the output Amazon S3 bucket.
"""
function start_media_analysis_job(
Input, OperationsConfig, OutputConfig; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"StartMediaAnalysisJob",
Dict{String,Any}(
"Input" => Input,
"OperationsConfig" => OperationsConfig,
"OutputConfig" => OutputConfig,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_media_analysis_job(
Input,
OperationsConfig,
OutputConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"StartMediaAnalysisJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Input" => Input,
"OperationsConfig" => OperationsConfig,
"OutputConfig" => OutputConfig,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_person_tracking(video)
start_person_tracking(video, params::Dict{String,<:Any})
Starts the asynchronous tracking of a person's path in a stored video. Amazon Rekognition
Video can track the path of people in a video stored in an Amazon S3 bucket. Use Video to
specify the bucket name and the filename of the video. StartPersonTracking returns a job
identifier (JobId) which you use to get the results of the operation. When label detection
is finished, Amazon Rekognition publishes a completion status to the Amazon Simple
Notification Service topic that you specify in NotificationChannel. To get the results of
the person detection operation, first check that the status value published to the Amazon
SNS topic is SUCCEEDED. If so, call GetPersonTracking and pass the job identifier (JobId)
from the initial call to StartPersonTracking.
# Arguments
- `video`: The video in which you want to detect people. The video must be stored in an
Amazon S3 bucket.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: Idempotent token used to identify the start request. If you use
the same token with multiple StartPersonTracking requests, the same JobId is returned. Use
ClientRequestToken to prevent the same job from being accidently started more than once.
- `"JobTag"`: An identifier you specify that's returned in the completion notification
that's published to your Amazon Simple Notification Service topic. For example, you can use
JobTag to group related jobs and identify them in the completion notification.
- `"NotificationChannel"`: The Amazon SNS topic ARN you want Amazon Rekognition Video to
publish the completion status of the people detection operation to. The Amazon SNS topic
must have a topic name that begins with AmazonRekognition if you are using the
AmazonRekognitionServiceRole permissions policy.
"""
function start_person_tracking(Video; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"StartPersonTracking",
Dict{String,Any}("Video" => Video);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_person_tracking(
Video, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"StartPersonTracking",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Video" => Video), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_project_version(min_inference_units, project_version_arn)
start_project_version(min_inference_units, project_version_arn, params::Dict{String,<:Any})
This operation applies only to Amazon Rekognition Custom Labels. Starts the running of
the version of a model. Starting a model takes a while to complete. To check the current
state of the model, use DescribeProjectVersions. Once the model is running, you can detect
custom labels in new images by calling DetectCustomLabels. You are charged for the amount
of time that the model is running. To stop a running model, call StopProjectVersion. This
operation requires permissions to perform the rekognition:StartProjectVersion action.
# Arguments
- `min_inference_units`: The minimum number of inference units to use. A single inference
unit represents 1 hour of processing. Use a higher number to increase the TPS throughput
of your model. You are charged for the number of inference units that you use.
- `project_version_arn`: The Amazon Resource Name(ARN) of the model version that you want
to start.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxInferenceUnits"`: The maximum number of inference units to use for auto-scaling the
model. If you don't specify a value, Amazon Rekognition Custom Labels doesn't auto-scale
the model.
"""
function start_project_version(
MinInferenceUnits, ProjectVersionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"StartProjectVersion",
Dict{String,Any}(
"MinInferenceUnits" => MinInferenceUnits,
"ProjectVersionArn" => ProjectVersionArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_project_version(
MinInferenceUnits,
ProjectVersionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"StartProjectVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MinInferenceUnits" => MinInferenceUnits,
"ProjectVersionArn" => ProjectVersionArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_segment_detection(segment_types, video)
start_segment_detection(segment_types, video, params::Dict{String,<:Any})
Starts asynchronous detection of segment detection in a stored video. Amazon Rekognition
Video can detect segments in a video stored in an Amazon S3 bucket. Use Video to specify
the bucket name and the filename of the video. StartSegmentDetection returns a job
identifier (JobId) which you use to get the results of the operation. When segment
detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon
Simple Notification Service topic that you specify in NotificationChannel. You can use the
Filters (StartSegmentDetectionFilters) input parameter to specify the minimum detection
confidence returned in the response. Within Filters, use ShotFilter
(StartShotDetectionFilter) to filter detected shots. Use TechnicalCueFilter
(StartTechnicalCueDetectionFilter) to filter technical cues. To get the results of the
segment detection operation, first check that the status value published to the Amazon SNS
topic is SUCCEEDED. if so, call GetSegmentDetection and pass the job identifier (JobId)
from the initial call to StartSegmentDetection. For more information, see Detecting video
segments in stored video in the Amazon Rekognition Developer Guide.
# Arguments
- `segment_types`: An array of segment types to detect in the video. Valid values are
TECHNICAL_CUE and SHOT.
- `video`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: Idempotent token used to identify the start request. If you use
the same token with multiple StartSegmentDetection requests, the same JobId is returned.
Use ClientRequestToken to prevent the same job from being accidently started more than
once.
- `"Filters"`: Filters for technical cue or shot detection.
- `"JobTag"`: An identifier you specify that's returned in the completion notification
that's published to your Amazon Simple Notification Service topic. For example, you can use
JobTag to group related jobs and identify them in the completion notification.
- `"NotificationChannel"`: The ARN of the Amazon SNS topic to which you want Amazon
Rekognition Video to publish the completion status of the segment detection operation. Note
that the Amazon SNS topic must have a topic name that begins with AmazonRekognition if you
are using the AmazonRekognitionServiceRole permissions policy to access the topic.
"""
function start_segment_detection(
SegmentTypes, Video; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"StartSegmentDetection",
Dict{String,Any}("SegmentTypes" => SegmentTypes, "Video" => Video);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_segment_detection(
SegmentTypes,
Video,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"StartSegmentDetection",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("SegmentTypes" => SegmentTypes, "Video" => Video),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_stream_processor(name)
start_stream_processor(name, params::Dict{String,<:Any})
Starts processing a stream processor. You create a stream processor by calling
CreateStreamProcessor. To tell StartStreamProcessor which stream processor to start, use
the value of the Name field specified in the call to CreateStreamProcessor. If you are
using a label detection stream processor to detect labels, you need to provide a Start
selector and a Stop selector to determine the length of the stream processing time.
# Arguments
- `name`: The name of the stream processor to start processing.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"StartSelector"`: Specifies the starting point in the Kinesis stream to start
processing. You can use the producer timestamp or the fragment number. If you use the
producer timestamp, you must put the time in milliseconds. For more information about
fragment numbers, see Fragment. This is a required parameter for label detection stream
processors and should not be used to start a face search stream processor.
- `"StopSelector"`: Specifies when to stop processing the stream. You can specify a
maximum amount of time to process the video. This is a required parameter for label
detection stream processors and should not be used to start a face search stream processor.
"""
function start_stream_processor(Name; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"StartStreamProcessor",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_stream_processor(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"StartStreamProcessor",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_text_detection(video)
start_text_detection(video, params::Dict{String,<:Any})
Starts asynchronous detection of text in a stored video. Amazon Rekognition Video can
detect text in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name
and the filename of the video. StartTextDetection returns a job identifier (JobId) which
you use to get the results of the operation. When text detection is finished, Amazon
Rekognition Video publishes a completion status to the Amazon Simple Notification Service
topic that you specify in NotificationChannel. To get the results of the text detection
operation, first check that the status value published to the Amazon SNS topic is
SUCCEEDED. if so, call GetTextDetection and pass the job identifier (JobId) from the
initial call to StartTextDetection.
# Arguments
- `video`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: Idempotent token used to identify the start request. If you use
the same token with multiple StartTextDetection requests, the same JobId is returned. Use
ClientRequestToken to prevent the same job from being accidentaly started more than once.
- `"Filters"`: Optional parameters that let you set criteria the text must meet to be
included in your response.
- `"JobTag"`: An identifier returned in the completion status published by your Amazon
Simple Notification Service topic. For example, you can use JobTag to group related jobs
and identify them in the completion notification.
- `"NotificationChannel"`:
"""
function start_text_detection(Video; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"StartTextDetection",
Dict{String,Any}("Video" => Video);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_text_detection(
Video, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"StartTextDetection",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Video" => Video), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_project_version(project_version_arn)
stop_project_version(project_version_arn, params::Dict{String,<:Any})
This operation applies only to Amazon Rekognition Custom Labels. Stops a running model.
The operation might take a while to complete. To check the current status, call
DescribeProjectVersions. Only applies to Custom Labels projects. This operation requires
permissions to perform the rekognition:StopProjectVersion action.
# Arguments
- `project_version_arn`: The Amazon Resource Name (ARN) of the model version that you want
to stop. This operation requires permissions to perform the rekognition:StopProjectVersion
action.
"""
function stop_project_version(
ProjectVersionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"StopProjectVersion",
Dict{String,Any}("ProjectVersionArn" => ProjectVersionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_project_version(
ProjectVersionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"StopProjectVersion",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ProjectVersionArn" => ProjectVersionArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_stream_processor(name)
stop_stream_processor(name, params::Dict{String,<:Any})
Stops a running stream processor that was created by CreateStreamProcessor.
# Arguments
- `name`: The name of a stream processor created by CreateStreamProcessor.
"""
function stop_stream_processor(Name; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"StopStreamProcessor",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_stream_processor(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"StopStreamProcessor",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds one or more key-value tags to an Amazon Rekognition collection, stream processor, or
Custom Labels model. For more information, see Tagging AWS Resources. This operation
requires permissions to perform the rekognition:TagResource action.
# Arguments
- `resource_arn`: Amazon Resource Name (ARN) of the model, collection, or stream processor
that you want to assign the tags to.
- `tags`: The key-value tags to assign to the resource.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"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 rekognition(
"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 an Amazon Rekognition collection, stream processor, or
Custom Labels model. This operation requires permissions to perform the
rekognition:UntagResource action.
# Arguments
- `resource_arn`: Amazon Resource Name (ARN) of the model, collection, or stream processor
that you want to remove the tags from.
- `tag_keys`: A list of the tags that you want to remove.
"""
function untag_resource(
ResourceArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"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 rekognition(
"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_entries(changes, dataset_arn)
update_dataset_entries(changes, dataset_arn, params::Dict{String,<:Any})
This operation applies only to Amazon Rekognition Custom Labels. Adds or updates one or
more entries (images) in a dataset. An entry is a JSON Line which contains the information
for a single image, including the image location, assigned labels, and object location
bounding boxes. For more information, see Image-Level labels in manifest files and Object
localization in manifest files in the Amazon Rekognition Custom Labels Developer Guide. If
the source-ref field in the JSON line references an existing image, the existing image in
the dataset is updated. If source-ref field doesn't reference an existing image, the image
is added as a new image to the dataset. You specify the changes that you want to make in
the Changes input parameter. There isn't a limit to the number JSON Lines that you can
change, but the size of Changes must be less than 5MB. UpdateDatasetEntries returns
immediatly, but the dataset update might take a while to complete. Use DescribeDataset to
check the current status. The dataset updated successfully if the value of Status is
UPDATE_COMPLETE. To check if any non-terminal errors occured, call ListDatasetEntries and
check for the presence of errors lists in the JSON Lines. Dataset update fails if a
terminal error occurs (Status = UPDATE_FAILED). Currently, you can't access the terminal
error information from the Amazon Rekognition Custom Labels SDK. This operation requires
permissions to perform the rekognition:UpdateDatasetEntries action.
# Arguments
- `changes`: The changes that you want to make to the dataset.
- `dataset_arn`: The Amazon Resource Name (ARN) of the dataset that you want to update.
"""
function update_dataset_entries(
Changes, DatasetArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"UpdateDatasetEntries",
Dict{String,Any}("Changes" => Changes, "DatasetArn" => DatasetArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_dataset_entries(
Changes,
DatasetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rekognition(
"UpdateDatasetEntries",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Changes" => Changes, "DatasetArn" => DatasetArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_stream_processor(name)
update_stream_processor(name, params::Dict{String,<:Any})
Allows you to update a stream processor. You can change some settings and regions of
interest and delete certain parameters.
# Arguments
- `name`: Name of the stream processor that you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataSharingPreferenceForUpdate"`: Shows whether you are sharing data with Rekognition
to improve model performance. You can choose this option at the account level or on a
per-stream basis. Note that if you opt out at the account level this setting is ignored on
individual streams.
- `"ParametersToDelete"`: A list of parameters you want to delete from the stream
processor.
- `"RegionsOfInterestForUpdate"`: Specifies locations in the frames where Amazon
Rekognition checks for objects or people. This is an optional parameter for label detection
stream processors.
- `"SettingsForUpdate"`: The stream processor settings that you want to update. Label
detection settings can be updated to detect different labels with a different minimum
confidence.
"""
function update_stream_processor(Name; aws_config::AbstractAWSConfig=global_aws_config())
return rekognition(
"UpdateStreamProcessor",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_stream_processor(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rekognition(
"UpdateStreamProcessor",
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 | 12226 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: repostspace
using AWS.Compat
using AWS.UUIDs
"""
create_space(name, subdomain, tier)
create_space(name, subdomain, tier, params::Dict{String,<:Any})
Creates an AWS re:Post Private private re:Post.
# Arguments
- `name`: The name for the private re:Post. This must be unique in your account.
- `subdomain`: The subdomain that you use to access your AWS re:Post Private private
re:Post. All custom subdomains must be approved by AWS before use. In addition to your
custom subdomain, all private re:Posts are issued an AWS generated subdomain for immediate
use.
- `tier`: The pricing tier for the private re:Post.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A description for the private re:Post. This is used only to help you
identify this private re:Post.
- `"roleArn"`: The IAM role that grants permissions to the private re:Post to convert
unanswered questions into AWS support tickets.
- `"tags"`: The list of tags associated with the private re:Post.
- `"userKMSKey"`: The AWS KMS key ARN that’s used for the AWS KMS encryption. If you
don't provide a key, your data is encrypted by default with a key that AWS owns and manages
for you.
"""
function create_space(
name, subdomain, tier; aws_config::AbstractAWSConfig=global_aws_config()
)
return repostspace(
"POST",
"/spaces",
Dict{String,Any}("name" => name, "subdomain" => subdomain, "tier" => tier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_space(
name,
subdomain,
tier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return repostspace(
"POST",
"/spaces",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("name" => name, "subdomain" => subdomain, "tier" => tier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_space(space_id)
delete_space(space_id, params::Dict{String,<:Any})
Deletes an AWS re:Post Private private re:Post.
# Arguments
- `space_id`: The unique ID of the private re:Post.
"""
function delete_space(spaceId; aws_config::AbstractAWSConfig=global_aws_config())
return repostspace(
"DELETE",
"/spaces/$(spaceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_space(
spaceId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return repostspace(
"DELETE",
"/spaces/$(spaceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_admin(admin_id, space_id)
deregister_admin(admin_id, space_id, params::Dict{String,<:Any})
Removes the user or group from the list of administrators of the private re:Post.
# Arguments
- `admin_id`: The ID of the admin to remove.
- `space_id`: The ID of the private re:Post to remove the admin from.
"""
function deregister_admin(
adminId, spaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return repostspace(
"DELETE",
"/spaces/$(spaceId)/admins/$(adminId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_admin(
adminId,
spaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return repostspace(
"DELETE",
"/spaces/$(spaceId)/admins/$(adminId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_space(space_id)
get_space(space_id, params::Dict{String,<:Any})
Displays information about the AWS re:Post Private private re:Post.
# Arguments
- `space_id`: The ID of the private re:Post.
"""
function get_space(spaceId; aws_config::AbstractAWSConfig=global_aws_config())
return repostspace(
"GET", "/spaces/$(spaceId)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_space(
spaceId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return repostspace(
"GET",
"/spaces/$(spaceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_spaces()
list_spaces(params::Dict{String,<:Any})
Returns a list of AWS re:Post Private private re:Posts in the account with some information
about each private re:Post.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of private re:Posts to include in the results.
- `"nextToken"`: The token for the next set of private re:Posts to return. You receive this
token from a previous ListSpaces operation.
"""
function list_spaces(; aws_config::AbstractAWSConfig=global_aws_config())
return repostspace(
"GET", "/spaces"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_spaces(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return repostspace(
"GET", "/spaces", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Returns the tags that are associated with the AWS re:Post Private resource specified by the
resourceArn. The only resource that can be tagged is a private re:Post.
# Arguments
- `resource_arn`: The ARN of the resource that the tags are associated with.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return repostspace(
"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 repostspace(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_admin(admin_id, space_id)
register_admin(admin_id, space_id, params::Dict{String,<:Any})
Adds a user or group to the list of administrators of the private re:Post.
# Arguments
- `admin_id`: The ID of the administrator.
- `space_id`: The ID of the private re:Post.
"""
function register_admin(adminId, spaceId; aws_config::AbstractAWSConfig=global_aws_config())
return repostspace(
"POST",
"/spaces/$(spaceId)/admins/$(adminId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_admin(
adminId,
spaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return repostspace(
"POST",
"/spaces/$(spaceId)/admins/$(adminId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_invites(accessor_ids, body, space_id, title)
send_invites(accessor_ids, body, space_id, title, params::Dict{String,<:Any})
Sends an invitation email to selected users and groups.
# Arguments
- `accessor_ids`: The array of identifiers for the users and groups.
- `body`: The body of the invite.
- `space_id`: The ID of the private re:Post.
- `title`: The title of the invite.
"""
function send_invites(
accessorIds, body, spaceId, title; aws_config::AbstractAWSConfig=global_aws_config()
)
return repostspace(
"POST",
"/spaces/$(spaceId)/invite",
Dict{String,Any}("accessorIds" => accessorIds, "body" => body, "title" => title);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_invites(
accessorIds,
body,
spaceId,
title,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return repostspace(
"POST",
"/spaces/$(spaceId)/invite",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"accessorIds" => accessorIds, "body" => body, "title" => title
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Associates tags with an AWS re:Post Private resource. Currently, the only resource that can
be tagged is the private re:Post. If you specify a new tag key for the resource, the tag is
appended to the list of tags that are associated with the resource. If you specify a tag
key that’s already associated with the resource, the new tag value that you specify
replaces the previous value for that tag.
# Arguments
- `resource_arn`: The ARN of the resource that the tag is associated with.
- `tags`: The list of tag keys and values that must be associated 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 repostspace(
"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 repostspace(
"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 association of the tag with the AWS re:Post Private resource.
# Arguments
- `resource_arn`: The ARN of the resource.
- `tag_keys`: The key values of the tag.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return repostspace(
"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 repostspace(
"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_space(space_id)
update_space(space_id, params::Dict{String,<:Any})
Modifies an existing AWS re:Post Private private re:Post.
# Arguments
- `space_id`: The unique ID of this private re:Post.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A description for the private re:Post. This is used only to help you
identify this private re:Post.
- `"roleArn"`: The IAM role that grants permissions to the private re:Post to convert
unanswered questions into AWS support tickets.
- `"tier"`: The pricing tier of this private re:Post.
"""
function update_space(spaceId; aws_config::AbstractAWSConfig=global_aws_config())
return repostspace(
"PUT", "/spaces/$(spaceId)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function update_space(
spaceId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return repostspace(
"PUT",
"/spaces/$(spaceId)",
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 | 106126 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: resiliencehub
using AWS.Compat
using AWS.UUIDs
"""
add_draft_app_version_resource_mappings(app_arn, resource_mappings)
add_draft_app_version_resource_mappings(app_arn, resource_mappings, params::Dict{String,<:Any})
Adds the source of resource-maps to the draft version of an application. During assessment,
Resilience Hub will use these resource-maps to resolve the latest physical ID for each
resource in the application template. For more information about different types of
resources suported by Resilience Hub and how to add them in your application, see Step 2:
How is your application managed? in the Resilience Hub User Guide.
# Arguments
- `app_arn`: Amazon Resource Name (ARN) of the Resilience Hub application. The format for
this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
- `resource_mappings`: Mappings used to map logical resources from the template to physical
resources. You can use the mapping type CFN_STACK if the application template uses a
logical stack name. Or you can map individual resources by using the mapping type RESOURCE.
We recommend using the mapping type CFN_STACK if the application is backed by a
CloudFormation stack.
"""
function add_draft_app_version_resource_mappings(
appArn, resourceMappings; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/add-draft-app-version-resource-mappings",
Dict{String,Any}("appArn" => appArn, "resourceMappings" => resourceMappings);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_draft_app_version_resource_mappings(
appArn,
resourceMappings,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/add-draft-app-version-resource-mappings",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"appArn" => appArn, "resourceMappings" => resourceMappings
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_update_recommendation_status(app_arn, request_entries)
batch_update_recommendation_status(app_arn, request_entries, params::Dict{String,<:Any})
Enables you to include or exclude one or more operational recommendations.
# Arguments
- `app_arn`: Amazon Resource Name (ARN) of the Resilience Hub application. The format for
this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
- `request_entries`: Defines the list of operational recommendations that need to be
included or excluded.
"""
function batch_update_recommendation_status(
appArn, requestEntries; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/batch-update-recommendation-status",
Dict{String,Any}("appArn" => appArn, "requestEntries" => requestEntries);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_update_recommendation_status(
appArn,
requestEntries,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/batch-update-recommendation-status",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("appArn" => appArn, "requestEntries" => requestEntries),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_app(name)
create_app(name, params::Dict{String,<:Any})
Creates an Resilience Hub application. An Resilience Hub application is a collection of
Amazon Web Services resources structured to prevent and recover Amazon Web Services
application disruptions. To describe a Resilience Hub application, you provide an
application name, resources from one or more CloudFormation stacks, Resource Groups,
Terraform state files, AppRegistry applications, and an appropriate resiliency policy. In
addition, you can also add resources that are located on Amazon Elastic Kubernetes Service
(Amazon EKS) clusters as optional resources. For more information about the number of
resources supported per application, see Service quotas. After you create an Resilience Hub
application, you publish it so that you can run a resiliency assessment on it. You can then
use recommendations from the assessment to improve resiliency by running another
assessment, comparing results, and then iterating the process until you achieve your goals
for recovery time objective (RTO) and recovery point objective (RPO).
# Arguments
- `name`: Name of the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"assessmentSchedule"`: Assessment execution schedule with 'Daily' or 'Disabled' values.
- `"clientToken"`: Used for an idempotency token. A client token is a unique,
case-sensitive string of up to 64 ASCII characters. You should not reuse the same client
token for other API requests.
- `"description"`: The optional description for an app.
- `"eventSubscriptions"`: The list of events you would like to subscribe and get
notification for. Currently, Resilience Hub supports only Drift detected and Scheduled
assessment failure events notification.
- `"permissionModel"`: Defines the roles and credentials that Resilience Hub would use
while creating the application, importing its resources, and running an assessment.
- `"policyArn"`: Amazon Resource Name (ARN) of the resiliency policy. The format for this
ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more
information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services
General Reference guide.
- `"tags"`: Tags assigned to the resource. A tag is a label that you assign to an Amazon
Web Services resource. Each tag consists of a key/value pair.
"""
function create_app(name; aws_config::AbstractAWSConfig=global_aws_config())
return resiliencehub(
"POST",
"/create-app",
Dict{String,Any}("name" => name, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_app(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/create-app",
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_app_version_app_component(app_arn, name, type)
create_app_version_app_component(app_arn, name, type, params::Dict{String,<:Any})
Creates a new Application Component in the Resilience Hub application. This API updates
the Resilience Hub application draft version. To use this Application Component for running
assessments, you must publish the Resilience Hub application using the PublishAppVersion
API.
# Arguments
- `app_arn`: Amazon Resource Name (ARN) of the Resilience Hub application. The format for
this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
- `name`: Name of the Application Component.
- `type`: Type of Application Component. For more information about the types of
Application Component, see Grouping resources in an AppComponent.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"additionalInfo"`: Currently, there is no supported additional information for
Application Components.
- `"clientToken"`: Used for an idempotency token. A client token is a unique,
case-sensitive string of up to 64 ASCII characters. You should not reuse the same client
token for other API requests.
- `"id"`: Identifier of the Application Component.
"""
function create_app_version_app_component(
appArn, name, type; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/create-app-version-app-component",
Dict{String,Any}(
"appArn" => appArn,
"name" => name,
"type" => type,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_app_version_app_component(
appArn,
name,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/create-app-version-app-component",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"appArn" => appArn,
"name" => name,
"type" => type,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_app_version_resource(app_arn, app_components, logical_resource_id, physical_resource_id, resource_type)
create_app_version_resource(app_arn, app_components, logical_resource_id, physical_resource_id, resource_type, params::Dict{String,<:Any})
Adds a resource to the Resilience Hub application and assigns it to the specified
Application Components. If you specify a new Application Component, Resilience Hub will
automatically create the Application Component. This action has no effect outside
Resilience Hub. This API updates the Resilience Hub application draft version. To use
this resource for running resiliency assessments, you must publish the Resilience Hub
application using the PublishAppVersion API. To update application version with new
physicalResourceID, you must call ResolveAppVersionResources API.
# Arguments
- `app_arn`: Amazon Resource Name (ARN) of the Resilience Hub application. The format for
this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
- `app_components`: List of Application Components that this resource belongs to. If an
Application Component is not part of the Resilience Hub application, it will be added.
- `logical_resource_id`: Logical identifier of the resource.
- `physical_resource_id`: Physical identifier of the resource.
- `resource_type`: Type of resource.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"additionalInfo"`: Currently, there is no supported additional information for resources.
- `"awsAccountId"`: Amazon Web Services account that owns the physical resource.
- `"awsRegion"`: Amazon Web Services region that owns the physical resource.
- `"clientToken"`: Used for an idempotency token. A client token is a unique,
case-sensitive string of up to 64 ASCII characters. You should not reuse the same client
token for other API requests.
- `"resourceName"`: Name of the resource.
"""
function create_app_version_resource(
appArn,
appComponents,
logicalResourceId,
physicalResourceId,
resourceType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/create-app-version-resource",
Dict{String,Any}(
"appArn" => appArn,
"appComponents" => appComponents,
"logicalResourceId" => logicalResourceId,
"physicalResourceId" => physicalResourceId,
"resourceType" => resourceType,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_app_version_resource(
appArn,
appComponents,
logicalResourceId,
physicalResourceId,
resourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/create-app-version-resource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"appArn" => appArn,
"appComponents" => appComponents,
"logicalResourceId" => logicalResourceId,
"physicalResourceId" => physicalResourceId,
"resourceType" => resourceType,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_recommendation_template(assessment_arn, name)
create_recommendation_template(assessment_arn, name, params::Dict{String,<:Any})
Creates a new recommendation template for the Resilience Hub application.
# Arguments
- `assessment_arn`: Amazon Resource Name (ARN) of the assessment. The format for this ARN
is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
- `name`: The name for the recommendation template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"bucketName"`: The name of the Amazon S3 bucket that will contain the recommendation
template.
- `"clientToken"`: Used for an idempotency token. A client token is a unique,
case-sensitive string of up to 64 ASCII characters. You should not reuse the same client
token for other API requests.
- `"format"`: The format for the recommendation template. CfnJson The template is
CloudFormation JSON. CfnYaml The template is CloudFormation YAML.
- `"recommendationIds"`: Identifiers for the recommendations used to create a
recommendation template.
- `"recommendationTypes"`: An array of strings that specify the recommendation template
type or types. Alarm The template is an AlarmRecommendation template. Sop The template
is a SopRecommendation template. Test The template is a TestRecommendation template.
- `"tags"`: Tags assigned to the resource. A tag is a label that you assign to an Amazon
Web Services resource. Each tag consists of a key/value pair.
"""
function create_recommendation_template(
assessmentArn, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/create-recommendation-template",
Dict{String,Any}(
"assessmentArn" => assessmentArn,
"name" => name,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_recommendation_template(
assessmentArn,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/create-recommendation-template",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"assessmentArn" => assessmentArn,
"name" => name,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_resiliency_policy(policy, policy_name, tier)
create_resiliency_policy(policy, policy_name, tier, params::Dict{String,<:Any})
Creates a resiliency policy for an application. Resilience Hub allows you to provide a
value of zero for rtoInSecs and rpoInSecs of your resiliency policy. But, while assessing
your application, the lowest possible assessment result is near zero. Hence, if you provide
value zero for rtoInSecs and rpoInSecs, the estimated workload RTO and estimated workload
RPO result will be near zero and the Compliance status for your application will be set to
Policy breached.
# Arguments
- `policy`: The type of resiliency policy to be created, including the recovery time
objective (RTO) and recovery point objective (RPO) in seconds.
- `policy_name`: The name of the policy
- `tier`: The tier for this resiliency policy, ranging from the highest severity
(MissionCritical) to lowest (NonCritical).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Used for an idempotency token. A client token is a unique,
case-sensitive string of up to 64 ASCII characters. You should not reuse the same client
token for other API requests.
- `"dataLocationConstraint"`: Specifies a high-level geographical location constraint for
where your resilience policy data can be stored.
- `"policyDescription"`: The description for the policy.
- `"tags"`: Tags assigned to the resource. A tag is a label that you assign to an Amazon
Web Services resource. Each tag consists of a key/value pair.
"""
function create_resiliency_policy(
policy, policyName, tier; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/create-resiliency-policy",
Dict{String,Any}(
"policy" => policy,
"policyName" => policyName,
"tier" => tier,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_resiliency_policy(
policy,
policyName,
tier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/create-resiliency-policy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"policy" => policy,
"policyName" => policyName,
"tier" => tier,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_app(app_arn)
delete_app(app_arn, params::Dict{String,<:Any})
Deletes an Resilience Hub application. This is a destructive action that can't be undone.
# Arguments
- `app_arn`: Amazon Resource Name (ARN) of the Resilience Hub application. The format for
this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Used for an idempotency token. A client token is a unique,
case-sensitive string of up to 64 ASCII characters. You should not reuse the same client
token for other API requests.
- `"forceDelete"`: A boolean option to force the deletion of an Resilience Hub application.
"""
function delete_app(appArn; aws_config::AbstractAWSConfig=global_aws_config())
return resiliencehub(
"POST",
"/delete-app",
Dict{String,Any}("appArn" => appArn, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_app(
appArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/delete-app",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("appArn" => appArn, "clientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_app_assessment(assessment_arn)
delete_app_assessment(assessment_arn, params::Dict{String,<:Any})
Deletes an Resilience Hub application assessment. This is a destructive action that can't
be undone.
# Arguments
- `assessment_arn`: Amazon Resource Name (ARN) of the assessment. The format for this ARN
is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Used for an idempotency token. A client token is a unique,
case-sensitive string of up to 64 ASCII characters. You should not reuse the same client
token for other API requests.
"""
function delete_app_assessment(
assessmentArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/delete-app-assessment",
Dict{String,Any}(
"assessmentArn" => assessmentArn, "clientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_app_assessment(
assessmentArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/delete-app-assessment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"assessmentArn" => assessmentArn, "clientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_app_input_source(app_arn)
delete_app_input_source(app_arn, params::Dict{String,<:Any})
Deletes the input source and all of its imported resources from the Resilience Hub
application.
# Arguments
- `app_arn`: Amazon Resource Name (ARN) of the Resilience Hub application. The format for
this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Used for an idempotency token. A client token is a unique,
case-sensitive string of up to 64 ASCII characters. You should not reuse the same client
token for other API requests.
- `"eksSourceClusterNamespace"`: The namespace on your Amazon Elastic Kubernetes Service
cluster that you want to delete from the Resilience Hub application.
- `"sourceArn"`: The Amazon Resource Name (ARN) of the imported resource you want to remove
from the Resilience Hub application. For more information about ARNs, see Amazon Resource
Names (ARNs) in the Amazon Web Services General Reference guide.
- `"terraformSource"`: The imported Terraform s3 state file you want to remove from the
Resilience Hub application.
"""
function delete_app_input_source(appArn; aws_config::AbstractAWSConfig=global_aws_config())
return resiliencehub(
"POST",
"/delete-app-input-source",
Dict{String,Any}("appArn" => appArn, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_app_input_source(
appArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/delete-app-input-source",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("appArn" => appArn, "clientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_app_version_app_component(app_arn, id)
delete_app_version_app_component(app_arn, id, params::Dict{String,<:Any})
Deletes an Application Component from the Resilience Hub application. This API updates
the Resilience Hub application draft version. To use this Application Component for running
assessments, you must publish the Resilience Hub application using the PublishAppVersion
API. You will not be able to delete an Application Component if it has resources
associated with it.
# Arguments
- `app_arn`: Amazon Resource Name (ARN) of the Resilience Hub application. The format for
this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
- `id`: Identifier of the Application Component.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Used for an idempotency token. A client token is a unique,
case-sensitive string of up to 64 ASCII characters. You should not reuse the same client
token for other API requests.
"""
function delete_app_version_app_component(
appArn, id; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/delete-app-version-app-component",
Dict{String,Any}("appArn" => appArn, "id" => id, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_app_version_app_component(
appArn,
id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/delete-app-version-app-component",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"appArn" => appArn, "id" => id, "clientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_app_version_resource(app_arn)
delete_app_version_resource(app_arn, params::Dict{String,<:Any})
Deletes a resource from the Resilience Hub application. You can only delete a manually
added resource. To exclude non-manually added resources, use the UpdateAppVersionResource
API. This action has no effect outside Resilience Hub. This API updates the Resilience
Hub application draft version. To use this resource for running resiliency assessments, you
must publish the Resilience Hub application using the PublishAppVersion API.
# Arguments
- `app_arn`: Amazon Resource Name (ARN) of the Resilience Hub application. The format for
this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"awsAccountId"`: Amazon Web Services account that owns the physical resource.
- `"awsRegion"`: Amazon Web Services region that owns the physical resource.
- `"clientToken"`: Used for an idempotency token. A client token is a unique,
case-sensitive string of up to 64 ASCII characters. You should not reuse the same client
token for other API requests.
- `"logicalResourceId"`: Logical identifier of the resource.
- `"physicalResourceId"`: Physical identifier of the resource.
- `"resourceName"`: Name of the resource.
"""
function delete_app_version_resource(
appArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/delete-app-version-resource",
Dict{String,Any}("appArn" => appArn, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_app_version_resource(
appArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/delete-app-version-resource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("appArn" => appArn, "clientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_recommendation_template(recommendation_template_arn)
delete_recommendation_template(recommendation_template_arn, params::Dict{String,<:Any})
Deletes a recommendation template. This is a destructive action that can't be undone.
# Arguments
- `recommendation_template_arn`: The Amazon Resource Name (ARN) for a recommendation
template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Used for an idempotency token. A client token is a unique,
case-sensitive string of up to 64 ASCII characters. You should not reuse the same client
token for other API requests.
"""
function delete_recommendation_template(
recommendationTemplateArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/delete-recommendation-template",
Dict{String,Any}(
"recommendationTemplateArn" => recommendationTemplateArn,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_recommendation_template(
recommendationTemplateArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/delete-recommendation-template",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"recommendationTemplateArn" => recommendationTemplateArn,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_resiliency_policy(policy_arn)
delete_resiliency_policy(policy_arn, params::Dict{String,<:Any})
Deletes a resiliency policy. This is a destructive action that can't be undone.
# Arguments
- `policy_arn`: Amazon Resource Name (ARN) of the resiliency policy. The format for this
ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more
information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services
General Reference guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Used for an idempotency token. A client token is a unique,
case-sensitive string of up to 64 ASCII characters. You should not reuse the same client
token for other API requests.
"""
function delete_resiliency_policy(
policyArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/delete-resiliency-policy",
Dict{String,Any}("policyArn" => policyArn, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_resiliency_policy(
policyArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/delete-resiliency-policy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"policyArn" => policyArn, "clientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_app(app_arn)
describe_app(app_arn, params::Dict{String,<:Any})
Describes an Resilience Hub application.
# Arguments
- `app_arn`: Amazon Resource Name (ARN) of the Resilience Hub application. The format for
this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
"""
function describe_app(appArn; aws_config::AbstractAWSConfig=global_aws_config())
return resiliencehub(
"POST",
"/describe-app",
Dict{String,Any}("appArn" => appArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_app(
appArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/describe-app",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("appArn" => appArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_app_assessment(assessment_arn)
describe_app_assessment(assessment_arn, params::Dict{String,<:Any})
Describes an assessment for an Resilience Hub application.
# Arguments
- `assessment_arn`: Amazon Resource Name (ARN) of the assessment. The format for this ARN
is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
"""
function describe_app_assessment(
assessmentArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/describe-app-assessment",
Dict{String,Any}("assessmentArn" => assessmentArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_app_assessment(
assessmentArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/describe-app-assessment",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("assessmentArn" => assessmentArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_app_version(app_arn, app_version)
describe_app_version(app_arn, app_version, params::Dict{String,<:Any})
Describes the Resilience Hub application version.
# Arguments
- `app_arn`: Amazon Resource Name (ARN) of the Resilience Hub application. The format for
this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
- `app_version`: Resilience Hub application version.
"""
function describe_app_version(
appArn, appVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/describe-app-version",
Dict{String,Any}("appArn" => appArn, "appVersion" => appVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_app_version(
appArn,
appVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/describe-app-version",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("appArn" => appArn, "appVersion" => appVersion),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_app_version_app_component(app_arn, app_version, id)
describe_app_version_app_component(app_arn, app_version, id, params::Dict{String,<:Any})
Describes an Application Component in the Resilience Hub application.
# Arguments
- `app_arn`: Amazon Resource Name (ARN) of the Resilience Hub application. The format for
this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
- `app_version`: Resilience Hub application version.
- `id`: Identifier of the Application Component.
"""
function describe_app_version_app_component(
appArn, appVersion, id; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/describe-app-version-app-component",
Dict{String,Any}("appArn" => appArn, "appVersion" => appVersion, "id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_app_version_app_component(
appArn,
appVersion,
id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/describe-app-version-app-component",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"appArn" => appArn, "appVersion" => appVersion, "id" => id
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_app_version_resource(app_arn, app_version)
describe_app_version_resource(app_arn, app_version, params::Dict{String,<:Any})
Describes a resource of the Resilience Hub application. This API accepts only one of the
following parameters to descibe the resource: resourceName logicalResourceId
physicalResourceId (Along with physicalResourceId, you can also provide awsAccountId, and
awsRegion)
# Arguments
- `app_arn`: Amazon Resource Name (ARN) of the Resilience Hub application. The format for
this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
- `app_version`: Resilience Hub application version.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"awsAccountId"`: Amazon Web Services account that owns the physical resource.
- `"awsRegion"`: Amazon Web Services region that owns the physical resource.
- `"logicalResourceId"`: Logical identifier of the resource.
- `"physicalResourceId"`: Physical identifier of the resource.
- `"resourceName"`: Name of the resource.
"""
function describe_app_version_resource(
appArn, appVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/describe-app-version-resource",
Dict{String,Any}("appArn" => appArn, "appVersion" => appVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_app_version_resource(
appArn,
appVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/describe-app-version-resource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("appArn" => appArn, "appVersion" => appVersion),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_app_version_resources_resolution_status(app_arn, app_version)
describe_app_version_resources_resolution_status(app_arn, app_version, params::Dict{String,<:Any})
Returns the resolution status for the specified resolution identifier for an application
version. If resolutionId is not specified, the current resolution status is returned.
# Arguments
- `app_arn`: Amazon Resource Name (ARN) of the Resilience Hub application. The format for
this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
- `app_version`: The version of the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"resolutionId"`: The identifier for a specific resolution.
"""
function describe_app_version_resources_resolution_status(
appArn, appVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/describe-app-version-resources-resolution-status",
Dict{String,Any}("appArn" => appArn, "appVersion" => appVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_app_version_resources_resolution_status(
appArn,
appVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/describe-app-version-resources-resolution-status",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("appArn" => appArn, "appVersion" => appVersion),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_app_version_template(app_arn, app_version)
describe_app_version_template(app_arn, app_version, params::Dict{String,<:Any})
Describes details about an Resilience Hub application.
# Arguments
- `app_arn`: Amazon Resource Name (ARN) of the Resilience Hub application. The format for
this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
- `app_version`: The version of the application.
"""
function describe_app_version_template(
appArn, appVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/describe-app-version-template",
Dict{String,Any}("appArn" => appArn, "appVersion" => appVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_app_version_template(
appArn,
appVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/describe-app-version-template",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("appArn" => appArn, "appVersion" => appVersion),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_draft_app_version_resources_import_status(app_arn)
describe_draft_app_version_resources_import_status(app_arn, params::Dict{String,<:Any})
Describes the status of importing resources to an application version. If you get a 404
error with ResourceImportStatusNotFoundAppMetadataException, you must call
importResourcesToDraftAppVersion after creating the application and before calling
describeDraftAppVersionResourcesImportStatus to obtain the status.
# Arguments
- `app_arn`: Amazon Resource Name (ARN) of the Resilience Hub application. The format for
this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
"""
function describe_draft_app_version_resources_import_status(
appArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/describe-draft-app-version-resources-import-status",
Dict{String,Any}("appArn" => appArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_draft_app_version_resources_import_status(
appArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/describe-draft-app-version-resources-import-status",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("appArn" => appArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_resiliency_policy(policy_arn)
describe_resiliency_policy(policy_arn, params::Dict{String,<:Any})
Describes a specified resiliency policy for an Resilience Hub application. The returned
policy object includes creation time, data location constraints, the Amazon Resource Name
(ARN) for the policy, tags, tier, and more.
# Arguments
- `policy_arn`: Amazon Resource Name (ARN) of the resiliency policy. The format for this
ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more
information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services
General Reference guide.
"""
function describe_resiliency_policy(
policyArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/describe-resiliency-policy",
Dict{String,Any}("policyArn" => policyArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_resiliency_policy(
policyArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/describe-resiliency-policy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("policyArn" => policyArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
import_resources_to_draft_app_version(app_arn)
import_resources_to_draft_app_version(app_arn, params::Dict{String,<:Any})
Imports resources to Resilience Hub application draft version from different input sources.
For more information about the input sources supported by Resilience Hub, see Discover the
structure and describe your Resilience Hub application.
# Arguments
- `app_arn`: Amazon Resource Name (ARN) of the Resilience Hub application. The format for
this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"eksSources"`: The input sources of the Amazon Elastic Kubernetes Service resources you
need to import.
- `"importStrategy"`: The import strategy you would like to set to import resources into
Resilience Hub application.
- `"sourceArns"`: The Amazon Resource Names (ARNs) for the resources.
- `"terraformSources"`: A list of terraform file s3 URLs you need to import.
"""
function import_resources_to_draft_app_version(
appArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/import-resources-to-draft-app-version",
Dict{String,Any}("appArn" => appArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function import_resources_to_draft_app_version(
appArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/import-resources-to-draft-app-version",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("appArn" => appArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_alarm_recommendations(assessment_arn)
list_alarm_recommendations(assessment_arn, params::Dict{String,<:Any})
Lists the alarm recommendations for an Resilience Hub application.
# Arguments
- `assessment_arn`: Amazon Resource Name (ARN) of the assessment. The format for this ARN
is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: 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.
- `"nextToken"`: Null, or the token from a previous call to get the next set of results.
"""
function list_alarm_recommendations(
assessmentArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/list-alarm-recommendations",
Dict{String,Any}("assessmentArn" => assessmentArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_alarm_recommendations(
assessmentArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/list-alarm-recommendations",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("assessmentArn" => assessmentArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_app_assessment_compliance_drifts(assessment_arn)
list_app_assessment_compliance_drifts(assessment_arn, params::Dict{String,<:Any})
List of compliance drifts that were detected while running an assessment.
# Arguments
- `assessment_arn`: Amazon Resource Name (ARN) of the assessment. The format for this ARN
is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Indicates the maximum number of applications requested.
- `"nextToken"`: Indicates the unique token number of the next application to be checked
for compliance and regulatory requirements from the list of applications.
"""
function list_app_assessment_compliance_drifts(
assessmentArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/list-app-assessment-compliance-drifts",
Dict{String,Any}("assessmentArn" => assessmentArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_app_assessment_compliance_drifts(
assessmentArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/list-app-assessment-compliance-drifts",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("assessmentArn" => assessmentArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_app_assessment_resource_drifts(assessment_arn)
list_app_assessment_resource_drifts(assessment_arn, params::Dict{String,<:Any})
Indicates the list of resource drifts that were detected while running an assessment.
# Arguments
- `assessment_arn`: Amazon Resource Name (ARN) of the assessment. The format for this ARN
is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Indicates the maximum number of drift 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.
- `"nextToken"`: Null, or the token from a previous call to get the next set of results.
"""
function list_app_assessment_resource_drifts(
assessmentArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/list-app-assessment-resource-drifts",
Dict{String,Any}("assessmentArn" => assessmentArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_app_assessment_resource_drifts(
assessmentArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/list-app-assessment-resource-drifts",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("assessmentArn" => assessmentArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_app_assessments()
list_app_assessments(params::Dict{String,<:Any})
Lists the assessments for an Resilience Hub application. You can use request parameters to
refine the results for the response object.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"appArn"`: Amazon Resource Name (ARN) of the Resilience Hub application. The format for
this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
- `"assessmentName"`: The name for the assessment.
- `"assessmentStatus"`: The current status of the assessment for the resiliency policy.
- `"complianceStatus"`: The current status of compliance for the resiliency policy.
- `"invoker"`: Specifies the entity that invoked a specific assessment, either a User or
the System.
- `"maxResults"`: 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.
- `"nextToken"`: Null, or the token from a previous call to get the next set of results.
- `"reverseOrder"`: The default is to sort by ascending startTime. To sort by descending
startTime, set reverseOrder to true.
"""
function list_app_assessments(; aws_config::AbstractAWSConfig=global_aws_config())
return resiliencehub(
"GET",
"/list-app-assessments";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_app_assessments(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"GET",
"/list-app-assessments",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_app_component_compliances(assessment_arn)
list_app_component_compliances(assessment_arn, params::Dict{String,<:Any})
Lists the compliances for an Resilience Hub Application Component.
# Arguments
- `assessment_arn`: Amazon Resource Name (ARN) of the assessment. The format for this ARN
is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: 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.
- `"nextToken"`: Null, or the token from a previous call to get the next set of results.
"""
function list_app_component_compliances(
assessmentArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/list-app-component-compliances",
Dict{String,Any}("assessmentArn" => assessmentArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_app_component_compliances(
assessmentArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/list-app-component-compliances",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("assessmentArn" => assessmentArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_app_component_recommendations(assessment_arn)
list_app_component_recommendations(assessment_arn, params::Dict{String,<:Any})
Lists the recommendations for an Resilience Hub Application Component.
# Arguments
- `assessment_arn`: Amazon Resource Name (ARN) of the assessment. The format for this ARN
is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: 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.
- `"nextToken"`: Null, or the token from a previous call to get the next set of results.
"""
function list_app_component_recommendations(
assessmentArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/list-app-component-recommendations",
Dict{String,Any}("assessmentArn" => assessmentArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_app_component_recommendations(
assessmentArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/list-app-component-recommendations",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("assessmentArn" => assessmentArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_app_input_sources(app_arn, app_version)
list_app_input_sources(app_arn, app_version, params::Dict{String,<:Any})
Lists all the input sources of the Resilience Hub application. For more information about
the input sources supported by Resilience Hub, see Discover the structure and describe your
Resilience Hub application.
# Arguments
- `app_arn`: Amazon Resource Name (ARN) of the Resilience Hub application. The format for
this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
- `app_version`: Resilience Hub application version.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Maximum number of input sources to be displayed per Resilience Hub
application.
- `"nextToken"`: Null, or the token from a previous call to get the next set of results.
"""
function list_app_input_sources(
appArn, appVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/list-app-input-sources",
Dict{String,Any}("appArn" => appArn, "appVersion" => appVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_app_input_sources(
appArn,
appVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/list-app-input-sources",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("appArn" => appArn, "appVersion" => appVersion),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_app_version_app_components(app_arn, app_version)
list_app_version_app_components(app_arn, app_version, params::Dict{String,<:Any})
Lists all the Application Components in the Resilience Hub application.
# Arguments
- `app_arn`: Amazon Resource Name (ARN) of the Resilience Hub application. The format for
this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
- `app_version`: Version of the Application Component.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Maximum number of Application Components to be displayed per Resilience
Hub application version.
- `"nextToken"`: Null, or the token from a previous call to get the next set of results.
"""
function list_app_version_app_components(
appArn, appVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/list-app-version-app-components",
Dict{String,Any}("appArn" => appArn, "appVersion" => appVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_app_version_app_components(
appArn,
appVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/list-app-version-app-components",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("appArn" => appArn, "appVersion" => appVersion),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_app_version_resource_mappings(app_arn, app_version)
list_app_version_resource_mappings(app_arn, app_version, params::Dict{String,<:Any})
Lists how the resources in an application version are mapped/sourced from. Mappings can be
physical resource identifiers, CloudFormation stacks, resource-groups, or an application
registry app.
# Arguments
- `app_arn`: Amazon Resource Name (ARN) of the Resilience Hub application. The format for
this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
- `app_version`: The version of the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: 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.
- `"nextToken"`: Null, or the token from a previous call to get the next set of results.
"""
function list_app_version_resource_mappings(
appArn, appVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/list-app-version-resource-mappings",
Dict{String,Any}("appArn" => appArn, "appVersion" => appVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_app_version_resource_mappings(
appArn,
appVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/list-app-version-resource-mappings",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("appArn" => appArn, "appVersion" => appVersion),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_app_version_resources(app_arn, app_version)
list_app_version_resources(app_arn, app_version, params::Dict{String,<:Any})
Lists all the resources in an Resilience Hub application.
# Arguments
- `app_arn`: Amazon Resource Name (ARN) of the Resilience Hub application. The format for
this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
- `app_version`: The version of the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: 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.
- `"nextToken"`: Null, or the token from a previous call to get the next set of results.
- `"resolutionId"`: The identifier for a specific resolution.
"""
function list_app_version_resources(
appArn, appVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/list-app-version-resources",
Dict{String,Any}("appArn" => appArn, "appVersion" => appVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_app_version_resources(
appArn,
appVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/list-app-version-resources",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("appArn" => appArn, "appVersion" => appVersion),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_app_versions(app_arn)
list_app_versions(app_arn, params::Dict{String,<:Any})
Lists the different versions for the Resilience Hub applications.
# Arguments
- `app_arn`: Amazon Resource Name (ARN) of the Resilience Hub application. The format for
this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"endTime"`: Upper limit of the time range to filter the application versions.
- `"maxResults"`: 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.
- `"nextToken"`: Null, or the token from a previous call to get the next set of results.
- `"startTime"`: Lower limit of the time range to filter the application versions.
"""
function list_app_versions(appArn; aws_config::AbstractAWSConfig=global_aws_config())
return resiliencehub(
"POST",
"/list-app-versions",
Dict{String,Any}("appArn" => appArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_app_versions(
appArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/list-app-versions",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("appArn" => appArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_apps()
list_apps(params::Dict{String,<:Any})
Lists your Resilience Hub applications. You can filter applications using only one filter
at a time or without using any filter. If you try to filter applications using multiple
filters, you will get the following error: An error occurred (ValidationException) when
calling the ListApps operation: Only one filter is supported for this operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"appArn"`: Amazon Resource Name (ARN) of the Resilience Hub application. The format for
this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
- `"fromLastAssessmentTime"`: Indicates the lower limit of the range that is used to filter
applications based on their last assessment times.
- `"maxResults"`: 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.
- `"name"`: The name for the one of the listed applications.
- `"nextToken"`: Null, or the token from a previous call to get the next set of results.
- `"reverseOrder"`: The application list is sorted based on the values of
lastAppComplianceEvaluationTime field. By default, application list is sorted in ascending
order. To sort the appliation list in descending order, set this field to True.
- `"toLastAssessmentTime"`: Indicates the upper limit of the range that is used to filter
the applications based on their last assessment times.
"""
function list_apps(; aws_config::AbstractAWSConfig=global_aws_config())
return resiliencehub(
"GET", "/list-apps"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_apps(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"GET", "/list-apps", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_recommendation_templates()
list_recommendation_templates(params::Dict{String,<:Any})
Lists the recommendation templates for the Resilience Hub applications.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"assessmentArn"`: Amazon Resource Name (ARN) of the assessment. The format for this ARN
is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
- `"maxResults"`: 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.
- `"name"`: The name for one of the listed recommendation templates.
- `"nextToken"`: Null, or the token from a previous call to get the next set of results.
- `"recommendationTemplateArn"`: The Amazon Resource Name (ARN) for a recommendation
template.
- `"reverseOrder"`: The default is to sort by ascending startTime. To sort by descending
startTime, set reverseOrder to true.
- `"status"`: Status of the action.
"""
function list_recommendation_templates(; aws_config::AbstractAWSConfig=global_aws_config())
return resiliencehub(
"GET",
"/list-recommendation-templates";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_recommendation_templates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"GET",
"/list-recommendation-templates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_resiliency_policies()
list_resiliency_policies(params::Dict{String,<:Any})
Lists the resiliency policies for the Resilience Hub applications.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: 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.
- `"nextToken"`: Null, or the token from a previous call to get the next set of results.
- `"policyName"`: The name of the policy
"""
function list_resiliency_policies(; aws_config::AbstractAWSConfig=global_aws_config())
return resiliencehub(
"GET",
"/list-resiliency-policies";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_resiliency_policies(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"GET",
"/list-resiliency-policies",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_sop_recommendations(assessment_arn)
list_sop_recommendations(assessment_arn, params::Dict{String,<:Any})
Lists the standard operating procedure (SOP) recommendations for the Resilience Hub
applications.
# Arguments
- `assessment_arn`: Amazon Resource Name (ARN) of the assessment. The format for this ARN
is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: 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.
- `"nextToken"`: Null, or the token from a previous call to get the next set of results.
"""
function list_sop_recommendations(
assessmentArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/list-sop-recommendations",
Dict{String,Any}("assessmentArn" => assessmentArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_sop_recommendations(
assessmentArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/list-sop-recommendations",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("assessmentArn" => assessmentArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_suggested_resiliency_policies()
list_suggested_resiliency_policies(params::Dict{String,<:Any})
Lists the suggested resiliency policies for the Resilience Hub applications.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: 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.
- `"nextToken"`: Null, or the token from a previous call to get the next set of results.
"""
function list_suggested_resiliency_policies(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"GET",
"/list-suggested-resiliency-policies";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_suggested_resiliency_policies(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"GET",
"/list-suggested-resiliency-policies",
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 your resources in your Resilience Hub applications.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) for a specific resource in your Resilience
Hub application.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"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 resiliencehub(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_test_recommendations(assessment_arn)
list_test_recommendations(assessment_arn, params::Dict{String,<:Any})
Lists the test recommendations for the Resilience Hub application.
# Arguments
- `assessment_arn`: Amazon Resource Name (ARN) of the assessment. The format for this ARN
is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: 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.
- `"nextToken"`: Null, or the token from a previous call to get the next set of results.
"""
function list_test_recommendations(
assessmentArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/list-test-recommendations",
Dict{String,Any}("assessmentArn" => assessmentArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_test_recommendations(
assessmentArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/list-test-recommendations",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("assessmentArn" => assessmentArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_unsupported_app_version_resources(app_arn, app_version)
list_unsupported_app_version_resources(app_arn, app_version, params::Dict{String,<:Any})
Lists the resources that are not currently supported in Resilience Hub. An unsupported
resource is a resource that exists in the object that was used to create an app, but is not
supported by Resilience Hub.
# Arguments
- `app_arn`: Amazon Resource Name (ARN) of the Resilience Hub application. The format for
this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
- `app_version`: The version of the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: 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.
- `"nextToken"`: Null, or the token from a previous call to get the next set of results.
- `"resolutionId"`: The identifier for a specific resolution.
"""
function list_unsupported_app_version_resources(
appArn, appVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/list-unsupported-app-version-resources",
Dict{String,Any}("appArn" => appArn, "appVersion" => appVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_unsupported_app_version_resources(
appArn,
appVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/list-unsupported-app-version-resources",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("appArn" => appArn, "appVersion" => appVersion),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
publish_app_version(app_arn)
publish_app_version(app_arn, params::Dict{String,<:Any})
Publishes a new version of a specific Resilience Hub application.
# Arguments
- `app_arn`: Amazon Resource Name (ARN) of the Resilience Hub application. The format for
this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"versionName"`: Name of the application version.
"""
function publish_app_version(appArn; aws_config::AbstractAWSConfig=global_aws_config())
return resiliencehub(
"POST",
"/publish-app-version",
Dict{String,Any}("appArn" => appArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function publish_app_version(
appArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/publish-app-version",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("appArn" => appArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_draft_app_version_template(app_arn, app_template_body)
put_draft_app_version_template(app_arn, app_template_body, params::Dict{String,<:Any})
Adds or updates the app template for an Resilience Hub application draft version.
# Arguments
- `app_arn`: Amazon Resource Name (ARN) of the Resilience Hub application. The format for
this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
- `app_template_body`: A JSON string that provides information about your application
structure. To learn more about the appTemplateBody template, see the sample template
provided in the Examples section. The appTemplateBody JSON string has the following
structure: resources The list of logical resources that must be included in the
Resilience Hub application. Type: Array Don't add the resources that you want to exclude.
Each resources array item includes the following fields: logicalResourceId Logical
identifier of the resource. Type: Object Each logicalResourceId object includes the
following fields: identifier Identifier of the resource. Type: String
logicalStackName The name of the CloudFormation stack this resource belongs to. Type:
String resourceGroupName The name of the resource group this resource belongs to. Type:
String terraformSourceName The name of the Terraform S3 state file this resource
belongs to. Type: String eksSourceName Name of the Amazon Elastic Kubernetes Service
cluster and namespace this resource belongs to. This parameter accepts values in
\"eks-cluster/namespace\" format. Type: String type The type of resource. Type:
string name The name of the resource. Type: String additionalInfo Additional
configuration parameters for an Resilience Hub application. If you want to implement
additionalInfo through the Resilience Hub console rather than using an API call, see
Configure the application configuration parameters. Currently, this parameter accepts a
key-value mapping (in a string format) of only one failover region and one associated
account. Key: \"failover-regions\" Value: \"[{\"region\":\"<REGION>\",
\"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\" appComponents List of
Application Components that this resource belongs to. If an Application Component is not
part of the Resilience Hub application, it will be added. Type: Array Each appComponents
array item includes the following fields: name Name of the Application Component. Type:
String type Type of Application Component. For more information about the types of
Application Component, see Grouping resources in an AppComponent. Type: String
resourceNames The list of included resources that are assigned to the Application
Component. Type: Array of strings additionalInfo Additional configuration parameters
for an Resilience Hub application. If you want to implement additionalInfo through the
Resilience Hub console rather than using an API call, see Configure the application
configuration parameters. Currently, this parameter accepts a key-value mapping (in a
string format) of only one failover region and one associated account. Key:
\"failover-regions\" Value: \"[{\"region\":\"<REGION>\",
\"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\" excludedResources The list of
logical resource identifiers to be excluded from the application. Type: Array Don't add
the resources that you want to include. Each excludedResources array item includes the
following fields: logicalResourceIds Logical identifier of the resource. Type: Object
You can configure only one of the following fields: logicalStackName
resourceGroupName terraformSourceName eksSourceName Each logicalResourceIds
object includes the following fields: identifier Identifier of the resource. Type:
String logicalStackName The name of the CloudFormation stack this resource belongs to.
Type: String resourceGroupName The name of the resource group this resource belongs to.
Type: String terraformSourceName The name of the Terraform S3 state file this resource
belongs to. Type: String eksSourceName Name of the Amazon Elastic Kubernetes Service
cluster and namespace this resource belongs to. This parameter accepts values in
\"eks-cluster/namespace\" format. Type: String version Resilience Hub
application version. additionalInfo Additional configuration parameters for an
Resilience Hub application. If you want to implement additionalInfo through the Resilience
Hub console rather than using an API call, see Configure the application configuration
parameters. Currently, this parameter accepts a key-value mapping (in a string format) of
only one failover region and one associated account. Key: \"failover-regions\" Value:
\"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"
"""
function put_draft_app_version_template(
appArn, appTemplateBody; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/put-draft-app-version-template",
Dict{String,Any}("appArn" => appArn, "appTemplateBody" => appTemplateBody);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_draft_app_version_template(
appArn,
appTemplateBody,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/put-draft-app-version-template",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("appArn" => appArn, "appTemplateBody" => appTemplateBody),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_draft_app_version_resource_mappings(app_arn)
remove_draft_app_version_resource_mappings(app_arn, params::Dict{String,<:Any})
Removes resource mappings from a draft application version.
# Arguments
- `app_arn`: Amazon Resource Name (ARN) of the Resilience Hub application. The format for
this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"appRegistryAppNames"`: The names of the registered applications you want to remove from
the resource mappings.
- `"eksSourceNames"`: The names of the Amazon Elastic Kubernetes Service clusters and
namespaces you want to remove from the resource mappings. This parameter accepts values in
\"eks-cluster/namespace\" format.
- `"logicalStackNames"`: The names of the CloudFormation stacks you want to remove from the
resource mappings.
- `"resourceGroupNames"`: The names of the resource groups you want to remove from the
resource mappings.
- `"resourceNames"`: The names of the resources you want to remove from the resource
mappings.
- `"terraformSourceNames"`: The names of the Terraform sources you want to remove from the
resource mappings.
"""
function remove_draft_app_version_resource_mappings(
appArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/remove-draft-app-version-resource-mappings",
Dict{String,Any}("appArn" => appArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_draft_app_version_resource_mappings(
appArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/remove-draft-app-version-resource-mappings",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("appArn" => appArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
resolve_app_version_resources(app_arn, app_version)
resolve_app_version_resources(app_arn, app_version, params::Dict{String,<:Any})
Resolves the resources for an application version.
# Arguments
- `app_arn`: Amazon Resource Name (ARN) of the Resilience Hub application. The format for
this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
- `app_version`: The version of the application.
"""
function resolve_app_version_resources(
appArn, appVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/resolve-app-version-resources",
Dict{String,Any}("appArn" => appArn, "appVersion" => appVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function resolve_app_version_resources(
appArn,
appVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/resolve-app-version-resources",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("appArn" => appArn, "appVersion" => appVersion),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_app_assessment(app_arn, app_version, assessment_name)
start_app_assessment(app_arn, app_version, assessment_name, params::Dict{String,<:Any})
Creates a new application assessment for an application.
# Arguments
- `app_arn`: Amazon Resource Name (ARN) of the Resilience Hub application. The format for
this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
- `app_version`: The version of the application.
- `assessment_name`: The name for the assessment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Used for an idempotency token. A client token is a unique,
case-sensitive string of up to 64 ASCII characters. You should not reuse the same client
token for other API requests.
- `"tags"`: Tags assigned to the resource. A tag is a label that you assign to an Amazon
Web Services resource. Each tag consists of a key/value pair.
"""
function start_app_assessment(
appArn, appVersion, assessmentName; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/start-app-assessment",
Dict{String,Any}(
"appArn" => appArn,
"appVersion" => appVersion,
"assessmentName" => assessmentName,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_app_assessment(
appArn,
appVersion,
assessmentName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/start-app-assessment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"appArn" => appArn,
"appVersion" => appVersion,
"assessmentName" => assessmentName,
"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})
Applies one or more tags to a resource.
# Arguments
- `resource_arn`: Amazon Resource Name (ARN) of the resource.
- `tags`: The tags to assign to the resource. Each tag consists of a key/value pair.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return resiliencehub(
"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 resiliencehub(
"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 a resource.
# Arguments
- `resource_arn`: Amazon Resource Name (ARN) of the resource.
- `tag_keys`: The keys of the tags you want to remove.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"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 resiliencehub(
"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_app(app_arn)
update_app(app_arn, params::Dict{String,<:Any})
Updates an application.
# Arguments
- `app_arn`: Amazon Resource Name (ARN) of the Resilience Hub application. The format for
this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"assessmentSchedule"`: Assessment execution schedule with 'Daily' or 'Disabled' values.
- `"clearResiliencyPolicyArn"`: Specifies if the resiliency policy ARN should be cleared.
- `"description"`: The optional description for an app.
- `"eventSubscriptions"`: The list of events you would like to subscribe and get
notification for. Currently, Resilience Hub supports notifications only for Drift detected
and Scheduled assessment failure events.
- `"permissionModel"`: Defines the roles and credentials that Resilience Hub would use
while creating an application, importing its resources, and running an assessment.
- `"policyArn"`: Amazon Resource Name (ARN) of the resiliency policy. The format for this
ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more
information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services
General Reference guide.
"""
function update_app(appArn; aws_config::AbstractAWSConfig=global_aws_config())
return resiliencehub(
"POST",
"/update-app",
Dict{String,Any}("appArn" => appArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_app(
appArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/update-app",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("appArn" => appArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_app_version(app_arn)
update_app_version(app_arn, params::Dict{String,<:Any})
Updates the Resilience Hub application version. This API updates the Resilience Hub
application draft version. To use this information for running resiliency assessments, you
must publish the Resilience Hub application using the PublishAppVersion API.
# Arguments
- `app_arn`: Amazon Resource Name (ARN) of the Resilience Hub application. The format for
this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"additionalInfo"`: Additional configuration parameters for an Resilience Hub
application. If you want to implement additionalInfo through the Resilience Hub console
rather than using an API call, see Configure the application configuration parameters.
Currently, this parameter accepts a key-value mapping (in a string format) of only one
failover region and one associated account. Key: \"failover-regions\" Value:
\"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"
"""
function update_app_version(appArn; aws_config::AbstractAWSConfig=global_aws_config())
return resiliencehub(
"POST",
"/update-app-version",
Dict{String,Any}("appArn" => appArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_app_version(
appArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/update-app-version",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("appArn" => appArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_app_version_app_component(app_arn, id)
update_app_version_app_component(app_arn, id, params::Dict{String,<:Any})
Updates an existing Application Component in the Resilience Hub application. This API
updates the Resilience Hub application draft version. To use this Application Component for
running assessments, you must publish the Resilience Hub application using the
PublishAppVersion API.
# Arguments
- `app_arn`: Amazon Resource Name (ARN) of the Resilience Hub application. The format for
this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
- `id`: Identifier of the Application Component.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"additionalInfo"`: Currently, there is no supported additional information for
Application Components.
- `"name"`: Name of the Application Component.
- `"type"`: Type of Application Component. For more information about the types of
Application Component, see Grouping resources in an AppComponent.
"""
function update_app_version_app_component(
appArn, id; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/update-app-version-app-component",
Dict{String,Any}("appArn" => appArn, "id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_app_version_app_component(
appArn,
id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/update-app-version-app-component",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("appArn" => appArn, "id" => id), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_app_version_resource(app_arn)
update_app_version_resource(app_arn, params::Dict{String,<:Any})
Updates the resource details in the Resilience Hub application. This action has no
effect outside Resilience Hub. This API updates the Resilience Hub application draft
version. To use this resource for running resiliency assessments, you must publish the
Resilience Hub application using the PublishAppVersion API. To update application version
with new physicalResourceID, you must call ResolveAppVersionResources API.
# Arguments
- `app_arn`: Amazon Resource Name (ARN) of the Resilience Hub application. The format for
this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"additionalInfo"`: Currently, there is no supported additional information for resources.
- `"appComponents"`: List of Application Components that this resource belongs to. If an
Application Component is not part of the Resilience Hub application, it will be added.
- `"awsAccountId"`: Amazon Web Services account that owns the physical resource.
- `"awsRegion"`: Amazon Web Services region that owns the physical resource.
- `"excluded"`: Indicates if a resource is excluded from an Resilience Hub application.
You can exclude only imported resources from an Resilience Hub application.
- `"logicalResourceId"`: Logical identifier of the resource.
- `"physicalResourceId"`: Physical identifier of the resource.
- `"resourceName"`: Name of the resource.
- `"resourceType"`: Type of resource.
"""
function update_app_version_resource(
appArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/update-app-version-resource",
Dict{String,Any}("appArn" => appArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_app_version_resource(
appArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/update-app-version-resource",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("appArn" => appArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_resiliency_policy(policy_arn)
update_resiliency_policy(policy_arn, params::Dict{String,<:Any})
Updates a resiliency policy. Resilience Hub allows you to provide a value of zero for
rtoInSecs and rpoInSecs of your resiliency policy. But, while assessing your application,
the lowest possible assessment result is near zero. Hence, if you provide value zero for
rtoInSecs and rpoInSecs, the estimated workload RTO and estimated workload RPO result will
be near zero and the Compliance status for your application will be set to Policy breached.
# Arguments
- `policy_arn`: Amazon Resource Name (ARN) of the resiliency policy. The format for this
ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more
information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services
General Reference guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"dataLocationConstraint"`: Specifies a high-level geographical location constraint for
where your resilience policy data can be stored.
- `"policy"`: The type of resiliency policy to be created, including the recovery time
objective (RTO) and recovery point objective (RPO) in seconds.
- `"policyDescription"`: The description for the policy.
- `"policyName"`: The name of the policy
- `"tier"`: The tier for this resiliency policy, ranging from the highest severity
(MissionCritical) to lowest (NonCritical).
"""
function update_resiliency_policy(
policyArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return resiliencehub(
"POST",
"/update-resiliency-policy",
Dict{String,Any}("policyArn" => policyArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_resiliency_policy(
policyArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resiliencehub(
"POST",
"/update-resiliency-policy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("policyArn" => policyArn), 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 | 38086 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: resource_explorer_2
using AWS.Compat
using AWS.UUIDs
"""
associate_default_view(view_arn)
associate_default_view(view_arn, params::Dict{String,<:Any})
Sets the specified view as the default for the Amazon Web Services Region in which you call
this operation. When a user performs a Search that doesn't explicitly specify which view to
use, then Amazon Web Services Resource Explorer automatically chooses this default view for
searches performed in this Amazon Web Services Region. If an Amazon Web Services Region
doesn't have a default view configured, then users must explicitly specify a view with
every Search operation performed in that Region.
# Arguments
- `view_arn`: The Amazon resource name (ARN) of the view to set as the default for the
Amazon Web Services Region and Amazon Web Services account in which you call this
operation. The specified view must already exist in the called Region.
"""
function associate_default_view(ViewArn; aws_config::AbstractAWSConfig=global_aws_config())
return resource_explorer_2(
"POST",
"/AssociateDefaultView",
Dict{String,Any}("ViewArn" => ViewArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_default_view(
ViewArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_explorer_2(
"POST",
"/AssociateDefaultView",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("ViewArn" => ViewArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_view()
batch_get_view(params::Dict{String,<:Any})
Retrieves details about a list of views.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ViewArns"`: A list of Amazon resource names (ARNs) that identify the views you want
details for.
"""
function batch_get_view(; aws_config::AbstractAWSConfig=global_aws_config())
return resource_explorer_2(
"POST", "/BatchGetView"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function batch_get_view(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_explorer_2(
"POST",
"/BatchGetView",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_index()
create_index(params::Dict{String,<:Any})
Turns on Amazon Web Services Resource Explorer in the Amazon Web Services Region in which
you called this operation by creating an index. Resource Explorer begins discovering the
resources in this Region and stores the details about the resources in the index so that
they can be queried by using the Search operation. You can create only one index in a
Region. This operation creates only a local index. To promote the local index in one
Amazon Web Services Region into the aggregator index for the Amazon Web Services account,
use the UpdateIndexType operation. For more information, see Turning on cross-Region search
by creating an aggregator index in the Amazon Web Services Resource Explorer User Guide.
For more details about what happens when you turn on Resource Explorer in an Amazon Web
Services Region, see Turn on Resource Explorer to index your resources in an Amazon Web
Services Region in the Amazon Web Services Resource Explorer User Guide. If this is the
first Amazon Web Services Region in which you've created an index for Resource Explorer,
then this operation also creates a service-linked role in your Amazon Web Services account
that allows Resource Explorer to enumerate your resources to populate the index. Action:
resource-explorer-2:CreateIndex Resource: The ARN of the index (as it will exist after
the operation completes) in the Amazon Web Services Region and account in which you're
trying to create the index. Use the wildcard character (*) at the end of the string to
match the eventual UUID. For example, the following Resource element restricts the role or
user to creating an index in only the us-east-2 Region of the specified account.
\"Resource\": \"arn:aws:resource-explorer-2:us-west-2:<account-id>:index/*\"
Alternatively, you can use \"Resource\": \"*\" to allow the role or user to create an index
in any Region. Action: iam:CreateServiceLinkedRole Resource: No specific resource (*).
This permission is required only the first time you create an index to turn on Resource
Explorer in the account. Resource Explorer uses this to create the service-linked role
needed to index the resources in your account. Resource Explorer uses the same
service-linked role for all additional indexes you create afterwards.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: This value helps ensure idempotency. Resource Explorer uses this value
to prevent the accidental creation of duplicate versions. We recommend that you generate a
UUID-type value to ensure the uniqueness of your index.
- `"Tags"`: The specified tags are attached only to the index created in this Amazon Web
Services Region. The tags aren't attached to any of the resources listed in the index.
"""
function create_index(; aws_config::AbstractAWSConfig=global_aws_config())
return resource_explorer_2(
"POST",
"/CreateIndex",
Dict{String,Any}("ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_index(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_explorer_2(
"POST",
"/CreateIndex",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_view(view_name)
create_view(view_name, params::Dict{String,<:Any})
Creates a view that users can query by using the Search operation. Results from queries
that you make using this view include only resources that match the view's Filters. For
more information about Amazon Web Services Resource Explorer views, see Managing views in
the Amazon Web Services Resource Explorer User Guide. Only the principals with an IAM
identity-based policy that grants Allow to the Search action on a Resource with the Amazon
resource name (ARN) of this view can Search using views you create with this operation.
# Arguments
- `view_name`: The name of the new view. This name appears in the list of views in Resource
Explorer. The name must be no more than 64 characters long, and can include letters,
digits, and the dash (-) character. The name must be unique within its Amazon Web Services
Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: This value helps ensure idempotency. Resource Explorer uses this value
to prevent the accidental creation of duplicate versions. We recommend that you generate a
UUID-type value to ensure the uniqueness of your views.
- `"Filters"`: An array of strings that specify which resources are included in the results
of queries made using this view. When you use this view in a Search operation, the filter
string is combined with the search's QueryString parameter using a logical AND operator.
For information about the supported syntax, see Search query reference for Resource
Explorer in the Amazon Web Services Resource Explorer User Guide. This query string in the
context of this operation supports only filter prefixes with optional operators. It doesn't
support free-form text. For example, the string region:us* service:ec2 -tag:stage=prod
includes all Amazon EC2 resources in any Amazon Web Services Region that begins with the
letters us and is not tagged with a key Stage that has the value prod.
- `"IncludedProperties"`: Specifies optional fields that you want included in search
results from this view. It is a list of objects that each describe a field to include. The
default is an empty list, with no optional fields included in the results.
- `"Scope"`: The root ARN of the account, an organizational unit (OU), or an organization
ARN. If left empty, the default is account.
- `"Tags"`: Tag key and value pairs that are attached to the view.
"""
function create_view(ViewName; aws_config::AbstractAWSConfig=global_aws_config())
return resource_explorer_2(
"POST",
"/CreateView",
Dict{String,Any}("ViewName" => ViewName, "ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_view(
ViewName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resource_explorer_2(
"POST",
"/CreateView",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ViewName" => ViewName, "ClientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_index(arn)
delete_index(arn, params::Dict{String,<:Any})
Deletes the specified index and turns off Amazon Web Services Resource Explorer in the
specified Amazon Web Services Region. When you delete an index, Resource Explorer stops
discovering and indexing resources in that Region. Resource Explorer also deletes all views
in that Region. These actions occur as asynchronous background tasks. You can check to see
when the actions are complete by using the GetIndex operation and checking the Status
response value. If the index you delete is the aggregator index for the Amazon Web
Services account, you must wait 24 hours before you can promote another local index to be
the aggregator index for the account. Users can't perform account-wide searches using
Resource Explorer until another aggregator index is configured.
# Arguments
- `arn`: The Amazon resource name (ARN) of the index that you want to delete.
"""
function delete_index(Arn; aws_config::AbstractAWSConfig=global_aws_config())
return resource_explorer_2(
"POST",
"/DeleteIndex",
Dict{String,Any}("Arn" => Arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_index(
Arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_explorer_2(
"POST",
"/DeleteIndex",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Arn" => Arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_view(view_arn)
delete_view(view_arn, params::Dict{String,<:Any})
Deletes the specified view. If the specified view is the default view for its Amazon Web
Services Region, then all Search operations in that Region must explicitly specify the view
to use until you configure a new default by calling the AssociateDefaultView operation.
# Arguments
- `view_arn`: The Amazon resource name (ARN) of the view that you want to delete.
"""
function delete_view(ViewArn; aws_config::AbstractAWSConfig=global_aws_config())
return resource_explorer_2(
"POST",
"/DeleteView",
Dict{String,Any}("ViewArn" => ViewArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_view(
ViewArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_explorer_2(
"POST",
"/DeleteView",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("ViewArn" => ViewArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_default_view()
disassociate_default_view(params::Dict{String,<:Any})
After you call this operation, the affected Amazon Web Services Region no longer has a
default view. All Search operations in that Region must explicitly specify a view or the
operation fails. You can configure a new default by calling the AssociateDefaultView
operation. If an Amazon Web Services Region doesn't have a default view configured, then
users must explicitly specify a view with every Search operation performed in that Region.
"""
function disassociate_default_view(; aws_config::AbstractAWSConfig=global_aws_config())
return resource_explorer_2(
"POST",
"/DisassociateDefaultView";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_default_view(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_explorer_2(
"POST",
"/DisassociateDefaultView",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_account_level_service_configuration()
get_account_level_service_configuration(params::Dict{String,<:Any})
Retrieves the status of your account's Amazon Web Services service access, and validates
the service linked role required to access the multi-account search feature. Only the
management account or a delegated administrator with service access enabled can invoke this
API call.
"""
function get_account_level_service_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_explorer_2(
"POST",
"/GetAccountLevelServiceConfiguration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_account_level_service_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_explorer_2(
"POST",
"/GetAccountLevelServiceConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_default_view()
get_default_view(params::Dict{String,<:Any})
Retrieves the Amazon Resource Name (ARN) of the view that is the default for the Amazon Web
Services Region in which you call this operation. You can then call GetView to retrieve the
details of that view.
"""
function get_default_view(; aws_config::AbstractAWSConfig=global_aws_config())
return resource_explorer_2(
"POST", "/GetDefaultView"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_default_view(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_explorer_2(
"POST",
"/GetDefaultView",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_index()
get_index(params::Dict{String,<:Any})
Retrieves details about the Amazon Web Services Resource Explorer index in the Amazon Web
Services Region in which you invoked the operation.
"""
function get_index(; aws_config::AbstractAWSConfig=global_aws_config())
return resource_explorer_2(
"POST", "/GetIndex"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_index(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_explorer_2(
"POST", "/GetIndex", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_view(view_arn)
get_view(view_arn, params::Dict{String,<:Any})
Retrieves details of the specified view.
# Arguments
- `view_arn`: The Amazon resource name (ARN) of the view that you want information about.
"""
function get_view(ViewArn; aws_config::AbstractAWSConfig=global_aws_config())
return resource_explorer_2(
"POST",
"/GetView",
Dict{String,Any}("ViewArn" => ViewArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_view(
ViewArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_explorer_2(
"POST",
"/GetView",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("ViewArn" => ViewArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_indexes()
list_indexes(params::Dict{String,<:Any})
Retrieves a list of all of the indexes in Amazon Web Services Regions that are currently
collecting resource information for Amazon Web Services Resource Explorer.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value appropriate to the
operation. If additional items exist beyond those included in the current response, the
NextToken response element is present and has a value (is not null). Include that value as
the NextToken request parameter in the next call to the operation to get the next part of
the results. An API operation can return fewer results than the maximum even when there
are more results available. You should check NextToken after every operation to ensure that
you receive all of the results.
- `"NextToken"`: The parameter for receiving additional results if you receive a NextToken
response in a previous request. A NextToken response indicates that more output is
available. Set this parameter to the value of the previous call's NextToken response to
indicate where the output should continue from. The pagination tokens expire after 24 hours.
- `"Regions"`: If specified, limits the response to only information about the index in the
specified list of Amazon Web Services Regions.
- `"Type"`: If specified, limits the output to only indexes of the specified Type, either
LOCAL or AGGREGATOR. Use this option to discover the aggregator index for your account.
"""
function list_indexes(; aws_config::AbstractAWSConfig=global_aws_config())
return resource_explorer_2(
"POST", "/ListIndexes"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_indexes(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_explorer_2(
"POST",
"/ListIndexes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_indexes_for_members(account_id_list)
list_indexes_for_members(account_id_list, params::Dict{String,<:Any})
Retrieves a list of a member's indexes in all Amazon Web Services Regions that are
currently collecting resource information for Amazon Web Services Resource Explorer. Only
the management account or a delegated administrator with service access enabled can invoke
this API call.
# Arguments
- `account_id_list`: The account IDs will limit the output to only indexes from these
accounts.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value appropriate to the
operation. If additional items exist beyond those included in the current response, the
NextToken response element is present and has a value (is not null). Include that value as
the NextToken request parameter in the next call to the operation to get the next part of
the results. An API operation can return fewer results than the maximum even when there
are more results available. You should check NextToken after every operation to ensure that
you receive all of the results.
- `"NextToken"`: The parameter for receiving additional results if you receive a NextToken
response in a previous request. A NextToken response indicates that more output is
available. Set this parameter to the value of the previous call's NextToken response to
indicate where the output should continue from. The pagination tokens expire after 24 hours.
"""
function list_indexes_for_members(
AccountIdList; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_explorer_2(
"POST",
"/ListIndexesForMembers",
Dict{String,Any}("AccountIdList" => AccountIdList);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_indexes_for_members(
AccountIdList,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resource_explorer_2(
"POST",
"/ListIndexesForMembers",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AccountIdList" => AccountIdList), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_supported_resource_types()
list_supported_resource_types(params::Dict{String,<:Any})
Retrieves a list of all resource types currently supported by Amazon Web Services Resource
Explorer.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value appropriate to the
operation. If additional items exist beyond those included in the current response, the
NextToken response element is present and has a value (is not null). Include that value as
the NextToken request parameter in the next call to the operation to get the next part of
the results. An API operation can return fewer results than the maximum even when there
are more results available. You should check NextToken after every operation to ensure that
you receive all of the results.
- `"NextToken"`: The parameter for receiving additional results if you receive a NextToken
response in a previous request. A NextToken response indicates that more output is
available. Set this parameter to the value of the previous call's NextToken response to
indicate where the output should continue from. The pagination tokens expire after 24 hours.
"""
function list_supported_resource_types(; aws_config::AbstractAWSConfig=global_aws_config())
return resource_explorer_2(
"POST",
"/ListSupportedResourceTypes";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_supported_resource_types(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_explorer_2(
"POST",
"/ListSupportedResourceTypes",
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 attached to the specified resource.
# Arguments
- `resource_arn`: The Amazon resource name (ARN) of the view or index that you want to
attach tags to.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_explorer_2(
"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 resource_explorer_2(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_views()
list_views(params::Dict{String,<:Any})
Lists the Amazon resource names (ARNs) of the views available in the Amazon Web Services
Region in which you call this operation. Always check the NextToken response parameter for
a null value when calling a paginated operation. These operations can occasionally return
an empty set of results even when there are more results available. The NextToken response
parameter value is null only when there are no more results to display.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value appropriate to the
operation. If additional items exist beyond those included in the current response, the
NextToken response element is present and has a value (is not null). Include that value as
the NextToken request parameter in the next call to the operation to get the next part of
the results. An API operation can return fewer results than the maximum even when there
are more results available. You should check NextToken after every operation to ensure that
you receive all of the results.
- `"NextToken"`: The parameter for receiving additional results if you receive a NextToken
response in a previous request. A NextToken response indicates that more output is
available. Set this parameter to the value of the previous call's NextToken response to
indicate where the output should continue from. The pagination tokens expire after 24 hours.
"""
function list_views(; aws_config::AbstractAWSConfig=global_aws_config())
return resource_explorer_2(
"POST", "/ListViews"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_views(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_explorer_2(
"POST", "/ListViews", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
search(query_string)
search(query_string, params::Dict{String,<:Any})
Searches for resources and displays details about all resources that match the specified
criteria. You must specify a query string. All search queries must use a view. If you don't
explicitly specify a view, then Amazon Web Services Resource Explorer uses the default view
for the Amazon Web Services Region in which you call this operation. The results are the
logical intersection of the results that match both the QueryString parameter supplied to
this operation and the SearchFilter parameter attached to the view. For the complete syntax
supported by the QueryString parameter, see Search query syntax reference for Resource
Explorer. If your search results are empty, or are missing results that you think should be
there, see Troubleshooting Resource Explorer search.
# Arguments
- `query_string`: A string that includes keywords and filters that specify the resources
that you want to include in the results. For the complete syntax supported by the
QueryString parameter, see Search query syntax reference for Resource Explorer. The search
is completely case insensitive. You can specify an empty string to return all results up to
the limit of 1,000 total results. The operation can return only the first 1,000 results.
If the resource you want is not included, then use a different value for QueryString to
refine the results.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value appropriate to the
operation. If additional items exist beyond those included in the current response, the
NextToken response element is present and has a value (is not null). Include that value as
the NextToken request parameter in the next call to the operation to get the next part of
the results. An API operation can return fewer results than the maximum even when there
are more results available. You should check NextToken after every operation to ensure that
you receive all of the results.
- `"NextToken"`: The parameter for receiving additional results if you receive a NextToken
response in a previous request. A NextToken response indicates that more output is
available. Set this parameter to the value of the previous call's NextToken response to
indicate where the output should continue from. The pagination tokens expire after 24 hours.
- `"ViewArn"`: Specifies the Amazon resource name (ARN) of the view to use for the query.
If you don't specify a value for this parameter, then the operation automatically uses the
default view for the Amazon Web Services Region in which you called this operation. If the
Region either doesn't have a default view or if you don't have permission to use the
default view, then the operation fails with a 401 Unauthorized exception.
"""
function search(QueryString; aws_config::AbstractAWSConfig=global_aws_config())
return resource_explorer_2(
"POST",
"/Search",
Dict{String,Any}("QueryString" => QueryString);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search(
QueryString,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resource_explorer_2(
"POST",
"/Search",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("QueryString" => QueryString), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn)
tag_resource(resource_arn, params::Dict{String,<:Any})
Adds one or more tag key and value pairs to an Amazon Web Services Resource Explorer view
or index.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the view or index that you want to
attach tags to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: A list of tag key and value pairs that you want to attach to the specified view
or index.
"""
function tag_resource(resourceArn; aws_config::AbstractAWSConfig=global_aws_config())
return resource_explorer_2(
"POST",
"/tags/$(resourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resource_explorer_2(
"POST",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes one or more tag key and value pairs from an Amazon Web Services Resource Explorer
view or index.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the view or index that you want to
remove tags from.
- `tag_keys`: A list of the keys for the tags that you want to remove from the specified
view or index.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_explorer_2(
"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 resource_explorer_2(
"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_index_type(arn, type)
update_index_type(arn, type, params::Dict{String,<:Any})
Changes the type of the index from one of the following types to the other. For more
information about indexes and the role they perform in Amazon Web Services Resource
Explorer, see Turning on cross-Region search by creating an aggregator index in the Amazon
Web Services Resource Explorer User Guide. AGGREGATOR index type The index contains
information about resources from all Amazon Web Services Regions in the Amazon Web Services
account in which you've created a Resource Explorer index. Resource information from all
other Regions is replicated to this Region's index. When you change the index type to
AGGREGATOR, Resource Explorer turns on replication of all discovered resource information
from the other Amazon Web Services Regions in your account to this index. You can then,
from this Region only, perform resource search queries that span all Amazon Web Services
Regions in the Amazon Web Services account. Turning on replication from all other Regions
is performed by asynchronous background tasks. You can check the status of the asynchronous
tasks by using the GetIndex operation. When the asynchronous tasks complete, the Status
response of that operation changes from UPDATING to ACTIVE. After that, you can start to
see results from other Amazon Web Services Regions in query results. However, it can take
several hours for replication from all other Regions to complete. You can have only one
aggregator index per Amazon Web Services account. Before you can promote a different index
to be the aggregator index for the account, you must first demote the existing aggregator
index to type LOCAL. LOCAL index type The index contains information about resources
in only the Amazon Web Services Region in which the index exists. If an aggregator index in
another Region exists, then information in this local index is replicated to the aggregator
index. When you change the index type to LOCAL, Resource Explorer turns off the replication
of resource information from all other Amazon Web Services Regions in the Amazon Web
Services account to this Region. The aggregator index remains in the UPDATING state until
all replication with other Regions successfully stops. You can check the status of the
asynchronous task by using the GetIndex operation. When Resource Explorer successfully
stops all replication with other Regions, the Status response of that operation changes
from UPDATING to ACTIVE. Separately, the resource information from other Regions that was
previously stored in the index is deleted within 30 days by another background task. Until
that asynchronous task completes, some results from other Regions can continue to appear in
search results. After you demote an aggregator index to a local index, you must wait 24
hours before you can promote another index to be the new aggregator index for the account.
# Arguments
- `arn`: The Amazon resource name (ARN) of the index that you want to update.
- `type`: The type of the index. To understand the difference between LOCAL and AGGREGATOR,
see Turning on cross-Region search in the Amazon Web Services Resource Explorer User Guide.
"""
function update_index_type(Arn, Type; aws_config::AbstractAWSConfig=global_aws_config())
return resource_explorer_2(
"POST",
"/UpdateIndexType",
Dict{String,Any}("Arn" => Arn, "Type" => Type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_index_type(
Arn,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resource_explorer_2(
"POST",
"/UpdateIndexType",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Arn" => Arn, "Type" => Type), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_view(view_arn)
update_view(view_arn, params::Dict{String,<:Any})
Modifies some of the details of a view. You can change the filter string and the list of
included properties. You can't change the name of the view.
# Arguments
- `view_arn`: The Amazon resource name (ARN) of the view that you want to modify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An array of strings that specify which resources are included in the results
of queries made using this view. When you use this view in a Search operation, the filter
string is combined with the search's QueryString parameter using a logical AND operator.
For information about the supported syntax, see Search query reference for Resource
Explorer in the Amazon Web Services Resource Explorer User Guide. This query string in the
context of this operation supports only filter prefixes with optional operators. It doesn't
support free-form text. For example, the string region:us* service:ec2 -tag:stage=prod
includes all Amazon EC2 resources in any Amazon Web Services Region that begins with the
letters us and is not tagged with a key Stage that has the value prod.
- `"IncludedProperties"`: Specifies optional fields that you want included in search
results from this view. It is a list of objects that each describe a field to include. The
default is an empty list, with no optional fields included in the results.
"""
function update_view(ViewArn; aws_config::AbstractAWSConfig=global_aws_config())
return resource_explorer_2(
"POST",
"/UpdateView",
Dict{String,Any}("ViewArn" => ViewArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_view(
ViewArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_explorer_2(
"POST",
"/UpdateView",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("ViewArn" => ViewArn), 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 | 28570 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: resource_groups
using AWS.Compat
using AWS.UUIDs
"""
create_group(name)
create_group(name, params::Dict{String,<:Any})
Creates a resource group with the specified name and description. You can optionally
include either a resource query or a service configuration. For more information about
constructing a resource query, see Build queries and groups in Resource Groups in the
Resource Groups User Guide. For more information about service-linked groups and service
configurations, see Service configurations for Resource Groups. Minimum permissions To
run this command, you must have the following permissions: resource-groups:CreateGroup
# Arguments
- `name`: The name of the group, which is the identifier of the group in other operations.
You can't change the name of a resource group after you create it. A resource group name
can consist of letters, numbers, hyphens, periods, and underscores. The name cannot start
with AWS, aws, or any other possible capitalization; these are reserved. A resource group
name must be unique within each Amazon Web Services Region in your Amazon Web Services
account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Configuration"`: A configuration associates the resource group with an Amazon Web
Services service and specifies how the service can interact with the resources in the
group. A configuration is an array of GroupConfigurationItem elements. For details about
the syntax of service configurations, see Service configurations for Resource Groups. A
resource group can contain either a Configuration or a ResourceQuery, but not both.
- `"Description"`: The description of the resource group. Descriptions can consist of
letters, numbers, hyphens, underscores, periods, and spaces.
- `"ResourceQuery"`: The resource query that determines which Amazon Web Services resources
are members of this group. For more information about resource queries, see Create a
tag-based group in Resource Groups. A resource group can contain either a ResourceQuery
or a Configuration, but not both.
- `"Tags"`: The tags to add to the group. A tag is key-value pair string.
"""
function create_group(Name; aws_config::AbstractAWSConfig=global_aws_config())
return resource_groups(
"POST",
"/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 resource_groups(
"POST",
"/groups",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_group()
delete_group(params::Dict{String,<:Any})
Deletes the specified resource group. Deleting a resource group does not delete any
resources that are members of the group; it only deletes the group structure. Minimum
permissions To run this command, you must have the following permissions:
resource-groups:DeleteGroup
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Group"`: The name or the ARN of the resource group to delete.
- `"GroupName"`: Deprecated - don't use this parameter. Use Group instead.
"""
function delete_group(; aws_config::AbstractAWSConfig=global_aws_config())
return resource_groups(
"POST", "/delete-group"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_group(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_groups(
"POST",
"/delete-group",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_account_settings()
get_account_settings(params::Dict{String,<:Any})
Retrieves the current status of optional features in Resource Groups.
"""
function get_account_settings(; aws_config::AbstractAWSConfig=global_aws_config())
return resource_groups(
"POST",
"/get-account-settings";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_account_settings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_groups(
"POST",
"/get-account-settings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_group()
get_group(params::Dict{String,<:Any})
Returns information about a specified resource group. Minimum permissions To run this
command, you must have the following permissions: resource-groups:GetGroup
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Group"`: The name or the ARN of the resource group to retrieve.
- `"GroupName"`: Deprecated - don't use this parameter. Use Group instead.
"""
function get_group(; aws_config::AbstractAWSConfig=global_aws_config())
return resource_groups(
"POST", "/get-group"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_group(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_groups(
"POST", "/get-group", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_group_configuration()
get_group_configuration(params::Dict{String,<:Any})
Retrieves the service configuration associated with the specified resource group. For
details about the service configuration syntax, see Service configurations for Resource
Groups. Minimum permissions To run this command, you must have the following permissions:
resource-groups:GetGroupConfiguration
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Group"`: The name or the ARN of the resource group for which you want to retrive the
service configuration.
"""
function get_group_configuration(; aws_config::AbstractAWSConfig=global_aws_config())
return resource_groups(
"POST",
"/get-group-configuration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_group_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_groups(
"POST",
"/get-group-configuration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_group_query()
get_group_query(params::Dict{String,<:Any})
Retrieves the resource query associated with the specified resource group. For more
information about resource queries, see Create a tag-based group in Resource Groups.
Minimum permissions To run this command, you must have the following permissions:
resource-groups:GetGroupQuery
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Group"`: The name or the ARN of the resource group to query.
- `"GroupName"`: Don't use this parameter. Use Group instead.
"""
function get_group_query(; aws_config::AbstractAWSConfig=global_aws_config())
return resource_groups(
"POST", "/get-group-query"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_group_query(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_groups(
"POST",
"/get-group-query",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_tags(arn)
get_tags(arn, params::Dict{String,<:Any})
Returns a list of tags that are associated with a resource group, specified by an ARN.
Minimum permissions To run this command, you must have the following permissions:
resource-groups:GetTags
# Arguments
- `arn`: The ARN of the resource group whose tags you want to retrieve.
"""
function get_tags(Arn; aws_config::AbstractAWSConfig=global_aws_config())
return resource_groups(
"GET",
"/resources/$(Arn)/tags";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_tags(
Arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_groups(
"GET",
"/resources/$(Arn)/tags",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
group_resources(group, resource_arns)
group_resources(group, resource_arns, params::Dict{String,<:Any})
Adds the specified resources to the specified group. You can use this operation with only
resource groups that are configured with the following types: AWS::EC2::HostManagement
AWS::EC2::CapacityReservationPool Other resource group type and resource types aren't
currently supported by this operation. Minimum permissions To run this command, you must
have the following permissions: resource-groups:GroupResources
# Arguments
- `group`: The name or the ARN of the resource group to add resources to.
- `resource_arns`: The list of ARNs of the resources to be added to the group.
"""
function group_resources(
Group, ResourceArns; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_groups(
"POST",
"/group-resources",
Dict{String,Any}("Group" => Group, "ResourceArns" => ResourceArns);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function group_resources(
Group,
ResourceArns,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resource_groups(
"POST",
"/group-resources",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Group" => Group, "ResourceArns" => ResourceArns),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_group_resources()
list_group_resources(params::Dict{String,<:Any})
Returns a list of ARNs of the resources that are members of a specified resource group.
Minimum permissions To run this command, you must have the following permissions:
resource-groups:ListGroupResources cloudformation:DescribeStacks
cloudformation:ListStackResources tag:GetResources
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters, formatted as ResourceFilter objects, that you want to apply to a
ListGroupResources operation. Filters the results to include only those of the specified
resource types. resource-type - Filter resources by their type. Specify up to five
resource types in the format AWS::ServiceCode::ResourceType. For example,
AWS::EC2::Instance, or AWS::S3::Bucket. When you specify a resource-type filter for
ListGroupResources, Resource Groups validates your filter resource types against the types
that are defined in the query associated with the group. For example, if a group contains
only S3 buckets because its query specifies only that resource type, but your resource-type
filter includes EC2 instances, AWS Resource Groups does not filter for EC2 instances. In
this case, a ListGroupResources request returns a BadRequestException error with a message
similar to the following: The resource types specified as filters in the request are not
valid. The error includes a list of resource types that failed the validation because they
are not part of the query associated with the group. This validation doesn't occur when the
group query specifies AWS::AllSupported, because a group based on such a query can contain
any of the allowed resource types for the query type (tag-based or Amazon CloudFront
stack-based queries).
- `"Group"`: The name or the ARN of the resource group
- `"GroupName"`: Deprecated - don't use this parameter. Use the Group request field
instead.
- `"MaxResults"`: The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value that is specific to
the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (is not null). Include that value as the
NextToken request parameter in the next call to the operation to get the next part of the
results. Note that the service might return fewer results than the maximum even when there
are more results available. You should check NextToken after every operation to ensure that
you receive all of the results.
- `"NextToken"`: The parameter for receiving additional results if you receive a NextToken
response in a previous request. A NextToken response indicates that more output is
available. Set this parameter to the value provided by a previous call's NextToken response
to indicate where the output should continue from.
"""
function list_group_resources(; aws_config::AbstractAWSConfig=global_aws_config())
return resource_groups(
"POST",
"/list-group-resources";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_group_resources(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_groups(
"POST",
"/list-group-resources",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_groups()
list_groups(params::Dict{String,<:Any})
Returns a list of existing Resource Groups in your account. Minimum permissions To run
this command, you must have the following permissions: resource-groups:ListGroups
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters, formatted as GroupFilter objects, that you want to apply to a
ListGroups operation. resource-type - Filter the results to include only those resource
groups that have the specified resource type in their ResourceTypeFilter. For example,
AWS::EC2::Instance would return any resource group with a ResourceTypeFilter that includes
AWS::EC2::Instance. configuration-type - Filter the results to include only those groups
that have the specified configuration types attached. The current supported values are:
AWS::AppRegistry::Application AWS::AppRegistry::ApplicationResourceGroups
AWS::CloudFormation::Stack AWS::EC2::CapacityReservationPool
AWS::EC2::HostManagement AWS::NetworkFirewall::RuleGroup
- `"maxResults"`: The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value that is specific to
the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (is not null). Include that value as the
NextToken request parameter in the next call to the operation to get the next part of the
results. Note that the service might return fewer results than the maximum even when there
are more results available. You should check NextToken after every operation to ensure that
you receive all of the results.
- `"nextToken"`: The parameter for receiving additional results if you receive a NextToken
response in a previous request. A NextToken response indicates that more output is
available. Set this parameter to the value provided by a previous call's NextToken response
to indicate where the output should continue from.
"""
function list_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return resource_groups(
"POST", "/groups-list"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_groups(
"POST",
"/groups-list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_group_configuration()
put_group_configuration(params::Dict{String,<:Any})
Attaches a service configuration to the specified group. This occurs asynchronously, and
can take time to complete. You can use GetGroupConfiguration to check the status of the
update. Minimum permissions To run this command, you must have the following permissions:
resource-groups:PutGroupConfiguration
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Configuration"`: The new configuration to associate with the specified group. A
configuration associates the resource group with an Amazon Web Services service and
specifies how the service can interact with the resources in the group. A configuration is
an array of GroupConfigurationItem elements. For information about the syntax of a service
configuration, see Service configurations for Resource Groups. A resource group can
contain either a Configuration or a ResourceQuery, but not both.
- `"Group"`: The name or ARN of the resource group with the configuration that you want to
update.
"""
function put_group_configuration(; aws_config::AbstractAWSConfig=global_aws_config())
return resource_groups(
"POST",
"/put-group-configuration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_group_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_groups(
"POST",
"/put-group-configuration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_resources(resource_query)
search_resources(resource_query, params::Dict{String,<:Any})
Returns a list of Amazon Web Services resource identifiers that matches the specified
query. The query uses the same format as a resource query in a CreateGroup or
UpdateGroupQuery operation. Minimum permissions To run this command, you must have the
following permissions: resource-groups:SearchResources cloudformation:DescribeStacks
cloudformation:ListStackResources tag:GetResources
# Arguments
- `resource_query`: The search query, using the same formats that are supported for
resource group definition. For more information, see CreateGroup.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value that is specific to
the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (is not null). Include that value as the
NextToken request parameter in the next call to the operation to get the next part of the
results. Note that the service might return fewer results than the maximum even when there
are more results available. You should check NextToken after every operation to ensure that
you receive all of the results.
- `"NextToken"`: The parameter for receiving additional results if you receive a NextToken
response in a previous request. A NextToken response indicates that more output is
available. Set this parameter to the value provided by a previous call's NextToken response
to indicate where the output should continue from.
"""
function search_resources(ResourceQuery; aws_config::AbstractAWSConfig=global_aws_config())
return resource_groups(
"POST",
"/resources/search",
Dict{String,Any}("ResourceQuery" => ResourceQuery);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_resources(
ResourceQuery,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resource_groups(
"POST",
"/resources/search",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceQuery" => ResourceQuery), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag(arn, tags)
tag(arn, tags, params::Dict{String,<:Any})
Adds tags to a resource group with the specified ARN. Existing tags on a resource group are
not changed if they are not specified in the request parameters. Do not store personally
identifiable information (PII) or other confidential or sensitive information in tags. We
use tags to provide you with billing and administration services. Tags are not intended to
be used for private or sensitive data. Minimum permissions To run this command, you must
have the following permissions: resource-groups:Tag
# Arguments
- `arn`: The ARN of the resource group to which to add tags.
- `tags`: The tags to add to the specified resource group. A tag is a string-to-string map
of key-value pairs.
"""
function tag(Arn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return resource_groups(
"PUT",
"/resources/$(Arn)/tags",
Dict{String,Any}("Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag(
Arn,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resource_groups(
"PUT",
"/resources/$(Arn)/tags",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Tags" => Tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
ungroup_resources(group, resource_arns)
ungroup_resources(group, resource_arns, params::Dict{String,<:Any})
Removes the specified resources from the specified group. This operation works only with
static groups that you populated using the GroupResources operation. It doesn't work with
any resource groups that are automatically populated by tag-based or CloudFormation
stack-based queries. Minimum permissions To run this command, you must have the following
permissions: resource-groups:UngroupResources
# Arguments
- `group`: The name or the ARN of the resource group from which to remove the resources.
- `resource_arns`: The ARNs of the resources to be removed from the group.
"""
function ungroup_resources(
Group, ResourceArns; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_groups(
"POST",
"/ungroup-resources",
Dict{String,Any}("Group" => Group, "ResourceArns" => ResourceArns);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function ungroup_resources(
Group,
ResourceArns,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resource_groups(
"POST",
"/ungroup-resources",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Group" => Group, "ResourceArns" => ResourceArns),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag(arn, keys)
untag(arn, keys, params::Dict{String,<:Any})
Deletes tags from a specified resource group. Minimum permissions To run this command,
you must have the following permissions: resource-groups:Untag
# Arguments
- `arn`: The ARN of the resource group from which to remove tags. The command removed both
the specified keys and any values associated with those keys.
- `keys`: The keys of the tags to be removed.
"""
function untag(Arn, Keys; aws_config::AbstractAWSConfig=global_aws_config())
return resource_groups(
"PATCH",
"/resources/$(Arn)/tags",
Dict{String,Any}("Keys" => Keys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag(
Arn,
Keys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resource_groups(
"PATCH",
"/resources/$(Arn)/tags",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Keys" => Keys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_account_settings()
update_account_settings(params::Dict{String,<:Any})
Turns on or turns off optional features in Resource Groups. The preceding example shows
that the request to turn on group lifecycle events is IN_PROGRESS. You can call the
GetAccountSettings operation to check for completion by looking for
GroupLifecycleEventsStatus to change to ACTIVE.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GroupLifecycleEventsDesiredStatus"`: Specifies whether you want to turn group lifecycle
events on or off.
"""
function update_account_settings(; aws_config::AbstractAWSConfig=global_aws_config())
return resource_groups(
"POST",
"/update-account-settings";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_account_settings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_groups(
"POST",
"/update-account-settings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_group()
update_group(params::Dict{String,<:Any})
Updates the description for an existing group. You cannot update the name of a resource
group. Minimum permissions To run this command, you must have the following permissions:
resource-groups:UpdateGroup
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The new description that you want to update the resource group with.
Descriptions can contain letters, numbers, hyphens, underscores, periods, and spaces.
- `"Group"`: The name or the ARN of the resource group to modify.
- `"GroupName"`: Don't use this parameter. Use Group instead.
"""
function update_group(; aws_config::AbstractAWSConfig=global_aws_config())
return resource_groups(
"POST", "/update-group"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function update_group(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_groups(
"POST",
"/update-group",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_group_query(resource_query)
update_group_query(resource_query, params::Dict{String,<:Any})
Updates the resource query of a group. For more information about resource queries, see
Create a tag-based group in Resource Groups. Minimum permissions To run this command, you
must have the following permissions: resource-groups:UpdateGroupQuery
# Arguments
- `resource_query`: The resource query to determine which Amazon Web Services resources are
members of this resource group. A resource group can contain either a Configuration or a
ResourceQuery, but not both.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Group"`: The name or the ARN of the resource group to query.
- `"GroupName"`: Don't use this parameter. Use Group instead.
"""
function update_group_query(
ResourceQuery; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_groups(
"POST",
"/update-group-query",
Dict{String,Any}("ResourceQuery" => ResourceQuery);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_group_query(
ResourceQuery,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resource_groups(
"POST",
"/update-group-query",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceQuery" => ResourceQuery), 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 | 21949 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: resource_groups_tagging_api
using AWS.Compat
using AWS.UUIDs
"""
describe_report_creation()
describe_report_creation(params::Dict{String,<:Any})
Describes the status of the StartReportCreation operation. You can call this operation
only from the organization's management account and from the us-east-1 Region.
"""
function describe_report_creation(; aws_config::AbstractAWSConfig=global_aws_config())
return resource_groups_tagging_api(
"DescribeReportCreation"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_report_creation(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_groups_tagging_api(
"DescribeReportCreation",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_compliance_summary()
get_compliance_summary(params::Dict{String,<:Any})
Returns a table that shows counts of resources that are noncompliant with their tag
policies. For more information on tag policies, see Tag Policies in the Organizations User
Guide. You can call this operation only from the organization's management account and
from the us-east-1 Region. This operation supports pagination, where the response can be
sent in multiple pages. You should check the PaginationToken response parameter to
determine if there are additional results available to return. Repeat the query, passing
the PaginationToken response parameter value as an input to the next request until you
recieve a null value. A null value for PaginationToken indicates that there are no more
results waiting to be returned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GroupBy"`: Specifies a list of attributes to group the counts of noncompliant resources
by. If supplied, the counts are sorted by those attributes.
- `"MaxResults"`: Specifies the maximum number of results to be returned in each page. A
query can return fewer than this maximum, even if there are more results still to return.
You should always check the PaginationToken response value to see if there are more
results. You can specify a minimum of 1 and a maximum value of 100.
- `"PaginationToken"`: Specifies a PaginationToken response value from a previous request
to indicate that you want the next page of results. Leave this parameter empty in your
initial request.
- `"RegionFilters"`: Specifies a list of Amazon Web Services Regions to limit the output
to. If you use this parameter, the count of returned noncompliant resources includes only
resources in the specified Regions.
- `"ResourceTypeFilters"`: Specifies that you want the response to include information for
only resources of the specified types. The format of each resource type is
service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon
EC2 resources (which includes EC2 instances). Specifying a resource type of ec2:instance
returns only EC2 instances. The string for each service name and resource type is the same
as that embedded in a resource's Amazon Resource Name (ARN). Consult the Amazon Web
Services General Reference for the following: For a list of service name strings, see
Amazon Web Services Service Namespaces. For resource type strings, see Example ARNs.
For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services
Service Namespaces. You can specify multiple resource types by using a comma separated
array. The array can include up to 100 items. Note that the length constraint requirement
applies to each resource type filter.
- `"TagKeyFilters"`: Specifies that you want the response to include information for only
resources that have tags with the specified tag keys. If you use this parameter, the count
of returned noncompliant resources includes only resources that have the specified tag keys.
- `"TargetIdFilters"`: Specifies target identifiers (usually, specific account IDs) to
limit the output by. If you use this parameter, the count of returned noncompliant
resources includes only resources with the specified target IDs.
"""
function get_compliance_summary(; aws_config::AbstractAWSConfig=global_aws_config())
return resource_groups_tagging_api(
"GetComplianceSummary"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_compliance_summary(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_groups_tagging_api(
"GetComplianceSummary",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resources()
get_resources(params::Dict{String,<:Any})
Returns all the tagged or previously tagged resources that are located in the specified
Amazon Web Services Region for the account. Depending on what information you want
returned, you can also specify the following: Filters that specify what tags and
resource types you want returned. The response includes all tags that are associated with
the requested resources. Information about compliance with the account's effective tag
policy. For more information on tag policies, see Tag Policies in the Organizations User
Guide. This operation supports pagination, where the response can be sent in multiple
pages. You should check the PaginationToken response parameter to determine if there are
additional results available to return. Repeat the query, passing the PaginationToken
response parameter value as an input to the next request until you recieve a null value. A
null value for PaginationToken indicates that there are no more results waiting to be
returned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExcludeCompliantResources"`: Specifies whether to exclude resources that are compliant
with the tag policy. Set this to true if you are interested in retrieving information on
noncompliant resources only. You can use this parameter only if the
IncludeComplianceDetails parameter is also set to true.
- `"IncludeComplianceDetails"`: Specifies whether to include details regarding the
compliance with the effective tag policy. Set this to true to determine whether resources
are compliant with the tag policy and to get details.
- `"PaginationToken"`: Specifies a PaginationToken response value from a previous request
to indicate that you want the next page of results. Leave this parameter empty in your
initial request.
- `"ResourceARNList"`: Specifies a list of ARNs of resources for which you want to retrieve
tag data. You can't specify both this parameter and any of the pagination parameters
(ResourcesPerPage, TagsPerPage, PaginationToken) in the same request. If you specify both,
you get an Invalid Parameter exception. If a resource specified by this parameter doesn't
exist, it doesn't generate an error; it simply isn't included in the response. An ARN
(Amazon Resource Name) uniquely identifies a resource. For more information, see Amazon
Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services
General Reference.
- `"ResourceTypeFilters"`: Specifies the resource types that you want included in the
response. The format of each resource type is service[:resourceType]. For example,
specifying a resource type of ec2 returns all Amazon EC2 resources (which includes EC2
instances). Specifying a resource type of ec2:instance returns only EC2 instances. The
string for each service name and resource type is the same as that embedded in a resource's
Amazon Resource Name (ARN). For the list of services whose resources you can use in this
parameter, see Services that support the Resource Groups Tagging API. You can specify
multiple resource types by using an array. The array can include up to 100 items. Note that
the length constraint requirement applies to each resource type filter. For example, the
following string would limit the response to only Amazon EC2 instances, Amazon S3 buckets,
or any Audit Manager resource: ec2:instance,s3:bucket,auditmanager
- `"ResourcesPerPage"`: Specifies the maximum number of results to be returned in each
page. A query can return fewer than this maximum, even if there are more results still to
return. You should always check the PaginationToken response value to see if there are more
results. You can specify a minimum of 1 and a maximum value of 100.
- `"TagFilters"`: Specifies a list of TagFilters (keys and values) to restrict the output
to only those resources that have tags with the specified keys and, if included, the
specified values. Each TagFilter must contain a key with values optional. A request can
include up to 50 keys, and each key can include up to 20 values. Note the following when
deciding how to use TagFilters: If you don't specify a TagFilter, the response includes
all resources that are currently tagged or ever had a tag. Resources that currently don't
have tags are shown with an empty tag set, like this: \"Tags\": []. If you specify more
than one filter in a single request, the response returns only those resources that satisfy
all filters. If you specify a filter that contains more than one value for a key, the
response returns resources that match any of the specified values for that key. If you
don't specify a value for a key, the response returns all resources that are tagged with
that key, with any or no value. For example, for the following filters: filter1=
{keyA,{value1}}, filter2={keyB,{value2,value3,value4}}, filter3= {keyC}:
GetResources({filter1}) returns resources tagged with key1=value1
GetResources({filter2}) returns resources tagged with key2=value2 or key2=value3 or
key2=value4 GetResources({filter3}) returns resources tagged with any tag with the key
key3, and with any or no value GetResources({filter1,filter2,filter3}) returns resources
tagged with (key1=value1) and (key2=value2 or key2=value3 or key2=value4) and (key3, any or
no value)
- `"TagsPerPage"`: Amazon Web Services recommends using ResourcesPerPage instead of this
parameter. A limit that restricts the number of tags (key and value pairs) returned by
GetResources in paginated output. A resource with no tags is counted as having one tag (one
key and value pair). GetResources does not split a resource and its associated tags across
pages. If the specified TagsPerPage would cause such a break, a PaginationToken is returned
in place of the affected resource and its tags. Use that token in another request to get
the remaining data. For example, if you specify a TagsPerPage of 100 and the account has 22
resources with 10 tags each (meaning that each resource has 10 key and value pairs), the
output will consist of three pages. The first page displays the first 10 resources, each
with its 10 tags. The second page displays the next 10 resources, each with its 10 tags.
The third page displays the remaining 2 resources, each with its 10 tags. You can set
TagsPerPage to a minimum of 100 items up to a maximum of 500 items.
"""
function get_resources(; aws_config::AbstractAWSConfig=global_aws_config())
return resource_groups_tagging_api(
"GetResources"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_resources(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_groups_tagging_api(
"GetResources", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_tag_keys()
get_tag_keys(params::Dict{String,<:Any})
Returns all tag keys currently in use in the specified Amazon Web Services Region for the
calling account. This operation supports pagination, where the response can be sent in
multiple pages. You should check the PaginationToken response parameter to determine if
there are additional results available to return. Repeat the query, passing the
PaginationToken response parameter value as an input to the next request until you recieve
a null value. A null value for PaginationToken indicates that there are no more results
waiting to be returned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PaginationToken"`: Specifies a PaginationToken response value from a previous request
to indicate that you want the next page of results. Leave this parameter empty in your
initial request.
"""
function get_tag_keys(; aws_config::AbstractAWSConfig=global_aws_config())
return resource_groups_tagging_api(
"GetTagKeys"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_tag_keys(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_groups_tagging_api(
"GetTagKeys", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_tag_values(key)
get_tag_values(key, params::Dict{String,<:Any})
Returns all tag values for the specified key that are used in the specified Amazon Web
Services Region for the calling account. This operation supports pagination, where the
response can be sent in multiple pages. You should check the PaginationToken response
parameter to determine if there are additional results available to return. Repeat the
query, passing the PaginationToken response parameter value as an input to the next request
until you recieve a null value. A null value for PaginationToken indicates that there are
no more results waiting to be returned.
# Arguments
- `key`: Specifies the tag key for which you want to list all existing values that are
currently used in the specified Amazon Web Services Region for the calling account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PaginationToken"`: Specifies a PaginationToken response value from a previous request
to indicate that you want the next page of results. Leave this parameter empty in your
initial request.
"""
function get_tag_values(Key; aws_config::AbstractAWSConfig=global_aws_config())
return resource_groups_tagging_api(
"GetTagValues",
Dict{String,Any}("Key" => Key);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_tag_values(
Key, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_groups_tagging_api(
"GetTagValues",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Key" => Key), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_report_creation(s3_bucket)
start_report_creation(s3_bucket, params::Dict{String,<:Any})
Generates a report that lists all tagged resources in the accounts across your organization
and tells whether each resource is compliant with the effective tag policy. Compliance data
is refreshed daily. The report is generated asynchronously. The generated report is saved
to the following location:
s3://example-bucket/AwsTagPolicies/o-exampleorgid/YYYY-MM-ddTHH:mm:ssZ/report.csv You can
call this operation only from the organization's management account and from the us-east-1
Region.
# Arguments
- `s3_bucket`: The name of the Amazon S3 bucket where the report will be stored; for
example: awsexamplebucket For more information on S3 bucket requirements, including an
example bucket policy, see the example S3 bucket policy on this page.
"""
function start_report_creation(S3Bucket; aws_config::AbstractAWSConfig=global_aws_config())
return resource_groups_tagging_api(
"StartReportCreation",
Dict{String,Any}("S3Bucket" => S3Bucket);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_report_creation(
S3Bucket,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resource_groups_tagging_api(
"StartReportCreation",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("S3Bucket" => S3Bucket), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resources(resource_arnlist, tags)
tag_resources(resource_arnlist, tags, params::Dict{String,<:Any})
Applies one or more tags to the specified resources. Note the following: Not all
resources can have tags. For a list of services with resources that support tagging using
this operation, see Services that support the Resource Groups Tagging API. If the resource
doesn't yet support this operation, the resource's service might support tagging using its
own API operations. For more information, refer to the documentation for that service.
Each resource can have up to 50 tags. For other limits, see Tag Naming and Usage
Conventions in the Amazon Web Services General Reference. You can only tag resources
that are located in the specified Amazon Web Services Region for the Amazon Web Services
account. To add tags to a resource, you need the necessary permissions for the service
that the resource belongs to as well as permissions for adding tags. For more information,
see the documentation for each service. Do not store personally identifiable information
(PII) or other confidential or sensitive information in tags. We use tags to provide you
with billing and administration services. Tags are not intended to be used for private or
sensitive data. Minimum permissions In addition to the tag:TagResources permission
required by this operation, you must also have the tagging permission defined by the
service that created the resource. For example, to tag an Amazon EC2 instance using the
TagResources operation, you must have both of the following permissions: tag:TagResource
ec2:CreateTags
# Arguments
- `resource_arnlist`: Specifies the list of ARNs of the resources that you want to apply
tags to. An ARN (Amazon Resource Name) uniquely identifies a resource. For more
information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in
the Amazon Web Services General Reference.
- `tags`: Specifies a list of tags that you want to add to the specified resources. A tag
consists of a key and a value that you define.
"""
function tag_resources(
ResourceARNList, Tags; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_groups_tagging_api(
"TagResources",
Dict{String,Any}("ResourceARNList" => ResourceARNList, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resources(
ResourceARNList,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resource_groups_tagging_api(
"TagResources",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceARNList" => ResourceARNList, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resources(resource_arnlist, tag_keys)
untag_resources(resource_arnlist, tag_keys, params::Dict{String,<:Any})
Removes the specified tags from the specified resources. 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 a resource that were already removed. Note the following: To
remove tags from a resource, you need the necessary permissions for the service that the
resource belongs to as well as permissions for removing tags. For more information, see the
documentation for the service whose resource you want to untag. You can only tag
resources that are located in the specified Amazon Web Services Region for the calling
Amazon Web Services account. Minimum permissions In addition to the tag:UntagResources
permission required by this operation, you must also have the remove tags permission
defined by the service that created the resource. For example, to remove the tags from an
Amazon EC2 instance using the UntagResources operation, you must have both of the following
permissions: tag:UntagResource ec2:DeleteTags
# Arguments
- `resource_arnlist`: Specifies a list of ARNs of the resources that you want to remove
tags from. An ARN (Amazon Resource Name) uniquely identifies a resource. For more
information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in
the Amazon Web Services General Reference.
- `tag_keys`: Specifies a list of tag keys that you want to remove from the specified
resources.
"""
function untag_resources(
ResourceARNList, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return resource_groups_tagging_api(
"UntagResources",
Dict{String,Any}("ResourceARNList" => ResourceARNList, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resources(
ResourceARNList,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return resource_groups_tagging_api(
"UntagResources",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ResourceARNList" => ResourceARNList, "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 | 78949 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: robomaker
using AWS.Compat
using AWS.UUIDs
"""
batch_delete_worlds(worlds)
batch_delete_worlds(worlds, params::Dict{String,<:Any})
Deletes one or more worlds in a batch operation.
# Arguments
- `worlds`: A list of Amazon Resource Names (arns) that correspond to worlds to delete.
"""
function batch_delete_worlds(worlds; aws_config::AbstractAWSConfig=global_aws_config())
return robomaker(
"POST",
"/batchDeleteWorlds",
Dict{String,Any}("worlds" => worlds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_delete_worlds(
worlds, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/batchDeleteWorlds",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("worlds" => worlds), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_describe_simulation_job(jobs)
batch_describe_simulation_job(jobs, params::Dict{String,<:Any})
Describes one or more simulation jobs.
# Arguments
- `jobs`: A list of Amazon Resource Names (ARNs) of simulation jobs to describe.
"""
function batch_describe_simulation_job(
jobs; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/batchDescribeSimulationJob",
Dict{String,Any}("jobs" => jobs);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_describe_simulation_job(
jobs, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/batchDescribeSimulationJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("jobs" => jobs), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_deployment_job(job)
cancel_deployment_job(job, params::Dict{String,<:Any})
Cancels the specified deployment job. This API will no longer be supported as of May 2,
2022. Use it to remove resources that were created for Deployment Service.
# Arguments
- `job`: The deployment job ARN to cancel.
"""
function cancel_deployment_job(job; aws_config::AbstractAWSConfig=global_aws_config())
return robomaker(
"POST",
"/cancelDeploymentJob",
Dict{String,Any}("job" => job);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_deployment_job(
job, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/cancelDeploymentJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("job" => job), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_simulation_job(job)
cancel_simulation_job(job, params::Dict{String,<:Any})
Cancels the specified simulation job.
# Arguments
- `job`: The simulation job ARN to cancel.
"""
function cancel_simulation_job(job; aws_config::AbstractAWSConfig=global_aws_config())
return robomaker(
"POST",
"/cancelSimulationJob",
Dict{String,Any}("job" => job);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_simulation_job(
job, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/cancelSimulationJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("job" => job), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_simulation_job_batch(batch)
cancel_simulation_job_batch(batch, params::Dict{String,<:Any})
Cancels a simulation job batch. When you cancel a simulation job batch, you are also
cancelling all of the active simulation jobs created as part of the batch.
# Arguments
- `batch`: The id of the batch to cancel.
"""
function cancel_simulation_job_batch(
batch; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/cancelSimulationJobBatch",
Dict{String,Any}("batch" => batch);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_simulation_job_batch(
batch, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/cancelSimulationJobBatch",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("batch" => batch), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_world_export_job(job)
cancel_world_export_job(job, params::Dict{String,<:Any})
Cancels the specified export job.
# Arguments
- `job`: The Amazon Resource Name (arn) of the world export job to cancel.
"""
function cancel_world_export_job(job; aws_config::AbstractAWSConfig=global_aws_config())
return robomaker(
"POST",
"/cancelWorldExportJob",
Dict{String,Any}("job" => job);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_world_export_job(
job, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/cancelWorldExportJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("job" => job), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_world_generation_job(job)
cancel_world_generation_job(job, params::Dict{String,<:Any})
Cancels the specified world generator job.
# Arguments
- `job`: The Amazon Resource Name (arn) of the world generator job to cancel.
"""
function cancel_world_generation_job(job; aws_config::AbstractAWSConfig=global_aws_config())
return robomaker(
"POST",
"/cancelWorldGenerationJob",
Dict{String,Any}("job" => job);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_world_generation_job(
job, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/cancelWorldGenerationJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("job" => job), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_deployment_job(client_request_token, deployment_application_configs, fleet)
create_deployment_job(client_request_token, deployment_application_configs, fleet, params::Dict{String,<:Any})
Deploys a specific version of a robot application to robots in a fleet. This API is no
longer supported and will throw an error if used. The robot application must have a
numbered applicationVersion for consistency reasons. To create a new version, use
CreateRobotApplicationVersion or see Creating a Robot Application Version. After 90 days,
deployment jobs expire and will be deleted. They will no longer be accessible.
# Arguments
- `client_request_token`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
- `deployment_application_configs`: The deployment application configuration.
- `fleet`: The Amazon Resource Name (ARN) of the fleet to deploy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"deploymentConfig"`: The requested deployment configuration.
- `"tags"`: A map that contains tag keys and tag values that are attached to the deployment
job.
"""
function create_deployment_job(
clientRequestToken,
deploymentApplicationConfigs,
fleet;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return robomaker(
"POST",
"/createDeploymentJob",
Dict{String,Any}(
"clientRequestToken" => clientRequestToken,
"deploymentApplicationConfigs" => deploymentApplicationConfigs,
"fleet" => fleet,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_deployment_job(
clientRequestToken,
deploymentApplicationConfigs,
fleet,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return robomaker(
"POST",
"/createDeploymentJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientRequestToken" => clientRequestToken,
"deploymentApplicationConfigs" => deploymentApplicationConfigs,
"fleet" => fleet,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_fleet(name)
create_fleet(name, params::Dict{String,<:Any})
Creates a fleet, a logical group of robots running the same robot application. This API is
no longer supported and will throw an error if used.
# Arguments
- `name`: The name of the fleet.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: A map that contains tag keys and tag values that are attached to the fleet.
"""
function create_fleet(name; aws_config::AbstractAWSConfig=global_aws_config())
return robomaker(
"POST",
"/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 robomaker(
"POST",
"/createFleet",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_robot(architecture, greengrass_group_id, name)
create_robot(architecture, greengrass_group_id, name, params::Dict{String,<:Any})
Creates a robot. This API is no longer supported and will throw an error if used.
# Arguments
- `architecture`: The target architecture of the robot.
- `greengrass_group_id`: The Greengrass group id.
- `name`: The name for the robot.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: A map that contains tag keys and tag values that are attached to the robot.
"""
function create_robot(
architecture, greengrassGroupId, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/createRobot",
Dict{String,Any}(
"architecture" => architecture,
"greengrassGroupId" => greengrassGroupId,
"name" => name,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_robot(
architecture,
greengrassGroupId,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return robomaker(
"POST",
"/createRobot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"architecture" => architecture,
"greengrassGroupId" => greengrassGroupId,
"name" => name,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_robot_application(name, robot_software_suite)
create_robot_application(name, robot_software_suite, params::Dict{String,<:Any})
Creates a robot application.
# Arguments
- `name`: The name of the robot application.
- `robot_software_suite`: The robot software suite (ROS distribuition) used by the robot
application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"environment"`: The object that contains that URI of the Docker image that you use for
your robot application.
- `"sources"`: The sources of the robot application.
- `"tags"`: A map that contains tag keys and tag values that are attached to the robot
application.
"""
function create_robot_application(
name, robotSoftwareSuite; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/createRobotApplication",
Dict{String,Any}("name" => name, "robotSoftwareSuite" => robotSoftwareSuite);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_robot_application(
name,
robotSoftwareSuite,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return robomaker(
"POST",
"/createRobotApplication",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name, "robotSoftwareSuite" => robotSoftwareSuite
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_robot_application_version(application)
create_robot_application_version(application, params::Dict{String,<:Any})
Creates a version of a robot application.
# Arguments
- `application`: The application information for the robot application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"currentRevisionId"`: The current revision id for the robot application. If you provide
a value and it matches the latest revision ID, a new version will be created.
- `"imageDigest"`: A SHA256 identifier for the Docker image that you use for your robot
application.
- `"s3Etags"`: The Amazon S3 identifier for the zip file bundle that you use for your robot
application.
"""
function create_robot_application_version(
application; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/createRobotApplicationVersion",
Dict{String,Any}("application" => application);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_robot_application_version(
application,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return robomaker(
"POST",
"/createRobotApplicationVersion",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("application" => application), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_simulation_application(name, robot_software_suite, simulation_software_suite)
create_simulation_application(name, robot_software_suite, simulation_software_suite, params::Dict{String,<:Any})
Creates a simulation application.
# Arguments
- `name`: The name of the simulation application.
- `robot_software_suite`: The robot software suite (ROS distribution) used by the
simulation application.
- `simulation_software_suite`: The simulation software suite used by the simulation
application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"environment"`: The object that contains the Docker image URI used to create your
simulation application.
- `"renderingEngine"`: The rendering engine for the simulation application.
- `"sources"`: The sources of the simulation application.
- `"tags"`: A map that contains tag keys and tag values that are attached to the simulation
application.
"""
function create_simulation_application(
name,
robotSoftwareSuite,
simulationSoftwareSuite;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return robomaker(
"POST",
"/createSimulationApplication",
Dict{String,Any}(
"name" => name,
"robotSoftwareSuite" => robotSoftwareSuite,
"simulationSoftwareSuite" => simulationSoftwareSuite,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_simulation_application(
name,
robotSoftwareSuite,
simulationSoftwareSuite,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return robomaker(
"POST",
"/createSimulationApplication",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name,
"robotSoftwareSuite" => robotSoftwareSuite,
"simulationSoftwareSuite" => simulationSoftwareSuite,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_simulation_application_version(application)
create_simulation_application_version(application, params::Dict{String,<:Any})
Creates a simulation application with a specific revision id.
# Arguments
- `application`: The application information for the simulation application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"currentRevisionId"`: The current revision id for the simulation application. If you
provide a value and it matches the latest revision ID, a new version will be created.
- `"imageDigest"`: The SHA256 digest used to identify the Docker image URI used to created
the simulation application.
- `"s3Etags"`: The Amazon S3 eTag identifier for the zip file bundle that you use to create
the simulation application.
"""
function create_simulation_application_version(
application; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/createSimulationApplicationVersion",
Dict{String,Any}("application" => application);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_simulation_application_version(
application,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return robomaker(
"POST",
"/createSimulationApplicationVersion",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("application" => application), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_simulation_job(iam_role, max_job_duration_in_seconds)
create_simulation_job(iam_role, max_job_duration_in_seconds, params::Dict{String,<:Any})
Creates a simulation job. After 90 days, simulation jobs expire and will be deleted. They
will no longer be accessible.
# Arguments
- `iam_role`: The IAM role name that allows the simulation instance to call the AWS APIs
that are specified in its associated policies on your behalf. This is how credentials are
passed in to your simulation job.
- `max_job_duration_in_seconds`: The maximum simulation job duration in seconds (up to 14
days or 1,209,600 seconds. When maxJobDurationInSeconds is reached, the simulation job will
status will transition to Completed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientRequestToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
- `"compute"`: Compute information for the simulation job.
- `"dataSources"`: Specify data sources to mount read-only files from S3 into your
simulation. These files are available under /opt/robomaker/datasources/data_source_name.
There is a limit of 100 files and a combined size of 25GB for all DataSourceConfig objects.
- `"failureBehavior"`: The failure behavior the simulation job. Continue Leaves the
instance running for its maximum timeout duration after a 4XX error code. Fail Stop the
simulation job and terminate the instance.
- `"loggingConfig"`: The logging configuration.
- `"outputLocation"`: Location for output files generated by the simulation job.
- `"robotApplications"`: The robot application to use in the simulation job.
- `"simulationApplications"`: The simulation application to use in the simulation job.
- `"tags"`: A map that contains tag keys and tag values that are attached to the simulation
job.
- `"vpcConfig"`: If your simulation job accesses resources in a VPC, you provide this
parameter identifying the list of security group IDs and subnet IDs. These must belong to
the same VPC. You must provide at least one security group and one subnet ID.
"""
function create_simulation_job(
iamRole, maxJobDurationInSeconds; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/createSimulationJob",
Dict{String,Any}(
"iamRole" => iamRole,
"maxJobDurationInSeconds" => maxJobDurationInSeconds,
"clientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_simulation_job(
iamRole,
maxJobDurationInSeconds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return robomaker(
"POST",
"/createSimulationJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"iamRole" => iamRole,
"maxJobDurationInSeconds" => maxJobDurationInSeconds,
"clientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_world_export_job(iam_role, output_location, worlds)
create_world_export_job(iam_role, output_location, worlds, params::Dict{String,<:Any})
Creates a world export job.
# Arguments
- `iam_role`: The IAM role that the world export process uses to access the Amazon S3
bucket and put the export.
- `output_location`:
- `worlds`: A list of Amazon Resource Names (arns) that correspond to worlds to export.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientRequestToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
- `"tags"`: A map that contains tag keys and tag values that are attached to the world
export job.
"""
function create_world_export_job(
iamRole, outputLocation, worlds; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/createWorldExportJob",
Dict{String,Any}(
"iamRole" => iamRole,
"outputLocation" => outputLocation,
"worlds" => worlds,
"clientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_world_export_job(
iamRole,
outputLocation,
worlds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return robomaker(
"POST",
"/createWorldExportJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"iamRole" => iamRole,
"outputLocation" => outputLocation,
"worlds" => worlds,
"clientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_world_generation_job(template, world_count)
create_world_generation_job(template, world_count, params::Dict{String,<:Any})
Creates worlds using the specified template.
# Arguments
- `template`: The Amazon Resource Name (arn) of the world template describing the worlds
you want to create.
- `world_count`: Information about the world count.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientRequestToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
- `"tags"`: A map that contains tag keys and tag values that are attached to the world
generator job.
- `"worldTags"`: A map that contains tag keys and tag values that are attached to the
generated worlds.
"""
function create_world_generation_job(
template, worldCount; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/createWorldGenerationJob",
Dict{String,Any}(
"template" => template,
"worldCount" => worldCount,
"clientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_world_generation_job(
template,
worldCount,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return robomaker(
"POST",
"/createWorldGenerationJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"template" => template,
"worldCount" => worldCount,
"clientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_world_template()
create_world_template(params::Dict{String,<:Any})
Creates a world template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientRequestToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
- `"name"`: The name of the world template.
- `"tags"`: A map that contains tag keys and tag values that are attached to the world
template.
- `"templateBody"`: The world template body.
- `"templateLocation"`: The location of the world template.
"""
function create_world_template(; aws_config::AbstractAWSConfig=global_aws_config())
return robomaker(
"POST",
"/createWorldTemplate";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_world_template(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/createWorldTemplate",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_fleet(fleet)
delete_fleet(fleet, params::Dict{String,<:Any})
Deletes a fleet. This API will no longer be supported as of May 2, 2022. Use it to remove
resources that were created for Deployment Service.
# Arguments
- `fleet`: The Amazon Resource Name (ARN) of the fleet.
"""
function delete_fleet(fleet; aws_config::AbstractAWSConfig=global_aws_config())
return robomaker(
"POST",
"/deleteFleet",
Dict{String,Any}("fleet" => fleet);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_fleet(
fleet, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/deleteFleet",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("fleet" => fleet), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_robot(robot)
delete_robot(robot, params::Dict{String,<:Any})
Deletes a robot. This API will no longer be supported as of May 2, 2022. Use it to remove
resources that were created for Deployment Service.
# Arguments
- `robot`: The Amazon Resource Name (ARN) of the robot.
"""
function delete_robot(robot; aws_config::AbstractAWSConfig=global_aws_config())
return robomaker(
"POST",
"/deleteRobot",
Dict{String,Any}("robot" => robot);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_robot(
robot, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/deleteRobot",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("robot" => robot), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_robot_application(application)
delete_robot_application(application, params::Dict{String,<:Any})
Deletes a robot application.
# Arguments
- `application`: The Amazon Resource Name (ARN) of the the robot application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"applicationVersion"`: The version of the robot application to delete.
"""
function delete_robot_application(
application; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/deleteRobotApplication",
Dict{String,Any}("application" => application);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_robot_application(
application,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return robomaker(
"POST",
"/deleteRobotApplication",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("application" => application), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_simulation_application(application)
delete_simulation_application(application, params::Dict{String,<:Any})
Deletes a simulation application.
# Arguments
- `application`: The application information for the simulation application to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"applicationVersion"`: The version of the simulation application to delete.
"""
function delete_simulation_application(
application; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/deleteSimulationApplication",
Dict{String,Any}("application" => application);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_simulation_application(
application,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return robomaker(
"POST",
"/deleteSimulationApplication",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("application" => application), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_world_template(template)
delete_world_template(template, params::Dict{String,<:Any})
Deletes a world template.
# Arguments
- `template`: The Amazon Resource Name (arn) of the world template you want to delete.
"""
function delete_world_template(template; aws_config::AbstractAWSConfig=global_aws_config())
return robomaker(
"POST",
"/deleteWorldTemplate",
Dict{String,Any}("template" => template);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_world_template(
template,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return robomaker(
"POST",
"/deleteWorldTemplate",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("template" => template), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_robot(fleet, robot)
deregister_robot(fleet, robot, params::Dict{String,<:Any})
Deregisters a robot. This API will no longer be supported as of May 2, 2022. Use it to
remove resources that were created for Deployment Service.
# Arguments
- `fleet`: The Amazon Resource Name (ARN) of the fleet.
- `robot`: The Amazon Resource Name (ARN) of the robot.
"""
function deregister_robot(fleet, robot; aws_config::AbstractAWSConfig=global_aws_config())
return robomaker(
"POST",
"/deregisterRobot",
Dict{String,Any}("fleet" => fleet, "robot" => robot);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_robot(
fleet,
robot,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return robomaker(
"POST",
"/deregisterRobot",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("fleet" => fleet, "robot" => robot), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_deployment_job(job)
describe_deployment_job(job, params::Dict{String,<:Any})
Describes a deployment job. This API will no longer be supported as of May 2, 2022. Use it
to remove resources that were created for Deployment Service.
# Arguments
- `job`: The Amazon Resource Name (ARN) of the deployment job.
"""
function describe_deployment_job(job; aws_config::AbstractAWSConfig=global_aws_config())
return robomaker(
"POST",
"/describeDeploymentJob",
Dict{String,Any}("job" => job);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_deployment_job(
job, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/describeDeploymentJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("job" => job), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_fleet(fleet)
describe_fleet(fleet, params::Dict{String,<:Any})
Describes a fleet. This API will no longer be supported as of May 2, 2022. Use it to
remove resources that were created for Deployment Service.
# Arguments
- `fleet`: The Amazon Resource Name (ARN) of the fleet.
"""
function describe_fleet(fleet; aws_config::AbstractAWSConfig=global_aws_config())
return robomaker(
"POST",
"/describeFleet",
Dict{String,Any}("fleet" => fleet);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_fleet(
fleet, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/describeFleet",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("fleet" => fleet), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_robot(robot)
describe_robot(robot, params::Dict{String,<:Any})
Describes a robot. This API will no longer be supported as of May 2, 2022. Use it to
remove resources that were created for Deployment Service.
# Arguments
- `robot`: The Amazon Resource Name (ARN) of the robot to be described.
"""
function describe_robot(robot; aws_config::AbstractAWSConfig=global_aws_config())
return robomaker(
"POST",
"/describeRobot",
Dict{String,Any}("robot" => robot);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_robot(
robot, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/describeRobot",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("robot" => robot), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_robot_application(application)
describe_robot_application(application, params::Dict{String,<:Any})
Describes a robot application.
# Arguments
- `application`: The Amazon Resource Name (ARN) of the robot application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"applicationVersion"`: The version of the robot application to describe.
"""
function describe_robot_application(
application; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/describeRobotApplication",
Dict{String,Any}("application" => application);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_robot_application(
application,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return robomaker(
"POST",
"/describeRobotApplication",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("application" => application), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_simulation_application(application)
describe_simulation_application(application, params::Dict{String,<:Any})
Describes a simulation application.
# Arguments
- `application`: The application information for the simulation application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"applicationVersion"`: The version of the simulation application to describe.
"""
function describe_simulation_application(
application; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/describeSimulationApplication",
Dict{String,Any}("application" => application);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_simulation_application(
application,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return robomaker(
"POST",
"/describeSimulationApplication",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("application" => application), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_simulation_job(job)
describe_simulation_job(job, params::Dict{String,<:Any})
Describes a simulation job.
# Arguments
- `job`: The Amazon Resource Name (ARN) of the simulation job to be described.
"""
function describe_simulation_job(job; aws_config::AbstractAWSConfig=global_aws_config())
return robomaker(
"POST",
"/describeSimulationJob",
Dict{String,Any}("job" => job);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_simulation_job(
job, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/describeSimulationJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("job" => job), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_simulation_job_batch(batch)
describe_simulation_job_batch(batch, params::Dict{String,<:Any})
Describes a simulation job batch.
# Arguments
- `batch`: The id of the batch to describe.
"""
function describe_simulation_job_batch(
batch; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/describeSimulationJobBatch",
Dict{String,Any}("batch" => batch);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_simulation_job_batch(
batch, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/describeSimulationJobBatch",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("batch" => batch), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_world(world)
describe_world(world, params::Dict{String,<:Any})
Describes a world.
# Arguments
- `world`: The Amazon Resource Name (arn) of the world you want to describe.
"""
function describe_world(world; aws_config::AbstractAWSConfig=global_aws_config())
return robomaker(
"POST",
"/describeWorld",
Dict{String,Any}("world" => world);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_world(
world, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/describeWorld",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("world" => world), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_world_export_job(job)
describe_world_export_job(job, params::Dict{String,<:Any})
Describes a world export job.
# Arguments
- `job`: The Amazon Resource Name (arn) of the world export job to describe.
"""
function describe_world_export_job(job; aws_config::AbstractAWSConfig=global_aws_config())
return robomaker(
"POST",
"/describeWorldExportJob",
Dict{String,Any}("job" => job);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_world_export_job(
job, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/describeWorldExportJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("job" => job), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_world_generation_job(job)
describe_world_generation_job(job, params::Dict{String,<:Any})
Describes a world generation job.
# Arguments
- `job`: The Amazon Resource Name (arn) of the world generation job to describe.
"""
function describe_world_generation_job(
job; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/describeWorldGenerationJob",
Dict{String,Any}("job" => job);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_world_generation_job(
job, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/describeWorldGenerationJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("job" => job), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_world_template(template)
describe_world_template(template, params::Dict{String,<:Any})
Describes a world template.
# Arguments
- `template`: The Amazon Resource Name (arn) of the world template you want to describe.
"""
function describe_world_template(
template; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/describeWorldTemplate",
Dict{String,Any}("template" => template);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_world_template(
template,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return robomaker(
"POST",
"/describeWorldTemplate",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("template" => template), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_world_template_body()
get_world_template_body(params::Dict{String,<:Any})
Gets the world template body.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"generationJob"`: The Amazon Resource Name (arn) of the world generator job.
- `"template"`: The Amazon Resource Name (arn) of the world template.
"""
function get_world_template_body(; aws_config::AbstractAWSConfig=global_aws_config())
return robomaker(
"POST",
"/getWorldTemplateBody";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_world_template_body(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/getWorldTemplateBody",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_deployment_jobs()
list_deployment_jobs(params::Dict{String,<:Any})
Returns a list of deployment jobs for a fleet. You can optionally provide filters to
retrieve specific deployment jobs. This API will no longer be supported as of May 2, 2022.
Use it to remove resources that were created for Deployment Service.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: Optional filters to limit results. The filter names status and fleetName are
supported. When filtering, you must use the complete value of the filtered item. You can
use up to three filters, but they must be for the same named item. For example, if you are
looking for items with the status InProgress or the status Pending.
- `"maxResults"`: When this parameter is used, ListDeploymentJobs 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 ListDeploymentJobs request with the
returned nextToken value. This value can be between 1 and 200. If this parameter is not
used, then ListDeploymentJobs returns up to 200 results and a nextToken value if
applicable.
- `"nextToken"`: If the previous paginated request did not return all of the remaining
results, the response object's nextToken parameter value is set to a token. To retrieve the
next set of results, call ListDeploymentJobs again and assign that token to the request
object's nextToken parameter. If there are no remaining results, the previous response
object's NextToken parameter is set to null.
"""
function list_deployment_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return robomaker(
"POST",
"/listDeploymentJobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_deployment_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/listDeploymentJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_fleets()
list_fleets(params::Dict{String,<:Any})
Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that
were created for Deployment Service.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: Optional filters to limit results. The filter name name is supported. When
filtering, you must use the complete value of the filtered item. You can use up to three
filters.
- `"maxResults"`: When this parameter is used, ListFleets 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 ListFleets request with the returned
nextToken value. This value can be between 1 and 200. If this parameter is not used, then
ListFleets returns up to 200 results and a nextToken value if applicable.
- `"nextToken"`: If the previous paginated request did not return all of the remaining
results, the response object's nextToken parameter value is set to a token. To retrieve the
next set of results, call ListFleets again and assign that token to the request object's
nextToken parameter. If there are no remaining results, the previous response object's
NextToken parameter is set to null. 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_fleets(; aws_config::AbstractAWSConfig=global_aws_config())
return robomaker(
"POST", "/listFleets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_fleets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/listFleets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_robot_applications()
list_robot_applications(params::Dict{String,<:Any})
Returns a list of robot application. You can optionally provide filters to retrieve
specific robot applications.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: Optional filters to limit results. The filter name name is supported. When
filtering, you must use the complete value of the filtered item. You can use up to three
filters.
- `"maxResults"`: When this parameter is used, ListRobotApplications 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 ListRobotApplications request
with the returned nextToken value. This value can be between 1 and 100. If this parameter
is not used, then ListRobotApplications returns up to 100 results and a nextToken value if
applicable.
- `"nextToken"`: If the previous paginated request did not return all of the remaining
results, the response object's nextToken parameter value is set to a token. To retrieve the
next set of results, call ListRobotApplications again and assign that token to the request
object's nextToken parameter. If there are no remaining results, the previous response
object's NextToken parameter is set to null.
- `"versionQualifier"`: The version qualifier of the robot application.
"""
function list_robot_applications(; aws_config::AbstractAWSConfig=global_aws_config())
return robomaker(
"POST",
"/listRobotApplications";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_robot_applications(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/listRobotApplications",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_robots()
list_robots(params::Dict{String,<:Any})
Returns a list of robots. You can optionally provide filters to retrieve specific robots.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that
were created for Deployment Service.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: Optional filters to limit results. The filter names status and fleetName are
supported. When filtering, you must use the complete value of the filtered item. You can
use up to three filters, but they must be for the same named item. For example, if you are
looking for items with the status Registered or the status Available.
- `"maxResults"`: When this parameter is used, ListRobots 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 ListRobots request with the returned
nextToken value. This value can be between 1 and 200. If this parameter is not used, then
ListRobots returns up to 200 results and a nextToken value if applicable.
- `"nextToken"`: If the previous paginated request did not return all of the remaining
results, the response object's nextToken parameter value is set to a token. To retrieve the
next set of results, call ListRobots again and assign that token to the request object's
nextToken parameter. If there are no remaining results, the previous response object's
NextToken parameter is set to null.
"""
function list_robots(; aws_config::AbstractAWSConfig=global_aws_config())
return robomaker(
"POST", "/listRobots"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_robots(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/listRobots",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_simulation_applications()
list_simulation_applications(params::Dict{String,<:Any})
Returns a list of simulation applications. You can optionally provide filters to retrieve
specific simulation applications.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: Optional list of filters to limit results. The filter name name is
supported. When filtering, you must use the complete value of the filtered item. You can
use up to three filters.
- `"maxResults"`: When this parameter is used, ListSimulationApplications 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 ListSimulationApplications
request with the returned nextToken value. This value can be between 1 and 100. If this
parameter is not used, then ListSimulationApplications returns up to 100 results and a
nextToken value if applicable.
- `"nextToken"`: If the previous paginated request did not return all of the remaining
results, the response object's nextToken parameter value is set to a token. To retrieve the
next set of results, call ListSimulationApplications again and assign that token to the
request object's nextToken parameter. If there are no remaining results, the previous
response object's NextToken parameter is set to null.
- `"versionQualifier"`: The version qualifier of the simulation application.
"""
function list_simulation_applications(; aws_config::AbstractAWSConfig=global_aws_config())
return robomaker(
"POST",
"/listSimulationApplications";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_simulation_applications(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/listSimulationApplications",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_simulation_job_batches()
list_simulation_job_batches(params::Dict{String,<:Any})
Returns a list simulation job batches. You can optionally provide filters to retrieve
specific simulation batch jobs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: Optional filters to limit results.
- `"maxResults"`: When this parameter is used, ListSimulationJobBatches 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 ListSimulationJobBatches
request with the returned nextToken value.
- `"nextToken"`: If the previous paginated request did not return all of the remaining
results, the response object's nextToken parameter value is set to a token. To retrieve the
next set of results, call ListSimulationJobBatches again and assign that token to the
request object's nextToken parameter. If there are no remaining results, the previous
response object's NextToken parameter is set to null.
"""
function list_simulation_job_batches(; aws_config::AbstractAWSConfig=global_aws_config())
return robomaker(
"POST",
"/listSimulationJobBatches";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_simulation_job_batches(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/listSimulationJobBatches",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_simulation_jobs()
list_simulation_jobs(params::Dict{String,<:Any})
Returns a list of simulation jobs. You can optionally provide filters to retrieve specific
simulation jobs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: Optional filters to limit results. The filter names status and
simulationApplicationName and robotApplicationName are supported. When filtering, you must
use the complete value of the filtered item. You can use up to three filters, but they must
be for the same named item. For example, if you are looking for items with the status
Preparing or the status Running.
- `"maxResults"`: When this parameter is used, ListSimulationJobs 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 ListSimulationJobs request with the
returned nextToken value. This value can be between 1 and 1000. If this parameter is not
used, then ListSimulationJobs returns up to 1000 results and a nextToken value if
applicable.
- `"nextToken"`: If the previous paginated request did not return all of the remaining
results, the response object's nextToken parameter value is set to a token. To retrieve the
next set of results, call ListSimulationJobs again and assign that token to the request
object's nextToken parameter. If there are no remaining results, the previous response
object's NextToken parameter is set to null.
"""
function list_simulation_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return robomaker(
"POST",
"/listSimulationJobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_simulation_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/listSimulationJobs",
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 AWS RoboMaker resource.
# Arguments
- `resource_arn`: The AWS RoboMaker Amazon Resource Name (ARN) with tags to be listed.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"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 robomaker(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_world_export_jobs()
list_world_export_jobs(params::Dict{String,<:Any})
Lists world export jobs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: Optional filters to limit results. You can use generationJobId and
templateId.
- `"maxResults"`: When this parameter is used, ListWorldExportJobs 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 ListWorldExportJobs request with the
returned nextToken value. This value can be between 1 and 100. If this parameter is not
used, then ListWorldExportJobs returns up to 100 results and a nextToken value if
applicable.
- `"nextToken"`: If the previous paginated request did not return all of the remaining
results, the response object's nextToken parameter value is set to a token. To retrieve the
next set of results, call ListWorldExportJobs again and assign that token to the request
object's nextToken parameter. If there are no remaining results, the previous response
object's NextToken parameter is set to null.
"""
function list_world_export_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return robomaker(
"POST",
"/listWorldExportJobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_world_export_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/listWorldExportJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_world_generation_jobs()
list_world_generation_jobs(params::Dict{String,<:Any})
Lists world generator jobs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: Optional filters to limit results. You can use status and templateId.
- `"maxResults"`: When this parameter is used, ListWorldGeneratorJobs 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 ListWorldGeneratorJobs
request with the returned nextToken value. This value can be between 1 and 100. If this
parameter is not used, then ListWorldGeneratorJobs returns up to 100 results and a
nextToken value if applicable.
- `"nextToken"`: If the previous paginated request did not return all of the remaining
results, the response object's nextToken parameter value is set to a token. To retrieve the
next set of results, call ListWorldGenerationJobsRequest again and assign that token to the
request object's nextToken parameter. If there are no remaining results, the previous
response object's NextToken parameter is set to null.
"""
function list_world_generation_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return robomaker(
"POST",
"/listWorldGenerationJobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_world_generation_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/listWorldGenerationJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_world_templates()
list_world_templates(params::Dict{String,<:Any})
Lists world templates.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: When this parameter is used, ListWorldTemplates 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 ListWorldTemplates request with the
returned nextToken value. This value can be between 1 and 100. If this parameter is not
used, then ListWorldTemplates returns up to 100 results and a nextToken value if
applicable.
- `"nextToken"`: If the previous paginated request did not return all of the remaining
results, the response object's nextToken parameter value is set to a token. To retrieve the
next set of results, call ListWorldTemplates again and assign that token to the request
object's nextToken parameter. If there are no remaining results, the previous response
object's NextToken parameter is set to null.
"""
function list_world_templates(; aws_config::AbstractAWSConfig=global_aws_config())
return robomaker(
"POST",
"/listWorldTemplates";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_world_templates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/listWorldTemplates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_worlds()
list_worlds(params::Dict{String,<:Any})
Lists worlds.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: Optional filters to limit results. You can use status.
- `"maxResults"`: When this parameter is used, ListWorlds 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 ListWorlds request with the returned
nextToken value. This value can be between 1 and 100. If this parameter is not used, then
ListWorlds returns up to 100 results and a nextToken value if applicable.
- `"nextToken"`: If the previous paginated request did not return all of the remaining
results, the response object's nextToken parameter value is set to a token. To retrieve the
next set of results, call ListWorlds again and assign that token to the request object's
nextToken parameter. If there are no remaining results, the previous response object's
NextToken parameter is set to null.
"""
function list_worlds(; aws_config::AbstractAWSConfig=global_aws_config())
return robomaker(
"POST", "/listWorlds"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_worlds(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/listWorlds",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_robot(fleet, robot)
register_robot(fleet, robot, params::Dict{String,<:Any})
Registers a robot with a fleet. This API is no longer supported and will throw an error if
used.
# Arguments
- `fleet`: The Amazon Resource Name (ARN) of the fleet.
- `robot`: The Amazon Resource Name (ARN) of the robot.
"""
function register_robot(fleet, robot; aws_config::AbstractAWSConfig=global_aws_config())
return robomaker(
"POST",
"/registerRobot",
Dict{String,Any}("fleet" => fleet, "robot" => robot);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_robot(
fleet,
robot,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return robomaker(
"POST",
"/registerRobot",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("fleet" => fleet, "robot" => robot), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restart_simulation_job(job)
restart_simulation_job(job, params::Dict{String,<:Any})
Restarts a running simulation job.
# Arguments
- `job`: The Amazon Resource Name (ARN) of the simulation job.
"""
function restart_simulation_job(job; aws_config::AbstractAWSConfig=global_aws_config())
return robomaker(
"POST",
"/restartSimulationJob",
Dict{String,Any}("job" => job);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function restart_simulation_job(
job, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/restartSimulationJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("job" => job), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_simulation_job_batch(create_simulation_job_requests)
start_simulation_job_batch(create_simulation_job_requests, params::Dict{String,<:Any})
Starts a new simulation job batch. The batch is defined using one or more
SimulationJobRequest objects.
# Arguments
- `create_simulation_job_requests`: A list of simulation job requests to create in the
batch.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"batchPolicy"`: The batch policy.
- `"clientRequestToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
- `"tags"`: A map that contains tag keys and tag values that are attached to the deployment
job batch.
"""
function start_simulation_job_batch(
createSimulationJobRequests; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/startSimulationJobBatch",
Dict{String,Any}(
"createSimulationJobRequests" => createSimulationJobRequests,
"clientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_simulation_job_batch(
createSimulationJobRequests,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return robomaker(
"POST",
"/startSimulationJobBatch",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"createSimulationJobRequests" => createSimulationJobRequests,
"clientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
sync_deployment_job(client_request_token, fleet)
sync_deployment_job(client_request_token, fleet, params::Dict{String,<:Any})
Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were
added after a deployment. This API will no longer be supported as of May 2, 2022. Use it
to remove resources that were created for Deployment Service.
# Arguments
- `client_request_token`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
- `fleet`: The target fleet for the synchronization.
"""
function sync_deployment_job(
clientRequestToken, fleet; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/syncDeploymentJob",
Dict{String,Any}("clientRequestToken" => clientRequestToken, "fleet" => fleet);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function sync_deployment_job(
clientRequestToken,
fleet,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return robomaker(
"POST",
"/syncDeploymentJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientRequestToken" => clientRequestToken, "fleet" => fleet
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds or edits tags for a AWS RoboMaker resource. Each tag consists of a tag key and a tag
value. Tag keys and tag values are both required, but tag values can be empty strings. For
information about the rules that apply to tag keys and tag values, see User-Defined Tag
Restrictions in the AWS Billing and Cost Management User Guide.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are
tagging.
- `tags`: A map that contains tag keys and tag values that are attached to the resource.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return robomaker(
"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 robomaker(
"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 AWS RoboMaker resource. To remove a tag,
specify the tag key. To change the tag value of an existing tag key, use TagResource .
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are
removing tags.
- `tag_keys`: A map that contains tag keys and tag values that will be unattached from the
resource.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"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 robomaker(
"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_robot_application(application, robot_software_suite)
update_robot_application(application, robot_software_suite, params::Dict{String,<:Any})
Updates a robot application.
# Arguments
- `application`: The application information for the robot application.
- `robot_software_suite`: The robot software suite (ROS distribution) used by the robot
application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"currentRevisionId"`: The revision id for the robot application.
- `"environment"`: The object that contains the Docker image URI for your robot application.
- `"sources"`: The sources of the robot application.
"""
function update_robot_application(
application, robotSoftwareSuite; aws_config::AbstractAWSConfig=global_aws_config()
)
return robomaker(
"POST",
"/updateRobotApplication",
Dict{String,Any}(
"application" => application, "robotSoftwareSuite" => robotSoftwareSuite
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_robot_application(
application,
robotSoftwareSuite,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return robomaker(
"POST",
"/updateRobotApplication",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"application" => application, "robotSoftwareSuite" => robotSoftwareSuite
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_simulation_application(application, robot_software_suite, simulation_software_suite)
update_simulation_application(application, robot_software_suite, simulation_software_suite, params::Dict{String,<:Any})
Updates a simulation application.
# Arguments
- `application`: The application information for the simulation application.
- `robot_software_suite`: Information about the robot software suite (ROS distribution).
- `simulation_software_suite`: The simulation software suite used by the simulation
application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"currentRevisionId"`: The revision id for the robot application.
- `"environment"`: The object that contains the Docker image URI for your simulation
application.
- `"renderingEngine"`: The rendering engine for the simulation application.
- `"sources"`: The sources of the simulation application.
"""
function update_simulation_application(
application,
robotSoftwareSuite,
simulationSoftwareSuite;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return robomaker(
"POST",
"/updateSimulationApplication",
Dict{String,Any}(
"application" => application,
"robotSoftwareSuite" => robotSoftwareSuite,
"simulationSoftwareSuite" => simulationSoftwareSuite,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_simulation_application(
application,
robotSoftwareSuite,
simulationSoftwareSuite,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return robomaker(
"POST",
"/updateSimulationApplication",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"application" => application,
"robotSoftwareSuite" => robotSoftwareSuite,
"simulationSoftwareSuite" => simulationSoftwareSuite,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_world_template(template)
update_world_template(template, params::Dict{String,<:Any})
Updates a world template.
# Arguments
- `template`: The Amazon Resource Name (arn) of the world template to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"name"`: The name of the template.
- `"templateBody"`: The world template body.
- `"templateLocation"`: The location of the world template.
"""
function update_world_template(template; aws_config::AbstractAWSConfig=global_aws_config())
return robomaker(
"POST",
"/updateWorldTemplate",
Dict{String,Any}("template" => template);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_world_template(
template,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return robomaker(
"POST",
"/updateWorldTemplate",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("template" => template), 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 | 35127 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: rolesanywhere
using AWS.Compat
using AWS.UUIDs
"""
create_profile(name, role_arns)
create_profile(name, role_arns, params::Dict{String,<:Any})
Creates a profile, a list of the roles that Roles Anywhere service is trusted to assume.
You use profiles to intersect permissions with IAM managed policies. Required permissions:
rolesanywhere:CreateProfile.
# Arguments
- `name`: The name of the profile.
- `role_arns`: A list of IAM roles that this profile can assume in a temporary credential
request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"durationSeconds"`: Used to determine how long sessions vended using this profile are
valid for. See the Expiration section of the CreateSession API documentation page for more
details. In requests, if this value is not provided, the default value will be 3600.
- `"enabled"`: Specifies whether the profile is enabled.
- `"managedPolicyArns"`: A list of managed policy ARNs that apply to the vended session
credentials.
- `"requireInstanceProperties"`: Specifies whether instance properties are required in
temporary credential requests with this profile.
- `"sessionPolicy"`: A session policy that applies to the trust boundary of the vended
session credentials.
- `"tags"`: The tags to attach to the profile.
"""
function create_profile(name, roleArns; aws_config::AbstractAWSConfig=global_aws_config())
return rolesanywhere(
"POST",
"/profiles",
Dict{String,Any}("name" => name, "roleArns" => roleArns);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_profile(
name,
roleArns,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rolesanywhere(
"POST",
"/profiles",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("name" => name, "roleArns" => roleArns), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_trust_anchor(name, source)
create_trust_anchor(name, source, params::Dict{String,<:Any})
Creates a trust anchor to establish trust between IAM Roles Anywhere and your certificate
authority (CA). You can define a trust anchor as a reference to an Private Certificate
Authority (Private CA) or by uploading a CA certificate. Your Amazon Web Services workloads
can authenticate with the trust anchor using certificates issued by the CA in exchange for
temporary Amazon Web Services credentials. Required permissions:
rolesanywhere:CreateTrustAnchor.
# Arguments
- `name`: The name of the trust anchor.
- `source`: The trust anchor type and its related certificate data.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"enabled"`: Specifies whether the trust anchor is enabled.
- `"notificationSettings"`: A list of notification settings to be associated to the trust
anchor.
- `"tags"`: The tags to attach to the trust anchor.
"""
function create_trust_anchor(
name, source; aws_config::AbstractAWSConfig=global_aws_config()
)
return rolesanywhere(
"POST",
"/trustanchors",
Dict{String,Any}("name" => name, "source" => source);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_trust_anchor(
name,
source,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rolesanywhere(
"POST",
"/trustanchors",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("name" => name, "source" => source), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_attribute_mapping(certificate_field, profile_id)
delete_attribute_mapping(certificate_field, profile_id, params::Dict{String,<:Any})
Delete an entry from the attribute mapping rules enforced by a given profile.
# Arguments
- `certificate_field`: Fields (x509Subject, x509Issuer and x509SAN) within X.509
certificates.
- `profile_id`: The unique identifier of the profile.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"specifiers"`: A list of specifiers of a certificate field; for example, CN, OU, UID
from a Subject.
"""
function delete_attribute_mapping(
certificateField, profileId; aws_config::AbstractAWSConfig=global_aws_config()
)
return rolesanywhere(
"DELETE",
"/profiles/$(profileId)/mappings",
Dict{String,Any}("certificateField" => certificateField);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_attribute_mapping(
certificateField,
profileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rolesanywhere(
"DELETE",
"/profiles/$(profileId)/mappings",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("certificateField" => certificateField), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_crl(crl_id)
delete_crl(crl_id, params::Dict{String,<:Any})
Deletes a certificate revocation list (CRL). Required permissions:
rolesanywhere:DeleteCrl.
# Arguments
- `crl_id`: The unique identifier of the certificate revocation list (CRL).
"""
function delete_crl(crlId; aws_config::AbstractAWSConfig=global_aws_config())
return rolesanywhere(
"DELETE", "/crl/$(crlId)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_crl(
crlId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rolesanywhere(
"DELETE",
"/crl/$(crlId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_profile(profile_id)
delete_profile(profile_id, params::Dict{String,<:Any})
Deletes a profile. Required permissions: rolesanywhere:DeleteProfile.
# Arguments
- `profile_id`: The unique identifier of the profile.
"""
function delete_profile(profileId; aws_config::AbstractAWSConfig=global_aws_config())
return rolesanywhere(
"DELETE",
"/profile/$(profileId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_profile(
profileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rolesanywhere(
"DELETE",
"/profile/$(profileId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_trust_anchor(trust_anchor_id)
delete_trust_anchor(trust_anchor_id, params::Dict{String,<:Any})
Deletes a trust anchor. Required permissions: rolesanywhere:DeleteTrustAnchor.
# Arguments
- `trust_anchor_id`: The unique identifier of the trust anchor.
"""
function delete_trust_anchor(
trustAnchorId; aws_config::AbstractAWSConfig=global_aws_config()
)
return rolesanywhere(
"DELETE",
"/trustanchor/$(trustAnchorId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_trust_anchor(
trustAnchorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rolesanywhere(
"DELETE",
"/trustanchor/$(trustAnchorId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_crl(crl_id)
disable_crl(crl_id, params::Dict{String,<:Any})
Disables a certificate revocation list (CRL). Required permissions:
rolesanywhere:DisableCrl.
# Arguments
- `crl_id`: The unique identifier of the certificate revocation list (CRL).
"""
function disable_crl(crlId; aws_config::AbstractAWSConfig=global_aws_config())
return rolesanywhere(
"POST",
"/crl/$(crlId)/disable";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_crl(
crlId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rolesanywhere(
"POST",
"/crl/$(crlId)/disable",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_profile(profile_id)
disable_profile(profile_id, params::Dict{String,<:Any})
Disables a profile. When disabled, temporary credential requests with this profile fail.
Required permissions: rolesanywhere:DisableProfile.
# Arguments
- `profile_id`: The unique identifier of the profile.
"""
function disable_profile(profileId; aws_config::AbstractAWSConfig=global_aws_config())
return rolesanywhere(
"POST",
"/profile/$(profileId)/disable";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_profile(
profileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rolesanywhere(
"POST",
"/profile/$(profileId)/disable",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_trust_anchor(trust_anchor_id)
disable_trust_anchor(trust_anchor_id, params::Dict{String,<:Any})
Disables a trust anchor. When disabled, temporary credential requests specifying this trust
anchor are unauthorized. Required permissions: rolesanywhere:DisableTrustAnchor.
# Arguments
- `trust_anchor_id`: The unique identifier of the trust anchor.
"""
function disable_trust_anchor(
trustAnchorId; aws_config::AbstractAWSConfig=global_aws_config()
)
return rolesanywhere(
"POST",
"/trustanchor/$(trustAnchorId)/disable";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_trust_anchor(
trustAnchorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rolesanywhere(
"POST",
"/trustanchor/$(trustAnchorId)/disable",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_crl(crl_id)
enable_crl(crl_id, params::Dict{String,<:Any})
Enables a certificate revocation list (CRL). When enabled, certificates stored in the CRL
are unauthorized to receive session credentials. Required permissions:
rolesanywhere:EnableCrl.
# Arguments
- `crl_id`: The unique identifier of the certificate revocation list (CRL).
"""
function enable_crl(crlId; aws_config::AbstractAWSConfig=global_aws_config())
return rolesanywhere(
"POST",
"/crl/$(crlId)/enable";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_crl(
crlId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rolesanywhere(
"POST",
"/crl/$(crlId)/enable",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_profile(profile_id)
enable_profile(profile_id, params::Dict{String,<:Any})
Enables temporary credential requests for a profile. Required permissions:
rolesanywhere:EnableProfile.
# Arguments
- `profile_id`: The unique identifier of the profile.
"""
function enable_profile(profileId; aws_config::AbstractAWSConfig=global_aws_config())
return rolesanywhere(
"POST",
"/profile/$(profileId)/enable";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_profile(
profileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rolesanywhere(
"POST",
"/profile/$(profileId)/enable",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_trust_anchor(trust_anchor_id)
enable_trust_anchor(trust_anchor_id, params::Dict{String,<:Any})
Enables a trust anchor. When enabled, certificates in the trust anchor chain are authorized
for trust validation. Required permissions: rolesanywhere:EnableTrustAnchor.
# Arguments
- `trust_anchor_id`: The unique identifier of the trust anchor.
"""
function enable_trust_anchor(
trustAnchorId; aws_config::AbstractAWSConfig=global_aws_config()
)
return rolesanywhere(
"POST",
"/trustanchor/$(trustAnchorId)/enable";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_trust_anchor(
trustAnchorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rolesanywhere(
"POST",
"/trustanchor/$(trustAnchorId)/enable",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_crl(crl_id)
get_crl(crl_id, params::Dict{String,<:Any})
Gets a certificate revocation list (CRL). Required permissions: rolesanywhere:GetCrl.
# Arguments
- `crl_id`: The unique identifier of the certificate revocation list (CRL).
"""
function get_crl(crlId; aws_config::AbstractAWSConfig=global_aws_config())
return rolesanywhere(
"GET", "/crl/$(crlId)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_crl(
crlId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rolesanywhere(
"GET",
"/crl/$(crlId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_profile(profile_id)
get_profile(profile_id, params::Dict{String,<:Any})
Gets a profile. Required permissions: rolesanywhere:GetProfile.
# Arguments
- `profile_id`: The unique identifier of the profile.
"""
function get_profile(profileId; aws_config::AbstractAWSConfig=global_aws_config())
return rolesanywhere(
"GET",
"/profile/$(profileId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_profile(
profileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rolesanywhere(
"GET",
"/profile/$(profileId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_subject(subject_id)
get_subject(subject_id, params::Dict{String,<:Any})
Gets a subject, which associates a certificate identity with authentication attempts. The
subject stores auditing information such as the status of the last authentication attempt,
the certificate data used in the attempt, and the last time the associated identity
attempted authentication. Required permissions: rolesanywhere:GetSubject.
# Arguments
- `subject_id`: The unique identifier of the subject.
"""
function get_subject(subjectId; aws_config::AbstractAWSConfig=global_aws_config())
return rolesanywhere(
"GET",
"/subject/$(subjectId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_subject(
subjectId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rolesanywhere(
"GET",
"/subject/$(subjectId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_trust_anchor(trust_anchor_id)
get_trust_anchor(trust_anchor_id, params::Dict{String,<:Any})
Gets a trust anchor. Required permissions: rolesanywhere:GetTrustAnchor.
# Arguments
- `trust_anchor_id`: The unique identifier of the trust anchor.
"""
function get_trust_anchor(trustAnchorId; aws_config::AbstractAWSConfig=global_aws_config())
return rolesanywhere(
"GET",
"/trustanchor/$(trustAnchorId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_trust_anchor(
trustAnchorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rolesanywhere(
"GET",
"/trustanchor/$(trustAnchorId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
import_crl(crl_data, name, trust_anchor_arn)
import_crl(crl_data, name, trust_anchor_arn, params::Dict{String,<:Any})
Imports the certificate revocation list (CRL). A CRL is a list of certificates that have
been revoked by the issuing certificate Authority (CA).In order to be properly imported, a
CRL must be in PEM format. IAM Roles Anywhere validates against the CRL before issuing
credentials. Required permissions: rolesanywhere:ImportCrl.
# Arguments
- `crl_data`: The x509 v3 specified certificate revocation list (CRL).
- `name`: The name of the certificate revocation list (CRL).
- `trust_anchor_arn`: The ARN of the TrustAnchor the certificate revocation list (CRL) will
provide revocation for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"enabled"`: Specifies whether the certificate revocation list (CRL) is enabled.
- `"tags"`: A list of tags to attach to the certificate revocation list (CRL).
"""
function import_crl(
crlData, name, trustAnchorArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return rolesanywhere(
"POST",
"/crls",
Dict{String,Any}(
"crlData" => crlData, "name" => name, "trustAnchorArn" => trustAnchorArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function import_crl(
crlData,
name,
trustAnchorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rolesanywhere(
"POST",
"/crls",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"crlData" => crlData, "name" => name, "trustAnchorArn" => trustAnchorArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_crls()
list_crls(params::Dict{String,<:Any})
Lists all certificate revocation lists (CRL) in the authenticated account and Amazon Web
Services Region. Required permissions: rolesanywhere:ListCrls.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: A token that indicates where the output should continue from, if a
previous request did not show all results. To get the next results, make the request again
with this value.
- `"pageSize"`: The number of resources in the paginated list.
"""
function list_crls(; aws_config::AbstractAWSConfig=global_aws_config())
return rolesanywhere(
"GET", "/crls"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_crls(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rolesanywhere(
"GET", "/crls", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_profiles()
list_profiles(params::Dict{String,<:Any})
Lists all profiles in the authenticated account and Amazon Web Services Region. Required
permissions: rolesanywhere:ListProfiles.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: A token that indicates where the output should continue from, if a
previous request did not show all results. To get the next results, make the request again
with this value.
- `"pageSize"`: The number of resources in the paginated list.
"""
function list_profiles(; aws_config::AbstractAWSConfig=global_aws_config())
return rolesanywhere(
"GET", "/profiles"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_profiles(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rolesanywhere(
"GET", "/profiles", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_subjects()
list_subjects(params::Dict{String,<:Any})
Lists the subjects in the authenticated account and Amazon Web Services Region. Required
permissions: rolesanywhere:ListSubjects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: A token that indicates where the output should continue from, if a
previous request did not show all results. To get the next results, make the request again
with this value.
- `"pageSize"`: The number of resources in the paginated list.
"""
function list_subjects(; aws_config::AbstractAWSConfig=global_aws_config())
return rolesanywhere(
"GET", "/subjects"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_subjects(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rolesanywhere(
"GET", "/subjects", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Lists the tags attached to the resource. Required permissions:
rolesanywhere:ListTagsForResource.
# Arguments
- `resource_arn`: The ARN of the resource.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return rolesanywhere(
"GET",
"/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 rolesanywhere(
"GET",
"/ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_trust_anchors()
list_trust_anchors(params::Dict{String,<:Any})
Lists the trust anchors in the authenticated account and Amazon Web Services Region.
Required permissions: rolesanywhere:ListTrustAnchors.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: A token that indicates where the output should continue from, if a
previous request did not show all results. To get the next results, make the request again
with this value.
- `"pageSize"`: The number of resources in the paginated list.
"""
function list_trust_anchors(; aws_config::AbstractAWSConfig=global_aws_config())
return rolesanywhere(
"GET", "/trustanchors"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_trust_anchors(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rolesanywhere(
"GET",
"/trustanchors",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_attribute_mapping(certificate_field, mapping_rules, profile_id)
put_attribute_mapping(certificate_field, mapping_rules, profile_id, params::Dict{String,<:Any})
Put an entry in the attribute mapping rules that will be enforced by a given profile. A
mapping specifies a certificate field and one or more specifiers that have contextual
meanings.
# Arguments
- `certificate_field`: Fields (x509Subject, x509Issuer and x509SAN) within X.509
certificates.
- `mapping_rules`: A list of mapping entries for every supported specifier or sub-field.
- `profile_id`: The unique identifier of the profile.
"""
function put_attribute_mapping(
certificateField,
mappingRules,
profileId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rolesanywhere(
"PUT",
"/profiles/$(profileId)/mappings",
Dict{String,Any}(
"certificateField" => certificateField, "mappingRules" => mappingRules
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_attribute_mapping(
certificateField,
mappingRules,
profileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rolesanywhere(
"PUT",
"/profiles/$(profileId)/mappings",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"certificateField" => certificateField, "mappingRules" => mappingRules
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_notification_settings(notification_settings, trust_anchor_id)
put_notification_settings(notification_settings, trust_anchor_id, params::Dict{String,<:Any})
Attaches a list of notification settings to a trust anchor. A notification setting includes
information such as event name, threshold, status of the notification setting, and the
channel to notify. Required permissions: rolesanywhere:PutNotificationSettings.
# Arguments
- `notification_settings`: A list of notification settings to be associated to the trust
anchor.
- `trust_anchor_id`: The unique identifier of the trust anchor.
"""
function put_notification_settings(
notificationSettings, trustAnchorId; aws_config::AbstractAWSConfig=global_aws_config()
)
return rolesanywhere(
"PATCH",
"/put-notifications-settings",
Dict{String,Any}(
"notificationSettings" => notificationSettings, "trustAnchorId" => trustAnchorId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_notification_settings(
notificationSettings,
trustAnchorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rolesanywhere(
"PATCH",
"/put-notifications-settings",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"notificationSettings" => notificationSettings,
"trustAnchorId" => trustAnchorId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reset_notification_settings(notification_setting_keys, trust_anchor_id)
reset_notification_settings(notification_setting_keys, trust_anchor_id, params::Dict{String,<:Any})
Resets the custom notification setting to IAM Roles Anywhere default setting. Required
permissions: rolesanywhere:ResetNotificationSettings.
# Arguments
- `notification_setting_keys`: A list of notification setting keys to reset. A notification
setting key includes the event and the channel.
- `trust_anchor_id`: The unique identifier of the trust anchor.
"""
function reset_notification_settings(
notificationSettingKeys,
trustAnchorId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rolesanywhere(
"PATCH",
"/reset-notifications-settings",
Dict{String,Any}(
"notificationSettingKeys" => notificationSettingKeys,
"trustAnchorId" => trustAnchorId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reset_notification_settings(
notificationSettingKeys,
trustAnchorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rolesanywhere(
"PATCH",
"/reset-notifications-settings",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"notificationSettingKeys" => notificationSettingKeys,
"trustAnchorId" => trustAnchorId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Attaches tags to a resource. Required permissions: rolesanywhere:TagResource.
# Arguments
- `resource_arn`: The ARN of the resource.
- `tags`: The tags to attach to the resource.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return rolesanywhere(
"POST",
"/TagResource",
Dict{String,Any}("resourceArn" => resourceArn, "tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resourceArn,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rolesanywhere(
"POST",
"/TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("resourceArn" => resourceArn, "tags" => tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes tags from the resource. Required permissions: rolesanywhere:UntagResource.
# Arguments
- `resource_arn`: The ARN of the resource.
- `tag_keys`: A list of keys. Tag keys are the unique identifiers of tags.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return rolesanywhere(
"POST",
"/UntagResource",
Dict{String,Any}("resourceArn" => resourceArn, "tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rolesanywhere(
"POST",
"/UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("resourceArn" => resourceArn, "tagKeys" => tagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_crl(crl_id)
update_crl(crl_id, params::Dict{String,<:Any})
Updates the certificate revocation list (CRL). A CRL is a list of certificates that have
been revoked by the issuing certificate authority (CA). IAM Roles Anywhere validates
against the CRL before issuing credentials. Required permissions:
rolesanywhere:UpdateCrl.
# Arguments
- `crl_id`: The unique identifier of the certificate revocation list (CRL).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"crlData"`: The x509 v3 specified certificate revocation list (CRL).
- `"name"`: The name of the Crl.
"""
function update_crl(crlId; aws_config::AbstractAWSConfig=global_aws_config())
return rolesanywhere(
"PATCH", "/crl/$(crlId)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function update_crl(
crlId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rolesanywhere(
"PATCH",
"/crl/$(crlId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_profile(profile_id)
update_profile(profile_id, params::Dict{String,<:Any})
Updates a profile, a list of the roles that IAM Roles Anywhere service is trusted to
assume. You use profiles to intersect permissions with IAM managed policies. Required
permissions: rolesanywhere:UpdateProfile.
# Arguments
- `profile_id`: The unique identifier of the profile.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"durationSeconds"`: Used to determine how long sessions vended using this profile are
valid for. See the Expiration section of the CreateSession API documentation page for more
details. In requests, if this value is not provided, the default value will be 3600.
- `"managedPolicyArns"`: A list of managed policy ARNs that apply to the vended session
credentials.
- `"name"`: The name of the profile.
- `"roleArns"`: A list of IAM roles that this profile can assume in a temporary credential
request.
- `"sessionPolicy"`: A session policy that applies to the trust boundary of the vended
session credentials.
"""
function update_profile(profileId; aws_config::AbstractAWSConfig=global_aws_config())
return rolesanywhere(
"PATCH",
"/profile/$(profileId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_profile(
profileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rolesanywhere(
"PATCH",
"/profile/$(profileId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_trust_anchor(trust_anchor_id)
update_trust_anchor(trust_anchor_id, params::Dict{String,<:Any})
Updates a trust anchor. You establish trust between IAM Roles Anywhere and your certificate
authority (CA) by configuring a trust anchor. You can define a trust anchor as a reference
to an Private Certificate Authority (Private CA) or by uploading a CA certificate. Your
Amazon Web Services workloads can authenticate with the trust anchor using certificates
issued by the CA in exchange for temporary Amazon Web Services credentials. Required
permissions: rolesanywhere:UpdateTrustAnchor.
# Arguments
- `trust_anchor_id`: The unique identifier of the trust anchor.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"name"`: The name of the trust anchor.
- `"source"`: The trust anchor type and its related certificate data.
"""
function update_trust_anchor(
trustAnchorId; aws_config::AbstractAWSConfig=global_aws_config()
)
return rolesanywhere(
"PATCH",
"/trustanchor/$(trustAnchorId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_trust_anchor(
trustAnchorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rolesanywhere(
"PATCH",
"/trustanchor/$(trustAnchorId)",
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 | 11831 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: route53_recovery_cluster
using AWS.Compat
using AWS.UUIDs
"""
get_routing_control_state(routing_control_arn)
get_routing_control_state(routing_control_arn, params::Dict{String,<:Any})
Get the state for a routing control. A routing control is a simple on/off switch that you
can use to route traffic to cells. When a routing control state is set to ON, traffic flows
to a cell. When the state is set to OFF, traffic does not flow. Before you can create a
routing control, you must first create a cluster, and then host the control in a control
panel on the cluster. For more information, see Create routing control structures in the
Amazon Route 53 Application Recovery Controller Developer Guide. You access one of the
endpoints for the cluster to get or update the routing control state to redirect traffic
for your application. You must specify Regional endpoints when you work with API cluster
operations to get or update routing control states in Route 53 ARC. To see a code example
for getting a routing control state, including accessing Regional cluster endpoints in
sequence, see API examples in the Amazon Route 53 Application Recovery Controller Developer
Guide. Learn more about working with routing controls in the following topics in the Amazon
Route 53 Application Recovery Controller Developer Guide: Viewing and updating routing
control states Working with routing controls in Route 53 ARC
# Arguments
- `routing_control_arn`: The Amazon Resource Name (ARN) for the routing control that you
want to get the state for.
"""
function get_routing_control_state(
RoutingControlArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_cluster(
"GetRoutingControlState",
Dict{String,Any}("RoutingControlArn" => RoutingControlArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_routing_control_state(
RoutingControlArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_cluster(
"GetRoutingControlState",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("RoutingControlArn" => RoutingControlArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_routing_controls()
list_routing_controls(params::Dict{String,<:Any})
List routing control names and Amazon Resource Names (ARNs), as well as the routing control
state for each routing control, along with the control panel name and control panel ARN for
the routing controls. If you specify a control panel ARN, this call lists the routing
controls in the control panel. Otherwise, it lists all the routing controls in the cluster.
A routing control is a simple on/off switch in Route 53 ARC that you can use to route
traffic to cells. When a routing control state is set to ON, traffic flows to a cell. When
the state is set to OFF, traffic does not flow. Before you can create a routing control,
you must first create a cluster, and then host the control in a control panel on the
cluster. For more information, see Create routing control structures in the Amazon Route
53 Application Recovery Controller Developer Guide. You access one of the endpoints for the
cluster to get or update the routing control state to redirect traffic for your
application. You must specify Regional endpoints when you work with API cluster
operations to use this API operation to list routing controls in Route 53 ARC. Learn more
about working with routing controls in the following topics in the Amazon Route 53
Application Recovery Controller Developer Guide: Viewing and updating routing control
states Working with routing controls in Route 53 ARC
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ControlPanelArn"`: The Amazon Resource Name (ARN) of the control panel of the routing
controls to list.
- `"MaxResults"`: The number of routing controls objects that you want to return with this
call. The default value is 500.
- `"NextToken"`: The token for the next set of results. You receive this token from a
previous call.
"""
function list_routing_controls(; aws_config::AbstractAWSConfig=global_aws_config())
return route53_recovery_cluster(
"ListRoutingControls"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_routing_controls(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_cluster(
"ListRoutingControls",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_routing_control_state(routing_control_arn, routing_control_state)
update_routing_control_state(routing_control_arn, routing_control_state, params::Dict{String,<:Any})
Set the state of the routing control to reroute traffic. You can set the value to ON or
OFF. When the state is ON, traffic flows to a cell. When the state is OFF, traffic does not
flow. With Route 53 ARC, you can add safety rules for routing controls, which are
safeguards for routing control state updates that help prevent unexpected outcomes, like
fail open traffic routing. However, there are scenarios when you might want to bypass the
routing control safeguards that are enforced with safety rules that you've configured. For
example, you might want to fail over quickly for disaster recovery, and one or more safety
rules might be unexpectedly preventing you from updating a routing control state to reroute
traffic. In a \"break glass\" scenario like this, you can override one or more safety rules
to change a routing control state and fail over your application. The SafetyRulesToOverride
property enables you override one or more safety rules and update routing control states.
For more information, see Override safety rules to reroute traffic in the Amazon Route 53
Application Recovery Controller Developer Guide. You must specify Regional endpoints when
you work with API cluster operations to get or update routing control states in Route 53
ARC. To see a code example for getting a routing control state, including accessing
Regional cluster endpoints in sequence, see API examples in the Amazon Route 53 Application
Recovery Controller Developer Guide. Viewing and updating routing control states
Working with routing controls overall
# Arguments
- `routing_control_arn`: The Amazon Resource Name (ARN) for the routing control that you
want to update the state for.
- `routing_control_state`: The state of the routing control. You can set the value to ON or
OFF.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SafetyRulesToOverride"`: The Amazon Resource Names (ARNs) for the safety rules that you
want to override when you're updating the state of a routing control. You can override one
safety rule or multiple safety rules by including one or more ARNs, separated by commas.
For more information, see Override safety rules to reroute traffic in the Amazon Route 53
Application Recovery Controller Developer Guide.
"""
function update_routing_control_state(
RoutingControlArn,
RoutingControlState;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_cluster(
"UpdateRoutingControlState",
Dict{String,Any}(
"RoutingControlArn" => RoutingControlArn,
"RoutingControlState" => RoutingControlState,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_routing_control_state(
RoutingControlArn,
RoutingControlState,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_cluster(
"UpdateRoutingControlState",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"RoutingControlArn" => RoutingControlArn,
"RoutingControlState" => RoutingControlState,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_routing_control_states(update_routing_control_state_entries)
update_routing_control_states(update_routing_control_state_entries, params::Dict{String,<:Any})
Set multiple routing control states. You can set the value for each state to be ON or OFF.
When the state is ON, traffic flows to a cell. When it's OFF, traffic does not flow. With
Route 53 ARC, you can add safety rules for routing controls, which are safeguards for
routing control state updates that help prevent unexpected outcomes, like fail open traffic
routing. However, there are scenarios when you might want to bypass the routing control
safeguards that are enforced with safety rules that you've configured. For example, you
might want to fail over quickly for disaster recovery, and one or more safety rules might
be unexpectedly preventing you from updating a routing control state to reroute traffic. In
a \"break glass\" scenario like this, you can override one or more safety rules to change a
routing control state and fail over your application. The SafetyRulesToOverride property
enables you override one or more safety rules and update routing control states. For more
information, see Override safety rules to reroute traffic in the Amazon Route 53
Application Recovery Controller Developer Guide. You must specify Regional endpoints when
you work with API cluster operations to get or update routing control states in Route 53
ARC. To see a code example for getting a routing control state, including accessing
Regional cluster endpoints in sequence, see API examples in the Amazon Route 53 Application
Recovery Controller Developer Guide. Viewing and updating routing control states
Working with routing controls overall
# Arguments
- `update_routing_control_state_entries`: A set of routing control entries that you want to
update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SafetyRulesToOverride"`: The Amazon Resource Names (ARNs) for the safety rules that you
want to override when you're updating routing control states. You can override one safety
rule or multiple safety rules by including one or more ARNs, separated by commas. For more
information, see Override safety rules to reroute traffic in the Amazon Route 53
Application Recovery Controller Developer Guide.
"""
function update_routing_control_states(
UpdateRoutingControlStateEntries; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_cluster(
"UpdateRoutingControlStates",
Dict{String,Any}(
"UpdateRoutingControlStateEntries" => UpdateRoutingControlStateEntries
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_routing_control_states(
UpdateRoutingControlStateEntries,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_cluster(
"UpdateRoutingControlStates",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"UpdateRoutingControlStateEntries" => UpdateRoutingControlStateEntries
),
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 | 29661 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: route53_recovery_control_config
using AWS.Compat
using AWS.UUIDs
"""
create_cluster(cluster_name)
create_cluster(cluster_name, params::Dict{String,<:Any})
Create a new cluster. A cluster is a set of redundant Regional endpoints against which you
can run API calls to update or get the state of one or more routing controls. Each cluster
has a name, status, Amazon Resource Name (ARN), and an array of the five cluster endpoints
(one for each supported Amazon Web Services Region) that you can use with API calls to the
cluster data plane.
# Arguments
- `cluster_name`: The name of the cluster.
# 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. To make an
idempotent API request with an action, specify a client token in the request.
- `"Tags"`: The tags associated with the cluster.
"""
function create_cluster(ClusterName; aws_config::AbstractAWSConfig=global_aws_config())
return route53_recovery_control_config(
"POST",
"/cluster",
Dict{String,Any}("ClusterName" => ClusterName, "ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_cluster(
ClusterName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_control_config(
"POST",
"/cluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClusterName" => ClusterName, "ClientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_control_panel(cluster_arn, control_panel_name)
create_control_panel(cluster_arn, control_panel_name, params::Dict{String,<:Any})
Creates a new control panel. A control panel represents a group of routing controls that
can be changed together in a single transaction. You can use a control panel to centrally
view the operational status of applications across your organization, and trigger multi-app
failovers in a single transaction, for example, to fail over an Availability Zone or Amazon
Web Services Region.
# Arguments
- `cluster_arn`: The Amazon Resource Name (ARN) of the cluster for the control panel.
- `control_panel_name`: The name of the control panel.
# 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. To make an
idempotent API request with an action, specify a client token in the request.
- `"Tags"`: The tags associated with the control panel.
"""
function create_control_panel(
ClusterArn, ControlPanelName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_control_config(
"POST",
"/controlpanel",
Dict{String,Any}(
"ClusterArn" => ClusterArn,
"ControlPanelName" => ControlPanelName,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_control_panel(
ClusterArn,
ControlPanelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_control_config(
"POST",
"/controlpanel",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClusterArn" => ClusterArn,
"ControlPanelName" => ControlPanelName,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_routing_control(cluster_arn, routing_control_name)
create_routing_control(cluster_arn, routing_control_name, params::Dict{String,<:Any})
Creates a new routing control. A routing control has one of two states: ON and OFF. You can
map the routing control state to the state of an Amazon Route 53 health check, which can be
used to control traffic routing. To get or update the routing control state, see the
Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery
Controller.
# Arguments
- `cluster_arn`: The Amazon Resource Name (ARN) of the cluster that includes the routing
control.
- `routing_control_name`: The name of the routing control.
# 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. To make an
idempotent API request with an action, specify a client token in the request.
- `"ControlPanelArn"`: The Amazon Resource Name (ARN) of the control panel that includes
the routing control.
"""
function create_routing_control(
ClusterArn, RoutingControlName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_control_config(
"POST",
"/routingcontrol",
Dict{String,Any}(
"ClusterArn" => ClusterArn,
"RoutingControlName" => RoutingControlName,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_routing_control(
ClusterArn,
RoutingControlName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_control_config(
"POST",
"/routingcontrol",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClusterArn" => ClusterArn,
"RoutingControlName" => RoutingControlName,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_safety_rule()
create_safety_rule(params::Dict{String,<:Any})
Creates a safety rule in a control panel. Safety rules let you add safeguards around
changing routing control states, and for enabling and disabling routing controls, to help
prevent unexpected outcomes. There are two types of safety rules: assertion rules and
gating rules. Assertion rule: An assertion rule enforces that, when you change a routing
control state, that a certain criteria is met. For example, the criteria might be that at
least one routing control state is On after the transaction so that traffic continues to
flow to at least one cell for the application. This ensures that you avoid a fail-open
scenario. Gating rule: A gating rule lets you configure a gating routing control as an
overall \"on/off\" switch for a group of routing controls. Or, you can configure more
complex gating scenarios, for example by configuring multiple gating routing controls. For
more information, see Safety rules in the Amazon Route 53 Application Recovery Controller
Developer Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AssertionRule"`: The assertion rule requested.
- `"ClientToken"`: A unique, case-sensitive string of up to 64 ASCII characters. To make an
idempotent API request with an action, specify a client token in the request.
- `"GatingRule"`: The gating rule requested.
- `"Tags"`: The tags associated with the safety rule.
"""
function create_safety_rule(; aws_config::AbstractAWSConfig=global_aws_config())
return route53_recovery_control_config(
"POST",
"/safetyrule",
Dict{String,Any}("ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_safety_rule(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_control_config(
"POST",
"/safetyrule",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_cluster(cluster_arn)
delete_cluster(cluster_arn, params::Dict{String,<:Any})
Delete a cluster.
# Arguments
- `cluster_arn`: The Amazon Resource Name (ARN) of the cluster that you're deleting.
"""
function delete_cluster(ClusterArn; aws_config::AbstractAWSConfig=global_aws_config())
return route53_recovery_control_config(
"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 route53_recovery_control_config(
"DELETE",
"/cluster/$(ClusterArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_control_panel(control_panel_arn)
delete_control_panel(control_panel_arn, params::Dict{String,<:Any})
Deletes a control panel.
# Arguments
- `control_panel_arn`: The Amazon Resource Name (ARN) of the control panel.
"""
function delete_control_panel(
ControlPanelArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_control_config(
"DELETE",
"/controlpanel/$(ControlPanelArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_control_panel(
ControlPanelArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_control_config(
"DELETE",
"/controlpanel/$(ControlPanelArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_routing_control(routing_control_arn)
delete_routing_control(routing_control_arn, params::Dict{String,<:Any})
Deletes a routing control.
# Arguments
- `routing_control_arn`: The Amazon Resource Name (ARN) of the routing control that you're
deleting.
"""
function delete_routing_control(
RoutingControlArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_control_config(
"DELETE",
"/routingcontrol/$(RoutingControlArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_routing_control(
RoutingControlArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_control_config(
"DELETE",
"/routingcontrol/$(RoutingControlArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_safety_rule(safety_rule_arn)
delete_safety_rule(safety_rule_arn, params::Dict{String,<:Any})
Deletes a safety rule./>
# Arguments
- `safety_rule_arn`: The ARN of the safety rule.
"""
function delete_safety_rule(
SafetyRuleArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_control_config(
"DELETE",
"/safetyrule/$(SafetyRuleArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_safety_rule(
SafetyRuleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_control_config(
"DELETE",
"/safetyrule/$(SafetyRuleArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_cluster(cluster_arn)
describe_cluster(cluster_arn, params::Dict{String,<:Any})
Display the details about a cluster. The response includes the cluster name, endpoints,
status, and Amazon Resource Name (ARN).
# Arguments
- `cluster_arn`: The Amazon Resource Name (ARN) of the cluster.
"""
function describe_cluster(ClusterArn; aws_config::AbstractAWSConfig=global_aws_config())
return route53_recovery_control_config(
"GET",
"/cluster/$(ClusterArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_cluster(
ClusterArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_control_config(
"GET",
"/cluster/$(ClusterArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_control_panel(control_panel_arn)
describe_control_panel(control_panel_arn, params::Dict{String,<:Any})
Displays details about a control panel.
# Arguments
- `control_panel_arn`: The Amazon Resource Name (ARN) of the control panel.
"""
function describe_control_panel(
ControlPanelArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_control_config(
"GET",
"/controlpanel/$(ControlPanelArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_control_panel(
ControlPanelArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_control_config(
"GET",
"/controlpanel/$(ControlPanelArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_routing_control(routing_control_arn)
describe_routing_control(routing_control_arn, params::Dict{String,<:Any})
Displays details about a routing control. A routing control has one of two states: ON and
OFF. You can map the routing control state to the state of an Amazon Route 53 health check,
which can be used to control routing. To get or update the routing control state, see the
Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery
Controller.
# Arguments
- `routing_control_arn`: The Amazon Resource Name (ARN) of the routing control.
"""
function describe_routing_control(
RoutingControlArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_control_config(
"GET",
"/routingcontrol/$(RoutingControlArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_routing_control(
RoutingControlArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_control_config(
"GET",
"/routingcontrol/$(RoutingControlArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_safety_rule(safety_rule_arn)
describe_safety_rule(safety_rule_arn, params::Dict{String,<:Any})
Returns information about a safety rule.
# Arguments
- `safety_rule_arn`: The ARN of the safety rule.
"""
function describe_safety_rule(
SafetyRuleArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_control_config(
"GET",
"/safetyrule/$(SafetyRuleArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_safety_rule(
SafetyRuleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_control_config(
"GET",
"/safetyrule/$(SafetyRuleArn)",
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})
Get information about the resource policy for a cluster.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
"""
function get_resource_policy(ResourceArn; aws_config::AbstractAWSConfig=global_aws_config())
return route53_recovery_control_config(
"GET",
"/resourcePolicy/$(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 route53_recovery_control_config(
"GET",
"/resourcePolicy/$(ResourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_associated_route53_health_checks(routing_control_arn)
list_associated_route53_health_checks(routing_control_arn, params::Dict{String,<:Any})
Returns an array of all Amazon Route 53 health checks associated with a specific routing
control.
# Arguments
- `routing_control_arn`: The Amazon Resource Name (ARN) of the routing control.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The number of objects that you want to return with this call.
- `"NextToken"`: The token that identifies which batch of results you want to see.
"""
function list_associated_route53_health_checks(
RoutingControlArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_control_config(
"GET",
"/routingcontrol/$(RoutingControlArn)/associatedRoute53HealthChecks";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_associated_route53_health_checks(
RoutingControlArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_control_config(
"GET",
"/routingcontrol/$(RoutingControlArn)/associatedRoute53HealthChecks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_clusters()
list_clusters(params::Dict{String,<:Any})
Returns an array of all the clusters in an account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The number of objects that you want to return with this call.
- `"NextToken"`: The token that identifies which batch of results you want to see.
"""
function list_clusters(; aws_config::AbstractAWSConfig=global_aws_config())
return route53_recovery_control_config(
"GET", "/cluster"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_clusters(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_control_config(
"GET", "/cluster", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_control_panels()
list_control_panels(params::Dict{String,<:Any})
Returns an array of control panels in an account or in a cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClusterArn"`: The Amazon Resource Name (ARN) of a cluster.
- `"MaxResults"`: The number of objects that you want to return with this call.
- `"NextToken"`: The token that identifies which batch of results you want to see.
"""
function list_control_panels(; aws_config::AbstractAWSConfig=global_aws_config())
return route53_recovery_control_config(
"GET", "/controlpanels"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_control_panels(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_control_config(
"GET",
"/controlpanels",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_routing_controls(control_panel_arn)
list_routing_controls(control_panel_arn, params::Dict{String,<:Any})
Returns an array of routing controls for a control panel. A routing control is an Amazon
Route 53 Application Recovery Controller construct that has one of two states: ON and OFF.
You can map the routing control state to the state of an Amazon Route 53 health check,
which can be used to control routing.
# Arguments
- `control_panel_arn`: The Amazon Resource Name (ARN) of the control panel.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The number of objects that you want to return with this call.
- `"NextToken"`: The token that identifies which batch of results you want to see.
"""
function list_routing_controls(
ControlPanelArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_control_config(
"GET",
"/controlpanel/$(ControlPanelArn)/routingcontrols";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_routing_controls(
ControlPanelArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_control_config(
"GET",
"/controlpanel/$(ControlPanelArn)/routingcontrols",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_safety_rules(control_panel_arn)
list_safety_rules(control_panel_arn, params::Dict{String,<:Any})
List the safety rules (the assertion rules and gating rules) that you've defined for the
routing controls in a control panel.
# Arguments
- `control_panel_arn`: The Amazon Resource Name (ARN) of the control panel.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The number of objects that you want to return with this call.
- `"NextToken"`: The token that identifies which batch of results you want to see.
"""
function list_safety_rules(
ControlPanelArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_control_config(
"GET",
"/controlpanel/$(ControlPanelArn)/safetyrules";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_safety_rules(
ControlPanelArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_control_config(
"GET",
"/controlpanel/$(ControlPanelArn)/safetyrules",
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.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) for the resource that's tagged.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_control_config(
"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 route53_recovery_control_config(
"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 a tag to a resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) for the resource that's tagged.
- `tags`: The tags associated with the resource.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return route53_recovery_control_config(
"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 route53_recovery_control_config(
"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 the resource that's tagged.
- `tag_keys`: Keys for the tags to be removed.
"""
function untag_resource(
ResourceArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_control_config(
"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 route53_recovery_control_config(
"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_control_panel(control_panel_arn, control_panel_name)
update_control_panel(control_panel_arn, control_panel_name, params::Dict{String,<:Any})
Updates a control panel. The only update you can make to a control panel is to change the
name of the control panel.
# Arguments
- `control_panel_arn`: The Amazon Resource Name (ARN) of the control panel.
- `control_panel_name`: The name of the control panel.
"""
function update_control_panel(
ControlPanelArn, ControlPanelName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_control_config(
"PUT",
"/controlpanel",
Dict{String,Any}(
"ControlPanelArn" => ControlPanelArn, "ControlPanelName" => ControlPanelName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_control_panel(
ControlPanelArn,
ControlPanelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_control_config(
"PUT",
"/controlpanel",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ControlPanelArn" => ControlPanelArn,
"ControlPanelName" => ControlPanelName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_routing_control(routing_control_arn, routing_control_name)
update_routing_control(routing_control_arn, routing_control_name, params::Dict{String,<:Any})
Updates a routing control. You can only update the name of the routing control. To get or
update the routing control state, see the Recovery Cluster (data plane) API actions for
Amazon Route 53 Application Recovery Controller.
# Arguments
- `routing_control_arn`: The Amazon Resource Name (ARN) of the routing control.
- `routing_control_name`: The name of the routing control.
"""
function update_routing_control(
RoutingControlArn, RoutingControlName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_control_config(
"PUT",
"/routingcontrol",
Dict{String,Any}(
"RoutingControlArn" => RoutingControlArn,
"RoutingControlName" => RoutingControlName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_routing_control(
RoutingControlArn,
RoutingControlName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_control_config(
"PUT",
"/routingcontrol",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"RoutingControlArn" => RoutingControlArn,
"RoutingControlName" => RoutingControlName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_safety_rule()
update_safety_rule(params::Dict{String,<:Any})
Update a safety rule (an assertion rule or gating rule). You can only update the name and
the waiting period for a safety rule. To make other updates, delete the safety rule and
create a new one.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AssertionRuleUpdate"`: The assertion rule to update.
- `"GatingRuleUpdate"`: The gating rule to update.
"""
function update_safety_rule(; aws_config::AbstractAWSConfig=global_aws_config())
return route53_recovery_control_config(
"PUT", "/safetyrule"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function update_safety_rule(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_control_config(
"PUT", "/safetyrule", 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 | 37213 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: route53_recovery_readiness
using AWS.Compat
using AWS.UUIDs
"""
create_cell(cell_name)
create_cell(cell_name, params::Dict{String,<:Any})
Creates a cell in an account.
# Arguments
- `cell_name`: The name of the cell to create.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cells"`: A list of cell Amazon Resource Names (ARNs) contained within this cell, for
use in nested cells. For example, Availability Zones within specific Amazon Web Services
Regions.
- `"tags"`:
"""
function create_cell(cellName; aws_config::AbstractAWSConfig=global_aws_config())
return route53_recovery_readiness(
"POST",
"/cells",
Dict{String,Any}("cellName" => cellName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_cell(
cellName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_readiness(
"POST",
"/cells",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("cellName" => cellName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_cross_account_authorization(cross_account_authorization)
create_cross_account_authorization(cross_account_authorization, params::Dict{String,<:Any})
Creates a cross-account readiness authorization. This lets you authorize another account to
work with Route 53 Application Recovery Controller, for example, to check the readiness
status of resources in a separate account.
# Arguments
- `cross_account_authorization`: The cross-account authorization.
"""
function create_cross_account_authorization(
crossAccountAuthorization; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_readiness(
"POST",
"/crossaccountauthorizations",
Dict{String,Any}("crossAccountAuthorization" => crossAccountAuthorization);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_cross_account_authorization(
crossAccountAuthorization,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_readiness(
"POST",
"/crossaccountauthorizations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("crossAccountAuthorization" => crossAccountAuthorization),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_readiness_check(readiness_check_name, resource_set_name)
create_readiness_check(readiness_check_name, resource_set_name, params::Dict{String,<:Any})
Creates a readiness check in an account. A readiness check monitors a resource set in your
application, such as a set of Amazon Aurora instances, that Application Recovery Controller
is auditing recovery readiness for. The audits run once every minute on every resource
that's associated with a readiness check.
# Arguments
- `readiness_check_name`: The name of the readiness check to create.
- `resource_set_name`: The name of the resource set to check.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`:
"""
function create_readiness_check(
readinessCheckName, resourceSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_readiness(
"POST",
"/readinesschecks",
Dict{String,Any}(
"readinessCheckName" => readinessCheckName, "resourceSetName" => resourceSetName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_readiness_check(
readinessCheckName,
resourceSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_readiness(
"POST",
"/readinesschecks",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"readinessCheckName" => readinessCheckName,
"resourceSetName" => resourceSetName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_recovery_group(recovery_group_name)
create_recovery_group(recovery_group_name, params::Dict{String,<:Any})
Creates a recovery group in an account. A recovery group corresponds to an application and
includes a list of the cells that make up the application.
# Arguments
- `recovery_group_name`: The name of the recovery group to create.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cells"`: A list of the cell Amazon Resource Names (ARNs) in the recovery group.
- `"tags"`:
"""
function create_recovery_group(
recoveryGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_readiness(
"POST",
"/recoverygroups",
Dict{String,Any}("recoveryGroupName" => recoveryGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_recovery_group(
recoveryGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_readiness(
"POST",
"/recoverygroups",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("recoveryGroupName" => recoveryGroupName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_resource_set(resource_set_name, resource_set_type, resources)
create_resource_set(resource_set_name, resource_set_type, resources, params::Dict{String,<:Any})
Creates a resource set. A resource set is a set of resources of one type that span multiple
cells. You can associate a resource set with a readiness check to monitor the resources for
failover readiness.
# Arguments
- `resource_set_name`: The name of the resource set to create.
- `resource_set_type`: The resource type of the resources in the resource set. Enter one of
the following values for resource type: AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage,
AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway,
AWS::DynamoDB::Table, AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer,
AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function, AWS::MSK::Cluster,
AWS::RDS::DBCluster, AWS::Route53::HealthCheck, AWS::SQS::Queue, AWS::SNS::Topic,
AWS::SNS::Subscription, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway,
AWS::Route53RecoveryReadiness::DNSTargetResource
- `resources`: A list of resource objects in the resource set.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: A tag to associate with the parameters for a resource set.
"""
function create_resource_set(
resourceSetName,
resourceSetType,
resources;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_readiness(
"POST",
"/resourcesets",
Dict{String,Any}(
"resourceSetName" => resourceSetName,
"resourceSetType" => resourceSetType,
"resources" => resources,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_resource_set(
resourceSetName,
resourceSetType,
resources,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_readiness(
"POST",
"/resourcesets",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"resourceSetName" => resourceSetName,
"resourceSetType" => resourceSetType,
"resources" => resources,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_cell(cell_name)
delete_cell(cell_name, params::Dict{String,<:Any})
Delete a cell. When successful, the response code is 204, with no response body.
# Arguments
- `cell_name`: The name of the cell.
"""
function delete_cell(cellName; aws_config::AbstractAWSConfig=global_aws_config())
return route53_recovery_readiness(
"DELETE",
"/cells/$(cellName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_cell(
cellName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_readiness(
"DELETE",
"/cells/$(cellName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_cross_account_authorization(cross_account_authorization)
delete_cross_account_authorization(cross_account_authorization, params::Dict{String,<:Any})
Deletes cross account readiness authorization.
# Arguments
- `cross_account_authorization`: The cross-account authorization.
"""
function delete_cross_account_authorization(
crossAccountAuthorization; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_readiness(
"DELETE",
"/crossaccountauthorizations/$(crossAccountAuthorization)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_cross_account_authorization(
crossAccountAuthorization,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_readiness(
"DELETE",
"/crossaccountauthorizations/$(crossAccountAuthorization)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_readiness_check(readiness_check_name)
delete_readiness_check(readiness_check_name, params::Dict{String,<:Any})
Deletes a readiness check.
# Arguments
- `readiness_check_name`: Name of a readiness check.
"""
function delete_readiness_check(
readinessCheckName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_readiness(
"DELETE",
"/readinesschecks/$(readinessCheckName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_readiness_check(
readinessCheckName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_readiness(
"DELETE",
"/readinesschecks/$(readinessCheckName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_recovery_group(recovery_group_name)
delete_recovery_group(recovery_group_name, params::Dict{String,<:Any})
Deletes a recovery group.
# Arguments
- `recovery_group_name`: The name of a recovery group.
"""
function delete_recovery_group(
recoveryGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_readiness(
"DELETE",
"/recoverygroups/$(recoveryGroupName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_recovery_group(
recoveryGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_readiness(
"DELETE",
"/recoverygroups/$(recoveryGroupName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_resource_set(resource_set_name)
delete_resource_set(resource_set_name, params::Dict{String,<:Any})
Deletes a resource set.
# Arguments
- `resource_set_name`: Name of a resource set.
"""
function delete_resource_set(
resourceSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_readiness(
"DELETE",
"/resourcesets/$(resourceSetName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_resource_set(
resourceSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_readiness(
"DELETE",
"/resourcesets/$(resourceSetName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_architecture_recommendations(recovery_group_name)
get_architecture_recommendations(recovery_group_name, params::Dict{String,<:Any})
Gets recommendations about architecture designs for improving resiliency for an
application, based on a recovery group.
# Arguments
- `recovery_group_name`: The name of a recovery group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The number of objects that you want to return with this call.
- `"nextToken"`: The token that identifies which batch of results you want to see.
"""
function get_architecture_recommendations(
recoveryGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_readiness(
"GET",
"/recoverygroups/$(recoveryGroupName)/architectureRecommendations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_architecture_recommendations(
recoveryGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_readiness(
"GET",
"/recoverygroups/$(recoveryGroupName)/architectureRecommendations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_cell(cell_name)
get_cell(cell_name, params::Dict{String,<:Any})
Gets information about a cell including cell name, cell Amazon Resource Name (ARN), ARNs of
nested cells for this cell, and a list of those cell ARNs with their associated recovery
group ARNs.
# Arguments
- `cell_name`: The name of the cell.
"""
function get_cell(cellName; aws_config::AbstractAWSConfig=global_aws_config())
return route53_recovery_readiness(
"GET", "/cells/$(cellName)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_cell(
cellName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_readiness(
"GET",
"/cells/$(cellName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_cell_readiness_summary(cell_name)
get_cell_readiness_summary(cell_name, params::Dict{String,<:Any})
Gets readiness for a cell. Aggregates the readiness of all the resources that are
associated with the cell into a single value.
# Arguments
- `cell_name`: The name of the cell.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The number of objects that you want to return with this call.
- `"nextToken"`: The token that identifies which batch of results you want to see.
"""
function get_cell_readiness_summary(
cellName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_readiness(
"GET",
"/cellreadiness/$(cellName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_cell_readiness_summary(
cellName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_readiness(
"GET",
"/cellreadiness/$(cellName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_readiness_check(readiness_check_name)
get_readiness_check(readiness_check_name, params::Dict{String,<:Any})
Gets details about a readiness check.
# Arguments
- `readiness_check_name`: Name of a readiness check.
"""
function get_readiness_check(
readinessCheckName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_readiness(
"GET",
"/readinesschecks/$(readinessCheckName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_readiness_check(
readinessCheckName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_readiness(
"GET",
"/readinesschecks/$(readinessCheckName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_readiness_check_resource_status(readiness_check_name, resource_identifier)
get_readiness_check_resource_status(readiness_check_name, resource_identifier, params::Dict{String,<:Any})
Gets individual readiness status for a readiness check. To see the overall readiness status
for a recovery group, that considers the readiness status for all the readiness checks in
the recovery group, use GetRecoveryGroupReadinessSummary.
# Arguments
- `readiness_check_name`: Name of a readiness check.
- `resource_identifier`: The resource identifier, which is the Amazon Resource Name (ARN)
or the identifier generated for the resource by Application Recovery Controller (for
example, for a DNS target resource).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The number of objects that you want to return with this call.
- `"nextToken"`: The token that identifies which batch of results you want to see.
"""
function get_readiness_check_resource_status(
readinessCheckName,
resourceIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_readiness(
"GET",
"/readinesschecks/$(readinessCheckName)/resource/$(resourceIdentifier)/status";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_readiness_check_resource_status(
readinessCheckName,
resourceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_readiness(
"GET",
"/readinesschecks/$(readinessCheckName)/resource/$(resourceIdentifier)/status",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_readiness_check_status(readiness_check_name)
get_readiness_check_status(readiness_check_name, params::Dict{String,<:Any})
Gets the readiness status for an individual readiness check. To see the overall readiness
status for a recovery group, that considers the readiness status for all the readiness
checks in a recovery group, use GetRecoveryGroupReadinessSummary.
# Arguments
- `readiness_check_name`: Name of a readiness check.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The number of objects that you want to return with this call.
- `"nextToken"`: The token that identifies which batch of results you want to see.
"""
function get_readiness_check_status(
readinessCheckName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_readiness(
"GET",
"/readinesschecks/$(readinessCheckName)/status";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_readiness_check_status(
readinessCheckName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_readiness(
"GET",
"/readinesschecks/$(readinessCheckName)/status",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_recovery_group(recovery_group_name)
get_recovery_group(recovery_group_name, params::Dict{String,<:Any})
Gets details about a recovery group, including a list of the cells that are included in it.
# Arguments
- `recovery_group_name`: The name of a recovery group.
"""
function get_recovery_group(
recoveryGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_readiness(
"GET",
"/recoverygroups/$(recoveryGroupName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_recovery_group(
recoveryGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_readiness(
"GET",
"/recoverygroups/$(recoveryGroupName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_recovery_group_readiness_summary(recovery_group_name)
get_recovery_group_readiness_summary(recovery_group_name, params::Dict{String,<:Any})
Displays a summary of information about a recovery group's readiness status. Includes the
readiness checks for resources in the recovery group and the readiness status of each one.
# Arguments
- `recovery_group_name`: The name of a recovery group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The number of objects that you want to return with this call.
- `"nextToken"`: The token that identifies which batch of results you want to see.
"""
function get_recovery_group_readiness_summary(
recoveryGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_readiness(
"GET",
"/recoverygroupreadiness/$(recoveryGroupName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_recovery_group_readiness_summary(
recoveryGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_readiness(
"GET",
"/recoverygroupreadiness/$(recoveryGroupName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resource_set(resource_set_name)
get_resource_set(resource_set_name, params::Dict{String,<:Any})
Displays the details about a resource set, including a list of the resources in the set.
# Arguments
- `resource_set_name`: Name of a resource set.
"""
function get_resource_set(
resourceSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_readiness(
"GET",
"/resourcesets/$(resourceSetName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resource_set(
resourceSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_readiness(
"GET",
"/resourcesets/$(resourceSetName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_cells()
list_cells(params::Dict{String,<:Any})
Lists the cells for an account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The number of objects that you want to return with this call.
- `"nextToken"`: The token that identifies which batch of results you want to see.
"""
function list_cells(; aws_config::AbstractAWSConfig=global_aws_config())
return route53_recovery_readiness(
"GET", "/cells"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_cells(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_readiness(
"GET", "/cells", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_cross_account_authorizations()
list_cross_account_authorizations(params::Dict{String,<:Any})
Lists the cross-account readiness authorizations that are in place for an account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The number of objects that you want to return with this call.
- `"nextToken"`: The token that identifies which batch of results you want to see.
"""
function list_cross_account_authorizations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_readiness(
"GET",
"/crossaccountauthorizations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_cross_account_authorizations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_readiness(
"GET",
"/crossaccountauthorizations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_readiness_checks()
list_readiness_checks(params::Dict{String,<:Any})
Lists the readiness checks for an account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The number of objects that you want to return with this call.
- `"nextToken"`: The token that identifies which batch of results you want to see.
"""
function list_readiness_checks(; aws_config::AbstractAWSConfig=global_aws_config())
return route53_recovery_readiness(
"GET", "/readinesschecks"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_readiness_checks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_readiness(
"GET",
"/readinesschecks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_recovery_groups()
list_recovery_groups(params::Dict{String,<:Any})
Lists the recovery groups in an account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The number of objects that you want to return with this call.
- `"nextToken"`: The token that identifies which batch of results you want to see.
"""
function list_recovery_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return route53_recovery_readiness(
"GET", "/recoverygroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_recovery_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_readiness(
"GET",
"/recoverygroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_resource_sets()
list_resource_sets(params::Dict{String,<:Any})
Lists the resource sets in an account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The number of objects that you want to return with this call.
- `"nextToken"`: The token that identifies which batch of results you want to see.
"""
function list_resource_sets(; aws_config::AbstractAWSConfig=global_aws_config())
return route53_recovery_readiness(
"GET", "/resourcesets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_resource_sets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_readiness(
"GET",
"/resourcesets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_rules()
list_rules(params::Dict{String,<:Any})
Lists all readiness rules, or lists the readiness rules for a specific resource type.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The number of objects that you want to return with this call.
- `"nextToken"`: The token that identifies which batch of results you want to see.
- `"resourceType"`: The resource type that a readiness rule applies to.
"""
function list_rules(; aws_config::AbstractAWSConfig=global_aws_config())
return route53_recovery_readiness(
"GET", "/rules"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_rules(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_readiness(
"GET", "/rules", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tags_for_resources(resource-arn)
list_tags_for_resources(resource-arn, params::Dict{String,<:Any})
Lists the tags for a resource.
# Arguments
- `resource-arn`: The Amazon Resource Name (ARN) for a resource.
"""
function list_tags_for_resources(
resource_arn; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_readiness(
"GET",
"/tags/$(resource-arn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resources(
resource_arn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_readiness(
"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 a tag to a resource.
# Arguments
- `resource-arn`: The Amazon Resource Name (ARN) for a resource.
- `tags`:
"""
function tag_resource(resource_arn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return route53_recovery_readiness(
"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 route53_recovery_readiness(
"POST",
"/tags/$(resource-arn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tags" => tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource-arn, tag_keys)
untag_resource(resource-arn, tag_keys, params::Dict{String,<:Any})
Removes a tag from a resource.
# Arguments
- `resource-arn`: The Amazon Resource Name (ARN) for a resource.
- `tag_keys`: The keys for tags you add to resources.
"""
function untag_resource(
resource_arn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_readiness(
"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 route53_recovery_readiness(
"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_cell(cell_name, cells)
update_cell(cell_name, cells, params::Dict{String,<:Any})
Updates a cell to replace the list of nested cells with a new list of nested cells.
# Arguments
- `cell_name`: The name of the cell.
- `cells`: A list of cell Amazon Resource Names (ARNs), which completely replaces the
previous list.
"""
function update_cell(cellName, cells; aws_config::AbstractAWSConfig=global_aws_config())
return route53_recovery_readiness(
"PUT",
"/cells/$(cellName)",
Dict{String,Any}("cells" => cells);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_cell(
cellName,
cells,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_readiness(
"PUT",
"/cells/$(cellName)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("cells" => cells), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_readiness_check(readiness_check_name, resource_set_name)
update_readiness_check(readiness_check_name, resource_set_name, params::Dict{String,<:Any})
Updates a readiness check.
# Arguments
- `readiness_check_name`: Name of a readiness check.
- `resource_set_name`: The name of the resource set to be checked.
"""
function update_readiness_check(
readinessCheckName, resourceSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_readiness(
"PUT",
"/readinesschecks/$(readinessCheckName)",
Dict{String,Any}("resourceSetName" => resourceSetName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_readiness_check(
readinessCheckName,
resourceSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_readiness(
"PUT",
"/readinesschecks/$(readinessCheckName)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("resourceSetName" => resourceSetName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_recovery_group(cells, recovery_group_name)
update_recovery_group(cells, recovery_group_name, params::Dict{String,<:Any})
Updates a recovery group.
# Arguments
- `cells`: A list of cell Amazon Resource Names (ARNs). This list completely replaces the
previous list.
- `recovery_group_name`: The name of a recovery group.
"""
function update_recovery_group(
cells, recoveryGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53_recovery_readiness(
"PUT",
"/recoverygroups/$(recoveryGroupName)",
Dict{String,Any}("cells" => cells);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_recovery_group(
cells,
recoveryGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_readiness(
"PUT",
"/recoverygroups/$(recoveryGroupName)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("cells" => cells), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_resource_set(resource_set_name, resource_set_type, resources)
update_resource_set(resource_set_name, resource_set_type, resources, params::Dict{String,<:Any})
Updates a resource set.
# Arguments
- `resource_set_name`: Name of a resource set.
- `resource_set_type`: The resource type of the resources in the resource set. Enter one of
the following values for resource type: AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage,
AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway,
AWS::DynamoDB::Table, AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer,
AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function, AWS::MSK::Cluster,
AWS::RDS::DBCluster, AWS::Route53::HealthCheck, AWS::SQS::Queue, AWS::SNS::Topic,
AWS::SNS::Subscription, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway,
AWS::Route53RecoveryReadiness::DNSTargetResource
- `resources`: A list of resource objects.
"""
function update_resource_set(
resourceSetName,
resourceSetType,
resources;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_readiness(
"PUT",
"/resourcesets/$(resourceSetName)",
Dict{String,Any}("resourceSetType" => resourceSetType, "resources" => resources);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_resource_set(
resourceSetName,
resourceSetType,
resources,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53_recovery_readiness(
"PUT",
"/resourcesets/$(resourceSetName)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"resourceSetType" => resourceSetType, "resources" => resources
),
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 | 20492 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: route53profiles
using AWS.Compat
using AWS.UUIDs
"""
associate_profile(name, profile_id, resource_id)
associate_profile(name, profile_id, resource_id, params::Dict{String,<:Any})
Associates a Route 53 Profiles profile with a VPC. A VPC can have only one Profile
associated with it, but a Profile can be associated with 1000 of VPCs (and you can request
a higher quota). For more information, see
https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html#limits-api-ent
ities.
# Arguments
- `name`: A name for the association.
- `profile_id`: ID of the Profile.
- `resource_id`: The ID of the VPC.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: A list of the tag keys and values that you want to identify the Profile
association.
"""
function associate_profile(
Name, ProfileId, ResourceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53profiles(
"POST",
"/profileassociation",
Dict{String,Any}(
"Name" => Name, "ProfileId" => ProfileId, "ResourceId" => ResourceId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_profile(
Name,
ProfileId,
ResourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53profiles(
"POST",
"/profileassociation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Name" => Name, "ProfileId" => ProfileId, "ResourceId" => ResourceId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_resource_to_profile(name, profile_id, resource_arn)
associate_resource_to_profile(name, profile_id, resource_arn, params::Dict{String,<:Any})
Associates a DNS reource configuration to a Route 53 Profile.
# Arguments
- `name`: Name for the resource association.
- `profile_id`: ID of the Profile.
- `resource_arn`: Amazon resource number, ARN, of the DNS resource.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ResourceProperties"`: If you are adding a DNS Firewall rule group, include also a
priority. The priority indicates the processing order for the rule groups, starting with
the priority assinged the lowest value. The allowed values for priority are between 100
and 9900.
"""
function associate_resource_to_profile(
Name, ProfileId, ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53profiles(
"POST",
"/profileresourceassociation",
Dict{String,Any}(
"Name" => Name, "ProfileId" => ProfileId, "ResourceArn" => ResourceArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_resource_to_profile(
Name,
ProfileId,
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53profiles(
"POST",
"/profileresourceassociation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Name" => Name, "ProfileId" => ProfileId, "ResourceArn" => ResourceArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_profile(client_token, name)
create_profile(client_token, name, params::Dict{String,<:Any})
Creates an empty Route 53 Profile.
# Arguments
- `client_token`: ClientToken is an idempotency token that ensures a call to CreateProfile
completes only once. You choose the value to pass. For example, an issue might prevent you
from getting a response from CreateProfile. In this case, safely retry your call to
CreateProfile by using the same CreateProfile parameter value.
- `name`: A name for the Profile.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: A list of the tag keys and values that you want to associate with the Route 53
Profile.
"""
function create_profile(
ClientToken, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53profiles(
"POST",
"/profile",
Dict{String,Any}("ClientToken" => ClientToken, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_profile(
ClientToken,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53profiles(
"POST",
"/profile",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ClientToken" => ClientToken, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_profile(profile_id)
delete_profile(profile_id, params::Dict{String,<:Any})
Deletes the specified Route 53 Profile. Before you can delete a profile, you must first
disassociate it from all VPCs.
# Arguments
- `profile_id`: The ID of the Profile that you want to delete.
"""
function delete_profile(ProfileId; aws_config::AbstractAWSConfig=global_aws_config())
return route53profiles(
"DELETE",
"/profile/$(ProfileId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_profile(
ProfileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53profiles(
"DELETE",
"/profile/$(ProfileId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_profile(profile_id, resource_id)
disassociate_profile(profile_id, resource_id, params::Dict{String,<:Any})
Dissociates a specified Route 53 Profile from the specified VPC.
# Arguments
- `profile_id`: ID of the Profile.
- `resource_id`: The ID of the VPC.
"""
function disassociate_profile(
ProfileId, ResourceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53profiles(
"DELETE",
"/profileassociation/Profileid/$(ProfileId)/resourceid/$(ResourceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_profile(
ProfileId,
ResourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53profiles(
"DELETE",
"/profileassociation/Profileid/$(ProfileId)/resourceid/$(ResourceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_resource_from_profile(profile_id, resource_arn)
disassociate_resource_from_profile(profile_id, resource_arn, params::Dict{String,<:Any})
Dissoaciated a specified resource, from the Route 53 Profile.
# Arguments
- `profile_id`: The ID of the Profile.
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
"""
function disassociate_resource_from_profile(
ProfileId, ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53profiles(
"DELETE",
"/profileresourceassociation/profileid/$(ProfileId)/resourcearn/$(ResourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_resource_from_profile(
ProfileId,
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53profiles(
"DELETE",
"/profileresourceassociation/profileid/$(ProfileId)/resourcearn/$(ResourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_profile(profile_id)
get_profile(profile_id, params::Dict{String,<:Any})
Returns information about a specified Route 53 Profile, such as whether whether the
Profile is shared, and the current status of the Profile.
# Arguments
- `profile_id`: ID of the Profile.
"""
function get_profile(ProfileId; aws_config::AbstractAWSConfig=global_aws_config())
return route53profiles(
"GET",
"/profile/$(ProfileId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_profile(
ProfileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53profiles(
"GET",
"/profile/$(ProfileId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_profile_association(profile_association_id)
get_profile_association(profile_association_id, params::Dict{String,<:Any})
Retrieves a Route 53 Profile association for a VPC. A VPC can have only one Profile
association, but a Profile can be associated with up to 5000 VPCs.
# Arguments
- `profile_association_id`: The identifier of the association you want to get information
about.
"""
function get_profile_association(
ProfileAssociationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53profiles(
"GET",
"/profileassociation/$(ProfileAssociationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_profile_association(
ProfileAssociationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53profiles(
"GET",
"/profileassociation/$(ProfileAssociationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_profile_resource_association(profile_resource_association_id)
get_profile_resource_association(profile_resource_association_id, params::Dict{String,<:Any})
Returns information about a specified Route 53 Profile resource association.
# Arguments
- `profile_resource_association_id`: The ID of the profile resource association that you
want to get information about.
"""
function get_profile_resource_association(
ProfileResourceAssociationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53profiles(
"GET",
"/profileresourceassociation/$(ProfileResourceAssociationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_profile_resource_association(
ProfileResourceAssociationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53profiles(
"GET",
"/profileresourceassociation/$(ProfileResourceAssociationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_profile_associations()
list_profile_associations(params::Dict{String,<:Any})
Lists all the VPCs that the specified Route 53 Profile is associated with.
# 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 to return for this request.
If more objects are available, in the response, a NextToken value, which you can use in a
subsequent call to get the next batch of objects, is provided. If you don't specify a
value for MaxResults, up to 100 objects are returned.
- `"nextToken"`: For the first call to this list request, omit this value. When you
request a list of objects, at most the number of objects specified by MaxResults is
returned. If more objects are available for retrieval, a NextToken value is returned in the
response. To retrieve the next batch of objects, use the token that was returned for the
prior request in your next request.
- `"profileId"`: ID of the Profile.
- `"resourceId"`: ID of the VPC.
"""
function list_profile_associations(; aws_config::AbstractAWSConfig=global_aws_config())
return route53profiles(
"GET",
"/profileassociations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_profile_associations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53profiles(
"GET",
"/profileassociations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_profile_resource_associations(profile_id)
list_profile_resource_associations(profile_id, params::Dict{String,<:Any})
Lists all the resource associations for the specified Route 53 Profile.
# Arguments
- `profile_id`: The ID of the Profile.
# 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 to return for this request.
If more objects are available, in the response, a NextToken value, which you can use in a
subsequent call to get the next batch of objects, is provided. If you don't specify a
value for MaxResults, up to 100 objects are returned.
- `"nextToken"`: For the first call to this list request, omit this value. When you
request a list of objects, at most the number of objects specified by MaxResults is
returned. If more objects are available for retrieval, a NextToken value is returned in the
response. To retrieve the next batch of objects, use the token that was returned for the
prior request in your next request.
- `"resourceType"`: ID of a resource if you want information on only one type.
"""
function list_profile_resource_associations(
ProfileId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53profiles(
"GET",
"/profileresourceassociations/profileid/$(ProfileId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_profile_resource_associations(
ProfileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53profiles(
"GET",
"/profileresourceassociations/profileid/$(ProfileId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_profiles()
list_profiles(params::Dict{String,<:Any})
Lists all the Route 53 Profiles associated with your Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of objects that you want to return for this request.
If more objects are available, in the response, a NextToken value, which you can use in a
subsequent call to get the next batch of objects, is provided. If you don't specify a
value for MaxResults, up to 100 objects are returned.
- `"nextToken"`: For the first call to this list request, omit this value. When you
request a list of objects, at most the number of objects specified by MaxResults is
returned. If more objects are available for retrieval, a NextToken value is returned in the
response. To retrieve the next batch of objects, use the token that was returned for the
prior request in your next request.
"""
function list_profiles(; aws_config::AbstractAWSConfig=global_aws_config())
return route53profiles(
"GET", "/profiles"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_profiles(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53profiles(
"GET", "/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 that you associated with the specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) for the resource that you want to list
the tags for.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53profiles(
"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 route53profiles(
"GET",
"/tags/$(ResourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds one or more tags to a specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) for the resource that you want to add
tags to.
- `tags`: The tags that you want to add to the specified resource.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return route53profiles(
"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 route53profiles(
"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 a specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) for the resource that you want to remove
tags from.
- `tag_keys`: The tags that you want to remove to the specified resource.
"""
function untag_resource(
ResourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53profiles(
"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 route53profiles(
"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_profile_resource_association(profile_resource_association_id)
update_profile_resource_association(profile_resource_association_id, params::Dict{String,<:Any})
Updates the specified Route 53 Profile resourse association.
# Arguments
- `profile_resource_association_id`: ID of the resource association.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Name"`: Name of the resource association.
- `"ResourceProperties"`: If you are adding a DNS Firewall rule group, include also a
priority. The priority indicates the processing order for the rule groups, starting with
the priority assinged the lowest value. The allowed values for priority are between 100
and 9900.
"""
function update_profile_resource_association(
ProfileResourceAssociationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53profiles(
"PATCH",
"/profileresourceassociation/$(ProfileResourceAssociationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_profile_resource_association(
ProfileResourceAssociationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53profiles(
"PATCH",
"/profileresourceassociation/$(ProfileResourceAssociationId)",
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 | 131399 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: route53resolver
using AWS.Compat
using AWS.UUIDs
"""
associate_firewall_rule_group(creator_request_id, firewall_rule_group_id, name, priority, vpc_id)
associate_firewall_rule_group(creator_request_id, firewall_rule_group_id, name, priority, vpc_id, params::Dict{String,<:Any})
Associates a FirewallRuleGroup with a VPC, to provide DNS filtering for the VPC.
# Arguments
- `creator_request_id`: A unique string that identifies the request and that allows failed
requests to be retried without the risk of running the operation twice. CreatorRequestId
can be any unique string, for example, a date/time stamp.
- `firewall_rule_group_id`: The unique identifier of the firewall rule group.
- `name`: A name that lets you identify the association, to manage and use it.
- `priority`: The setting that determines the processing order of the rule group among the
rule groups that you associate with the specified VPC. DNS Firewall filters VPC traffic
starting from the rule group with the lowest numeric priority setting. You must specify a
unique priority for each rule group that you associate with a single VPC. To make it easier
to insert rule groups later, leave space between the numbers, for example, use 101, 200,
and so on. You can change the priority setting for a rule group association after you
create it. The allowed values for Priority are between 100 and 9900.
- `vpc_id`: The unique identifier of the VPC that you want to associate with the rule
group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MutationProtection"`: If enabled, this setting disallows modification or removal of the
association, to help prevent against accidentally altering DNS firewall protections. When
you create the association, the default setting is DISABLED.
- `"Tags"`: A list of the tag keys and values that you want to associate with the rule
group association.
"""
function associate_firewall_rule_group(
CreatorRequestId,
FirewallRuleGroupId,
Name,
Priority,
VpcId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"AssociateFirewallRuleGroup",
Dict{String,Any}(
"CreatorRequestId" => CreatorRequestId,
"FirewallRuleGroupId" => FirewallRuleGroupId,
"Name" => Name,
"Priority" => Priority,
"VpcId" => VpcId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_firewall_rule_group(
CreatorRequestId,
FirewallRuleGroupId,
Name,
Priority,
VpcId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"AssociateFirewallRuleGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CreatorRequestId" => CreatorRequestId,
"FirewallRuleGroupId" => FirewallRuleGroupId,
"Name" => Name,
"Priority" => Priority,
"VpcId" => VpcId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_resolver_endpoint_ip_address(ip_address, resolver_endpoint_id)
associate_resolver_endpoint_ip_address(ip_address, resolver_endpoint_id, params::Dict{String,<:Any})
Adds IP addresses to an inbound or an outbound Resolver endpoint. If you want to add more
than one IP address, submit one AssociateResolverEndpointIpAddress request for each IP
address. To remove an IP address from an endpoint, see
DisassociateResolverEndpointIpAddress.
# Arguments
- `ip_address`: Either the IPv4 address that you want to add to a Resolver endpoint or a
subnet ID. If you specify a subnet ID, Resolver chooses an IP address for you from the
available IPs in the specified subnet.
- `resolver_endpoint_id`: The ID of the Resolver endpoint that you want to associate IP
addresses with.
"""
function associate_resolver_endpoint_ip_address(
IpAddress, ResolverEndpointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"AssociateResolverEndpointIpAddress",
Dict{String,Any}(
"IpAddress" => IpAddress, "ResolverEndpointId" => ResolverEndpointId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_resolver_endpoint_ip_address(
IpAddress,
ResolverEndpointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"AssociateResolverEndpointIpAddress",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IpAddress" => IpAddress, "ResolverEndpointId" => ResolverEndpointId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_resolver_query_log_config(resolver_query_log_config_id, resource_id)
associate_resolver_query_log_config(resolver_query_log_config_id, resource_id, params::Dict{String,<:Any})
Associates an Amazon VPC with a specified query logging configuration. Route 53 Resolver
logs DNS queries that originate in all of the Amazon VPCs that are associated with a
specified query logging configuration. To associate more than one VPC with a configuration,
submit one AssociateResolverQueryLogConfig request for each VPC. The VPCs that you
associate with a query logging configuration must be in the same Region as the
configuration. To remove a VPC from a query logging configuration, see
DisassociateResolverQueryLogConfig.
# Arguments
- `resolver_query_log_config_id`: The ID of the query logging configuration that you want
to associate a VPC with.
- `resource_id`: The ID of an Amazon VPC that you want this query logging configuration to
log queries for. The VPCs and the query logging configuration must be in the same Region.
"""
function associate_resolver_query_log_config(
ResolverQueryLogConfigId, ResourceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"AssociateResolverQueryLogConfig",
Dict{String,Any}(
"ResolverQueryLogConfigId" => ResolverQueryLogConfigId,
"ResourceId" => ResourceId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_resolver_query_log_config(
ResolverQueryLogConfigId,
ResourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"AssociateResolverQueryLogConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ResolverQueryLogConfigId" => ResolverQueryLogConfigId,
"ResourceId" => ResourceId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_resolver_rule(resolver_rule_id, vpcid)
associate_resolver_rule(resolver_rule_id, vpcid, params::Dict{String,<:Any})
Associates a Resolver rule with a VPC. When you associate a rule with a VPC, Resolver
forwards all DNS queries for the domain name that is specified in the rule and that
originate in the VPC. The queries are forwarded to the IP addresses for the DNS resolvers
that are specified in the rule. For more information about rules, see CreateResolverRule.
# Arguments
- `resolver_rule_id`: The ID of the Resolver rule that you want to associate with the VPC.
To list the existing Resolver rules, use ListResolverRules.
- `vpcid`: The ID of the VPC that you want to associate the Resolver rule with.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Name"`: A name for the association that you're creating between a Resolver rule and a
VPC.
"""
function associate_resolver_rule(
ResolverRuleId, VPCId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"AssociateResolverRule",
Dict{String,Any}("ResolverRuleId" => ResolverRuleId, "VPCId" => VPCId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_resolver_rule(
ResolverRuleId,
VPCId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"AssociateResolverRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResolverRuleId" => ResolverRuleId, "VPCId" => VPCId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_firewall_domain_list(creator_request_id, name)
create_firewall_domain_list(creator_request_id, name, params::Dict{String,<:Any})
Creates an empty firewall domain list for use in DNS Firewall rules. You can populate the
domains for the new list with a file, using ImportFirewallDomains, or with domain strings,
using UpdateFirewallDomains.
# Arguments
- `creator_request_id`: A unique string that identifies the request and that allows you to
retry failed requests without the risk of running the operation twice. CreatorRequestId can
be any unique string, for example, a date/time stamp.
- `name`: A name that lets you identify the domain list to manage and use it.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: A list of the tag keys and values that you want to associate with the domain
list.
"""
function create_firewall_domain_list(
CreatorRequestId, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"CreateFirewallDomainList",
Dict{String,Any}("CreatorRequestId" => CreatorRequestId, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_firewall_domain_list(
CreatorRequestId,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"CreateFirewallDomainList",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CreatorRequestId" => CreatorRequestId, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_firewall_rule(action, creator_request_id, firewall_domain_list_id, firewall_rule_group_id, name, priority)
create_firewall_rule(action, creator_request_id, firewall_domain_list_id, firewall_rule_group_id, name, priority, params::Dict{String,<:Any})
Creates a single DNS Firewall rule in the specified rule group, using the specified domain
list.
# Arguments
- `action`: The action that DNS Firewall should take on a DNS query when it matches one of
the domains in the rule's domain list: ALLOW - Permit the request to go through.
ALERT - Permit the request and send metrics and logs to Cloud Watch. BLOCK - Disallow
the request. This option requires additional details in the rule's BlockResponse.
- `creator_request_id`: A unique string that identifies the request and that allows you to
retry failed requests without the risk of running the operation twice. CreatorRequestId can
be any unique string, for example, a date/time stamp.
- `firewall_domain_list_id`: The ID of the domain list that you want to use in the rule.
- `firewall_rule_group_id`: The unique identifier of the firewall rule group where you want
to create the rule.
- `name`: A name that lets you identify the rule in the rule group.
- `priority`: The setting that determines the processing order of the rule in the rule
group. DNS Firewall processes the rules in a rule group by order of priority, starting from
the lowest setting. You must specify a unique priority for each rule in a rule group. To
make it easier to insert rules later, leave space between the numbers, for example, use
100, 200, and so on. You can change the priority setting for the rules in a rule group at
any time.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BlockOverrideDnsType"`: The DNS record's type. This determines the format of the record
value that you provided in BlockOverrideDomain. Used for the rule action BLOCK with a
BlockResponse setting of OVERRIDE. This setting is required if the BlockResponse setting is
OVERRIDE.
- `"BlockOverrideDomain"`: The custom DNS record to send back in response to the query.
Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE. This setting is
required if the BlockResponse setting is OVERRIDE.
- `"BlockOverrideTtl"`: The recommended amount of time, in seconds, for the DNS resolver or
web browser to cache the provided override record. Used for the rule action BLOCK with a
BlockResponse setting of OVERRIDE. This setting is required if the BlockResponse setting is
OVERRIDE.
- `"BlockResponse"`: The way that you want DNS Firewall to block the request, used with the
rule action setting BLOCK. NODATA - Respond indicating that the query was successful,
but no response is available for it. NXDOMAIN - Respond indicating that the domain name
that's in the query doesn't exist. OVERRIDE - Provide a custom override in the response.
This option requires custom handling details in the rule's BlockOverride* settings. This
setting is required if the rule action setting is BLOCK.
- `"FirewallDomainRedirectionAction"`: How you want the the rule to evaluate DNS
redirection in the DNS redirection chain, such as CNAME or DNAME.
Inspect_Redirection_Domain (Default) inspects all domains in the redirection chain. The
individual domains in the redirection chain must be added to the domain list.
Trust_Redirection_Domain inspects only the first domain in the redirection chain. You
don't need to add the subsequent domains in the domain in the redirection list to the
domain list.
- `"Qtype"`: The DNS query type you want the rule to evaluate. Allowed values are; A:
Returns an IPv4 address. AAAA: Returns an Ipv6 address. CAA: Restricts CAs that can
create SSL/TLS certifications for the domain. CNAME: Returns another domain name. DS:
Record that identifies the DNSSEC signing key of a delegated zone. MX: Specifies mail
servers. NAPTR: Regular-expression-based rewriting of domain names. NS: Authoritative
name servers. PTR: Maps an IP address to a domain name. SOA: Start of authority record
for the zone. SPF: Lists the servers authorized to send emails from a domain. SRV:
Application specific values that identify servers. TXT: Verifies email senders and
application-specific values. A query type you define by using the DNS type ID, for
example 28 for AAAA. The values must be defined as TYPENUMBER, where the NUMBER can be
1-65334, for example, TYPE28. For more information, see List of DNS record types.
"""
function create_firewall_rule(
Action,
CreatorRequestId,
FirewallDomainListId,
FirewallRuleGroupId,
Name,
Priority;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"CreateFirewallRule",
Dict{String,Any}(
"Action" => Action,
"CreatorRequestId" => CreatorRequestId,
"FirewallDomainListId" => FirewallDomainListId,
"FirewallRuleGroupId" => FirewallRuleGroupId,
"Name" => Name,
"Priority" => Priority,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_firewall_rule(
Action,
CreatorRequestId,
FirewallDomainListId,
FirewallRuleGroupId,
Name,
Priority,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"CreateFirewallRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Action" => Action,
"CreatorRequestId" => CreatorRequestId,
"FirewallDomainListId" => FirewallDomainListId,
"FirewallRuleGroupId" => FirewallRuleGroupId,
"Name" => Name,
"Priority" => Priority,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_firewall_rule_group(creator_request_id, name)
create_firewall_rule_group(creator_request_id, name, params::Dict{String,<:Any})
Creates an empty DNS Firewall rule group for filtering DNS network traffic in a VPC. You
can add rules to the new rule group by calling CreateFirewallRule.
# Arguments
- `creator_request_id`: A unique string defined by you to identify the request. This allows
you to retry failed requests without the risk of running the operation twice. This can be
any unique string, for example, a timestamp.
- `name`: A name that lets you identify the rule group, to manage and use it.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: A list of the tag keys and values that you want to associate with the rule
group.
"""
function create_firewall_rule_group(
CreatorRequestId, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"CreateFirewallRuleGroup",
Dict{String,Any}("CreatorRequestId" => CreatorRequestId, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_firewall_rule_group(
CreatorRequestId,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"CreateFirewallRuleGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CreatorRequestId" => CreatorRequestId, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_outpost_resolver(creator_request_id, name, outpost_arn, preferred_instance_type)
create_outpost_resolver(creator_request_id, name, outpost_arn, preferred_instance_type, params::Dict{String,<:Any})
Creates a Route 53 Resolver on an Outpost.
# Arguments
- `creator_request_id`: A unique string that identifies the request and that allows failed
requests to be retried without the risk of running the operation twice. CreatorRequestId
can be any unique string, for example, a date/time stamp.
- `name`: A friendly name that lets you easily find a configuration in the Resolver
dashboard in the Route 53 console.
- `outpost_arn`: The Amazon Resource Name (ARN) of the Outpost. If you specify this, you
must also specify a value for the PreferredInstanceType.
- `preferred_instance_type`: The Amazon EC2 instance type. If you specify this, you must
also specify a value for the OutpostArn.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InstanceCount"`: Number of Amazon EC2 instances for the Resolver on Outpost. The
default and minimal value is 4.
- `"Tags"`: A string that helps identify the Route 53 Resolvers on Outpost.
"""
function create_outpost_resolver(
CreatorRequestId,
Name,
OutpostArn,
PreferredInstanceType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"CreateOutpostResolver",
Dict{String,Any}(
"CreatorRequestId" => CreatorRequestId,
"Name" => Name,
"OutpostArn" => OutpostArn,
"PreferredInstanceType" => PreferredInstanceType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_outpost_resolver(
CreatorRequestId,
Name,
OutpostArn,
PreferredInstanceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"CreateOutpostResolver",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CreatorRequestId" => CreatorRequestId,
"Name" => Name,
"OutpostArn" => OutpostArn,
"PreferredInstanceType" => PreferredInstanceType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_resolver_endpoint(creator_request_id, direction, ip_addresses, security_group_ids)
create_resolver_endpoint(creator_request_id, direction, ip_addresses, security_group_ids, params::Dict{String,<:Any})
Creates a Resolver endpoint. There are two types of Resolver endpoints, inbound and
outbound: An inbound Resolver endpoint forwards DNS queries to the DNS service for a VPC
from your network. An outbound Resolver endpoint forwards DNS queries from the DNS
service for a VPC to your network.
# Arguments
- `creator_request_id`: A unique string that identifies the request and that allows failed
requests to be retried without the risk of running the operation twice. CreatorRequestId
can be any unique string, for example, a date/time stamp.
- `direction`: Specify the applicable value: INBOUND: Resolver forwards DNS queries to
the DNS service for a VPC from your network OUTBOUND: Resolver forwards DNS queries from
the DNS service for a VPC to your network
- `ip_addresses`: The subnets and IP addresses in your VPC that DNS queries originate from
(for outbound endpoints) or that you forward DNS queries to (for inbound endpoints). The
subnet ID uniquely identifies a VPC. Even though the minimum is 1, Route 53 requires
that you create at least two.
- `security_group_ids`: The ID of one or more security groups that you want to use to
control access to this VPC. The security group that you specify must include one or more
inbound rules (for inbound Resolver endpoints) or outbound rules (for outbound Resolver
endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access,
open port 53. For outbound access, open the port that you're using for DNS queries on your
network. Some security group rules will cause your connection to be tracked. For outbound
resolver endpoint, it can potentially impact the maximum queries per second from outbound
endpoint to your target name server. For inbound resolver endpoint, it can bring down the
overall maximum queries per second per IP address to as low as 1500. To avoid connection
tracking caused by security group, see Untracked connections.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Name"`: A friendly name that lets you easily find a configuration in the Resolver
dashboard in the Route 53 console.
- `"OutpostArn"`: The Amazon Resource Name (ARN) of the Outpost. If you specify this, you
must also specify a value for the PreferredInstanceType.
- `"PreferredInstanceType"`: The instance type. If you specify this, you must also specify
a value for the OutpostArn.
- `"Protocols"`: The protocols you want to use for the endpoint. DoH-FIPS is applicable
for inbound endpoints only. For an inbound endpoint you can apply the protocols as
follows: Do53 and DoH in combination. Do53 and DoH-FIPS in combination. Do53 alone.
DoH alone. DoH-FIPS alone. None, which is treated as Do53. For an outbound endpoint
you can apply the protocols as follows: Do53 and DoH in combination. Do53 alone. DoH
alone. None, which is treated as Do53.
- `"ResolverEndpointType"`: For the endpoint type you can choose either IPv4, IPv6, or
dual-stack. A dual-stack endpoint means that it will resolve via both IPv4 and IPv6. This
endpoint type is applied to all IP addresses.
- `"Tags"`: A list of the tag keys and values that you want to associate with the endpoint.
"""
function create_resolver_endpoint(
CreatorRequestId,
Direction,
IpAddresses,
SecurityGroupIds;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"CreateResolverEndpoint",
Dict{String,Any}(
"CreatorRequestId" => CreatorRequestId,
"Direction" => Direction,
"IpAddresses" => IpAddresses,
"SecurityGroupIds" => SecurityGroupIds,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_resolver_endpoint(
CreatorRequestId,
Direction,
IpAddresses,
SecurityGroupIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"CreateResolverEndpoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CreatorRequestId" => CreatorRequestId,
"Direction" => Direction,
"IpAddresses" => IpAddresses,
"SecurityGroupIds" => SecurityGroupIds,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_resolver_query_log_config(creator_request_id, destination_arn, name)
create_resolver_query_log_config(creator_request_id, destination_arn, name, params::Dict{String,<:Any})
Creates a Resolver query logging configuration, which defines where you want Resolver to
save DNS query logs that originate in your VPCs. Resolver can log queries only for VPCs
that are in the same Region as the query logging configuration. To specify which VPCs you
want to log queries for, you use AssociateResolverQueryLogConfig. For more information, see
AssociateResolverQueryLogConfig. You can optionally use Resource Access Manager (RAM) to
share a query logging configuration with other Amazon Web Services accounts. The other
accounts can then associate VPCs with the configuration. The query logs that Resolver
creates for a configuration include all DNS queries that originate in all VPCs that are
associated with the configuration.
# Arguments
- `creator_request_id`: A unique string that identifies the request and that allows failed
requests to be retried without the risk of running the operation twice. CreatorRequestId
can be any unique string, for example, a date/time stamp.
- `destination_arn`: The ARN of the resource that you want Resolver to send query logs. You
can send query logs to an S3 bucket, a CloudWatch Logs log group, or a Kinesis Data
Firehose delivery stream. Examples of valid values include the following: S3 bucket:
arn:aws:s3:::examplebucket You can optionally append a file prefix to the end of the ARN.
arn:aws:s3:::examplebucket/development/ CloudWatch Logs log group:
arn:aws:logs:us-west-1:123456789012:log-group:/mystack-testgroup-12ABC1AB12A1:* Kinesis
Data Firehose delivery stream: arn:aws:kinesis:us-east-2:0123456789:stream/my_stream_name
- `name`: The name that you want to give the query logging configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: A list of the tag keys and values that you want to associate with the query
logging configuration.
"""
function create_resolver_query_log_config(
CreatorRequestId,
DestinationArn,
Name;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"CreateResolverQueryLogConfig",
Dict{String,Any}(
"CreatorRequestId" => CreatorRequestId,
"DestinationArn" => DestinationArn,
"Name" => Name,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_resolver_query_log_config(
CreatorRequestId,
DestinationArn,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"CreateResolverQueryLogConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CreatorRequestId" => CreatorRequestId,
"DestinationArn" => DestinationArn,
"Name" => Name,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_resolver_rule(creator_request_id, rule_type)
create_resolver_rule(creator_request_id, rule_type, params::Dict{String,<:Any})
For DNS queries that originate in your VPCs, specifies which Resolver endpoint the queries
pass through, one domain name that you want to forward to your network, and the IP
addresses of the DNS resolvers in your network.
# Arguments
- `creator_request_id`: A unique string that identifies the request and that allows failed
requests to be retried without the risk of running the operation twice. CreatorRequestId
can be any unique string, for example, a date/time stamp.
- `rule_type`: When you want to forward DNS queries for specified domain name to resolvers
on your network, specify FORWARD. When you have a forwarding rule to forward DNS queries
for a domain to your network and you want Resolver to process queries for a subdomain of
that domain, specify SYSTEM. For example, to forward DNS queries for example.com to
resolvers on your network, you create a rule and specify FORWARD for RuleType. To then have
Resolver process queries for apex.example.com, you create a rule and specify SYSTEM for
RuleType. Currently, only Resolver can create rules that have a value of RECURSIVE for
RuleType.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DomainName"`: DNS queries for this domain name are forwarded to the IP addresses that
you specify in TargetIps. If a query matches multiple Resolver rules (example.com and
www.example.com), outbound DNS queries are routed using the Resolver rule that contains the
most specific domain name (www.example.com).
- `"Name"`: A friendly name that lets you easily find a rule in the Resolver dashboard in
the Route 53 console.
- `"ResolverEndpointId"`: The ID of the outbound Resolver endpoint that you want to use to
route DNS queries to the IP addresses that you specify in TargetIps.
- `"Tags"`: A list of the tag keys and values that you want to associate with the endpoint.
- `"TargetIps"`: The IPs that you want Resolver to forward DNS queries to. You can specify
either Ipv4 or Ipv6 addresses but not both in the same rule. Separate IP addresses with a
space. TargetIps is available only when the value of Rule type is FORWARD.
"""
function create_resolver_rule(
CreatorRequestId, RuleType; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"CreateResolverRule",
Dict{String,Any}("CreatorRequestId" => CreatorRequestId, "RuleType" => RuleType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_resolver_rule(
CreatorRequestId,
RuleType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"CreateResolverRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CreatorRequestId" => CreatorRequestId, "RuleType" => RuleType
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_firewall_domain_list(firewall_domain_list_id)
delete_firewall_domain_list(firewall_domain_list_id, params::Dict{String,<:Any})
Deletes the specified domain list.
# Arguments
- `firewall_domain_list_id`: The ID of the domain list that you want to delete.
"""
function delete_firewall_domain_list(
FirewallDomainListId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"DeleteFirewallDomainList",
Dict{String,Any}("FirewallDomainListId" => FirewallDomainListId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_firewall_domain_list(
FirewallDomainListId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"DeleteFirewallDomainList",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("FirewallDomainListId" => FirewallDomainListId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_firewall_rule(firewall_domain_list_id, firewall_rule_group_id)
delete_firewall_rule(firewall_domain_list_id, firewall_rule_group_id, params::Dict{String,<:Any})
Deletes the specified firewall rule.
# Arguments
- `firewall_domain_list_id`: The ID of the domain list that's used in the rule.
- `firewall_rule_group_id`: The unique identifier of the firewall rule group that you want
to delete the rule from.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Qtype"`: The DNS query type that the rule you are deleting evaluates. Allowed values
are; A: Returns an IPv4 address. AAAA: Returns an Ipv6 address. CAA: Restricts CAs
that can create SSL/TLS certifications for the domain. CNAME: Returns another domain
name. DS: Record that identifies the DNSSEC signing key of a delegated zone. MX:
Specifies mail servers. NAPTR: Regular-expression-based rewriting of domain names. NS:
Authoritative name servers. PTR: Maps an IP address to a domain name. SOA: Start of
authority record for the zone. SPF: Lists the servers authorized to send emails from a
domain. SRV: Application specific values that identify servers. TXT: Verifies email
senders and application-specific values. A query type you define by using the DNS type
ID, for example 28 for AAAA. The values must be defined as TYPENUMBER, where the NUMBER can
be 1-65334, for example, TYPE28. For more information, see List of DNS record types.
"""
function delete_firewall_rule(
FirewallDomainListId,
FirewallRuleGroupId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"DeleteFirewallRule",
Dict{String,Any}(
"FirewallDomainListId" => FirewallDomainListId,
"FirewallRuleGroupId" => FirewallRuleGroupId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_firewall_rule(
FirewallDomainListId,
FirewallRuleGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"DeleteFirewallRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FirewallDomainListId" => FirewallDomainListId,
"FirewallRuleGroupId" => FirewallRuleGroupId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_firewall_rule_group(firewall_rule_group_id)
delete_firewall_rule_group(firewall_rule_group_id, params::Dict{String,<:Any})
Deletes the specified firewall rule group.
# Arguments
- `firewall_rule_group_id`: The unique identifier of the firewall rule group that you want
to delete.
"""
function delete_firewall_rule_group(
FirewallRuleGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"DeleteFirewallRuleGroup",
Dict{String,Any}("FirewallRuleGroupId" => FirewallRuleGroupId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_firewall_rule_group(
FirewallRuleGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"DeleteFirewallRuleGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("FirewallRuleGroupId" => FirewallRuleGroupId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_outpost_resolver(id)
delete_outpost_resolver(id, params::Dict{String,<:Any})
Deletes a Resolver on the Outpost.
# Arguments
- `id`: A unique string that identifies the Resolver on the Outpost.
"""
function delete_outpost_resolver(Id; aws_config::AbstractAWSConfig=global_aws_config())
return route53resolver(
"DeleteOutpostResolver",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_outpost_resolver(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"DeleteOutpostResolver",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_resolver_endpoint(resolver_endpoint_id)
delete_resolver_endpoint(resolver_endpoint_id, params::Dict{String,<:Any})
Deletes a Resolver endpoint. The effect of deleting a Resolver endpoint depends on whether
it's an inbound or an outbound Resolver endpoint: Inbound: DNS queries from your network
are no longer routed to the DNS service for the specified VPC. Outbound: DNS queries
from a VPC are no longer routed to your network.
# Arguments
- `resolver_endpoint_id`: The ID of the Resolver endpoint that you want to delete.
"""
function delete_resolver_endpoint(
ResolverEndpointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"DeleteResolverEndpoint",
Dict{String,Any}("ResolverEndpointId" => ResolverEndpointId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_resolver_endpoint(
ResolverEndpointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"DeleteResolverEndpoint",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ResolverEndpointId" => ResolverEndpointId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_resolver_query_log_config(resolver_query_log_config_id)
delete_resolver_query_log_config(resolver_query_log_config_id, params::Dict{String,<:Any})
Deletes a query logging configuration. When you delete a configuration, Resolver stops
logging DNS queries for all of the Amazon VPCs that are associated with the configuration.
This also applies if the query logging configuration is shared with other Amazon Web
Services accounts, and the other accounts have associated VPCs with the shared
configuration. Before you can delete a query logging configuration, you must first
disassociate all VPCs from the configuration. See DisassociateResolverQueryLogConfig. If
you used Resource Access Manager (RAM) to share a query logging configuration with other
accounts, you must stop sharing the configuration before you can delete a configuration.
The accounts that you shared the configuration with can first disassociate VPCs that they
associated with the configuration, but that's not necessary. If you stop sharing the
configuration, those VPCs are automatically disassociated from the configuration.
# Arguments
- `resolver_query_log_config_id`: The ID of the query logging configuration that you want
to delete.
"""
function delete_resolver_query_log_config(
ResolverQueryLogConfigId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"DeleteResolverQueryLogConfig",
Dict{String,Any}("ResolverQueryLogConfigId" => ResolverQueryLogConfigId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_resolver_query_log_config(
ResolverQueryLogConfigId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"DeleteResolverQueryLogConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResolverQueryLogConfigId" => ResolverQueryLogConfigId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_resolver_rule(resolver_rule_id)
delete_resolver_rule(resolver_rule_id, params::Dict{String,<:Any})
Deletes a Resolver rule. Before you can delete a Resolver rule, you must disassociate it
from all the VPCs that you associated the Resolver rule with. For more information, see
DisassociateResolverRule.
# Arguments
- `resolver_rule_id`: The ID of the Resolver rule that you want to delete.
"""
function delete_resolver_rule(
ResolverRuleId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"DeleteResolverRule",
Dict{String,Any}("ResolverRuleId" => ResolverRuleId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_resolver_rule(
ResolverRuleId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"DeleteResolverRule",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResolverRuleId" => ResolverRuleId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_firewall_rule_group(firewall_rule_group_association_id)
disassociate_firewall_rule_group(firewall_rule_group_association_id, params::Dict{String,<:Any})
Disassociates a FirewallRuleGroup from a VPC, to remove DNS filtering from the VPC.
# Arguments
- `firewall_rule_group_association_id`: The identifier of the FirewallRuleGroupAssociation.
"""
function disassociate_firewall_rule_group(
FirewallRuleGroupAssociationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"DisassociateFirewallRuleGroup",
Dict{String,Any}(
"FirewallRuleGroupAssociationId" => FirewallRuleGroupAssociationId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_firewall_rule_group(
FirewallRuleGroupAssociationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"DisassociateFirewallRuleGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FirewallRuleGroupAssociationId" => FirewallRuleGroupAssociationId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_resolver_endpoint_ip_address(ip_address, resolver_endpoint_id)
disassociate_resolver_endpoint_ip_address(ip_address, resolver_endpoint_id, params::Dict{String,<:Any})
Removes IP addresses from an inbound or an outbound Resolver endpoint. If you want to
remove more than one IP address, submit one DisassociateResolverEndpointIpAddress request
for each IP address. To add an IP address to an endpoint, see
AssociateResolverEndpointIpAddress.
# Arguments
- `ip_address`: The IPv4 address that you want to remove from a Resolver endpoint.
- `resolver_endpoint_id`: The ID of the Resolver endpoint that you want to disassociate an
IP address from.
"""
function disassociate_resolver_endpoint_ip_address(
IpAddress, ResolverEndpointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"DisassociateResolverEndpointIpAddress",
Dict{String,Any}(
"IpAddress" => IpAddress, "ResolverEndpointId" => ResolverEndpointId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_resolver_endpoint_ip_address(
IpAddress,
ResolverEndpointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"DisassociateResolverEndpointIpAddress",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IpAddress" => IpAddress, "ResolverEndpointId" => ResolverEndpointId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_resolver_query_log_config(resolver_query_log_config_id, resource_id)
disassociate_resolver_query_log_config(resolver_query_log_config_id, resource_id, params::Dict{String,<:Any})
Disassociates a VPC from a query logging configuration. Before you can delete a query
logging configuration, you must first disassociate all VPCs from the configuration. If you
used Resource Access Manager (RAM) to share a query logging configuration with other
accounts, VPCs can be disassociated from the configuration in the following ways: The
accounts that you shared the configuration with can disassociate VPCs from the
configuration. You can stop sharing the configuration.
# Arguments
- `resolver_query_log_config_id`: The ID of the query logging configuration that you want
to disassociate a specified VPC from.
- `resource_id`: The ID of the Amazon VPC that you want to disassociate from a specified
query logging configuration.
"""
function disassociate_resolver_query_log_config(
ResolverQueryLogConfigId, ResourceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"DisassociateResolverQueryLogConfig",
Dict{String,Any}(
"ResolverQueryLogConfigId" => ResolverQueryLogConfigId,
"ResourceId" => ResourceId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_resolver_query_log_config(
ResolverQueryLogConfigId,
ResourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"DisassociateResolverQueryLogConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ResolverQueryLogConfigId" => ResolverQueryLogConfigId,
"ResourceId" => ResourceId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_resolver_rule(resolver_rule_id, vpcid)
disassociate_resolver_rule(resolver_rule_id, vpcid, params::Dict{String,<:Any})
Removes the association between a specified Resolver rule and a specified VPC. If you
disassociate a Resolver rule from a VPC, Resolver stops forwarding DNS queries for the
domain name that you specified in the Resolver rule.
# Arguments
- `resolver_rule_id`: The ID of the Resolver rule that you want to disassociate from the
specified VPC.
- `vpcid`: The ID of the VPC that you want to disassociate the Resolver rule from.
"""
function disassociate_resolver_rule(
ResolverRuleId, VPCId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"DisassociateResolverRule",
Dict{String,Any}("ResolverRuleId" => ResolverRuleId, "VPCId" => VPCId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_resolver_rule(
ResolverRuleId,
VPCId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"DisassociateResolverRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResolverRuleId" => ResolverRuleId, "VPCId" => VPCId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_firewall_config(resource_id)
get_firewall_config(resource_id, params::Dict{String,<:Any})
Retrieves the configuration of the firewall behavior provided by DNS Firewall for a single
VPC from Amazon Virtual Private Cloud (Amazon VPC).
# Arguments
- `resource_id`: The ID of the VPC from Amazon VPC that the configuration is for.
"""
function get_firewall_config(ResourceId; aws_config::AbstractAWSConfig=global_aws_config())
return route53resolver(
"GetFirewallConfig",
Dict{String,Any}("ResourceId" => ResourceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_firewall_config(
ResourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"GetFirewallConfig",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceId" => ResourceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_firewall_domain_list(firewall_domain_list_id)
get_firewall_domain_list(firewall_domain_list_id, params::Dict{String,<:Any})
Retrieves the specified firewall domain list.
# Arguments
- `firewall_domain_list_id`: The ID of the domain list.
"""
function get_firewall_domain_list(
FirewallDomainListId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"GetFirewallDomainList",
Dict{String,Any}("FirewallDomainListId" => FirewallDomainListId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_firewall_domain_list(
FirewallDomainListId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"GetFirewallDomainList",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("FirewallDomainListId" => FirewallDomainListId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_firewall_rule_group(firewall_rule_group_id)
get_firewall_rule_group(firewall_rule_group_id, params::Dict{String,<:Any})
Retrieves the specified firewall rule group.
# Arguments
- `firewall_rule_group_id`: The unique identifier of the firewall rule group.
"""
function get_firewall_rule_group(
FirewallRuleGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"GetFirewallRuleGroup",
Dict{String,Any}("FirewallRuleGroupId" => FirewallRuleGroupId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_firewall_rule_group(
FirewallRuleGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"GetFirewallRuleGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("FirewallRuleGroupId" => FirewallRuleGroupId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_firewall_rule_group_association(firewall_rule_group_association_id)
get_firewall_rule_group_association(firewall_rule_group_association_id, params::Dict{String,<:Any})
Retrieves a firewall rule group association, which enables DNS filtering for a VPC with one
rule group. A VPC can have more than one firewall rule group association, and a rule group
can be associated with more than one VPC.
# Arguments
- `firewall_rule_group_association_id`: The identifier of the FirewallRuleGroupAssociation.
"""
function get_firewall_rule_group_association(
FirewallRuleGroupAssociationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"GetFirewallRuleGroupAssociation",
Dict{String,Any}(
"FirewallRuleGroupAssociationId" => FirewallRuleGroupAssociationId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_firewall_rule_group_association(
FirewallRuleGroupAssociationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"GetFirewallRuleGroupAssociation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FirewallRuleGroupAssociationId" => FirewallRuleGroupAssociationId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_firewall_rule_group_policy(arn)
get_firewall_rule_group_policy(arn, params::Dict{String,<:Any})
Returns the Identity and Access Management (Amazon Web Services IAM) policy for sharing the
specified rule group. You can use the policy to share the rule group using Resource Access
Manager (RAM).
# Arguments
- `arn`: The ARN (Amazon Resource Name) for the rule group.
"""
function get_firewall_rule_group_policy(
Arn; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"GetFirewallRuleGroupPolicy",
Dict{String,Any}("Arn" => Arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_firewall_rule_group_policy(
Arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"GetFirewallRuleGroupPolicy",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Arn" => Arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_outpost_resolver(id)
get_outpost_resolver(id, params::Dict{String,<:Any})
Gets information about a specified Resolver on the Outpost, such as its instance count and
type, name, and the current status of the Resolver.
# Arguments
- `id`: The ID of the Resolver on the Outpost.
"""
function get_outpost_resolver(Id; aws_config::AbstractAWSConfig=global_aws_config())
return route53resolver(
"GetOutpostResolver",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_outpost_resolver(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"GetOutpostResolver",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resolver_config(resource_id)
get_resolver_config(resource_id, params::Dict{String,<:Any})
Retrieves the behavior configuration of Route 53 Resolver behavior for a single VPC from
Amazon Virtual Private Cloud.
# Arguments
- `resource_id`: Resource ID of the Amazon VPC that you want to get information about.
"""
function get_resolver_config(ResourceId; aws_config::AbstractAWSConfig=global_aws_config())
return route53resolver(
"GetResolverConfig",
Dict{String,Any}("ResourceId" => ResourceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resolver_config(
ResourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"GetResolverConfig",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceId" => ResourceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resolver_dnssec_config(resource_id)
get_resolver_dnssec_config(resource_id, params::Dict{String,<:Any})
Gets DNSSEC validation information for a specified resource.
# Arguments
- `resource_id`: The ID of the virtual private cloud (VPC) for the DNSSEC validation status.
"""
function get_resolver_dnssec_config(
ResourceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"GetResolverDnssecConfig",
Dict{String,Any}("ResourceId" => ResourceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resolver_dnssec_config(
ResourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"GetResolverDnssecConfig",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceId" => ResourceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resolver_endpoint(resolver_endpoint_id)
get_resolver_endpoint(resolver_endpoint_id, params::Dict{String,<:Any})
Gets information about a specified Resolver endpoint, such as whether it's an inbound or an
outbound Resolver endpoint, and the current status of the endpoint.
# Arguments
- `resolver_endpoint_id`: The ID of the Resolver endpoint that you want to get information
about.
"""
function get_resolver_endpoint(
ResolverEndpointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"GetResolverEndpoint",
Dict{String,Any}("ResolverEndpointId" => ResolverEndpointId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resolver_endpoint(
ResolverEndpointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"GetResolverEndpoint",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ResolverEndpointId" => ResolverEndpointId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resolver_query_log_config(resolver_query_log_config_id)
get_resolver_query_log_config(resolver_query_log_config_id, params::Dict{String,<:Any})
Gets information about a specified Resolver query logging configuration, such as the number
of VPCs that the configuration is logging queries for and the location that logs are sent
to.
# Arguments
- `resolver_query_log_config_id`: The ID of the Resolver query logging configuration that
you want to get information about.
"""
function get_resolver_query_log_config(
ResolverQueryLogConfigId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"GetResolverQueryLogConfig",
Dict{String,Any}("ResolverQueryLogConfigId" => ResolverQueryLogConfigId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resolver_query_log_config(
ResolverQueryLogConfigId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"GetResolverQueryLogConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResolverQueryLogConfigId" => ResolverQueryLogConfigId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resolver_query_log_config_association(resolver_query_log_config_association_id)
get_resolver_query_log_config_association(resolver_query_log_config_association_id, params::Dict{String,<:Any})
Gets information about a specified association between a Resolver query logging
configuration and an Amazon VPC. When you associate a VPC with a query logging
configuration, Resolver logs DNS queries that originate in that VPC.
# Arguments
- `resolver_query_log_config_association_id`: The ID of the Resolver query logging
configuration association that you want to get information about.
"""
function get_resolver_query_log_config_association(
ResolverQueryLogConfigAssociationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"GetResolverQueryLogConfigAssociation",
Dict{String,Any}(
"ResolverQueryLogConfigAssociationId" => ResolverQueryLogConfigAssociationId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resolver_query_log_config_association(
ResolverQueryLogConfigAssociationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"GetResolverQueryLogConfigAssociation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ResolverQueryLogConfigAssociationId" =>
ResolverQueryLogConfigAssociationId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resolver_query_log_config_policy(arn)
get_resolver_query_log_config_policy(arn, params::Dict{String,<:Any})
Gets information about a query logging policy. A query logging policy specifies the
Resolver query logging operations and resources that you want to allow another Amazon Web
Services account to be able to use.
# Arguments
- `arn`: The ARN of the query logging configuration that you want to get the query logging
policy for.
"""
function get_resolver_query_log_config_policy(
Arn; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"GetResolverQueryLogConfigPolicy",
Dict{String,Any}("Arn" => Arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resolver_query_log_config_policy(
Arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"GetResolverQueryLogConfigPolicy",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Arn" => Arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resolver_rule(resolver_rule_id)
get_resolver_rule(resolver_rule_id, params::Dict{String,<:Any})
Gets information about a specified Resolver rule, such as the domain name that the rule
forwards DNS queries for and the ID of the outbound Resolver endpoint that the rule is
associated with.
# Arguments
- `resolver_rule_id`: The ID of the Resolver rule that you want to get information about.
"""
function get_resolver_rule(
ResolverRuleId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"GetResolverRule",
Dict{String,Any}("ResolverRuleId" => ResolverRuleId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resolver_rule(
ResolverRuleId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"GetResolverRule",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResolverRuleId" => ResolverRuleId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resolver_rule_association(resolver_rule_association_id)
get_resolver_rule_association(resolver_rule_association_id, params::Dict{String,<:Any})
Gets information about an association between a specified Resolver rule and a VPC. You
associate a Resolver rule and a VPC using AssociateResolverRule.
# Arguments
- `resolver_rule_association_id`: The ID of the Resolver rule association that you want to
get information about.
"""
function get_resolver_rule_association(
ResolverRuleAssociationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"GetResolverRuleAssociation",
Dict{String,Any}("ResolverRuleAssociationId" => ResolverRuleAssociationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resolver_rule_association(
ResolverRuleAssociationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"GetResolverRuleAssociation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResolverRuleAssociationId" => ResolverRuleAssociationId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resolver_rule_policy(arn)
get_resolver_rule_policy(arn, params::Dict{String,<:Any})
Gets information about the Resolver rule policy for a specified rule. A Resolver rule
policy includes the rule that you want to share with another account, the account that you
want to share the rule with, and the Resolver operations that you want to allow the account
to use.
# Arguments
- `arn`: The ID of the Resolver rule that you want to get the Resolver rule policy for.
"""
function get_resolver_rule_policy(Arn; aws_config::AbstractAWSConfig=global_aws_config())
return route53resolver(
"GetResolverRulePolicy",
Dict{String,Any}("Arn" => Arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resolver_rule_policy(
Arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"GetResolverRulePolicy",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Arn" => Arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
import_firewall_domains(domain_file_url, firewall_domain_list_id, operation)
import_firewall_domains(domain_file_url, firewall_domain_list_id, operation, params::Dict{String,<:Any})
Imports domain names from a file into a domain list, for use in a DNS firewall rule group.
Each domain specification in your domain list must satisfy the following requirements:
It can optionally start with * (asterisk). With the exception of the optional starting
asterisk, it must only contain the following characters: A-Z, a-z, 0-9, - (hyphen). It
must be from 1-255 characters in length.
# Arguments
- `domain_file_url`: The fully qualified URL or URI of the file stored in Amazon Simple
Storage Service (Amazon S3) that contains the list of domains to import. The file must be
in an S3 bucket that's in the same Region as your DNS Firewall. The file must be a text
file and must contain a single domain per line.
- `firewall_domain_list_id`: The ID of the domain list that you want to modify with the
import operation.
- `operation`: What you want DNS Firewall to do with the domains that are listed in the
file. This must be set to REPLACE, which updates the domain list to exactly match the list
in the file.
"""
function import_firewall_domains(
DomainFileUrl,
FirewallDomainListId,
Operation;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"ImportFirewallDomains",
Dict{String,Any}(
"DomainFileUrl" => DomainFileUrl,
"FirewallDomainListId" => FirewallDomainListId,
"Operation" => Operation,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function import_firewall_domains(
DomainFileUrl,
FirewallDomainListId,
Operation,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"ImportFirewallDomains",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DomainFileUrl" => DomainFileUrl,
"FirewallDomainListId" => FirewallDomainListId,
"Operation" => Operation,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_firewall_configs()
list_firewall_configs(params::Dict{String,<:Any})
Retrieves the firewall configurations that you have defined. DNS Firewall uses the
configurations to manage firewall behavior for your VPCs. A single call might return only
a partial list of the configurations. For information, see MaxResults.
# 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 Resolver to return for this
request. If more objects are available, in the response, Resolver provides a NextToken
value that you can use in a subsequent call to get the next batch of objects. If you don't
specify a value for MaxResults, Resolver returns up to 100 objects.
- `"NextToken"`: For the first call to this list request, omit this value. When you request
a list of objects, Resolver returns at most the number of objects specified in MaxResults.
If more objects are available for retrieval, Resolver returns a NextToken value in the
response. To retrieve the next batch of objects, use the token that was returned for the
prior request in your next request.
"""
function list_firewall_configs(; aws_config::AbstractAWSConfig=global_aws_config())
return route53resolver(
"ListFirewallConfigs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_firewall_configs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"ListFirewallConfigs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_firewall_domain_lists()
list_firewall_domain_lists(params::Dict{String,<:Any})
Retrieves the firewall domain lists that you have defined. For each firewall domain list,
you can retrieve the domains that are defined for a list by calling ListFirewallDomains. A
single call to this list operation might return only a partial list of the domain lists.
For information, see MaxResults.
# 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 Resolver to return for this
request. If more objects are available, in the response, Resolver provides a NextToken
value that you can use in a subsequent call to get the next batch of objects. If you don't
specify a value for MaxResults, Resolver returns up to 100 objects.
- `"NextToken"`: For the first call to this list request, omit this value. When you request
a list of objects, Resolver returns at most the number of objects specified in MaxResults.
If more objects are available for retrieval, Resolver returns a NextToken value in the
response. To retrieve the next batch of objects, use the token that was returned for the
prior request in your next request.
"""
function list_firewall_domain_lists(; aws_config::AbstractAWSConfig=global_aws_config())
return route53resolver(
"ListFirewallDomainLists"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_firewall_domain_lists(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"ListFirewallDomainLists",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_firewall_domains(firewall_domain_list_id)
list_firewall_domains(firewall_domain_list_id, params::Dict{String,<:Any})
Retrieves the domains that you have defined for the specified firewall domain list. A
single call might return only a partial list of the domains. For information, see
MaxResults.
# Arguments
- `firewall_domain_list_id`: The ID of the domain list whose domains 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 objects that you want Resolver to return for this
request. If more objects are available, in the response, Resolver provides a NextToken
value that you can use in a subsequent call to get the next batch of objects. If you don't
specify a value for MaxResults, Resolver returns up to 100 objects.
- `"NextToken"`: For the first call to this list request, omit this value. When you request
a list of objects, Resolver returns at most the number of objects specified in MaxResults.
If more objects are available for retrieval, Resolver returns a NextToken value in the
response. To retrieve the next batch of objects, use the token that was returned for the
prior request in your next request.
"""
function list_firewall_domains(
FirewallDomainListId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"ListFirewallDomains",
Dict{String,Any}("FirewallDomainListId" => FirewallDomainListId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_firewall_domains(
FirewallDomainListId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"ListFirewallDomains",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("FirewallDomainListId" => FirewallDomainListId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_firewall_rule_group_associations()
list_firewall_rule_group_associations(params::Dict{String,<:Any})
Retrieves the firewall rule group associations that you have defined. Each association
enables DNS filtering for a VPC with one rule group. A single call might return only a
partial list of the associations. For information, see MaxResults.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FirewallRuleGroupId"`: The unique identifier of the firewall rule group that you want
to retrieve the associations for. Leave this blank to retrieve associations for any rule
group.
- `"MaxResults"`: The maximum number of objects that you want Resolver to return for this
request. If more objects are available, in the response, Resolver provides a NextToken
value that you can use in a subsequent call to get the next batch of objects. If you don't
specify a value for MaxResults, Resolver returns up to 100 objects.
- `"NextToken"`: For the first call to this list request, omit this value. When you request
a list of objects, Resolver returns at most the number of objects specified in MaxResults.
If more objects are available for retrieval, Resolver returns a NextToken value in the
response. To retrieve the next batch of objects, use the token that was returned for the
prior request in your next request.
- `"Priority"`: The setting that determines the processing order of the rule group among
the rule groups that are associated with a single VPC. DNS Firewall filters VPC traffic
starting from the rule group with the lowest numeric priority setting.
- `"Status"`: The association Status setting that you want DNS Firewall to filter on for
the list. If you don't specify this, then DNS Firewall returns all associations, regardless
of status.
- `"VpcId"`: The unique identifier of the VPC that you want to retrieve the associations
for. Leave this blank to retrieve associations for any VPC.
"""
function list_firewall_rule_group_associations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"ListFirewallRuleGroupAssociations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_firewall_rule_group_associations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"ListFirewallRuleGroupAssociations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_firewall_rule_groups()
list_firewall_rule_groups(params::Dict{String,<:Any})
Retrieves the minimal high-level information for the rule groups that you have defined. A
single call might return only a partial list of the rule groups. For information, see
MaxResults.
# 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 Resolver to return for this
request. If more objects are available, in the response, Resolver provides a NextToken
value that you can use in a subsequent call to get the next batch of objects. If you don't
specify a value for MaxResults, Resolver returns up to 100 objects.
- `"NextToken"`: For the first call to this list request, omit this value. When you request
a list of objects, Resolver returns at most the number of objects specified in MaxResults.
If more objects are available for retrieval, Resolver returns a NextToken value in the
response. To retrieve the next batch of objects, use the token that was returned for the
prior request in your next request.
"""
function list_firewall_rule_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return route53resolver(
"ListFirewallRuleGroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_firewall_rule_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"ListFirewallRuleGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_firewall_rules(firewall_rule_group_id)
list_firewall_rules(firewall_rule_group_id, params::Dict{String,<:Any})
Retrieves the firewall rules that you have defined for the specified firewall rule group.
DNS Firewall uses the rules in a rule group to filter DNS network traffic for a VPC. A
single call might return only a partial list of the rules. For information, see MaxResults.
# Arguments
- `firewall_rule_group_id`: The unique identifier of the firewall rule group that you want
to retrieve the rules for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Action"`: Optional additional filter for the rules to retrieve. The action that DNS
Firewall should take on a DNS query when it matches one of the domains in the rule's domain
list: ALLOW - Permit the request to go through. ALERT - Permit the request to go
through but send an alert to the logs. BLOCK - Disallow the request. If this is
specified, additional handling details are provided in the rule's BlockResponse setting.
- `"MaxResults"`: The maximum number of objects that you want Resolver to return for this
request. If more objects are available, in the response, Resolver provides a NextToken
value that you can use in a subsequent call to get the next batch of objects. If you don't
specify a value for MaxResults, Resolver returns up to 100 objects.
- `"NextToken"`: For the first call to this list request, omit this value. When you request
a list of objects, Resolver returns at most the number of objects specified in MaxResults.
If more objects are available for retrieval, Resolver returns a NextToken value in the
response. To retrieve the next batch of objects, use the token that was returned for the
prior request in your next request.
- `"Priority"`: Optional additional filter for the rules to retrieve. The setting that
determines the processing order of the rules in a rule group. DNS Firewall processes the
rules in a rule group by order of priority, starting from the lowest setting.
"""
function list_firewall_rules(
FirewallRuleGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"ListFirewallRules",
Dict{String,Any}("FirewallRuleGroupId" => FirewallRuleGroupId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_firewall_rules(
FirewallRuleGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"ListFirewallRules",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("FirewallRuleGroupId" => FirewallRuleGroupId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_outpost_resolvers()
list_outpost_resolvers(params::Dict{String,<:Any})
Lists all the Resolvers on Outposts that were created using the current 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 Resolvers on the Outpost that you want to return in
the response to a ListOutpostResolver request. If you don't specify a value for MaxResults,
the request returns up to 100 Resolvers.
- `"NextToken"`: For the first ListOutpostResolver request, omit this value.
- `"OutpostArn"`: The Amazon Resource Name (ARN) of the Outpost.
"""
function list_outpost_resolvers(; aws_config::AbstractAWSConfig=global_aws_config())
return route53resolver(
"ListOutpostResolvers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_outpost_resolvers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"ListOutpostResolvers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_resolver_configs()
list_resolver_configs(params::Dict{String,<:Any})
Retrieves the Resolver configurations that you have defined. Route 53 Resolver uses the
configurations to manage DNS resolution behavior for your VPCs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of Resolver configurations that you want to return in
the response to a ListResolverConfigs request. If you don't specify a value for MaxResults,
up to 100 Resolver configurations are returned.
- `"NextToken"`: (Optional) If the current Amazon Web Services account has more than
MaxResults Resolver configurations, use NextToken to get the second and subsequent pages of
results. For the first ListResolverConfigs request, omit this value. For the second and
subsequent requests, get the value of NextToken from the previous response and specify that
value for NextToken in the request.
"""
function list_resolver_configs(; aws_config::AbstractAWSConfig=global_aws_config())
return route53resolver(
"ListResolverConfigs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_resolver_configs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"ListResolverConfigs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_resolver_dnssec_configs()
list_resolver_dnssec_configs(params::Dict{String,<:Any})
Lists the configurations for DNSSEC validation that are associated with the current Amazon
Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An optional specification to return a subset of objects.
- `"MaxResults"`: Optional: An integer that specifies the maximum number of DNSSEC
configuration results that you want Amazon Route 53 to return. If you don't specify a value
for MaxResults, Route 53 returns up to 100 configuration per page.
- `"NextToken"`: (Optional) If the current Amazon Web Services account has more than
MaxResults DNSSEC configurations, use NextToken to get the second and subsequent pages of
results. For the first ListResolverDnssecConfigs request, omit this value. For the second
and subsequent requests, get the value of NextToken from the previous response and specify
that value for NextToken in the request.
"""
function list_resolver_dnssec_configs(; aws_config::AbstractAWSConfig=global_aws_config())
return route53resolver(
"ListResolverDnssecConfigs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_resolver_dnssec_configs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"ListResolverDnssecConfigs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_resolver_endpoint_ip_addresses(resolver_endpoint_id)
list_resolver_endpoint_ip_addresses(resolver_endpoint_id, params::Dict{String,<:Any})
Gets the IP addresses for a specified Resolver endpoint.
# Arguments
- `resolver_endpoint_id`: The ID of the Resolver endpoint that you want to get IP addresses
for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of IP addresses that you want to return in the
response to a ListResolverEndpointIpAddresses request. If you don't specify a value for
MaxResults, Resolver returns up to 100 IP addresses.
- `"NextToken"`: For the first ListResolverEndpointIpAddresses request, omit this value. If
the specified Resolver endpoint has more than MaxResults IP addresses, you can submit
another ListResolverEndpointIpAddresses request to get the next group of IP addresses. In
the next request, specify the value of NextToken from the previous response.
"""
function list_resolver_endpoint_ip_addresses(
ResolverEndpointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"ListResolverEndpointIpAddresses",
Dict{String,Any}("ResolverEndpointId" => ResolverEndpointId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_resolver_endpoint_ip_addresses(
ResolverEndpointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"ListResolverEndpointIpAddresses",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ResolverEndpointId" => ResolverEndpointId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_resolver_endpoints()
list_resolver_endpoints(params::Dict{String,<:Any})
Lists all the Resolver endpoints that were created using the current Amazon Web Services
account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An optional specification to return a subset of Resolver endpoints, such as
all inbound Resolver endpoints. If you submit a second or subsequent ListResolverEndpoints
request and specify the NextToken parameter, you must use the same values for Filters, if
any, as in the previous request.
- `"MaxResults"`: The maximum number of Resolver endpoints that you want to return in the
response to a ListResolverEndpoints request. If you don't specify a value for MaxResults,
Resolver returns up to 100 Resolver endpoints.
- `"NextToken"`: For the first ListResolverEndpoints request, omit this value. If you have
more than MaxResults Resolver endpoints, you can submit another ListResolverEndpoints
request to get the next group of Resolver endpoints. In the next request, specify the value
of NextToken from the previous response.
"""
function list_resolver_endpoints(; aws_config::AbstractAWSConfig=global_aws_config())
return route53resolver(
"ListResolverEndpoints"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_resolver_endpoints(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"ListResolverEndpoints",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_resolver_query_log_config_associations()
list_resolver_query_log_config_associations(params::Dict{String,<:Any})
Lists information about associations between Amazon VPCs and query logging configurations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An optional specification to return a subset of query logging associations.
If you submit a second or subsequent ListResolverQueryLogConfigAssociations request and
specify the NextToken parameter, you must use the same values for Filters, if any, as in
the previous request.
- `"MaxResults"`: The maximum number of query logging associations that you want to return
in the response to a ListResolverQueryLogConfigAssociations request. If you don't specify a
value for MaxResults, Resolver returns up to 100 query logging associations.
- `"NextToken"`: For the first ListResolverQueryLogConfigAssociations request, omit this
value. If there are more than MaxResults query logging associations that match the values
that you specify for Filters, you can submit another ListResolverQueryLogConfigAssociations
request to get the next group of associations. In the next request, specify the value of
NextToken from the previous response.
- `"SortBy"`: The element that you want Resolver to sort query logging associations by.
If you submit a second or subsequent ListResolverQueryLogConfigAssociations request and
specify the NextToken parameter, you must use the same value for SortBy, if any, as in the
previous request. Valid values include the following elements: CreationTime: The ID of
the query logging association. Error: If the value of Status is FAILED, the value of
Error indicates the cause: DESTINATION_NOT_FOUND: The specified destination (for
example, an Amazon S3 bucket) was deleted. ACCESS_DENIED: Permissions don't allow
sending logs to the destination. If Status is a value other than FAILED, ERROR is null.
Id: The ID of the query logging association ResolverQueryLogConfigId: The ID of the
query logging configuration ResourceId: The ID of the VPC that is associated with the
query logging configuration Status: The current status of the configuration. Valid
values include the following: CREATING: Resolver is creating an association between an
Amazon VPC and a query logging configuration. CREATED: The association between an Amazon
VPC and a query logging configuration was successfully created. Resolver is logging queries
that originate in the specified VPC. DELETING: Resolver is deleting this query logging
association. FAILED: Resolver either couldn't create or couldn't delete the query
logging association. Here are two common causes: The specified destination (for example,
an Amazon S3 bucket) was deleted. Permissions don't allow sending logs to the
destination.
- `"SortOrder"`: If you specified a value for SortBy, the order that you want query logging
associations to be listed in, ASCENDING or DESCENDING. If you submit a second or
subsequent ListResolverQueryLogConfigAssociations request and specify the NextToken
parameter, you must use the same value for SortOrder, if any, as in the previous request.
"""
function list_resolver_query_log_config_associations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"ListResolverQueryLogConfigAssociations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_resolver_query_log_config_associations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"ListResolverQueryLogConfigAssociations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_resolver_query_log_configs()
list_resolver_query_log_configs(params::Dict{String,<:Any})
Lists information about the specified query logging configurations. Each configuration
defines where you want Resolver to save DNS query logs and specifies the VPCs that you want
to log queries for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An optional specification to return a subset of query logging
configurations. If you submit a second or subsequent ListResolverQueryLogConfigs request
and specify the NextToken parameter, you must use the same values for Filters, if any, as
in the previous request.
- `"MaxResults"`: The maximum number of query logging configurations that you want to
return in the response to a ListResolverQueryLogConfigs request. If you don't specify a
value for MaxResults, Resolver returns up to 100 query logging configurations.
- `"NextToken"`: For the first ListResolverQueryLogConfigs request, omit this value. If
there are more than MaxResults query logging configurations that match the values that you
specify for Filters, you can submit another ListResolverQueryLogConfigs request to get the
next group of configurations. In the next request, specify the value of NextToken from the
previous response.
- `"SortBy"`: The element that you want Resolver to sort query logging configurations by.
If you submit a second or subsequent ListResolverQueryLogConfigs request and specify the
NextToken parameter, you must use the same value for SortBy, if any, as in the previous
request. Valid values include the following elements: Arn: The ARN of the query logging
configuration AssociationCount: The number of VPCs that are associated with the
specified configuration CreationTime: The date and time that Resolver returned when the
configuration was created CreatorRequestId: The value that was specified for
CreatorRequestId when the configuration was created DestinationArn: The location that
logs are sent to Id: The ID of the configuration Name: The name of the configuration
OwnerId: The Amazon Web Services account number of the account that created the
configuration ShareStatus: Whether the configuration is shared with other Amazon Web
Services accounts or shared with the current account by another Amazon Web Services
account. Sharing is configured through Resource Access Manager (RAM). Status: The
current status of the configuration. Valid values include the following: CREATING:
Resolver is creating the query logging configuration. CREATED: The query logging
configuration was successfully created. Resolver is logging queries that originate in the
specified VPC. DELETING: Resolver is deleting this query logging configuration.
FAILED: Resolver either couldn't create or couldn't delete the query logging configuration.
Here are two common causes: The specified destination (for example, an Amazon S3 bucket)
was deleted. Permissions don't allow sending logs to the destination.
- `"SortOrder"`: If you specified a value for SortBy, the order that you want query logging
configurations to be listed in, ASCENDING or DESCENDING. If you submit a second or
subsequent ListResolverQueryLogConfigs request and specify the NextToken parameter, you
must use the same value for SortOrder, if any, as in the previous request.
"""
function list_resolver_query_log_configs(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"ListResolverQueryLogConfigs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_resolver_query_log_configs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"ListResolverQueryLogConfigs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_resolver_rule_associations()
list_resolver_rule_associations(params::Dict{String,<:Any})
Lists the associations that were created between Resolver rules and VPCs using the current
Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An optional specification to return a subset of Resolver rules, such as
Resolver rules that are associated with the same VPC ID. If you submit a second or
subsequent ListResolverRuleAssociations request and specify the NextToken parameter, you
must use the same values for Filters, if any, as in the previous request.
- `"MaxResults"`: The maximum number of rule associations that you want to return in the
response to a ListResolverRuleAssociations request. If you don't specify a value for
MaxResults, Resolver returns up to 100 rule associations.
- `"NextToken"`: For the first ListResolverRuleAssociation request, omit this value. If you
have more than MaxResults rule associations, you can submit another
ListResolverRuleAssociation request to get the next group of rule associations. In the next
request, specify the value of NextToken from the previous response.
"""
function list_resolver_rule_associations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"ListResolverRuleAssociations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_resolver_rule_associations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"ListResolverRuleAssociations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_resolver_rules()
list_resolver_rules(params::Dict{String,<:Any})
Lists the Resolver rules that were created using the current Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An optional specification to return a subset of Resolver rules, such as all
Resolver rules that are associated with the same Resolver endpoint. If you submit a second
or subsequent ListResolverRules request and specify the NextToken parameter, you must use
the same values for Filters, if any, as in the previous request.
- `"MaxResults"`: The maximum number of Resolver rules that you want to return in the
response to a ListResolverRules request. If you don't specify a value for MaxResults,
Resolver returns up to 100 Resolver rules.
- `"NextToken"`: For the first ListResolverRules request, omit this value. If you have more
than MaxResults Resolver rules, you can submit another ListResolverRules request to get the
next group of Resolver rules. In the next request, specify the value of NextToken from the
previous response.
"""
function list_resolver_rules(; aws_config::AbstractAWSConfig=global_aws_config())
return route53resolver(
"ListResolverRules"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_resolver_rules(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"ListResolverRules", 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 you associated with the specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) for the resource that you want to list
tags for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of tags that you want to return in the response to a
ListTagsForResource request. If you don't specify a value for MaxResults, Resolver returns
up to 100 tags.
- `"NextToken"`: For the first ListTagsForResource request, omit this value. If you have
more than MaxResults tags, you can submit another ListTagsForResource request to get the
next group of tags for the resource. In the next request, specify the value of NextToken
from the previous response.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"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 route53resolver(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_firewall_rule_group_policy(arn, firewall_rule_group_policy)
put_firewall_rule_group_policy(arn, firewall_rule_group_policy, params::Dict{String,<:Any})
Attaches an Identity and Access Management (Amazon Web Services IAM) policy for sharing the
rule group. You can use the policy to share the rule group using Resource Access Manager
(RAM).
# Arguments
- `arn`: The ARN (Amazon Resource Name) for the rule group that you want to share.
- `firewall_rule_group_policy`: The Identity and Access Management (Amazon Web Services
IAM) policy to attach to the rule group.
"""
function put_firewall_rule_group_policy(
Arn, FirewallRuleGroupPolicy; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"PutFirewallRuleGroupPolicy",
Dict{String,Any}(
"Arn" => Arn, "FirewallRuleGroupPolicy" => FirewallRuleGroupPolicy
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_firewall_rule_group_policy(
Arn,
FirewallRuleGroupPolicy,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"PutFirewallRuleGroupPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Arn" => Arn, "FirewallRuleGroupPolicy" => FirewallRuleGroupPolicy
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_resolver_query_log_config_policy(arn, resolver_query_log_config_policy)
put_resolver_query_log_config_policy(arn, resolver_query_log_config_policy, params::Dict{String,<:Any})
Specifies an Amazon Web Services account that you want to share a query logging
configuration with, the query logging configuration that you want to share, and the
operations that you want the account to be able to perform on the configuration.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the account that you want to share rules with.
- `resolver_query_log_config_policy`: An Identity and Access Management policy statement
that lists the query logging configurations that you want to share with another Amazon Web
Services account and the operations that you want the account to be able to perform. You
can specify the following operations in the Actions section of the statement:
route53resolver:AssociateResolverQueryLogConfig
route53resolver:DisassociateResolverQueryLogConfig
route53resolver:ListResolverQueryLogConfigs In the Resource section of the statement,
you specify the ARNs for the query logging configurations that you want to share with the
account that you specified in Arn.
"""
function put_resolver_query_log_config_policy(
Arn, ResolverQueryLogConfigPolicy; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"PutResolverQueryLogConfigPolicy",
Dict{String,Any}(
"Arn" => Arn, "ResolverQueryLogConfigPolicy" => ResolverQueryLogConfigPolicy
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_resolver_query_log_config_policy(
Arn,
ResolverQueryLogConfigPolicy,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"PutResolverQueryLogConfigPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Arn" => Arn,
"ResolverQueryLogConfigPolicy" => ResolverQueryLogConfigPolicy,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_resolver_rule_policy(arn, resolver_rule_policy)
put_resolver_rule_policy(arn, resolver_rule_policy, params::Dict{String,<:Any})
Specifies an Amazon Web Services rule that you want to share with another account, the
account that you want to share the rule with, and the operations that you want the account
to be able to perform on the rule.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the rule that you want to share with another
account.
- `resolver_rule_policy`: An Identity and Access Management policy statement that lists the
rules that you want to share with another Amazon Web Services account and the operations
that you want the account to be able to perform. You can specify the following operations
in the Action section of the statement: route53resolver:GetResolverRule
route53resolver:AssociateResolverRule route53resolver:DisassociateResolverRule
route53resolver:ListResolverRules route53resolver:ListResolverRuleAssociations In
the Resource section of the statement, specify the ARN for the rule that you want to share
with another account. Specify the same ARN that you specified in Arn.
"""
function put_resolver_rule_policy(
Arn, ResolverRulePolicy; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"PutResolverRulePolicy",
Dict{String,Any}("Arn" => Arn, "ResolverRulePolicy" => ResolverRulePolicy);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_resolver_rule_policy(
Arn,
ResolverRulePolicy,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"PutResolverRulePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Arn" => Arn, "ResolverRulePolicy" => ResolverRulePolicy),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds one or more tags to a specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) for the resource that you want to add tags
to. To get the ARN for a resource, use the applicable Get or List command:
GetResolverEndpoint GetResolverRule GetResolverRuleAssociation
ListResolverEndpoints ListResolverRuleAssociations ListResolverRules
- `tags`: The tags that you want to add to the specified resource.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return route53resolver(
"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 route53resolver(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes one or more tags from a specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) for the resource that you want to remove
tags from. To get the ARN for a resource, use the applicable Get or List command:
GetResolverEndpoint GetResolverRule GetResolverRuleAssociation
ListResolverEndpoints ListResolverRuleAssociations ListResolverRules
- `tag_keys`: The tags that you want to remove to the specified resource.
"""
function untag_resource(
ResourceArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"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 route53resolver(
"UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_firewall_config(firewall_fail_open, resource_id)
update_firewall_config(firewall_fail_open, resource_id, params::Dict{String,<:Any})
Updates the configuration of the firewall behavior provided by DNS Firewall for a single
VPC from Amazon Virtual Private Cloud (Amazon VPC).
# Arguments
- `firewall_fail_open`: Determines how Route 53 Resolver handles queries during failures,
for example when all traffic that is sent to DNS Firewall fails to receive a reply. By
default, fail open is disabled, which means the failure mode is closed. This approach
favors security over availability. DNS Firewall blocks queries that it is unable to
evaluate properly. If you enable this option, the failure mode is open. This approach
favors availability over security. DNS Firewall allows queries to proceed if it is unable
to properly evaluate them. This behavior is only enforced for VPCs that have at least
one DNS Firewall rule group association.
- `resource_id`: The ID of the VPC that the configuration is for.
"""
function update_firewall_config(
FirewallFailOpen, ResourceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"UpdateFirewallConfig",
Dict{String,Any}(
"FirewallFailOpen" => FirewallFailOpen, "ResourceId" => ResourceId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_firewall_config(
FirewallFailOpen,
ResourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"UpdateFirewallConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FirewallFailOpen" => FirewallFailOpen, "ResourceId" => ResourceId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_firewall_domains(domains, firewall_domain_list_id, operation)
update_firewall_domains(domains, firewall_domain_list_id, operation, params::Dict{String,<:Any})
Updates the firewall domain list from an array of domain specifications.
# Arguments
- `domains`: A list of domains to use in the update operation. There is a limit of 1000
domains per request. Each domain specification in your domain list must satisfy the
following requirements: It can optionally start with * (asterisk). With the exception
of the optional starting asterisk, it must only contain the following characters: A-Z, a-z,
0-9, - (hyphen). It must be from 1-255 characters in length.
- `firewall_domain_list_id`: The ID of the domain list whose domains you want to update.
- `operation`: What you want DNS Firewall to do with the domains that you are providing:
ADD - Add the domains to the ones that are already in the domain list. REMOVE - Search
the domain list for the domains and remove them from the list. REPLACE - Update the
domain list to exactly match the list that you are providing.
"""
function update_firewall_domains(
Domains,
FirewallDomainListId,
Operation;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"UpdateFirewallDomains",
Dict{String,Any}(
"Domains" => Domains,
"FirewallDomainListId" => FirewallDomainListId,
"Operation" => Operation,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_firewall_domains(
Domains,
FirewallDomainListId,
Operation,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"UpdateFirewallDomains",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Domains" => Domains,
"FirewallDomainListId" => FirewallDomainListId,
"Operation" => Operation,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_firewall_rule(firewall_domain_list_id, firewall_rule_group_id)
update_firewall_rule(firewall_domain_list_id, firewall_rule_group_id, params::Dict{String,<:Any})
Updates the specified firewall rule.
# Arguments
- `firewall_domain_list_id`: The ID of the domain list to use in the rule.
- `firewall_rule_group_id`: The unique identifier of the firewall rule group for the rule.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Action"`: The action that DNS Firewall should take on a DNS query when it matches one
of the domains in the rule's domain list: ALLOW - Permit the request to go through.
ALERT - Permit the request to go through but send an alert to the logs. BLOCK - Disallow
the request. This option requires additional details in the rule's BlockResponse.
- `"BlockOverrideDnsType"`: The DNS record's type. This determines the format of the record
value that you provided in BlockOverrideDomain. Used for the rule action BLOCK with a
BlockResponse setting of OVERRIDE.
- `"BlockOverrideDomain"`: The custom DNS record to send back in response to the query.
Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.
- `"BlockOverrideTtl"`: The recommended amount of time, in seconds, for the DNS resolver or
web browser to cache the provided override record. Used for the rule action BLOCK with a
BlockResponse setting of OVERRIDE.
- `"BlockResponse"`: The way that you want DNS Firewall to block the request. Used for the
rule action setting BLOCK. NODATA - Respond indicating that the query was successful,
but no response is available for it. NXDOMAIN - Respond indicating that the domain name
that's in the query doesn't exist. OVERRIDE - Provide a custom override in the response.
This option requires custom handling details in the rule's BlockOverride* settings.
- `"FirewallDomainRedirectionAction"`: How you want the the rule to evaluate DNS
redirection in the DNS redirection chain, such as CNAME or DNAME.
Inspect_Redirection_Domain (Default) inspects all domains in the redirection chain. The
individual domains in the redirection chain must be added to the domain list.
Trust_Redirection_Domain inspects only the first domain in the redirection chain. You
don't need to add the subsequent domains in the domain in the redirection list to the
domain list.
- `"Name"`: The name of the rule.
- `"Priority"`: The setting that determines the processing order of the rule in the rule
group. DNS Firewall processes the rules in a rule group by order of priority, starting from
the lowest setting. You must specify a unique priority for each rule in a rule group. To
make it easier to insert rules later, leave space between the numbers, for example, use
100, 200, and so on. You can change the priority setting for the rules in a rule group at
any time.
- `"Qtype"`: The DNS query type you want the rule to evaluate. Allowed values are; A:
Returns an IPv4 address. AAAA: Returns an Ipv6 address. CAA: Restricts CAs that can
create SSL/TLS certifications for the domain. CNAME: Returns another domain name. DS:
Record that identifies the DNSSEC signing key of a delegated zone. MX: Specifies mail
servers. NAPTR: Regular-expression-based rewriting of domain names. NS: Authoritative
name servers. PTR: Maps an IP address to a domain name. SOA: Start of authority record
for the zone. SPF: Lists the servers authorized to send emails from a domain. SRV:
Application specific values that identify servers. TXT: Verifies email senders and
application-specific values. A query type you define by using the DNS type ID, for
example 28 for AAAA. The values must be defined as TYPENUMBER, where the NUMBER can be
1-65334, for example, TYPE28. For more information, see List of DNS record types.
"""
function update_firewall_rule(
FirewallDomainListId,
FirewallRuleGroupId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"UpdateFirewallRule",
Dict{String,Any}(
"FirewallDomainListId" => FirewallDomainListId,
"FirewallRuleGroupId" => FirewallRuleGroupId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_firewall_rule(
FirewallDomainListId,
FirewallRuleGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"UpdateFirewallRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FirewallDomainListId" => FirewallDomainListId,
"FirewallRuleGroupId" => FirewallRuleGroupId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_firewall_rule_group_association(firewall_rule_group_association_id)
update_firewall_rule_group_association(firewall_rule_group_association_id, params::Dict{String,<:Any})
Changes the association of a FirewallRuleGroup with a VPC. The association enables DNS
filtering for the VPC.
# Arguments
- `firewall_rule_group_association_id`: The identifier of the FirewallRuleGroupAssociation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MutationProtection"`: If enabled, this setting disallows modification or removal of the
association, to help prevent against accidentally altering DNS firewall protections.
- `"Name"`: The name of the rule group association.
- `"Priority"`: The setting that determines the processing order of the rule group among
the rule groups that you associate with the specified VPC. DNS Firewall filters VPC traffic
starting from the rule group with the lowest numeric priority setting. You must specify a
unique priority for each rule group that you associate with a single VPC. To make it easier
to insert rule groups later, leave space between the numbers, for example, use 100, 200,
and so on. You can change the priority setting for a rule group association after you
create it.
"""
function update_firewall_rule_group_association(
FirewallRuleGroupAssociationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"UpdateFirewallRuleGroupAssociation",
Dict{String,Any}(
"FirewallRuleGroupAssociationId" => FirewallRuleGroupAssociationId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_firewall_rule_group_association(
FirewallRuleGroupAssociationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"UpdateFirewallRuleGroupAssociation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FirewallRuleGroupAssociationId" => FirewallRuleGroupAssociationId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_outpost_resolver(id)
update_outpost_resolver(id, params::Dict{String,<:Any})
You can use UpdateOutpostResolver to update the instance count, type, or name of a Resolver
on an Outpost.
# Arguments
- `id`: A unique string that identifies Resolver on an Outpost.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InstanceCount"`: The Amazon EC2 instance count for a Resolver on the Outpost.
- `"Name"`: Name of the Resolver on the Outpost.
- `"PreferredInstanceType"`: Amazon EC2 instance type.
"""
function update_outpost_resolver(Id; aws_config::AbstractAWSConfig=global_aws_config())
return route53resolver(
"UpdateOutpostResolver",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_outpost_resolver(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"UpdateOutpostResolver",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_resolver_config(autodefined_reverse_flag, resource_id)
update_resolver_config(autodefined_reverse_flag, resource_id, params::Dict{String,<:Any})
Updates the behavior configuration of Route 53 Resolver behavior for a single VPC from
Amazon Virtual Private Cloud.
# Arguments
- `autodefined_reverse_flag`: Indicates whether or not the Resolver will create autodefined
rules for reverse DNS lookups. This is enabled by default. Disabling this option will also
affect EC2-Classic instances using ClassicLink. For more information, see ClassicLink in
the Amazon EC2 guide. We are retiring EC2-Classic on August 15, 2022. We recommend that
you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic
to a VPC in the Amazon EC2 guide and the blog EC2-Classic Networking is Retiring –
Here’s How to Prepare. It can take some time for the status change to be completed.
- `resource_id`: Resource ID of the Amazon VPC that you want to update the Resolver
configuration for.
"""
function update_resolver_config(
AutodefinedReverseFlag, ResourceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"UpdateResolverConfig",
Dict{String,Any}(
"AutodefinedReverseFlag" => AutodefinedReverseFlag, "ResourceId" => ResourceId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_resolver_config(
AutodefinedReverseFlag,
ResourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"UpdateResolverConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AutodefinedReverseFlag" => AutodefinedReverseFlag,
"ResourceId" => ResourceId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_resolver_dnssec_config(resource_id, validation)
update_resolver_dnssec_config(resource_id, validation, params::Dict{String,<:Any})
Updates an existing DNSSEC validation configuration. If there is no existing DNSSEC
validation configuration, one is created.
# Arguments
- `resource_id`: The ID of the virtual private cloud (VPC) that you're updating the DNSSEC
validation status for.
- `validation`: The new value that you are specifying for DNSSEC validation for the VPC.
The value can be ENABLE or DISABLE. Be aware that it can take time for a validation status
change to be completed.
"""
function update_resolver_dnssec_config(
ResourceId, Validation; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"UpdateResolverDnssecConfig",
Dict{String,Any}("ResourceId" => ResourceId, "Validation" => Validation);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_resolver_dnssec_config(
ResourceId,
Validation,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"UpdateResolverDnssecConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceId" => ResourceId, "Validation" => Validation),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_resolver_endpoint(resolver_endpoint_id)
update_resolver_endpoint(resolver_endpoint_id, params::Dict{String,<:Any})
Updates the name, or endpoint type for an inbound or an outbound Resolver endpoint. You can
only update between IPV4 and DUALSTACK, IPV6 endpoint type can't be updated to other type.
# Arguments
- `resolver_endpoint_id`: The ID of the Resolver endpoint that you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Name"`: The name of the Resolver endpoint that you want to update.
- `"Protocols"`: The protocols you want to use for the endpoint. DoH-FIPS is applicable
for inbound endpoints only. For an inbound endpoint you can apply the protocols as
follows: Do53 and DoH in combination. Do53 and DoH-FIPS in combination. Do53 alone.
DoH alone. DoH-FIPS alone. None, which is treated as Do53. For an outbound endpoint
you can apply the protocols as follows: Do53 and DoH in combination. Do53 alone. DoH
alone. None, which is treated as Do53. You can't change the protocol of an inbound
endpoint directly from only Do53 to only DoH, or DoH-FIPS. This is to prevent a sudden
disruption to incoming traffic that relies on Do53. To change the protocol from Do53 to
DoH, or DoH-FIPS, you must first enable both Do53 and DoH, or Do53 and DoH-FIPS, to make
sure that all incoming traffic has transferred to using the DoH protocol, or DoH-FIPS, and
then remove the Do53.
- `"ResolverEndpointType"`: Specifies the endpoint type for what type of IP address the
endpoint uses to forward DNS queries. Updating to IPV6 type isn't currently supported.
- `"UpdateIpAddresses"`: Specifies the IPv6 address when you update the Resolver endpoint
from IPv4 to dual-stack. If you don't specify an IPv6 address, one will be automatically
chosen from your subnet.
"""
function update_resolver_endpoint(
ResolverEndpointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"UpdateResolverEndpoint",
Dict{String,Any}("ResolverEndpointId" => ResolverEndpointId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_resolver_endpoint(
ResolverEndpointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"UpdateResolverEndpoint",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ResolverEndpointId" => ResolverEndpointId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_resolver_rule(config, resolver_rule_id)
update_resolver_rule(config, resolver_rule_id, params::Dict{String,<:Any})
Updates settings for a specified Resolver rule. ResolverRuleId is required, and all other
parameters are optional. If you don't specify a parameter, it retains its current value.
# Arguments
- `config`: The new settings for the Resolver rule.
- `resolver_rule_id`: The ID of the Resolver rule that you want to update.
"""
function update_resolver_rule(
Config, ResolverRuleId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route53resolver(
"UpdateResolverRule",
Dict{String,Any}("Config" => Config, "ResolverRuleId" => ResolverRuleId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_resolver_rule(
Config,
ResolverRuleId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route53resolver(
"UpdateResolverRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Config" => Config, "ResolverRuleId" => ResolverRuleId),
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 | 155551 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: route_53
using AWS.Compat
using AWS.UUIDs
"""
activate_key_signing_key(hosted_zone_id, name)
activate_key_signing_key(hosted_zone_id, name, params::Dict{String,<:Any})
Activates a key-signing key (KSK) so that it can be used for signing by DNSSEC. This
operation changes the KSK status to ACTIVE.
# Arguments
- `hosted_zone_id`: A unique string used to identify a hosted zone.
- `name`: A string used to identify a key-signing key (KSK). Name can include numbers,
letters, and underscores (_). Name must be unique for each key-signing key in the same
hosted zone.
"""
function activate_key_signing_key(
HostedZoneId, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"POST",
"/2013-04-01/keysigningkey/$(HostedZoneId)/$(Name)/activate";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function activate_key_signing_key(
HostedZoneId,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"POST",
"/2013-04-01/keysigningkey/$(HostedZoneId)/$(Name)/activate",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_vpcwith_hosted_zone(id, vpc)
associate_vpcwith_hosted_zone(id, vpc, params::Dict{String,<:Any})
Associates an Amazon VPC with a private hosted zone. To perform the association, the VPC
and the private hosted zone must already exist. You can't convert a public hosted zone into
a private hosted zone. If you want to associate a VPC that was created by using one
Amazon Web Services account with a private hosted zone that was created by using a
different account, the Amazon Web Services account that created the private hosted zone
must first submit a CreateVPCAssociationAuthorization request. Then the account that
created the VPC must submit an AssociateVPCWithHostedZone request. When granting access,
the hosted zone and the Amazon VPC must belong to the same partition. A partition is a
group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one
partition. The following are the supported partitions: aws - Amazon Web Services Regions
aws-cn - China Regions aws-us-gov - Amazon Web Services GovCloud (US) Region For
more information, see Access Management in the Amazon Web Services General Reference.
# Arguments
- `id`: The ID of the private hosted zone that you want to associate an Amazon VPC with.
Note that you can't associate a VPC with a hosted zone that doesn't have an existing VPC
association.
- `vpc`: A complex type that contains information about the VPC that you want to associate
with a private hosted zone.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Comment"`: Optional: A comment about the association request.
"""
function associate_vpcwith_hosted_zone(
Id, VPC; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"POST",
"/2013-04-01/hostedzone/$(Id)/associatevpc",
Dict{String,Any}("VPC" => VPC);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_vpcwith_hosted_zone(
Id, VPC, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"POST",
"/2013-04-01/hostedzone/$(Id)/associatevpc",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("VPC" => VPC), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
change_cidr_collection(changes, cidr_collection_id)
change_cidr_collection(changes, cidr_collection_id, params::Dict{String,<:Any})
Creates, changes, or deletes CIDR blocks within a collection. Contains authoritative IP
information mapping blocks to one or multiple locations. A change request can update
multiple locations in a collection at a time, which is helpful if you want to move one or
more CIDR blocks from one location to another in one transaction, without downtime.
Limits The max number of CIDR blocks included in the request is 1000. As a result, big
updates require multiple API calls. PUT and DELETE_IF_EXISTS Use ChangeCidrCollection to
perform the following actions: PUT: Create a CIDR block within the specified collection.
DELETE_IF_EXISTS: Delete an existing CIDR block from the collection.
# Arguments
- `changes`: Information about changes to a CIDR collection.
- `cidr_collection_id`: The UUID of the CIDR collection to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CollectionVersion"`: A sequential counter that Amazon Route 53 sets to 1 when you
create a collection and increments it by 1 each time you update the collection. We
recommend that you use ListCidrCollection to get the current value of CollectionVersion for
the collection that you want to update, and then include that value with the change
request. This prevents Route 53 from overwriting an intervening update: If the value in
the request matches the value of CollectionVersion in the collection, Route 53 updates the
collection. If the value of CollectionVersion in the collection is greater than the value
in the request, the collection was changed after you got the version number. Route 53 does
not update the collection, and it returns a CidrCollectionVersionMismatch error.
"""
function change_cidr_collection(
Changes, CidrCollectionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"POST",
"/2013-04-01/cidrcollection/$(CidrCollectionId)",
Dict{String,Any}("Changes" => Changes);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function change_cidr_collection(
Changes,
CidrCollectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"POST",
"/2013-04-01/cidrcollection/$(CidrCollectionId)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Changes" => Changes), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
change_resource_record_sets(change_batch, id)
change_resource_record_sets(change_batch, id, params::Dict{String,<:Any})
Creates, changes, or deletes a resource record set, which contains authoritative DNS
information for a specified domain name or subdomain name. For example, you can use
ChangeResourceRecordSets to create a resource record set that routes traffic for
test.example.com to a web server that has an IP address of 192.0.2.44. Deleting Resource
Record Sets To delete a resource record set, you must specify all the same values that you
specified when you created it. Change Batches and Transactional Changes The request body
must include a document with a ChangeResourceRecordSetsRequest element. The request body
contains a list of change items, known as a change batch. Change batches are considered
transactional changes. Route 53 validates the changes in the request and then either makes
all or none of the changes in the change batch request. This ensures that DNS routing isn't
adversely affected by partial changes to the resource record sets in a hosted zone. For
example, suppose a change batch request contains two changes: it deletes the CNAME resource
record set for www.example.com and creates an alias resource record set for
www.example.com. If validation for both records succeeds, Route 53 deletes the first
resource record set and creates the second resource record set in a single operation. If
validation for either the DELETE or the CREATE action fails, then the request is canceled,
and the original CNAME record continues to exist. If you try to delete the same resource
record set more than once in a single change batch, Route 53 returns an InvalidChangeBatch
error. Traffic Flow To create resource record sets for complex routing configurations,
use either the traffic flow visual editor in the Route 53 console or the API actions for
traffic policies and traffic policy instances. Save the configuration as a traffic policy,
then associate the traffic policy with one or more domain names (such as example.com) or
subdomain names (such as www.example.com), in the same hosted zone or in multiple hosted
zones. You can roll back the updates if the new configuration isn't performing as expected.
For more information, see Using Traffic Flow to Route DNS Traffic in the Amazon Route 53
Developer Guide. Create, Delete, and Upsert Use ChangeResourceRecordsSetsRequest to
perform the following actions: CREATE: Creates a resource record set that has the
specified values. DELETE: Deletes an existing resource record set that has the specified
values. UPSERT: If a resource set doesn't exist, Route 53 creates it. If a resource set
exists Route 53 updates it with the values in the request. Syntaxes for Creating,
Updating, and Deleting Resource Record Sets The syntax for a request depends on the type
of resource record set that you want to create, delete, or update, such as weighted, alias,
or failover. The XML elements in your request must appear in the order listed in the
syntax. For an example for each type of resource record set, see \"Examples.\" Don't refer
to the syntax in the \"Parameter Syntax\" section, which includes all of the elements for
every kind of resource record set that you can create, delete, or update by using
ChangeResourceRecordSets. Change Propagation to Route 53 DNS Servers When you submit a
ChangeResourceRecordSets request, Route 53 propagates your changes to all of the Route 53
authoritative DNS servers managing the hosted zone. While your changes are propagating,
GetChange returns a status of PENDING. When propagation is complete, GetChange returns a
status of INSYNC. Changes generally propagate to all Route 53 name servers managing the
hosted zone within 60 seconds. For more information, see GetChange. Limits on
ChangeResourceRecordSets Requests For information about the limits on a
ChangeResourceRecordSets request, see Limits in the Amazon Route 53 Developer Guide.
# Arguments
- `change_batch`: A complex type that contains an optional comment and the Changes element.
- `id`: The ID of the hosted zone that contains the resource record sets that you want to
change.
"""
function change_resource_record_sets(
ChangeBatch, Id; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"POST",
"/2013-04-01/hostedzone/$(Id)/rrset/",
Dict{String,Any}("ChangeBatch" => ChangeBatch);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function change_resource_record_sets(
ChangeBatch,
Id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"POST",
"/2013-04-01/hostedzone/$(Id)/rrset/",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ChangeBatch" => ChangeBatch), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
change_tags_for_resource(resource_id, resource_type)
change_tags_for_resource(resource_id, resource_type, params::Dict{String,<:Any})
Adds, edits, or deletes tags for a health check or a hosted zone. For information about
using tags for cost allocation, see Using Cost Allocation Tags in the Billing and Cost
Management User Guide.
# Arguments
- `resource_id`: The ID of the resource for which you want to add, change, or delete tags.
- `resource_type`: The type of the resource. The resource type for health checks is
healthcheck. The resource type for hosted zones is hostedzone.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AddTags"`: A complex type that contains a list of the tags that you want to add to the
specified health check or hosted zone and/or the tags that you want to edit Value for. You
can add a maximum of 10 tags to a health check or a hosted zone.
- `"RemoveTagKeys"`: A complex type that contains a list of the tags that you want to
delete from the specified health check or hosted zone. You can specify up to 10 keys.
"""
function change_tags_for_resource(
ResourceId, ResourceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"POST",
"/2013-04-01/tags/$(ResourceType)/$(ResourceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function change_tags_for_resource(
ResourceId,
ResourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"POST",
"/2013-04-01/tags/$(ResourceType)/$(ResourceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_cidr_collection(caller_reference, name)
create_cidr_collection(caller_reference, name, params::Dict{String,<:Any})
Creates a CIDR collection in the current Amazon Web Services account.
# Arguments
- `caller_reference`: A client-specific token that allows requests to be securely retried
so that the intended outcome will only occur once, retries receive a similar response, and
there are no additional edge cases to handle.
- `name`: A unique identifier for the account that can be used to reference the collection
from other API calls.
"""
function create_cidr_collection(
CallerReference, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"POST",
"/2013-04-01/cidrcollection",
Dict{String,Any}("CallerReference" => CallerReference, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_cidr_collection(
CallerReference,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"POST",
"/2013-04-01/cidrcollection",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CallerReference" => CallerReference, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_health_check(caller_reference, health_check_config)
create_health_check(caller_reference, health_check_config, params::Dict{String,<:Any})
Creates a new health check. For information about adding health checks to resource record
sets, see HealthCheckId in ChangeResourceRecordSets. ELB Load Balancers If you're
registering EC2 instances with an Elastic Load Balancing (ELB) load balancer, do not create
Amazon Route 53 health checks for the EC2 instances. When you register an EC2 instance with
a load balancer, you configure settings for an ELB health check, which performs a similar
function to a Route 53 health check. Private Hosted Zones You can associate health checks
with failover resource record sets in a private hosted zone. Note the following: Route 53
health checkers are outside the VPC. To check the health of an endpoint within a VPC by IP
address, you must assign a public IP address to the instance in the VPC. You can
configure a health checker to check the health of an external resource that the instance
relies on, such as a database server. You can create a CloudWatch metric, associate an
alarm with the metric, and then create a health check that is based on the state of the
alarm. For example, you might create a CloudWatch metric that checks the status of the
Amazon EC2 StatusCheckFailed metric, add an alarm to the metric, and then create a health
check that is based on the state of the alarm. For information about creating CloudWatch
metrics and alarms by using the CloudWatch console, see the Amazon CloudWatch User Guide.
# Arguments
- `caller_reference`: A unique string that identifies the request and that allows you to
retry a failed CreateHealthCheck request without the risk of creating two identical health
checks: If you send a CreateHealthCheck request with the same CallerReference and
settings as a previous request, and if the health check doesn't exist, Amazon Route 53
creates the health check. If the health check does exist, Route 53 returns the settings for
the existing health check. If you send a CreateHealthCheck request with the same
CallerReference as a deleted health check, regardless of the settings, Route 53 returns a
HealthCheckAlreadyExists error. If you send a CreateHealthCheck request with the same
CallerReference as an existing health check but with different settings, Route 53 returns a
HealthCheckAlreadyExists error. If you send a CreateHealthCheck request with a unique
CallerReference but settings identical to an existing health check, Route 53 creates the
health check. Route 53 does not store the CallerReference for a deleted health check
indefinitely. The CallerReference for a deleted health check will be deleted after a number
of days.
- `health_check_config`: A complex type that contains settings for a new health check.
"""
function create_health_check(
CallerReference, HealthCheckConfig; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"POST",
"/2013-04-01/healthcheck",
Dict{String,Any}(
"CallerReference" => CallerReference, "HealthCheckConfig" => HealthCheckConfig
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_health_check(
CallerReference,
HealthCheckConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"POST",
"/2013-04-01/healthcheck",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CallerReference" => CallerReference,
"HealthCheckConfig" => HealthCheckConfig,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_hosted_zone(caller_reference, name)
create_hosted_zone(caller_reference, name, params::Dict{String,<:Any})
Creates a new public or private hosted zone. You create records in a public hosted zone to
define how you want to route traffic on the internet for a domain, such as example.com, and
its subdomains (apex.example.com, acme.example.com). You create records in a private hosted
zone to define how you want to route traffic for a domain and its subdomains within one or
more Amazon Virtual Private Clouds (Amazon VPCs). You can't convert a public hosted zone
to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the
same name and create new resource record sets. For more information about charges for
hosted zones, see Amazon Route 53 Pricing. Note the following: You can't create a hosted
zone for a top-level domain (TLD) such as .com. For public hosted zones, Route 53
automatically creates a default SOA record and four NS records for the zone. For more
information about SOA and NS records, see NS and SOA Records that Route 53 Creates for a
Hosted Zone in the Amazon Route 53 Developer Guide. If you want to use the same name
servers for multiple public hosted zones, you can optionally associate a reusable
delegation set with the hosted zone. See the DelegationSetId element. If your domain is
registered with a registrar other than Route 53, you must update the name servers with
your registrar to make Route 53 the DNS service for the domain. For more information, see
Migrating DNS Service for an Existing Domain to Amazon Route 53 in the Amazon Route 53
Developer Guide. When you submit a CreateHostedZone request, the initial status of the
hosted zone is PENDING. For public hosted zones, this means that the NS and SOA records are
not yet available on all Route 53 DNS servers. When the NS and SOA records are available,
the status of the zone changes to INSYNC. The CreateHostedZone request requires the caller
to have an ec2:DescribeVpcs permission. When creating private hosted zones, the Amazon VPC
must belong to the same partition where the hosted zone is created. A partition is a group
of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one
partition. The following are the supported partitions: aws - Amazon Web Services Regions
aws-cn - China Regions aws-us-gov - Amazon Web Services GovCloud (US) Region For
more information, see Access Management in the Amazon Web Services General Reference.
# Arguments
- `caller_reference`: A unique string that identifies the request and that allows failed
CreateHostedZone requests to be retried without the risk of executing the operation twice.
You must use a unique CallerReference string every time you submit a CreateHostedZone
request. CallerReference can be any unique string, for example, a date/time stamp.
- `name`: The name of the domain. Specify a fully qualified domain name, for example,
www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain
name is fully qualified. This means that Route 53 treats www.example.com (without a
trailing dot) and www.example.com. (with a trailing dot) as identical. If you're creating a
public hosted zone, this is the name you have registered with your DNS registrar. If your
domain name is registered with a registrar other than Route 53, change the name servers
for your domain to the set of NameServers that CreateHostedZone returns in DelegationSet.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DelegationSetId"`: If you want to associate a reusable delegation set with this hosted
zone, the ID that Amazon Route 53 assigned to the reusable delegation set when you created
it. For more information about reusable delegation sets, see CreateReusableDelegationSet.
If you are using a reusable delegation set to create a public hosted zone for a subdomain,
make sure that the parent hosted zone doesn't use one or more of the same name servers. If
you have overlapping nameservers, the operation will cause a ConflictingDomainsExist error.
- `"HostedZoneConfig"`: (Optional) A complex type that contains the following optional
values: For public and private hosted zones, an optional comment For private hosted
zones, an optional PrivateZone element If you don't specify a comment or the PrivateZone
element, omit HostedZoneConfig and the other elements.
- `"VPC"`: (Private hosted zones only) A complex type that contains information about the
Amazon VPC that you're associating with this hosted zone. You can specify only one Amazon
VPC when you create a private hosted zone. If you are associating a VPC with a hosted zone
with this request, the paramaters VPCId and VPCRegion are also required. To associate
additional Amazon VPCs with the hosted zone, use AssociateVPCWithHostedZone after you
create a hosted zone.
"""
function create_hosted_zone(
CallerReference, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"POST",
"/2013-04-01/hostedzone",
Dict{String,Any}("CallerReference" => CallerReference, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_hosted_zone(
CallerReference,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"POST",
"/2013-04-01/hostedzone",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CallerReference" => CallerReference, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_key_signing_key(caller_reference, hosted_zone_id, key_management_service_arn, name, status)
create_key_signing_key(caller_reference, hosted_zone_id, key_management_service_arn, name, status, params::Dict{String,<:Any})
Creates a new key-signing key (KSK) associated with a hosted zone. You can only have two
KSKs per hosted zone.
# Arguments
- `caller_reference`: A unique string that identifies the request.
- `hosted_zone_id`: The unique string (ID) used to identify a hosted zone.
- `key_management_service_arn`: The Amazon resource name (ARN) for a customer managed key
in Key Management Service (KMS). The KeyManagementServiceArn must be unique for each
key-signing key (KSK) in a single hosted zone. To see an example of KeyManagementServiceArn
that grants the correct permissions for DNSSEC, scroll down to Example. You must configure
the customer managed customer managed key as follows: Status Enabled Key spec
ECC_NIST_P256 Key usage Sign and verify Key policy The key policy must give permission
for the following actions: DescribeKey GetPublicKey Sign The key policy must also
include the Amazon Route 53 service in the principal for your account. Specify the
following: \"Service\": \"dnssec-route53.amazonaws.com\" For more information about
working with a customer managed key in KMS, see Key Management Service concepts.
- `name`: A string used to identify a key-signing key (KSK). Name can include numbers,
letters, and underscores (_). Name must be unique for each key-signing key in the same
hosted zone.
- `status`: A string specifying the initial status of the key-signing key (KSK). You can
set the value to ACTIVE or INACTIVE.
"""
function create_key_signing_key(
CallerReference,
HostedZoneId,
KeyManagementServiceArn,
Name,
Status;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"POST",
"/2013-04-01/keysigningkey",
Dict{String,Any}(
"CallerReference" => CallerReference,
"HostedZoneId" => HostedZoneId,
"KeyManagementServiceArn" => KeyManagementServiceArn,
"Name" => Name,
"Status" => Status,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_key_signing_key(
CallerReference,
HostedZoneId,
KeyManagementServiceArn,
Name,
Status,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"POST",
"/2013-04-01/keysigningkey",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CallerReference" => CallerReference,
"HostedZoneId" => HostedZoneId,
"KeyManagementServiceArn" => KeyManagementServiceArn,
"Name" => Name,
"Status" => Status,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_query_logging_config(cloud_watch_logs_log_group_arn, hosted_zone_id)
create_query_logging_config(cloud_watch_logs_log_group_arn, hosted_zone_id, params::Dict{String,<:Any})
Creates a configuration for DNS query logging. After you create a query logging
configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log
group. DNS query logs contain information about the queries that Route 53 receives for a
specified public hosted zone, such as the following: Route 53 edge location that
responded to the DNS query Domain or subdomain that was requested DNS record type, such
as A or AAAA DNS response code, such as NoError or ServFail Log Group and Resource
Policy Before you create a query logging configuration, perform the following operations.
If you create a query logging configuration using the Route 53 console, Route 53 performs
these operations automatically. Create a CloudWatch Logs log group, and make note of the
ARN, which you specify when you create a query logging configuration. Note the following:
You must create the log group in the us-east-1 region. You must use the same Amazon Web
Services account to create the log group and the hosted zone that you want to configure
query logging for. When you create log groups for query logging, we recommend that you
use a consistent prefix, for example: /aws/route53/hosted zone name In the next step,
you'll create a resource policy, which controls access to one or more log groups and the
associated Amazon Web Services resources, such as Route 53 hosted zones. There's a limit on
the number of resource policies that you can create, so we recommend that you use a
consistent prefix so you can use the same resource policy for all the log groups that you
create for query logging. Create a CloudWatch Logs resource policy, and give it the
permissions that Route 53 needs to create log streams and to send query logs to log
streams. For the value of Resource, specify the ARN for the log group that you created in
the previous step. To use the same resource policy for all the CloudWatch Logs log groups
that you created for query logging configurations, replace the hosted zone name with *, for
example: arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/* To avoid the
confused deputy problem, a security issue where an entity without a permission for an
action can coerce a more-privileged entity to perform it, you can optionally limit the
permissions that a service has to a resource in a resource-based policy by supplying the
following values: For aws:SourceArn, supply the hosted zone ARN used in creating the
query logging configuration. For example, aws:SourceArn:
arn:aws:route53:::hostedzone/hosted zone ID. For aws:SourceAccount, supply the account ID
for the account that creates the query logging configuration. For example,
aws:SourceAccount:111111111111. For more information, see The confused deputy problem in
the Amazon Web Services IAM User Guide. You can't use the CloudWatch console to create or
edit a resource policy. You must use the CloudWatch API, one of the Amazon Web Services
SDKs, or the CLI. Log Streams and Edge Locations When Route 53 finishes creating the
configuration for DNS query logging, it does the following: Creates a log stream for an
edge location the first time that the edge location responds to DNS queries for the
specified hosted zone. That log stream is used to log all queries that Route 53 responds to
for that edge location. Begins to send query logs to the applicable log stream. The
name of each log stream is in the following format: hosted zone ID/edge location code
The edge location code is a three-letter code and an arbitrarily assigned number, for
example, DFW3. The three-letter code typically corresponds with the International Air
Transport Association airport code for an airport near the edge location. (These
abbreviations might change in the future.) For a list of edge locations, see \"The Route 53
Global Network\" on the Route 53 Product Details page. Queries That Are Logged Query logs
contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has
already cached the response to a query (such as the IP address for a load balancer for
example.com), the resolver will continue to return the cached response. It doesn't forward
another query to Route 53 until the TTL for the corresponding resource record set expires.
Depending on how many DNS queries are submitted for a resource record set, and depending on
the TTL for that resource record set, query logs might contain information about only one
query out of every several thousand queries that are submitted to DNS. For more information
about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the
Amazon Route 53 Developer Guide. Log File Format For a list of the values in each query
log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer
Guide. Pricing For information about charges for query logs, see Amazon CloudWatch
Pricing. How to Stop Logging If you want Route 53 to stop sending query logs to
CloudWatch Logs, delete the query logging configuration. For more information, see
DeleteQueryLoggingConfig.
# Arguments
- `cloud_watch_logs_log_group_arn`: The Amazon Resource Name (ARN) for the log group that
you want to Amazon Route 53 to send query logs to. This is the format of the ARN:
arn:aws:logs:region:account-id:log-group:log_group_name To get the ARN for a log group,
you can use the CloudWatch console, the DescribeLogGroups API action, the
describe-log-groups command, or the applicable command in one of the Amazon Web Services
SDKs.
- `hosted_zone_id`: The ID of the hosted zone that you want to log queries for. You can log
queries only for public hosted zones.
"""
function create_query_logging_config(
CloudWatchLogsLogGroupArn,
HostedZoneId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"POST",
"/2013-04-01/queryloggingconfig",
Dict{String,Any}(
"CloudWatchLogsLogGroupArn" => CloudWatchLogsLogGroupArn,
"HostedZoneId" => HostedZoneId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_query_logging_config(
CloudWatchLogsLogGroupArn,
HostedZoneId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"POST",
"/2013-04-01/queryloggingconfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CloudWatchLogsLogGroupArn" => CloudWatchLogsLogGroupArn,
"HostedZoneId" => HostedZoneId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_reusable_delegation_set(caller_reference)
create_reusable_delegation_set(caller_reference, params::Dict{String,<:Any})
Creates a delegation set (a group of four name servers) that can be reused by multiple
hosted zones that were created by the same Amazon Web Services account. You can also
create a reusable delegation set that uses the four name servers that are associated with
an existing hosted zone. Specify the hosted zone ID in the CreateReusableDelegationSet
request. You can't associate a reusable delegation set with a private hosted zone. For
information about using a reusable delegation set to configure white label name servers,
see Configuring White Label Name Servers. The process for migrating existing hosted zones
to use a reusable delegation set is comparable to the process for configuring white label
name servers. You need to perform the following steps: Create a reusable delegation set.
Recreate hosted zones, and reduce the TTL to 60 seconds or less. Recreate resource
record sets in the new hosted zones. Change the registrar's name servers to use the name
servers for the new hosted zones. Monitor traffic for the website or application.
Change TTLs back to their original values. If you want to migrate existing hosted zones
to use a reusable delegation set, the existing hosted zones can't use any of the name
servers that are assigned to the reusable delegation set. If one or more hosted zones do
use one or more name servers that are assigned to the reusable delegation set, you can do
one of the following: For small numbers of hosted zones—up to a few hundred—it's
relatively easy to create reusable delegation sets until you get one that has four name
servers that don't overlap with any of the name servers in your hosted zones. For larger
numbers of hosted zones, the easiest solution is to use more than one reusable delegation
set. For larger numbers of hosted zones, you can also migrate hosted zones that have
overlapping name servers to hosted zones that don't have overlapping name servers, then
migrate the hosted zones again to use the reusable delegation set.
# Arguments
- `caller_reference`: A unique string that identifies the request, and that allows you to
retry failed CreateReusableDelegationSet requests without the risk of executing the
operation twice. You must use a unique CallerReference string every time you submit a
CreateReusableDelegationSet request. CallerReference can be any unique string, for example
a date/time stamp.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"HostedZoneId"`: If you want to mark the delegation set for an existing hosted zone as
reusable, the ID for that hosted zone.
"""
function create_reusable_delegation_set(
CallerReference; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"POST",
"/2013-04-01/delegationset",
Dict{String,Any}("CallerReference" => CallerReference);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_reusable_delegation_set(
CallerReference,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"POST",
"/2013-04-01/delegationset",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("CallerReference" => CallerReference), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_traffic_policy(document, name)
create_traffic_policy(document, name, params::Dict{String,<:Any})
Creates a traffic policy, which you use to create multiple DNS resource record sets for one
domain name (such as example.com) or one subdomain name (such as www.example.com).
# Arguments
- `document`: The definition of this traffic policy in JSON format. For more information,
see Traffic Policy Document Format.
- `name`: The name of the traffic policy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Comment"`: (Optional) Any comments that you want to include about the traffic policy.
"""
function create_traffic_policy(
Document, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"POST",
"/2013-04-01/trafficpolicy",
Dict{String,Any}("Document" => Document, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_traffic_policy(
Document,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"POST",
"/2013-04-01/trafficpolicy",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Document" => Document, "Name" => Name), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_traffic_policy_instance(hosted_zone_id, name, ttl, traffic_policy_id, traffic_policy_version)
create_traffic_policy_instance(hosted_zone_id, name, ttl, traffic_policy_id, traffic_policy_version, params::Dict{String,<:Any})
Creates resource record sets in a specified hosted zone based on the settings in a
specified traffic policy version. In addition, CreateTrafficPolicyInstance associates the
resource record sets with a specified domain name (such as example.com) or subdomain name
(such as www.example.com). Amazon Route 53 responds to DNS queries for the domain or
subdomain name by using the resource record sets that CreateTrafficPolicyInstance created.
After you submit an CreateTrafficPolicyInstance request, there's a brief delay while Amazon
Route 53 creates the resource record sets that are specified in the traffic policy
definition. Use GetTrafficPolicyInstance with the id of new traffic policy instance to
confirm that the CreateTrafficPolicyInstance request completed successfully. For more
information, see the State response element.
# Arguments
- `hosted_zone_id`: The ID of the hosted zone that you want Amazon Route 53 to create
resource record sets in by using the configuration in a traffic policy.
- `name`: The domain name (such as example.com) or subdomain name (such as www.example.com)
for which Amazon Route 53 responds to DNS queries by using the resource record sets that
Route 53 creates for this traffic policy instance.
- `ttl`: (Optional) The TTL that you want Amazon Route 53 to assign to all of the resource
record sets that it creates in the specified hosted zone.
- `traffic_policy_id`: The ID of the traffic policy that you want to use to create resource
record sets in the specified hosted zone.
- `traffic_policy_version`: The version of the traffic policy that you want to use to
create resource record sets in the specified hosted zone.
"""
function create_traffic_policy_instance(
HostedZoneId,
Name,
TTL,
TrafficPolicyId,
TrafficPolicyVersion;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"POST",
"/2013-04-01/trafficpolicyinstance",
Dict{String,Any}(
"HostedZoneId" => HostedZoneId,
"Name" => Name,
"TTL" => TTL,
"TrafficPolicyId" => TrafficPolicyId,
"TrafficPolicyVersion" => TrafficPolicyVersion,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_traffic_policy_instance(
HostedZoneId,
Name,
TTL,
TrafficPolicyId,
TrafficPolicyVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"POST",
"/2013-04-01/trafficpolicyinstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"HostedZoneId" => HostedZoneId,
"Name" => Name,
"TTL" => TTL,
"TrafficPolicyId" => TrafficPolicyId,
"TrafficPolicyVersion" => TrafficPolicyVersion,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_traffic_policy_version(document, id)
create_traffic_policy_version(document, id, params::Dict{String,<:Any})
Creates a new version of an existing traffic policy. When you create a new version of a
traffic policy, you specify the ID of the traffic policy that you want to update and a
JSON-formatted document that describes the new version. You use traffic policies to create
multiple DNS resource record sets for one domain name (such as example.com) or one
subdomain name (such as www.example.com). You can create a maximum of 1000 versions of a
traffic policy. If you reach the limit and need to create another version, you'll need to
start a new traffic policy.
# Arguments
- `document`: The definition of this version of the traffic policy, in JSON format. You
specified the JSON in the CreateTrafficPolicyVersion request. For more information about
the JSON format, see CreateTrafficPolicy.
- `id`: The ID of the traffic policy for which you want to create a new version.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Comment"`: The comment that you specified in the CreateTrafficPolicyVersion request, if
any.
"""
function create_traffic_policy_version(
Document, Id; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"POST",
"/2013-04-01/trafficpolicy/$(Id)",
Dict{String,Any}("Document" => Document);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_traffic_policy_version(
Document,
Id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"POST",
"/2013-04-01/trafficpolicy/$(Id)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Document" => Document), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_vpcassociation_authorization(id, vpc)
create_vpcassociation_authorization(id, vpc, params::Dict{String,<:Any})
Authorizes the Amazon Web Services account that created a specified VPC to submit an
AssociateVPCWithHostedZone request to associate the VPC with a specified hosted zone that
was created by a different account. To submit a CreateVPCAssociationAuthorization request,
you must use the account that created the hosted zone. After you authorize the association,
use the account that created the VPC to submit an AssociateVPCWithHostedZone request. If
you want to associate multiple VPCs that you created by using one account with a hosted
zone that you created by using a different account, you must submit one authorization
request for each VPC.
# Arguments
- `id`: The ID of the private hosted zone that you want to authorize associating a VPC with.
- `vpc`: A complex type that contains the VPC ID and region for the VPC that you want to
authorize associating with your hosted zone.
"""
function create_vpcassociation_authorization(
Id, VPC; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"POST",
"/2013-04-01/hostedzone/$(Id)/authorizevpcassociation",
Dict{String,Any}("VPC" => VPC);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_vpcassociation_authorization(
Id, VPC, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"POST",
"/2013-04-01/hostedzone/$(Id)/authorizevpcassociation",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("VPC" => VPC), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deactivate_key_signing_key(hosted_zone_id, name)
deactivate_key_signing_key(hosted_zone_id, name, params::Dict{String,<:Any})
Deactivates a key-signing key (KSK) so that it will not be used for signing by DNSSEC. This
operation changes the KSK status to INACTIVE.
# Arguments
- `hosted_zone_id`: A unique string used to identify a hosted zone.
- `name`: A string used to identify a key-signing key (KSK).
"""
function deactivate_key_signing_key(
HostedZoneId, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"POST",
"/2013-04-01/keysigningkey/$(HostedZoneId)/$(Name)/deactivate";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deactivate_key_signing_key(
HostedZoneId,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"POST",
"/2013-04-01/keysigningkey/$(HostedZoneId)/$(Name)/deactivate",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_cidr_collection(cidr_collection_id)
delete_cidr_collection(cidr_collection_id, params::Dict{String,<:Any})
Deletes a CIDR collection in the current Amazon Web Services account. The collection must
be empty before it can be deleted.
# Arguments
- `cidr_collection_id`: The UUID of the collection to delete.
"""
function delete_cidr_collection(
CidrCollectionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"DELETE",
"/2013-04-01/cidrcollection/$(CidrCollectionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_cidr_collection(
CidrCollectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"DELETE",
"/2013-04-01/cidrcollection/$(CidrCollectionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_health_check(health_check_id)
delete_health_check(health_check_id, params::Dict{String,<:Any})
Deletes a health check. Amazon Route 53 does not prevent you from deleting a health check
even if the health check is associated with one or more resource record sets. If you delete
a health check and you don't update the associated resource record sets, the future status
of the health check can't be predicted and may change. This will affect the routing of DNS
queries for your DNS failover configuration. For more information, see Replacing and
Deleting Health Checks in the Amazon Route 53 Developer Guide. If you're using Cloud Map
and you configured Cloud Map to create a Route 53 health check when you register an
instance, you can't use the Route 53 DeleteHealthCheck command to delete the health check.
The health check is deleted automatically when you deregister the instance; there can be a
delay of several hours before the health check is deleted from Route 53.
# Arguments
- `health_check_id`: The ID of the health check that you want to delete.
"""
function delete_health_check(
HealthCheckId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"DELETE",
"/2013-04-01/healthcheck/$(HealthCheckId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_health_check(
HealthCheckId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"DELETE",
"/2013-04-01/healthcheck/$(HealthCheckId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_hosted_zone(id)
delete_hosted_zone(id, params::Dict{String,<:Any})
Deletes a hosted zone. If the hosted zone was created by another service, such as Cloud
Map, see Deleting Public Hosted Zones That Were Created by Another Service in the Amazon
Route 53 Developer Guide for information about how to delete it. (The process is the same
for public and private hosted zones that were created by another service.) If you want to
keep your domain registration but you want to stop routing internet traffic to your website
or web application, we recommend that you delete resource record sets in the hosted zone
instead of deleting the hosted zone. If you delete a hosted zone, you can't undelete it.
You must create a new hosted zone and update the name servers for your domain registration,
which can require up to 48 hours to take effect. (If you delegated responsibility for a
subdomain to a hosted zone and you delete the child hosted zone, you must update the name
servers in the parent hosted zone.) In addition, if you delete a hosted zone, someone could
hijack the domain and route traffic to their own resources using your domain name. If you
want to avoid the monthly charge for the hosted zone, you can transfer DNS service for the
domain to a free DNS service. When you transfer DNS service, you have to update the name
servers for the domain registration. If the domain is registered with Route 53, see
UpdateDomainNameservers for information about how to replace Route 53 name servers with
name servers for the new DNS service. If the domain is registered with another registrar,
use the method provided by the registrar to update name servers for the domain
registration. For more information, perform an internet search on \"free DNS service.\" You
can delete a hosted zone only if it contains only the default SOA record and NS resource
record sets. If the hosted zone contains other resource record sets, you must delete them
before you can delete the hosted zone. If you try to delete a hosted zone that contains
other resource record sets, the request fails, and Route 53 returns a HostedZoneNotEmpty
error. For information about deleting records from your hosted zone, see
ChangeResourceRecordSets. To verify that the hosted zone has been deleted, do one of the
following: Use the GetHostedZone action to request information about the hosted zone.
Use the ListHostedZones action to get a list of the hosted zones associated with the
current Amazon Web Services account.
# Arguments
- `id`: The ID of the hosted zone you want to delete.
"""
function delete_hosted_zone(Id; aws_config::AbstractAWSConfig=global_aws_config())
return route_53(
"DELETE",
"/2013-04-01/hostedzone/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_hosted_zone(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"DELETE",
"/2013-04-01/hostedzone/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_key_signing_key(hosted_zone_id, name)
delete_key_signing_key(hosted_zone_id, name, params::Dict{String,<:Any})
Deletes a key-signing key (KSK). Before you can delete a KSK, you must deactivate it. The
KSK must be deactivated before you can delete it regardless of whether the hosted zone is
enabled for DNSSEC signing. You can use DeactivateKeySigningKey to deactivate the key
before you delete it. Use GetDNSSEC to verify that the KSK is in an INACTIVE status.
# Arguments
- `hosted_zone_id`: A unique string used to identify a hosted zone.
- `name`: A string used to identify a key-signing key (KSK).
"""
function delete_key_signing_key(
HostedZoneId, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"DELETE",
"/2013-04-01/keysigningkey/$(HostedZoneId)/$(Name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_key_signing_key(
HostedZoneId,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"DELETE",
"/2013-04-01/keysigningkey/$(HostedZoneId)/$(Name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_query_logging_config(id)
delete_query_logging_config(id, params::Dict{String,<:Any})
Deletes a configuration for DNS query logging. If you delete a configuration, Amazon Route
53 stops sending query logs to CloudWatch Logs. Route 53 doesn't delete any logs that are
already in CloudWatch Logs. For more information about DNS query logs, see
CreateQueryLoggingConfig.
# Arguments
- `id`: The ID of the configuration that you want to delete.
"""
function delete_query_logging_config(Id; aws_config::AbstractAWSConfig=global_aws_config())
return route_53(
"DELETE",
"/2013-04-01/queryloggingconfig/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_query_logging_config(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"DELETE",
"/2013-04-01/queryloggingconfig/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_reusable_delegation_set(id)
delete_reusable_delegation_set(id, params::Dict{String,<:Any})
Deletes a reusable delegation set. You can delete a reusable delegation set only if it
isn't associated with any hosted zones. To verify that the reusable delegation set is not
associated with any hosted zones, submit a GetReusableDelegationSet request and specify the
ID of the reusable delegation set that you want to delete.
# Arguments
- `id`: The ID of the reusable delegation set that you want to delete.
"""
function delete_reusable_delegation_set(
Id; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"DELETE",
"/2013-04-01/delegationset/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_reusable_delegation_set(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"DELETE",
"/2013-04-01/delegationset/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_traffic_policy(id, version)
delete_traffic_policy(id, version, params::Dict{String,<:Any})
Deletes a traffic policy. When you delete a traffic policy, Route 53 sets a flag on the
policy to indicate that it has been deleted. However, Route 53 never fully deletes the
traffic policy. Note the following: Deleted traffic policies aren't listed if you run
ListTrafficPolicies. There's no way to get a list of deleted policies. If you retain
the ID of the policy, you can get information about the policy, including the traffic
policy document, by running GetTrafficPolicy.
# Arguments
- `id`: The ID of the traffic policy that you want to delete.
- `version`: The version number of the traffic policy that you want to delete.
"""
function delete_traffic_policy(
Id, Version; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"DELETE",
"/2013-04-01/trafficpolicy/$(Id)/$(Version)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_traffic_policy(
Id,
Version,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"DELETE",
"/2013-04-01/trafficpolicy/$(Id)/$(Version)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_traffic_policy_instance(id)
delete_traffic_policy_instance(id, params::Dict{String,<:Any})
Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53
created when you created the instance. In the Route 53 console, traffic policy instances
are known as policy records.
# Arguments
- `id`: The ID of the traffic policy instance that you want to delete. When you delete a
traffic policy instance, Amazon Route 53 also deletes all of the resource record sets that
were created when you created the traffic policy instance.
"""
function delete_traffic_policy_instance(
Id; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"DELETE",
"/2013-04-01/trafficpolicyinstance/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_traffic_policy_instance(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"DELETE",
"/2013-04-01/trafficpolicyinstance/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_vpcassociation_authorization(id, vpc)
delete_vpcassociation_authorization(id, vpc, params::Dict{String,<:Any})
Removes authorization to submit an AssociateVPCWithHostedZone request to associate a
specified VPC with a hosted zone that was created by a different account. You must use the
account that created the hosted zone to submit a DeleteVPCAssociationAuthorization request.
Sending this request only prevents the Amazon Web Services account that created the VPC
from associating the VPC with the Amazon Route 53 hosted zone in the future. If the VPC is
already associated with the hosted zone, DeleteVPCAssociationAuthorization won't
disassociate the VPC from the hosted zone. If you want to delete an existing association,
use DisassociateVPCFromHostedZone.
# Arguments
- `id`: When removing authorization to associate a VPC that was created by one Amazon Web
Services account with a hosted zone that was created with a different Amazon Web Services
account, the ID of the hosted zone.
- `vpc`: When removing authorization to associate a VPC that was created by one Amazon Web
Services account with a hosted zone that was created with a different Amazon Web Services
account, a complex type that includes the ID and region of the VPC.
"""
function delete_vpcassociation_authorization(
Id, VPC; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"POST",
"/2013-04-01/hostedzone/$(Id)/deauthorizevpcassociation",
Dict{String,Any}("VPC" => VPC);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_vpcassociation_authorization(
Id, VPC, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"POST",
"/2013-04-01/hostedzone/$(Id)/deauthorizevpcassociation",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("VPC" => VPC), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_hosted_zone_dnssec(id)
disable_hosted_zone_dnssec(id, params::Dict{String,<:Any})
Disables DNSSEC signing in a specific hosted zone. This action does not deactivate any
key-signing keys (KSKs) that are active in the hosted zone.
# Arguments
- `id`: A unique string used to identify a hosted zone.
"""
function disable_hosted_zone_dnssec(Id; aws_config::AbstractAWSConfig=global_aws_config())
return route_53(
"POST",
"/2013-04-01/hostedzone/$(Id)/disable-dnssec";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_hosted_zone_dnssec(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"POST",
"/2013-04-01/hostedzone/$(Id)/disable-dnssec",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_vpcfrom_hosted_zone(id, vpc)
disassociate_vpcfrom_hosted_zone(id, vpc, params::Dict{String,<:Any})
Disassociates an Amazon Virtual Private Cloud (Amazon VPC) from an Amazon Route 53 private
hosted zone. Note the following: You can't disassociate the last Amazon VPC from a
private hosted zone. You can't convert a private hosted zone into a public hosted zone.
You can submit a DisassociateVPCFromHostedZone request using either the account that
created the hosted zone or the account that created the Amazon VPC. Some services, such
as Cloud Map and Amazon Elastic File System (Amazon EFS) automatically create hosted zones
and associate VPCs with the hosted zones. A service can create a hosted zone using your
account or using its own account. You can disassociate a VPC from a hosted zone only if the
service created the hosted zone using your account. When you run
DisassociateVPCFromHostedZone, if the hosted zone has a value for OwningAccount, you can
use DisassociateVPCFromHostedZone. If the hosted zone has a value for OwningService, you
can't use DisassociateVPCFromHostedZone. When revoking access, the hosted zone and the
Amazon VPC must belong to the same partition. A partition is a group of Amazon Web Services
Regions. Each Amazon Web Services account is scoped to one partition. The following are the
supported partitions: aws - Amazon Web Services Regions aws-cn - China Regions
aws-us-gov - Amazon Web Services GovCloud (US) Region For more information, see Access
Management in the Amazon Web Services General Reference.
# Arguments
- `id`: The ID of the private hosted zone that you want to disassociate a VPC from.
- `vpc`: A complex type that contains information about the VPC that you're disassociating
from the specified hosted zone.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Comment"`: Optional: A comment about the disassociation request.
"""
function disassociate_vpcfrom_hosted_zone(
Id, VPC; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"POST",
"/2013-04-01/hostedzone/$(Id)/disassociatevpc",
Dict{String,Any}("VPC" => VPC);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_vpcfrom_hosted_zone(
Id, VPC, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"POST",
"/2013-04-01/hostedzone/$(Id)/disassociatevpc",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("VPC" => VPC), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_hosted_zone_dnssec(id)
enable_hosted_zone_dnssec(id, params::Dict{String,<:Any})
Enables DNSSEC signing in a specific hosted zone.
# Arguments
- `id`: A unique string used to identify a hosted zone.
"""
function enable_hosted_zone_dnssec(Id; aws_config::AbstractAWSConfig=global_aws_config())
return route_53(
"POST",
"/2013-04-01/hostedzone/$(Id)/enable-dnssec";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_hosted_zone_dnssec(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"POST",
"/2013-04-01/hostedzone/$(Id)/enable-dnssec",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_account_limit(type)
get_account_limit(type, params::Dict{String,<:Any})
Gets the specified limit for the current account, for example, the maximum number of health
checks that you can create using the account. For the default limit, see Limits in the
Amazon Route 53 Developer Guide. To request a higher limit, open a case. You can also view
account limits in Amazon Web Services Trusted Advisor. Sign in to the Amazon Web Services
Management Console and open the Trusted Advisor console at
https://console.aws.amazon.com/trustedadvisor/. Then choose Service limits in the
navigation pane.
# Arguments
- `type`: The limit that you want to get. Valid values include the following:
MAX_HEALTH_CHECKS_BY_OWNER: The maximum number of health checks that you can create using
the current account. MAX_HOSTED_ZONES_BY_OWNER: The maximum number of hosted zones that
you can create using the current account. MAX_REUSABLE_DELEGATION_SETS_BY_OWNER: The
maximum number of reusable delegation sets that you can create using the current account.
MAX_TRAFFIC_POLICIES_BY_OWNER: The maximum number of traffic policies that you can create
using the current account. MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER: The maximum number of
traffic policy instances that you can create using the current account. (Traffic policy
instances are referred to as traffic flow policy records in the Amazon Route 53 console.)
"""
function get_account_limit(Type; aws_config::AbstractAWSConfig=global_aws_config())
return route_53(
"GET",
"/2013-04-01/accountlimit/$(Type)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_account_limit(
Type, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/accountlimit/$(Type)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_change(id)
get_change(id, params::Dict{String,<:Any})
Returns the current status of a change batch request. The status is one of the following
values: PENDING indicates that the changes in this request have not propagated to all
Amazon Route 53 DNS servers managing the hosted zone. This is the initial status of all
change batch requests. INSYNC indicates that the changes have propagated to all Route 53
DNS servers managing the hosted zone.
# Arguments
- `id`: The ID of the change batch request. The value that you specify here is the value
that ChangeResourceRecordSets returned in the Id element when you submitted the request.
"""
function get_change(Id; aws_config::AbstractAWSConfig=global_aws_config())
return route_53(
"GET",
"/2013-04-01/change/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_change(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/change/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_checker_ip_ranges()
get_checker_ip_ranges(params::Dict{String,<:Any})
Route 53 does not perform authorization for this API because it retrieves information that
is already available to the public. GetCheckerIpRanges still works, but we recommend that
you download ip-ranges.json, which includes IP address ranges for all Amazon Web Services
services. For more information, see IP Address Ranges of Amazon Route 53 Servers in the
Amazon Route 53 Developer Guide.
"""
function get_checker_ip_ranges(; aws_config::AbstractAWSConfig=global_aws_config())
return route_53(
"GET",
"/2013-04-01/checkeripranges";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_checker_ip_ranges(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/checkeripranges",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_dnssec(id)
get_dnssec(id, params::Dict{String,<:Any})
Returns information about DNSSEC for a specific hosted zone, including the key-signing keys
(KSKs) in the hosted zone.
# Arguments
- `id`: A unique string used to identify a hosted zone.
"""
function get_dnssec(Id; aws_config::AbstractAWSConfig=global_aws_config())
return route_53(
"GET",
"/2013-04-01/hostedzone/$(Id)/dnssec";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_dnssec(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/hostedzone/$(Id)/dnssec",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_geo_location()
get_geo_location(params::Dict{String,<:Any})
Gets information about whether a specified geographic location is supported for Amazon
Route 53 geolocation resource record sets. Route 53 does not perform authorization for this
API because it retrieves information that is already available to the public. Use the
following syntax to determine whether a continent is supported for geolocation: GET
/2013-04-01/geolocation?continentcode=two-letter abbreviation for a continent Use the
following syntax to determine whether a country is supported for geolocation: GET
/2013-04-01/geolocation?countrycode=two-character country code Use the following syntax
to determine whether a subdivision of a country is supported for geolocation: GET
/2013-04-01/geolocation?countrycode=two-character country
code&subdivisioncode=subdivision code
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"continentcode"`: For geolocation resource record sets, a two-letter abbreviation that
identifies a continent. Amazon Route 53 supports the following continent codes: AF:
Africa AN: Antarctica AS: Asia EU: Europe OC: Oceania NA: North America
SA: South America
- `"countrycode"`: Amazon Route 53 uses the two-letter country codes that are specified in
ISO standard 3166-1 alpha-2. Route 53 also supports the country code UA for Ukraine.
- `"subdivisioncode"`: The code for the subdivision, such as a particular state within the
United States. For a list of US state abbreviations, see Appendix B: Two–Letter State and
Possession Abbreviations on the United States Postal Service website. For a list of all
supported subdivision codes, use the ListGeoLocations API.
"""
function get_geo_location(; aws_config::AbstractAWSConfig=global_aws_config())
return route_53(
"GET",
"/2013-04-01/geolocation";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_geo_location(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/geolocation",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_health_check(health_check_id)
get_health_check(health_check_id, params::Dict{String,<:Any})
Gets information about a specified health check.
# Arguments
- `health_check_id`: The identifier that Amazon Route 53 assigned to the health check when
you created it. When you add or update a resource record set, you use this value to specify
which health check to use. The value can be up to 64 characters long.
"""
function get_health_check(HealthCheckId; aws_config::AbstractAWSConfig=global_aws_config())
return route_53(
"GET",
"/2013-04-01/healthcheck/$(HealthCheckId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_health_check(
HealthCheckId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"GET",
"/2013-04-01/healthcheck/$(HealthCheckId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_health_check_count()
get_health_check_count(params::Dict{String,<:Any})
Retrieves the number of health checks that are associated with the current Amazon Web
Services account.
"""
function get_health_check_count(; aws_config::AbstractAWSConfig=global_aws_config())
return route_53(
"GET",
"/2013-04-01/healthcheckcount";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_health_check_count(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/healthcheckcount",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_health_check_last_failure_reason(health_check_id)
get_health_check_last_failure_reason(health_check_id, params::Dict{String,<:Any})
Gets the reason that a specified health check failed most recently.
# Arguments
- `health_check_id`: The ID for the health check for which you want the last failure
reason. When you created the health check, CreateHealthCheck returned the ID in the
response, in the HealthCheckId element. If you want to get the last failure reason for a
calculated health check, you must use the Amazon Route 53 console or the CloudWatch
console. You can't use GetHealthCheckLastFailureReason for a calculated health check.
"""
function get_health_check_last_failure_reason(
HealthCheckId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/healthcheck/$(HealthCheckId)/lastfailurereason";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_health_check_last_failure_reason(
HealthCheckId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"GET",
"/2013-04-01/healthcheck/$(HealthCheckId)/lastfailurereason",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_health_check_status(health_check_id)
get_health_check_status(health_check_id, params::Dict{String,<:Any})
Gets status of a specified health check. This API is intended for use during development
to diagnose behavior. It doesn’t support production use-cases with high query rates that
require immediate and actionable responses.
# Arguments
- `health_check_id`: The ID for the health check that you want the current status for. When
you created the health check, CreateHealthCheck returned the ID in the response, in the
HealthCheckId element. If you want to check the status of a calculated health check, you
must use the Amazon Route 53 console or the CloudWatch console. You can't use
GetHealthCheckStatus to get the status of a calculated health check.
"""
function get_health_check_status(
HealthCheckId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/healthcheck/$(HealthCheckId)/status";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_health_check_status(
HealthCheckId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"GET",
"/2013-04-01/healthcheck/$(HealthCheckId)/status",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_hosted_zone(id)
get_hosted_zone(id, params::Dict{String,<:Any})
Gets information about a specified hosted zone including the four name servers assigned to
the hosted zone.
# Arguments
- `id`: The ID of the hosted zone that you want to get information about.
"""
function get_hosted_zone(Id; aws_config::AbstractAWSConfig=global_aws_config())
return route_53(
"GET",
"/2013-04-01/hostedzone/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_hosted_zone(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/hostedzone/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_hosted_zone_count()
get_hosted_zone_count(params::Dict{String,<:Any})
Retrieves the number of hosted zones that are associated with the current Amazon Web
Services account.
"""
function get_hosted_zone_count(; aws_config::AbstractAWSConfig=global_aws_config())
return route_53(
"GET",
"/2013-04-01/hostedzonecount";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_hosted_zone_count(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/hostedzonecount",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_hosted_zone_limit(id, type)
get_hosted_zone_limit(id, type, params::Dict{String,<:Any})
Gets the specified limit for a specified hosted zone, for example, the maximum number of
records that you can create in the hosted zone. For the default limit, see Limits in the
Amazon Route 53 Developer Guide. To request a higher limit, open a case.
# Arguments
- `id`: The ID of the hosted zone that you want to get a limit for.
- `type`: The limit that you want to get. Valid values include the following:
MAX_RRSETS_BY_ZONE: The maximum number of records that you can create in the specified
hosted zone. MAX_VPCS_ASSOCIATED_BY_ZONE: The maximum number of Amazon VPCs that you can
associate with the specified private hosted zone.
"""
function get_hosted_zone_limit(Id, Type; aws_config::AbstractAWSConfig=global_aws_config())
return route_53(
"GET",
"/2013-04-01/hostedzonelimit/$(Id)/$(Type)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_hosted_zone_limit(
Id,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"GET",
"/2013-04-01/hostedzonelimit/$(Id)/$(Type)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_query_logging_config(id)
get_query_logging_config(id, params::Dict{String,<:Any})
Gets information about a specified configuration for DNS query logging. For more
information about DNS query logs, see CreateQueryLoggingConfig and Logging DNS Queries.
# Arguments
- `id`: The ID of the configuration for DNS query logging that you want to get information
about.
"""
function get_query_logging_config(Id; aws_config::AbstractAWSConfig=global_aws_config())
return route_53(
"GET",
"/2013-04-01/queryloggingconfig/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_query_logging_config(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/queryloggingconfig/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_reusable_delegation_set(id)
get_reusable_delegation_set(id, params::Dict{String,<:Any})
Retrieves information about a specified reusable delegation set, including the four name
servers that are assigned to the delegation set.
# Arguments
- `id`: The ID of the reusable delegation set that you want to get a list of name servers
for.
"""
function get_reusable_delegation_set(Id; aws_config::AbstractAWSConfig=global_aws_config())
return route_53(
"GET",
"/2013-04-01/delegationset/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_reusable_delegation_set(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/delegationset/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_reusable_delegation_set_limit(id, type)
get_reusable_delegation_set_limit(id, type, params::Dict{String,<:Any})
Gets the maximum number of hosted zones that you can associate with the specified reusable
delegation set. For the default limit, see Limits in the Amazon Route 53 Developer Guide.
To request a higher limit, open a case.
# Arguments
- `id`: The ID of the delegation set that you want to get the limit for.
- `type`: Specify MAX_ZONES_BY_REUSABLE_DELEGATION_SET to get the maximum number of hosted
zones that you can associate with the specified reusable delegation set.
"""
function get_reusable_delegation_set_limit(
Id, Type; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/reusabledelegationsetlimit/$(Id)/$(Type)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_reusable_delegation_set_limit(
Id,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"GET",
"/2013-04-01/reusabledelegationsetlimit/$(Id)/$(Type)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_traffic_policy(id, version)
get_traffic_policy(id, version, params::Dict{String,<:Any})
Gets information about a specific traffic policy version. For information about how of
deleting a traffic policy affects the response from GetTrafficPolicy, see
DeleteTrafficPolicy.
# Arguments
- `id`: The ID of the traffic policy that you want to get information about.
- `version`: The version number of the traffic policy that you want to get information
about.
"""
function get_traffic_policy(Id, Version; aws_config::AbstractAWSConfig=global_aws_config())
return route_53(
"GET",
"/2013-04-01/trafficpolicy/$(Id)/$(Version)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_traffic_policy(
Id,
Version,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"GET",
"/2013-04-01/trafficpolicy/$(Id)/$(Version)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_traffic_policy_instance(id)
get_traffic_policy_instance(id, params::Dict{String,<:Any})
Gets information about a specified traffic policy instance. Use GetTrafficPolicyInstance
with the id of new traffic policy instance to confirm that the CreateTrafficPolicyInstance
or an UpdateTrafficPolicyInstance request completed successfully. For more information, see
the State response element. In the Route 53 console, traffic policy instances are known
as policy records.
# Arguments
- `id`: The ID of the traffic policy instance that you want to get information about.
"""
function get_traffic_policy_instance(Id; aws_config::AbstractAWSConfig=global_aws_config())
return route_53(
"GET",
"/2013-04-01/trafficpolicyinstance/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_traffic_policy_instance(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/trafficpolicyinstance/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_traffic_policy_instance_count()
get_traffic_policy_instance_count(params::Dict{String,<:Any})
Gets the number of traffic policy instances that are associated with the current Amazon Web
Services account.
"""
function get_traffic_policy_instance_count(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/trafficpolicyinstancecount";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_traffic_policy_instance_count(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/trafficpolicyinstancecount",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_cidr_blocks(cidr_collection_id)
list_cidr_blocks(cidr_collection_id, params::Dict{String,<:Any})
Returns a paginated list of location objects and their CIDR blocks.
# Arguments
- `cidr_collection_id`: The UUID of the CIDR collection.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"location"`: The name of the CIDR collection location.
- `"maxresults"`: Maximum number of results you want returned.
- `"nexttoken"`: An opaque pagination token to indicate where the service is to begin
enumerating results.
"""
function list_cidr_blocks(
CidrCollectionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/cidrcollection/$(CidrCollectionId)/cidrblocks";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_cidr_blocks(
CidrCollectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"GET",
"/2013-04-01/cidrcollection/$(CidrCollectionId)/cidrblocks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_cidr_collections()
list_cidr_collections(params::Dict{String,<:Any})
Returns a paginated list of CIDR collections in the Amazon Web Services account (metadata
only).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxresults"`: The maximum number of CIDR collections to return in the response.
- `"nexttoken"`: An opaque pagination token to indicate where the service is to begin
enumerating results. If no value is provided, the listing of results starts from the
beginning.
"""
function list_cidr_collections(; aws_config::AbstractAWSConfig=global_aws_config())
return route_53(
"GET",
"/2013-04-01/cidrcollection";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_cidr_collections(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/cidrcollection",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_cidr_locations(cidr_collection_id)
list_cidr_locations(cidr_collection_id, params::Dict{String,<:Any})
Returns a paginated list of CIDR locations for the given collection (metadata only, does
not include CIDR blocks).
# Arguments
- `cidr_collection_id`: The CIDR collection ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxresults"`: The maximum number of CIDR collection locations to return in the response.
- `"nexttoken"`: An opaque pagination token to indicate where the service is to begin
enumerating results. If no value is provided, the listing of results starts from the
beginning.
"""
function list_cidr_locations(
CidrCollectionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/cidrcollection/$(CidrCollectionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_cidr_locations(
CidrCollectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"GET",
"/2013-04-01/cidrcollection/$(CidrCollectionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_geo_locations()
list_geo_locations(params::Dict{String,<:Any})
Retrieves a list of supported geographic locations. Countries are listed first, and
continents are listed last. If Amazon Route 53 supports subdivisions for a country (for
example, states or provinces), the subdivisions for that country are listed in alphabetical
order immediately after the corresponding country. Route 53 does not perform authorization
for this API because it retrieves information that is already available to the public. For
a list of supported geolocation codes, see the GeoLocation data type.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxitems"`: (Optional) The maximum number of geolocations to be included in the
response body for this request. If more than maxitems geolocations remain to be listed,
then the value of the IsTruncated element in the response is true.
- `"startcontinentcode"`: The code for the continent with which you want to start listing
locations that Amazon Route 53 supports for geolocation. If Route 53 has already returned a
page or more of results, if IsTruncated is true, and if NextContinentCode from the previous
response has a value, enter that value in startcontinentcode to return the next page of
results. Include startcontinentcode only if you want to list continents. Don't include
startcontinentcode when you're listing countries or countries with their subdivisions.
- `"startcountrycode"`: The code for the country with which you want to start listing
locations that Amazon Route 53 supports for geolocation. If Route 53 has already returned a
page or more of results, if IsTruncated is true, and if NextCountryCode from the previous
response has a value, enter that value in startcountrycode to return the next page of
results.
- `"startsubdivisioncode"`: The code for the state of the United States with which you want
to start listing locations that Amazon Route 53 supports for geolocation. If Route 53 has
already returned a page or more of results, if IsTruncated is true, and if
NextSubdivisionCode from the previous response has a value, enter that value in
startsubdivisioncode to return the next page of results. To list subdivisions (U.S.
states), you must include both startcountrycode and startsubdivisioncode.
"""
function list_geo_locations(; aws_config::AbstractAWSConfig=global_aws_config())
return route_53(
"GET",
"/2013-04-01/geolocations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_geo_locations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/geolocations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_health_checks()
list_health_checks(params::Dict{String,<:Any})
Retrieve a list of the health checks that are associated with the current Amazon Web
Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"marker"`: If the value of IsTruncated in the previous response was true, you have more
health checks. To get another group, submit another ListHealthChecks request. For the
value of marker, specify the value of NextMarker from the previous response, which is the
ID of the first health check that Amazon Route 53 will return if you submit another
request. If the value of IsTruncated in the previous response was false, there are no more
health checks to get.
- `"maxitems"`: The maximum number of health checks that you want ListHealthChecks to
return in response to the current request. Amazon Route 53 returns a maximum of 1000 items.
If you set MaxItems to a value greater than 1000, Route 53 returns only the first 1000
health checks.
"""
function list_health_checks(; aws_config::AbstractAWSConfig=global_aws_config())
return route_53(
"GET",
"/2013-04-01/healthcheck";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_health_checks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/healthcheck",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_hosted_zones()
list_hosted_zones(params::Dict{String,<:Any})
Retrieves a list of the public and private hosted zones that are associated with the
current Amazon Web Services account. The response includes a HostedZones child element for
each hosted zone. Amazon Route 53 returns a maximum of 100 items in each response. If you
have a lot of hosted zones, you can use the maxitems parameter to list them in groups of up
to 100.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"delegationsetid"`: If you're using reusable delegation sets and you want to list all of
the hosted zones that are associated with a reusable delegation set, specify the ID of that
reusable delegation set.
- `"hostedzonetype"`: (Optional) Specifies if the hosted zone is private.
- `"marker"`: If the value of IsTruncated in the previous response was true, you have more
hosted zones. To get more hosted zones, submit another ListHostedZones request. For the
value of marker, specify the value of NextMarker from the previous response, which is the
ID of the first hosted zone that Amazon Route 53 will return if you submit another request.
If the value of IsTruncated in the previous response was false, there are no more hosted
zones to get.
- `"maxitems"`: (Optional) The maximum number of hosted zones that you want Amazon Route 53
to return. If you have more than maxitems hosted zones, the value of IsTruncated in the
response is true, and the value of NextMarker is the hosted zone ID of the first hosted
zone that Route 53 will return if you submit another request.
"""
function list_hosted_zones(; aws_config::AbstractAWSConfig=global_aws_config())
return route_53(
"GET",
"/2013-04-01/hostedzone";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_hosted_zones(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/hostedzone",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_hosted_zones_by_name()
list_hosted_zones_by_name(params::Dict{String,<:Any})
Retrieves a list of your hosted zones in lexicographic order. The response includes a
HostedZones child element for each hosted zone created by the current Amazon Web Services
account. ListHostedZonesByName sorts hosted zones by name with the labels reversed. For
example: com.example.www. Note the trailing dot, which can change the sort order in some
circumstances. If the domain name includes escape characters or Punycode,
ListHostedZonesByName alphabetizes the domain name using the escaped or Punycoded value,
which is the format that Amazon Route 53 saves in its database. For example, to create a
hosted zone for exämple.com, you specify ex344mple.com for the domain name.
ListHostedZonesByName alphabetizes it as: com.ex344mple. The labels are reversed and
alphabetized using the escaped value. For more information about valid domain name formats,
including internationalized domain names, see DNS Domain Name Format in the Amazon Route 53
Developer Guide. Route 53 returns up to 100 items in each response. If you have a lot of
hosted zones, use the MaxItems parameter to list them in groups of up to 100. The response
includes values that help navigate from one group of MaxItems hosted zones to the next:
The DNSName and HostedZoneId elements in the response contain the values, if any, specified
for the dnsname and hostedzoneid parameters in the request that produced the current
response. The MaxItems element in the response contains the value, if any, that you
specified for the maxitems parameter in the request that produced the current response.
If the value of IsTruncated in the response is true, there are more hosted zones associated
with the current Amazon Web Services account. If IsTruncated is false, this response
includes the last hosted zone that is associated with the current account. The NextDNSName
element and NextHostedZoneId elements are omitted from the response. The NextDNSName and
NextHostedZoneId elements in the response contain the domain name and the hosted zone ID of
the next hosted zone that is associated with the current Amazon Web Services account. If
you want to list more hosted zones, make another call to ListHostedZonesByName, and specify
the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters,
respectively.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"dnsname"`: (Optional) For your first request to ListHostedZonesByName, include the
dnsname parameter only if you want to specify the name of the first hosted zone in the
response. If you don't include the dnsname parameter, Amazon Route 53 returns all of the
hosted zones that were created by the current Amazon Web Services account, in ASCII order.
For subsequent requests, include both dnsname and hostedzoneid parameters. For dnsname,
specify the value of NextDNSName from the previous response.
- `"hostedzoneid"`: (Optional) For your first request to ListHostedZonesByName, do not
include the hostedzoneid parameter. If you have more hosted zones than the value of
maxitems, ListHostedZonesByName returns only the first maxitems hosted zones. To get the
next group of maxitems hosted zones, submit another request to ListHostedZonesByName and
include both dnsname and hostedzoneid parameters. For the value of hostedzoneid, specify
the value of the NextHostedZoneId element from the previous response.
- `"maxitems"`: The maximum number of hosted zones to be included in the response body for
this request. If you have more than maxitems hosted zones, then the value of the
IsTruncated element in the response is true, and the values of NextDNSName and
NextHostedZoneId specify the first hosted zone in the next group of maxitems hosted zones.
"""
function list_hosted_zones_by_name(; aws_config::AbstractAWSConfig=global_aws_config())
return route_53(
"GET",
"/2013-04-01/hostedzonesbyname";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_hosted_zones_by_name(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/hostedzonesbyname",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_hosted_zones_by_vpc(vpcid, vpcregion)
list_hosted_zones_by_vpc(vpcid, vpcregion, params::Dict{String,<:Any})
Lists all the private hosted zones that a specified VPC is associated with, regardless of
which Amazon Web Services account or Amazon Web Services service owns the hosted zones. The
HostedZoneOwner structure in the response contains one of the following values: An
OwningAccount element, which contains the account number of either the current Amazon Web
Services account or another Amazon Web Services account. Some services, such as Cloud Map,
create hosted zones using the current account. An OwningService element, which
identifies the Amazon Web Services service that created and owns the hosted zone. For
example, if a hosted zone was created by Amazon Elastic File System (Amazon EFS), the value
of Owner is efs.amazonaws.com. When listing private hosted zones, the hosted zone and
the Amazon VPC must belong to the same partition where the hosted zones were created. A
partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is
scoped to one partition. The following are the supported partitions: aws - Amazon Web
Services Regions aws-cn - China Regions aws-us-gov - Amazon Web Services GovCloud
(US) Region For more information, see Access Management in the Amazon Web Services
General Reference.
# Arguments
- `vpcid`: The ID of the Amazon VPC that you want to list hosted zones for.
- `vpcregion`: For the Amazon VPC that you specified for VPCId, the Amazon Web Services
Region that you created the VPC in.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxitems"`: (Optional) The maximum number of hosted zones that you want Amazon Route 53
to return. If the specified VPC is associated with more than MaxItems hosted zones, the
response includes a NextToken element. NextToken contains an encrypted token that
identifies the first hosted zone that Route 53 will return if you submit another request.
- `"nexttoken"`: If the previous response included a NextToken element, the specified VPC
is associated with more hosted zones. To get more hosted zones, submit another
ListHostedZonesByVPC 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 hosted zones to get.
"""
function list_hosted_zones_by_vpc(
vpcid, vpcregion; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/hostedzonesbyvpc",
Dict{String,Any}("vpcid" => vpcid, "vpcregion" => vpcregion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_hosted_zones_by_vpc(
vpcid,
vpcregion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"GET",
"/2013-04-01/hostedzonesbyvpc",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("vpcid" => vpcid, "vpcregion" => vpcregion), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_query_logging_configs()
list_query_logging_configs(params::Dict{String,<:Any})
Lists the configurations for DNS query logging that are associated with the current Amazon
Web Services account or the configuration that is associated with a specified hosted zone.
For more information about DNS query logs, see CreateQueryLoggingConfig. Additional
information, including the format of DNS query logs, appears in Logging DNS Queries in the
Amazon Route 53 Developer Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"hostedzoneid"`: (Optional) If you want to list the query logging configuration that is
associated with a hosted zone, specify the ID in HostedZoneId. If you don't specify a
hosted zone ID, ListQueryLoggingConfigs returns all of the configurations that are
associated with the current Amazon Web Services account.
- `"maxresults"`: (Optional) The maximum number of query logging configurations that you
want Amazon Route 53 to return in response to the current request. If the current Amazon
Web Services account has more than MaxResults configurations, use the value of NextToken in
the response to get the next page of results. If you don't specify a value for MaxResults,
Route 53 returns up to 100 configurations.
- `"nexttoken"`: (Optional) If the current Amazon Web Services account has more than
MaxResults query logging configurations, use NextToken to get the second and subsequent
pages of results. For the first ListQueryLoggingConfigs request, omit this value. For the
second and subsequent requests, get the value of NextToken from the previous response and
specify that value for NextToken in the request.
"""
function list_query_logging_configs(; aws_config::AbstractAWSConfig=global_aws_config())
return route_53(
"GET",
"/2013-04-01/queryloggingconfig";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_query_logging_configs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/queryloggingconfig",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_resource_record_sets(id)
list_resource_record_sets(id, params::Dict{String,<:Any})
Lists the resource record sets in a specified hosted zone. ListResourceRecordSets returns
up to 300 resource record sets at a time in ASCII order, beginning at a position specified
by the name and type elements. Sort order ListResourceRecordSets sorts results first by
DNS name with the labels reversed, for example: com.example.www. Note the trailing dot,
which can change the sort order when the record name contains characters that appear before
. (decimal 46) in the ASCII table. These characters include the following: ! \" # % &
' ( ) * + , - When multiple records have the same DNS name, ListResourceRecordSets sorts
results by the record type. Specifying where to start listing records You can use the
name and type elements to specify the resource record set that the list begins with: If
you do not specify Name or Type The results begin with the first resource record set that
the hosted zone contains. If you specify Name but not Type The results begin with the
first resource record set in the list whose name is greater than or equal to Name. If you
specify Type but not Name Amazon Route 53 returns the InvalidInput error. If you specify
both Name and Type The results begin with the first resource record set in the list whose
name is greater than or equal to Name, and whose type is greater than or equal to Type.
Resource record sets that are PENDING This action returns the most current version of the
records. This includes records that are PENDING, and that are not yet available on all
Route 53 DNS servers. Changing resource record sets To ensure that you get an accurate
listing of the resource record sets for a hosted zone at a point in time, do not submit a
ChangeResourceRecordSets request while you're paging through the results of a
ListResourceRecordSets request. If you do, some pages may display results without the
latest changes while other pages display results with the latest changes. Displaying the
next page of results If a ListResourceRecordSets command returns more than one page of
results, the value of IsTruncated is true. To display the next page of results, get the
values of NextRecordName, NextRecordType, and NextRecordIdentifier (if any) from the
response. Then submit another ListResourceRecordSets request, and specify those values for
StartRecordName, StartRecordType, and StartRecordIdentifier.
# Arguments
- `id`: The ID of the hosted zone that contains the resource record sets that you want to
list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"identifier"`: Resource record sets that have a routing policy other than simple: If
results were truncated for a given DNS name and type, specify the value of
NextRecordIdentifier from the previous response to get the next resource record set that
has the current DNS name and type.
- `"maxitems"`: (Optional) The maximum number of resource records sets to include in the
response body for this request. If the response includes more than maxitems resource record
sets, the value of the IsTruncated element in the response is true, and the values of the
NextRecordName and NextRecordType elements in the response identify the first resource
record set in the next group of maxitems resource record sets.
- `"name"`: The first name in the lexicographic ordering of resource record sets that you
want to list. If the specified record name doesn't exist, the results begin with the first
resource record set that has a name greater than the value of name.
- `"type"`: The type of resource record set to begin the record listing from. Valid values
for basic resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF
| SRV | TXT Values for weighted, latency, geolocation, and failover resource record sets:
A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT Values for alias resource
record sets: API Gateway custom regional API or edge-optimized API: A CloudFront
distribution: A or AAAA Elastic Beanstalk environment that has a regionalized subdomain:
A Elastic Load Balancing load balancer: A | AAAA S3 bucket: A VPC interface VPC
endpoint: A Another resource record set in this hosted zone: The type of the resource
record set that the alias references. Constraint: Specifying type without specifying name
returns an InvalidInput error.
"""
function list_resource_record_sets(Id; aws_config::AbstractAWSConfig=global_aws_config())
return route_53(
"GET",
"/2013-04-01/hostedzone/$(Id)/rrset";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_resource_record_sets(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/hostedzone/$(Id)/rrset",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_reusable_delegation_sets()
list_reusable_delegation_sets(params::Dict{String,<:Any})
Retrieves a list of the reusable delegation sets that are associated with the current
Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"marker"`: If the value of IsTruncated in the previous response was true, you have more
reusable delegation sets. To get another group, submit another ListReusableDelegationSets
request. For the value of marker, specify the value of NextMarker from the previous
response, which is the ID of the first reusable delegation set that Amazon Route 53 will
return if you submit another request. If the value of IsTruncated in the previous response
was false, there are no more reusable delegation sets to get.
- `"maxitems"`: The number of reusable delegation sets that you want Amazon Route 53 to
return in the response to this request. If you specify a value greater than 100, Route 53
returns only the first 100 reusable delegation sets.
"""
function list_reusable_delegation_sets(; aws_config::AbstractAWSConfig=global_aws_config())
return route_53(
"GET",
"/2013-04-01/delegationset";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_reusable_delegation_sets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/delegationset",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_id, resource_type)
list_tags_for_resource(resource_id, resource_type, params::Dict{String,<:Any})
Lists tags for one health check or hosted zone. For information about using tags for cost
allocation, see Using Cost Allocation Tags in the Billing and Cost Management User Guide.
# Arguments
- `resource_id`: The ID of the resource for which you want to retrieve tags.
- `resource_type`: The type of the resource. The resource type for health checks is
healthcheck. The resource type for hosted zones is hostedzone.
"""
function list_tags_for_resource(
ResourceId, ResourceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/tags/$(ResourceType)/$(ResourceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
ResourceId,
ResourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"GET",
"/2013-04-01/tags/$(ResourceType)/$(ResourceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resources(resource_id, resource_type)
list_tags_for_resources(resource_id, resource_type, params::Dict{String,<:Any})
Lists tags for up to 10 health checks or hosted zones. For information about using tags for
cost allocation, see Using Cost Allocation Tags in the Billing and Cost Management User
Guide.
# Arguments
- `resource_id`: A complex type that contains the ResourceId element for each resource for
which you want to get a list of tags.
- `resource_type`: The type of the resources. The resource type for health checks is
healthcheck. The resource type for hosted zones is hostedzone.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ResourceIds"`: A complex type that contains the ResourceId element for each resource
for which you want to get a list of tags.
"""
function list_tags_for_resources(
ResourceId, ResourceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"POST",
"/2013-04-01/tags/$(ResourceType)",
Dict{String,Any}("ResourceId" => ResourceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resources(
ResourceId,
ResourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"POST",
"/2013-04-01/tags/$(ResourceType)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceId" => ResourceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_traffic_policies()
list_traffic_policies(params::Dict{String,<:Any})
Gets information about the latest version for every traffic policy that is associated with
the current Amazon Web Services account. Policies are listed in the order that they were
created in. For information about how of deleting a traffic policy affects the response
from ListTrafficPolicies, see DeleteTrafficPolicy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxitems"`: (Optional) The maximum number of traffic policies that you want Amazon
Route 53 to return in response to this request. If you have more than MaxItems traffic
policies, the value of IsTruncated in the response is true, and the value of
TrafficPolicyIdMarker is the ID of the first traffic policy that Route 53 will return if
you submit another request.
- `"trafficpolicyid"`: (Conditional) For your first request to ListTrafficPolicies, don't
include the TrafficPolicyIdMarker parameter. If you have more traffic policies than the
value of MaxItems, ListTrafficPolicies returns only the first MaxItems traffic policies. To
get the next group of policies, submit another request to ListTrafficPolicies. For the
value of TrafficPolicyIdMarker, specify the value of TrafficPolicyIdMarker that was
returned in the previous response.
"""
function list_traffic_policies(; aws_config::AbstractAWSConfig=global_aws_config())
return route_53(
"GET",
"/2013-04-01/trafficpolicies";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_traffic_policies(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/trafficpolicies",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_traffic_policy_instances()
list_traffic_policy_instances(params::Dict{String,<:Any})
Gets information about the traffic policy instances that you created by using the current
Amazon Web Services account. After you submit an UpdateTrafficPolicyInstance request,
there's a brief delay while Amazon Route 53 creates the resource record sets that are
specified in the traffic policy definition. For more information, see the State response
element. Route 53 returns a maximum of 100 items in each response. If you have a lot of
traffic policy instances, you can use the MaxItems parameter to list them in groups of up
to 100.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"hostedzoneid"`: If the value of IsTruncated in the previous response was true, you have
more traffic policy instances. To get more traffic policy instances, submit another
ListTrafficPolicyInstances request. For the value of HostedZoneId, specify the value of
HostedZoneIdMarker from the previous response, which is the hosted zone ID of the first
traffic policy instance in the next group of traffic policy instances. If the value of
IsTruncated in the previous response was false, there are no more traffic policy instances
to get.
- `"maxitems"`: The maximum number of traffic policy instances that you want Amazon Route
53 to return in response to a ListTrafficPolicyInstances request. If you have more than
MaxItems traffic policy instances, the value of the IsTruncated element in the response is
true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and
TrafficPolicyInstanceTypeMarker represent the first traffic policy instance in the next
group of MaxItems traffic policy instances.
- `"trafficpolicyinstancename"`: If the value of IsTruncated in the previous response was
true, you have more traffic policy instances. To get more traffic policy instances, submit
another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancename,
specify the value of TrafficPolicyInstanceNameMarker from the previous response, which is
the name of the first traffic policy instance in the next group of traffic policy
instances. If the value of IsTruncated in the previous response was false, there are no
more traffic policy instances to get.
- `"trafficpolicyinstancetype"`: If the value of IsTruncated in the previous response was
true, you have more traffic policy instances. To get more traffic policy instances, submit
another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancetype,
specify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is
the type of the first traffic policy instance in the next group of traffic policy
instances. If the value of IsTruncated in the previous response was false, there are no
more traffic policy instances to get.
"""
function list_traffic_policy_instances(; aws_config::AbstractAWSConfig=global_aws_config())
return route_53(
"GET",
"/2013-04-01/trafficpolicyinstances";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_traffic_policy_instances(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/trafficpolicyinstances",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_traffic_policy_instances_by_hosted_zone(id)
list_traffic_policy_instances_by_hosted_zone(id, params::Dict{String,<:Any})
Gets information about the traffic policy instances that you created in a specified hosted
zone. After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance
request, there's a brief delay while Amazon Route 53 creates the resource record sets that
are specified in the traffic policy definition. For more information, see the State
response element. Route 53 returns a maximum of 100 items in each response. If you have a
lot of traffic policy instances, you can use the MaxItems parameter to list them in groups
of up to 100.
# Arguments
- `id`: The ID of the hosted zone that you want to list traffic policy instances for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxitems"`: The maximum number of traffic policy instances to be included in the
response body for this request. If you have more than MaxItems traffic policy instances,
the value of the IsTruncated element in the response is true, and the values of
HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker
represent the first traffic policy instance that Amazon Route 53 will return if you submit
another request.
- `"trafficpolicyinstancename"`: If the value of IsTruncated in the previous response is
true, you have more traffic policy instances. To get more traffic policy instances, submit
another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancename,
specify the value of TrafficPolicyInstanceNameMarker from the previous response, which is
the name of the first traffic policy instance in the next group of traffic policy
instances. If the value of IsTruncated in the previous response was false, there are no
more traffic policy instances to get.
- `"trafficpolicyinstancetype"`: If the value of IsTruncated in the previous response is
true, you have more traffic policy instances. To get more traffic policy instances, submit
another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancetype,
specify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is
the type of the first traffic policy instance in the next group of traffic policy
instances. If the value of IsTruncated in the previous response was false, there are no
more traffic policy instances to get.
"""
function list_traffic_policy_instances_by_hosted_zone(
id; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/trafficpolicyinstances/hostedzone",
Dict{String,Any}("id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_traffic_policy_instances_by_hosted_zone(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/trafficpolicyinstances/hostedzone",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("id" => id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_traffic_policy_instances_by_policy(id, version)
list_traffic_policy_instances_by_policy(id, version, params::Dict{String,<:Any})
Gets information about the traffic policy instances that you created by using a specify
traffic policy version. After you submit a CreateTrafficPolicyInstance or an
UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates
the resource record sets that are specified in the traffic policy definition. For more
information, see the State response element. Route 53 returns a maximum of 100 items in
each response. If you have a lot of traffic policy instances, you can use the MaxItems
parameter to list them in groups of up to 100.
# Arguments
- `id`: The ID of the traffic policy for which you want to list traffic policy instances.
- `version`: The version of the traffic policy for which you want to list traffic policy
instances. The version must be associated with the traffic policy that is specified by
TrafficPolicyId.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"hostedzoneid"`: If the value of IsTruncated in the previous response was true, you have
more traffic policy instances. To get more traffic policy instances, submit another
ListTrafficPolicyInstancesByPolicy request. For the value of hostedzoneid, specify the
value of HostedZoneIdMarker from the previous response, which is the hosted zone ID of the
first traffic policy instance that Amazon Route 53 will return if you submit another
request. If the value of IsTruncated in the previous response was false, there are no more
traffic policy instances to get.
- `"maxitems"`: The maximum number of traffic policy instances to be included in the
response body for this request. If you have more than MaxItems traffic policy instances,
the value of the IsTruncated element in the response is true, and the values of
HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker
represent the first traffic policy instance that Amazon Route 53 will return if you submit
another request.
- `"trafficpolicyinstancename"`: If the value of IsTruncated in the previous response was
true, you have more traffic policy instances. To get more traffic policy instances, submit
another ListTrafficPolicyInstancesByPolicy request. For the value of
trafficpolicyinstancename, specify the value of TrafficPolicyInstanceNameMarker from the
previous response, which is the name of the first traffic policy instance that Amazon Route
53 will return if you submit another request. If the value of IsTruncated in the previous
response was false, there are no more traffic policy instances to get.
- `"trafficpolicyinstancetype"`: If the value of IsTruncated in the previous response was
true, you have more traffic policy instances. To get more traffic policy instances, submit
another ListTrafficPolicyInstancesByPolicy request. For the value of
trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker from the
previous response, which is the name of the first traffic policy instance that Amazon Route
53 will return if you submit another request. If the value of IsTruncated in the previous
response was false, there are no more traffic policy instances to get.
"""
function list_traffic_policy_instances_by_policy(
id, version; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/trafficpolicyinstances/trafficpolicy",
Dict{String,Any}("id" => id, "version" => version);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_traffic_policy_instances_by_policy(
id,
version,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"GET",
"/2013-04-01/trafficpolicyinstances/trafficpolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("id" => id, "version" => version), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_traffic_policy_versions(id)
list_traffic_policy_versions(id, params::Dict{String,<:Any})
Gets information about all of the versions for a specified traffic policy. Traffic policy
versions are listed in numerical order by VersionNumber.
# Arguments
- `id`: Specify the value of Id of the traffic policy for which you want to list all
versions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxitems"`: The maximum number of traffic policy versions that you want Amazon Route 53
to include in the response body for this request. If the specified traffic policy has more
than MaxItems versions, the value of IsTruncated in the response is true, and the value of
the TrafficPolicyVersionMarker element is the ID of the first version that Route 53 will
return if you submit another request.
- `"trafficpolicyversion"`: For your first request to ListTrafficPolicyVersions, don't
include the TrafficPolicyVersionMarker parameter. If you have more traffic policy versions
than the value of MaxItems, ListTrafficPolicyVersions returns only the first group of
MaxItems versions. To get more traffic policy versions, submit another
ListTrafficPolicyVersions request. For the value of TrafficPolicyVersionMarker, specify the
value of TrafficPolicyVersionMarker in the previous response.
"""
function list_traffic_policy_versions(Id; aws_config::AbstractAWSConfig=global_aws_config())
return route_53(
"GET",
"/2013-04-01/trafficpolicies/$(Id)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_traffic_policy_versions(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/trafficpolicies/$(Id)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_vpcassociation_authorizations(id)
list_vpcassociation_authorizations(id, params::Dict{String,<:Any})
Gets a list of the VPCs that were created by other accounts and that can be associated with
a specified hosted zone because you've submitted one or more
CreateVPCAssociationAuthorization requests. The response includes a VPCs element with a
VPC child element for each VPC that can be associated with the hosted zone.
# Arguments
- `id`: The ID of the hosted zone for which you want a list of VPCs that can be associated
with the hosted zone.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxresults"`: Optional: An integer that specifies the maximum number of VPCs that you
want Amazon Route 53 to return. If you don't specify a value for MaxResults, Route 53
returns up to 50 VPCs per page.
- `"nexttoken"`: Optional: If a response includes a NextToken element, there are more VPCs
that can be associated with the specified hosted zone. To get the next page of results,
submit another request, and include the value of NextToken from the response in the
nexttoken parameter in another ListVPCAssociationAuthorizations request.
"""
function list_vpcassociation_authorizations(
Id; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/hostedzone/$(Id)/authorizevpcassociation";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_vpcassociation_authorizations(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/hostedzone/$(Id)/authorizevpcassociation",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
test_dnsanswer(hostedzoneid, recordname, recordtype)
test_dnsanswer(hostedzoneid, recordname, recordtype, params::Dict{String,<:Any})
Gets the value that Amazon Route 53 returns in response to a DNS request for a specified
record name and type. You can optionally specify the IP address of a DNS resolver, an EDNS0
client subnet IP address, and a subnet mask. This call only supports querying public
hosted zones. The TestDnsAnswer returns information similar to what you would expect from
the answer section of the dig command. Therefore, if you query for the name servers of a
subdomain that point to the parent name servers, those will not be returned.
# Arguments
- `hostedzoneid`: The ID of the hosted zone that you want Amazon Route 53 to simulate a
query for.
- `recordname`: The name of the resource record set that you want Amazon Route 53 to
simulate a query for.
- `recordtype`: The type of the resource record set.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"edns0clientsubnetip"`: If the resolver that you specified for resolverip supports
EDNS0, specify the IPv4 or IPv6 address of a client in the applicable location, for
example, 192.0.2.44 or 2001:db8:85a3::8a2e:370:7334.
- `"edns0clientsubnetmask"`: If you specify an IP address for edns0clientsubnetip, you can
optionally specify the number of bits of the IP address that you want the checking tool to
include in the DNS query. For example, if you specify 192.0.2.44 for edns0clientsubnetip
and 24 for edns0clientsubnetmask, the checking tool will simulate a request from
192.0.2.0/24. The default value is 24 bits for IPv4 addresses and 64 bits for IPv6
addresses. The range of valid values depends on whether edns0clientsubnetip is an IPv4 or
an IPv6 address: IPv4: Specify a value between 0 and 32 IPv6: Specify a value between
0 and 128
- `"resolverip"`: If you want to simulate a request from a specific DNS resolver, specify
the IP address for that resolver. If you omit this value, TestDnsAnswer uses the IP address
of a DNS resolver in the Amazon Web Services US East (N. Virginia) Region (us-east-1).
"""
function test_dnsanswer(
hostedzoneid, recordname, recordtype; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"GET",
"/2013-04-01/testdnsanswer",
Dict{String,Any}(
"hostedzoneid" => hostedzoneid,
"recordname" => recordname,
"recordtype" => recordtype,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function test_dnsanswer(
hostedzoneid,
recordname,
recordtype,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"GET",
"/2013-04-01/testdnsanswer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"hostedzoneid" => hostedzoneid,
"recordname" => recordname,
"recordtype" => recordtype,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_health_check(health_check_id)
update_health_check(health_check_id, params::Dict{String,<:Any})
Updates an existing health check. Note that some values can't be updated. For more
information about updating health checks, see Creating, Updating, and Deleting Health
Checks in the Amazon Route 53 Developer Guide.
# Arguments
- `health_check_id`: The ID for the health check for which you want detailed information.
When you created the health check, CreateHealthCheck returned the ID in the response, in
the HealthCheckId element.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AlarmIdentifier"`: A complex type that identifies the CloudWatch alarm that you want
Amazon Route 53 health checkers to use to determine whether the specified health check is
healthy.
- `"ChildHealthChecks"`: A complex type that contains one ChildHealthCheck element for each
health check that you want to associate with a CALCULATED health check.
- `"Disabled"`: Stops Route 53 from performing health checks. When you disable a health
check, here's what happens: Health checks that check the health of endpoints: Route 53
stops submitting requests to your application, server, or other resource. Calculated
health checks: Route 53 stops aggregating the status of the referenced health checks.
Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding
CloudWatch metrics. After you disable a health check, Route 53 considers the status of
the health check to always be healthy. If you configured DNS failover, Route 53 continues
to route traffic to the corresponding resources. If you want to stop routing traffic to a
resource, change the value of Inverted. Charges for a health check still apply when the
health check is disabled. For more information, see Amazon Route 53 Pricing.
- `"EnableSNI"`: Specify whether you want Amazon Route 53 to send the value of
FullyQualifiedDomainName to the endpoint in the client_hello message during TLS
negotiation. This allows the endpoint to respond to HTTPS health check requests with the
applicable SSL/TLS certificate. Some endpoints require that HTTPS requests include the host
name in the client_hello message. If you don't enable SNI, the status of the health check
will be SSL alert handshake_failure. A health check can also have that status for other
reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS
configuration on your endpoint and confirm that your certificate is valid. The SSL/TLS
certificate on your endpoint includes a domain name in the Common Name field and possibly
several more in the Subject Alternative Names field. One of the domain names in the
certificate should match the value that you specify for FullyQualifiedDomainName. If the
endpoint responds to the client_hello message with a certificate that does not include the
domain name that you specified in FullyQualifiedDomainName, a health checker will retry the
handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName
from the client_hello message.
- `"FailureThreshold"`: The number of consecutive health checks that an endpoint must pass
or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to
healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an
Endpoint Is Healthy in the Amazon Route 53 Developer Guide. If you don't specify a value
for FailureThreshold, the default value is three health checks.
- `"FullyQualifiedDomainName"`: Amazon Route 53 behavior depends on whether you specify a
value for IPAddress. If a health check already has a value for IPAddress, you can change
the value. However, you can't update an existing health check to add or remove the value of
IPAddress. If you specify a value for IPAddress: Route 53 sends health check requests to
the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the
Host header for all health checks except TCP health checks. This is typically the fully
qualified DNS name of the endpoint on which you want Route 53 to perform health checks.
When Route 53 checks the health of an endpoint, here is how it constructs the Host header:
If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Route 53 passes
the value of FullyQualifiedDomainName to the endpoint in the Host header. If you specify
a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Route 53 passes the value of
FullyQualifiedDomainName to the endpoint in the Host header. If you specify another value
for Port and any value except TCP for Type, Route 53 passes FullyQualifiedDomainName:Port
to the endpoint in the Host header. If you don't specify a value for
FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress in the Host header in
each of the above cases. If you don't specify a value for IPAddress: If you don't specify
a value for IPAddress, Route 53 sends a DNS request to the domain that you specify in
FullyQualifiedDomainName at the interval you specify in RequestInterval. Using an IPv4
address that is returned by DNS, Route 53 then checks the health of the endpoint. If you
don't specify a value for IPAddress, you can’t update the health check to remove the
FullyQualifiedDomainName; if you don’t specify a value for IPAddress on creation, a
FullyQualifiedDomainName is required. If you don't specify a value for IPAddress, Route 53
uses only IPv4 to send health checks to the endpoint. If there's no resource record set
with a type of A for the name that you specify for FullyQualifiedDomainName, the health
check fails with a \"DNS resolution failed\" error. If you want to check the health of
weighted, latency, or failover resource record sets and you choose to specify the endpoint
only by FullyQualifiedDomainName, we recommend that you create a separate health check for
each endpoint. For example, create a health check for each HTTP server that is serving
content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain
name of the server (such as us-east-2-www.example.com), not the name of the resource record
sets (www.example.com). In this configuration, if the value of FullyQualifiedDomainName
matches the name of the resource record sets and you then associate the health check with
those resource record sets, health check results will be unpredictable. In addition, if
the value of Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Route 53 passes the
value of FullyQualifiedDomainName in the Host header, as it does when you specify a value
for IPAddress. If the value of Type is TCP, Route 53 doesn't pass a Host header.
- `"HealthCheckVersion"`: A sequential counter that Amazon Route 53 sets to 1 when you
create a health check and increments by 1 each time you update settings for the health
check. We recommend that you use GetHealthCheck or ListHealthChecks to get the current
value of HealthCheckVersion for the health check that you want to update, and that you
include that value in your UpdateHealthCheck request. This prevents Route 53 from
overwriting an intervening update: If the value in the UpdateHealthCheck request matches
the value of HealthCheckVersion in the health check, Route 53 updates the health check with
the new settings. If the value of HealthCheckVersion in the health check is greater, the
health check was changed after you got the version number. Route 53 does not update the
health check, and it returns a HealthCheckVersionMismatch error.
- `"HealthThreshold"`: The number of child health checks that are associated with a
CALCULATED health that Amazon Route 53 must consider healthy for the CALCULATED health
check to be considered healthy. To specify the child health checks that you want to
associate with a CALCULATED health check, use the ChildHealthChecks and ChildHealthCheck
elements. Note the following: If you specify a number greater than the number of child
health checks, Route 53 always considers this health check to be unhealthy. If you
specify 0, Route 53 always considers this health check to be healthy.
- `"IPAddress"`: The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53
to perform health checks on. If you don't specify a value for IPAddress, Route 53 sends a
DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the
interval that you specify in RequestInterval. Using an IP address that is returned by DNS,
Route 53 then checks the health of the endpoint. Use one of the following formats for the
value of IPAddress: IPv4 address: four values between 0 and 255, separated by periods
(.), for example, 192.0.2.44. IPv6 address: eight groups of four hexadecimal values,
separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also
shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345.
If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address,
associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This
ensures that the IP address of your instance never changes. For more information, see the
applicable documentation: Linux: Elastic IP Addresses (EIP) in the Amazon EC2 User Guide
for Linux Instances Windows: Elastic IP Addresses (EIP) in the Amazon EC2 User Guide for
Windows Instances If a health check already has a value for IPAddress, you can change
the value. However, you can't update an existing health check to add or remove the value of
IPAddress. For more information, see FullyQualifiedDomainName. Constraints: Route 53
can't check the health of endpoints for which the IP address is in local, private,
non-routable, or multicast ranges. For more information about IP addresses for which you
can't create health checks, see the following documents: RFC 5735, Special Use IPv4
Addresses RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address Space RFC 5156,
Special-Use IPv6 Addresses
- `"InsufficientDataHealthStatus"`: When CloudWatch has insufficient data about the metric
to determine the alarm state, the status that you want Amazon Route 53 to assign to the
health check: Healthy: Route 53 considers the health check to be healthy. Unhealthy:
Route 53 considers the health check to be unhealthy. LastKnownStatus: By default, Route
53 uses the status of the health check from the last time CloudWatch had sufficient data to
determine the alarm state. For new health checks that have no last known status, the status
for the health check is healthy.
- `"Inverted"`: Specify whether you want Amazon Route 53 to invert the status of a health
check, for example, to consider a health check unhealthy when it otherwise would be
considered healthy.
- `"Port"`: The port on the endpoint that you want Amazon Route 53 to perform health checks
on. Don't specify a value for Port when you specify a value for Type of CLOUDWATCH_METRIC
or CALCULATED.
- `"Regions"`: A complex type that contains one Region element for each region that you
want Amazon Route 53 health checkers to check the specified endpoint from.
- `"ResetElements"`: A complex type that contains one ResettableElementName element for
each element that you want to reset to the default value. Valid values for
ResettableElementName include the following: ChildHealthChecks: Amazon Route 53 resets
ChildHealthChecks to null. FullyQualifiedDomainName: Route 53 resets
FullyQualifiedDomainName. to null. Regions: Route 53 resets the Regions list to the
default set of regions. ResourcePath: Route 53 resets ResourcePath to null.
- `"ResourcePath"`: The path that you want Amazon Route 53 to request when performing
health checks. The path can be any value for which your endpoint will return an HTTP status
code of 2xx or 3xx when the endpoint is healthy, for example the file
/docs/route53-health-check.html. You can also include query string parameters, for example,
/welcome.html?language=jp&login=y. Specify this value only if you want to change it.
- `"SearchString"`: If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string
that you want Amazon Route 53 to search for in the response body from the specified
resource. If the string appears in the response body, Route 53 considers the resource
healthy. (You can't change the value of Type when you update a health check.)
"""
function update_health_check(
HealthCheckId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"POST",
"/2013-04-01/healthcheck/$(HealthCheckId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_health_check(
HealthCheckId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"POST",
"/2013-04-01/healthcheck/$(HealthCheckId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_hosted_zone_comment(id)
update_hosted_zone_comment(id, params::Dict{String,<:Any})
Updates the comment for a specified hosted zone.
# Arguments
- `id`: The ID for the hosted zone that you want to update the comment for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Comment"`: The new comment for the hosted zone. If you don't specify a value for
Comment, Amazon Route 53 deletes the existing value of the Comment element, if any.
"""
function update_hosted_zone_comment(Id; aws_config::AbstractAWSConfig=global_aws_config())
return route_53(
"POST",
"/2013-04-01/hostedzone/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_hosted_zone_comment(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"POST",
"/2013-04-01/hostedzone/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_traffic_policy_comment(comment, id, version)
update_traffic_policy_comment(comment, id, version, params::Dict{String,<:Any})
Updates the comment for a specified traffic policy version.
# Arguments
- `comment`: The new comment for the specified traffic policy and version.
- `id`: The value of Id for the traffic policy that you want to update the comment for.
- `version`: The value of Version for the traffic policy that you want to update the
comment for.
"""
function update_traffic_policy_comment(
Comment, Id, Version; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53(
"POST",
"/2013-04-01/trafficpolicy/$(Id)/$(Version)",
Dict{String,Any}("Comment" => Comment);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_traffic_policy_comment(
Comment,
Id,
Version,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"POST",
"/2013-04-01/trafficpolicy/$(Id)/$(Version)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Comment" => Comment), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_traffic_policy_instance(id, ttl, traffic_policy_id, traffic_policy_version)
update_traffic_policy_instance(id, ttl, traffic_policy_id, traffic_policy_version, params::Dict{String,<:Any})
After you submit a UpdateTrafficPolicyInstance request, there's a brief delay while
Route 53 creates the resource record sets that are specified in the traffic policy
definition. Use GetTrafficPolicyInstance with the id of updated traffic policy instance
confirm that the UpdateTrafficPolicyInstance request completed successfully. For more
information, see the State response element. Updates the resource record sets in a
specified hosted zone that were created based on the settings in a specified traffic policy
version. When you update a traffic policy instance, Amazon Route 53 continues to respond to
DNS queries for the root resource record set name (such as example.com) while it replaces
one group of resource record sets with another. Route 53 performs the following operations:
Route 53 creates a new group of resource record sets based on the specified traffic
policy. This is true regardless of how significant the differences are between the existing
resource record sets and the new resource record sets. When all of the new resource
record sets have been created, Route 53 starts to respond to DNS queries for the root
resource record set name (such as example.com) by using the new resource record sets.
Route 53 deletes the old group of resource record sets that are associated with the root
resource record set name.
# Arguments
- `id`: The ID of the traffic policy instance that you want to update.
- `ttl`: The TTL that you want Amazon Route 53 to assign to all of the updated resource
record sets.
- `traffic_policy_id`: The ID of the traffic policy that you want Amazon Route 53 to use to
update resource record sets for the specified traffic policy instance.
- `traffic_policy_version`: The version of the traffic policy that you want Amazon Route 53
to use to update resource record sets for the specified traffic policy instance.
"""
function update_traffic_policy_instance(
Id,
TTL,
TrafficPolicyId,
TrafficPolicyVersion;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"POST",
"/2013-04-01/trafficpolicyinstance/$(Id)",
Dict{String,Any}(
"TTL" => TTL,
"TrafficPolicyId" => TrafficPolicyId,
"TrafficPolicyVersion" => TrafficPolicyVersion,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_traffic_policy_instance(
Id,
TTL,
TrafficPolicyId,
TrafficPolicyVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53(
"POST",
"/2013-04-01/trafficpolicyinstance/$(Id)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TTL" => TTL,
"TrafficPolicyId" => TrafficPolicyId,
"TrafficPolicyVersion" => TrafficPolicyVersion,
),
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 | 67234 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: route_53_domains
using AWS.Compat
using AWS.UUIDs
"""
accept_domain_transfer_from_another_aws_account(domain_name, password)
accept_domain_transfer_from_another_aws_account(domain_name, password, params::Dict{String,<:Any})
Accepts the transfer of a domain from another Amazon Web Services account to the
currentAmazon Web Services account. You initiate a transfer between Amazon Web Services
accounts using TransferDomainToAnotherAwsAccount. If you use the CLI command at
accept-domain-transfer-from-another-aws-account, use JSON format as input instead of text
because otherwise CLI will throw an error from domain transfer input that includes single
quotes. Use either ListOperations or GetOperationDetail to determine whether the operation
succeeded. GetOperationDetail provides additional information, for example, Domain Transfer
from Aws Account 111122223333 has been cancelled.
# Arguments
- `domain_name`: The name of the domain that was specified when another Amazon Web Services
account submitted a TransferDomainToAnotherAwsAccount request.
- `password`: The password that was returned by the TransferDomainToAnotherAwsAccount
request.
"""
function accept_domain_transfer_from_another_aws_account(
DomainName, Password; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"AcceptDomainTransferFromAnotherAwsAccount",
Dict{String,Any}("DomainName" => DomainName, "Password" => Password);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function accept_domain_transfer_from_another_aws_account(
DomainName,
Password,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"AcceptDomainTransferFromAnotherAwsAccount",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DomainName" => DomainName, "Password" => Password),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_delegation_signer_to_domain(domain_name, signing_attributes)
associate_delegation_signer_to_domain(domain_name, signing_attributes, params::Dict{String,<:Any})
Creates a delegation signer (DS) record in the registry zone for this domain name. Note
that creating DS record at the registry impacts DNSSEC validation of your DNS records. This
action may render your domain name unavailable on the internet if the steps are completed
in the wrong order, or with incorrect timing. For more information about DNSSEC signing,
see Configuring DNSSEC signing in the Route 53 developer guide.
# Arguments
- `domain_name`: The name of the domain.
- `signing_attributes`: The information about a key, including the algorithm, public
key-value, and flags.
"""
function associate_delegation_signer_to_domain(
DomainName, SigningAttributes; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"AssociateDelegationSignerToDomain",
Dict{String,Any}(
"DomainName" => DomainName, "SigningAttributes" => SigningAttributes
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_delegation_signer_to_domain(
DomainName,
SigningAttributes,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"AssociateDelegationSignerToDomain",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DomainName" => DomainName, "SigningAttributes" => SigningAttributes
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_domain_transfer_to_another_aws_account(domain_name)
cancel_domain_transfer_to_another_aws_account(domain_name, params::Dict{String,<:Any})
Cancels the transfer of a domain from the current Amazon Web Services account to another
Amazon Web Services account. You initiate a transfer betweenAmazon Web Services accounts
using TransferDomainToAnotherAwsAccount. You must cancel the transfer before the other
Amazon Web Services account accepts the transfer using
AcceptDomainTransferFromAnotherAwsAccount. Use either ListOperations or GetOperationDetail
to determine whether the operation succeeded. GetOperationDetail provides additional
information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled.
# Arguments
- `domain_name`: The name of the domain for which you want to cancel the transfer to
another Amazon Web Services account.
"""
function cancel_domain_transfer_to_another_aws_account(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"CancelDomainTransferToAnotherAwsAccount",
Dict{String,Any}("DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_domain_transfer_to_another_aws_account(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"CancelDomainTransferToAnotherAwsAccount",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
check_domain_availability(domain_name)
check_domain_availability(domain_name, params::Dict{String,<:Any})
This operation checks the availability of one domain name. Note that if the availability
status of a domain is pending, you must submit another request to determine the
availability of the domain name.
# Arguments
- `domain_name`: The name of the domain that you want to get availability for. The
top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of
supported TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route
53 Developer Guide. The domain name can contain only the following characters: Letters a
through z. Domain names are not case sensitive. Numbers 0 through 9. Hyphen (-). You
can't specify a hyphen at the beginning or end of a label. Period (.) to separate the
labels in the name, such as the . in example.com. Internationalized domain names are not
supported for some top-level domains. To determine whether the TLD that you want to use
supports internationalized domain names, see Domains that You Can Register with Amazon
Route 53. For more information, see Formatting Internationalized Domain Names.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IdnLangCode"`: Reserved for future use.
"""
function check_domain_availability(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"CheckDomainAvailability",
Dict{String,Any}("DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function check_domain_availability(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"CheckDomainAvailability",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
check_domain_transferability(domain_name)
check_domain_transferability(domain_name, params::Dict{String,<:Any})
Checks whether a domain name can be transferred to Amazon Route 53.
# Arguments
- `domain_name`: The name of the domain that you want to transfer to Route 53. The
top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of
supported TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route
53 Developer Guide. The domain name can contain only the following characters: Letters a
through z. Domain names are not case sensitive. Numbers 0 through 9. Hyphen (-). You
can't specify a hyphen at the beginning or end of a label. Period (.) to separate the
labels in the name, such as the . in example.com.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AuthCode"`: If the registrar for the top-level domain (TLD) requires an authorization
code to transfer the domain, the code that you got from the current registrar for the
domain.
"""
function check_domain_transferability(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"CheckDomainTransferability",
Dict{String,Any}("DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function check_domain_transferability(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"CheckDomainTransferability",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_domain(domain_name)
delete_domain(domain_name, params::Dict{String,<:Any})
This operation deletes the specified domain. This action is permanent. For more
information, see Deleting a domain name registration. To transfer the domain registration
to another registrar, use the transfer process that’s provided by the registrar to which
you want to transfer the registration. Otherwise, the following apply: You can’t get a
refund for the cost of a deleted domain registration. The registry for the top-level
domain might hold the domain name for a brief time before releasing it for other users to
register (varies by registry). When the registration has been deleted, we'll send you a
confirmation to the registrant contact. The email will come from
[email protected] or [email protected].
# Arguments
- `domain_name`: Name of the domain to be deleted.
"""
function delete_domain(DomainName; aws_config::AbstractAWSConfig=global_aws_config())
return route_53_domains(
"DeleteDomain",
Dict{String,Any}("DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_domain(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"DeleteDomain",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_tags_for_domain(domain_name, tags_to_delete)
delete_tags_for_domain(domain_name, tags_to_delete, params::Dict{String,<:Any})
This operation deletes the specified tags for a domain. All tag operations are eventually
consistent; subsequent operations might not immediately represent all issued operations.
# Arguments
- `domain_name`: The domain for which you want to delete one or more tags.
- `tags_to_delete`: A list of tag keys to delete.
"""
function delete_tags_for_domain(
DomainName, TagsToDelete; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"DeleteTagsForDomain",
Dict{String,Any}("DomainName" => DomainName, "TagsToDelete" => TagsToDelete);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_tags_for_domain(
DomainName,
TagsToDelete,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"DeleteTagsForDomain",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DomainName" => DomainName, "TagsToDelete" => TagsToDelete
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_domain_auto_renew(domain_name)
disable_domain_auto_renew(domain_name, params::Dict{String,<:Any})
This operation disables automatic renewal of domain registration for the specified domain.
# Arguments
- `domain_name`: The name of the domain that you want to disable automatic renewal for.
"""
function disable_domain_auto_renew(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"DisableDomainAutoRenew",
Dict{String,Any}("DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_domain_auto_renew(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"DisableDomainAutoRenew",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_domain_transfer_lock(domain_name)
disable_domain_transfer_lock(domain_name, params::Dict{String,<:Any})
This operation removes the transfer lock on the domain (specifically the
clientTransferProhibited status) to allow domain transfers. We recommend you refrain from
performing this action unless you intend to transfer the domain to a different registrar.
Successful submission returns an operation ID that you can use to track the progress and
completion of the action. If the request is not completed successfully, the domain
registrant will be notified by email.
# Arguments
- `domain_name`: The name of the domain that you want to remove the transfer lock for.
"""
function disable_domain_transfer_lock(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"DisableDomainTransferLock",
Dict{String,Any}("DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_domain_transfer_lock(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"DisableDomainTransferLock",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_delegation_signer_from_domain(domain_name, id)
disassociate_delegation_signer_from_domain(domain_name, id, params::Dict{String,<:Any})
Deletes a delegation signer (DS) record in the registry zone for this domain name.
# Arguments
- `domain_name`: Name of the domain.
- `id`: An internal identification number assigned to each DS record after it’s created.
You can retrieve it as part of DNSSEC information returned by GetDomainDetail.
"""
function disassociate_delegation_signer_from_domain(
DomainName, Id; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"DisassociateDelegationSignerFromDomain",
Dict{String,Any}("DomainName" => DomainName, "Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_delegation_signer_from_domain(
DomainName,
Id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"DisassociateDelegationSignerFromDomain",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("DomainName" => DomainName, "Id" => Id), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_domain_auto_renew(domain_name)
enable_domain_auto_renew(domain_name, params::Dict{String,<:Any})
This operation configures Amazon Route 53 to automatically renew the specified domain
before the domain registration expires. The cost of renewing your domain registration is
billed to your Amazon Web Services account. The period during which you can renew a domain
name varies by TLD. For a list of TLDs and their renewal policies, see Domains That You Can
Register with Amazon Route 53 in the Amazon Route 53 Developer Guide. Route 53 requires
that you renew before the end of the renewal period so we can complete processing before
the deadline.
# Arguments
- `domain_name`: The name of the domain that you want to enable automatic renewal for.
"""
function enable_domain_auto_renew(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"EnableDomainAutoRenew",
Dict{String,Any}("DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_domain_auto_renew(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"EnableDomainAutoRenew",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_domain_transfer_lock(domain_name)
enable_domain_transfer_lock(domain_name, params::Dict{String,<:Any})
This operation sets the transfer lock on the domain (specifically the
clientTransferProhibited status) to prevent domain transfers. Successful submission returns
an operation ID that you can use to track the progress and completion of the action. If the
request is not completed successfully, the domain registrant will be notified by email.
# Arguments
- `domain_name`: The name of the domain that you want to set the transfer lock for.
"""
function enable_domain_transfer_lock(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"EnableDomainTransferLock",
Dict{String,Any}("DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_domain_transfer_lock(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"EnableDomainTransferLock",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_contact_reachability_status()
get_contact_reachability_status(params::Dict{String,<:Any})
For operations that require confirmation that the email address for the registrant contact
is valid, such as registering a new domain, this operation returns information about
whether the registrant contact has responded. If you want us to resend the email, use the
ResendContactReachabilityEmail operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"domainName"`: The name of the domain for which you want to know whether the registrant
contact has confirmed that the email address is valid.
"""
function get_contact_reachability_status(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"GetContactReachabilityStatus";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_contact_reachability_status(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"GetContactReachabilityStatus",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_domain_detail(domain_name)
get_domain_detail(domain_name, params::Dict{String,<:Any})
This operation returns detailed information about a specified domain that is associated
with the current Amazon Web Services account. Contact information for the domain is also
returned as part of the output.
# Arguments
- `domain_name`: The name of the domain that you want to get detailed information about.
"""
function get_domain_detail(DomainName; aws_config::AbstractAWSConfig=global_aws_config())
return route_53_domains(
"GetDomainDetail",
Dict{String,Any}("DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_domain_detail(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"GetDomainDetail",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_domain_suggestions(domain_name, only_available, suggestion_count)
get_domain_suggestions(domain_name, only_available, suggestion_count, params::Dict{String,<:Any})
The GetDomainSuggestions operation returns a list of suggested domain names.
# Arguments
- `domain_name`: A domain name that you want to use as the basis for a list of possible
domain names. The top-level domain (TLD), such as .com, must be a TLD that Route 53
supports. For a list of supported TLDs, see Domains that You Can Register with Amazon Route
53 in the Amazon Route 53 Developer Guide. The domain name can contain only the following
characters: Letters a through z. Domain names are not case sensitive. Numbers 0 through
9. Hyphen (-). You can't specify a hyphen at the beginning or end of a label. Period
(.) to separate the labels in the name, such as the . in example.com. Internationalized
domain names are not supported for some top-level domains. To determine whether the TLD
that you want to use supports internationalized domain names, see Domains that You Can
Register with Amazon Route 53.
- `only_available`: If OnlyAvailable is true, Route 53 returns only domain names that are
available. If OnlyAvailable is false, Route 53 returns domain names without checking
whether they're available to be registered. To determine whether the domain is available,
you can call checkDomainAvailability for each suggestion.
- `suggestion_count`: The number of suggested domain names that you want Route 53 to
return. Specify a value between 1 and 50.
"""
function get_domain_suggestions(
DomainName,
OnlyAvailable,
SuggestionCount;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"GetDomainSuggestions",
Dict{String,Any}(
"DomainName" => DomainName,
"OnlyAvailable" => OnlyAvailable,
"SuggestionCount" => SuggestionCount,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_domain_suggestions(
DomainName,
OnlyAvailable,
SuggestionCount,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"GetDomainSuggestions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DomainName" => DomainName,
"OnlyAvailable" => OnlyAvailable,
"SuggestionCount" => SuggestionCount,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_operation_detail(operation_id)
get_operation_detail(operation_id, params::Dict{String,<:Any})
This operation returns the current status of an operation that is not completed.
# Arguments
- `operation_id`: The identifier for the operation for which you want to get the status.
Route 53 returned the identifier in the response to the original request.
"""
function get_operation_detail(
OperationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"GetOperationDetail",
Dict{String,Any}("OperationId" => OperationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_operation_detail(
OperationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"GetOperationDetail",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("OperationId" => OperationId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_domains()
list_domains(params::Dict{String,<:Any})
This operation returns all the domain names registered with Amazon Route 53 for the current
Amazon Web Services account if no filtering conditions are used.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FilterConditions"`: A complex type that contains information about the filters applied
during the ListDomains request. The filter conditions can include domain name and domain
expiration.
- `"Marker"`: For an initial request for a list of domains, omit this element. If the
number of domains that are associated with the current Amazon Web Services account is
greater than the value that you specified for MaxItems, you can use Marker to return
additional domains. Get the value of NextPageMarker from the previous response, and submit
another request that includes the value of NextPageMarker in the Marker element.
Constraints: The marker must match the value specified in the previous request.
- `"MaxItems"`: Number of domains to be returned. Default: 20
- `"SortCondition"`: A complex type that contains information about the requested ordering
of domains in the returned list.
"""
function list_domains(; aws_config::AbstractAWSConfig=global_aws_config())
return route_53_domains(
"ListDomains"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_domains(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"ListDomains", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_operations()
list_operations(params::Dict{String,<:Any})
Returns information about all of the operations that return an operation ID and that have
ever been performed on domains that were registered by the current account. This command
runs only in the us-east-1 Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: For an initial request for a list of operations, omit this element. If the
number of operations that are not yet complete is greater than the value that you specified
for MaxItems, you can use Marker to return additional operations. Get the value of
NextPageMarker from the previous response, and submit another request that includes the
value of NextPageMarker in the Marker element.
- `"MaxItems"`: Number of domains to be returned. Default: 20
- `"SortBy"`: The sort type for returned values.
- `"SortOrder"`: The sort order for returned values, either ascending or descending.
- `"Status"`: The status of the operations.
- `"SubmittedSince"`: An optional parameter that lets you get information about all the
operations that you submitted after a specified date and time. Specify the date and time in
Unix time format and Coordinated Universal time (UTC).
- `"Type"`: An arrays of the domains operation types.
"""
function list_operations(; aws_config::AbstractAWSConfig=global_aws_config())
return route_53_domains(
"ListOperations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_operations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"ListOperations", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_prices()
list_prices(params::Dict{String,<:Any})
Lists the following prices for either all the TLDs supported by Route 53, or the specified
TLD: Registration Transfer Owner change Domain renewal Domain restoration
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: For an initial request for a list of prices, omit this element. If the number
of prices that are not yet complete is greater than the value that you specified for
MaxItems, you can use Marker to return additional prices. Get the value of NextPageMarker
from the previous response, and submit another request that includes the value of
NextPageMarker in the Marker element. Used only for all TLDs. If you specify a TLD, don't
specify a Marker.
- `"MaxItems"`: Number of Prices to be returned. Used only for all TLDs. If you specify a
TLD, don't specify a MaxItems.
- `"Tld"`: The TLD for which you want to receive the pricing information. For example.
.net. If a Tld value is not provided, a list of prices for all TLDs supported by Route 53
is returned.
"""
function list_prices(; aws_config::AbstractAWSConfig=global_aws_config())
return route_53_domains(
"ListPrices"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_prices(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"ListPrices", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tags_for_domain(domain_name)
list_tags_for_domain(domain_name, params::Dict{String,<:Any})
This operation returns all of the tags that are associated with the specified domain. All
tag operations are eventually consistent; subsequent operations might not immediately
represent all issued operations.
# Arguments
- `domain_name`: The domain for which you want to get a list of tags.
"""
function list_tags_for_domain(DomainName; aws_config::AbstractAWSConfig=global_aws_config())
return route_53_domains(
"ListTagsForDomain",
Dict{String,Any}("DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_domain(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"ListTagsForDomain",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
push_domain(domain_name, target)
push_domain(domain_name, target, params::Dict{String,<:Any})
Moves a domain from Amazon Web Services to another registrar. Supported actions:
Changes the IPS tags of a .uk domain, and pushes it to transit. Transit means that the
domain is ready to be transferred to another registrar.
# Arguments
- `domain_name`: Name of the domain.
- `target`: New IPS tag for the domain.
"""
function push_domain(DomainName, Target; aws_config::AbstractAWSConfig=global_aws_config())
return route_53_domains(
"PushDomain",
Dict{String,Any}("DomainName" => DomainName, "Target" => Target);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function push_domain(
DomainName,
Target,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"PushDomain",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DomainName" => DomainName, "Target" => Target),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_domain(admin_contact, domain_name, duration_in_years, registrant_contact, tech_contact)
register_domain(admin_contact, domain_name, duration_in_years, registrant_contact, tech_contact, params::Dict{String,<:Any})
This operation registers a domain. For some top-level domains (TLDs), this operation
requires extra parameters. When you register a domain, Amazon Route 53 does the following:
Creates a Route 53 hosted zone that has the same name as the domain. Route 53 assigns four
name servers to your hosted zone and automatically updates your domain registration with
the names of these name servers. Enables auto renew, so your domain registration will
renew automatically each year. We'll notify you in advance of the renewal date so you can
choose whether to renew the registration. Optionally enables privacy protection, so WHOIS
queries return contact for the registrar or the phrase \"REDACTED FOR PRIVACY\", or \"On
behalf of <domain name> owner.\" If you don't enable privacy protection, WHOIS
queries return the information that you entered for the administrative, registrant, and
technical contacts. While some domains may allow different privacy settings per contact,
we recommend specifying the same privacy setting for all contacts. If registration is
successful, returns an operation ID that you can use to track the progress and completion
of the action. If the request is not completed successfully, the domain registrant is
notified by email. Charges your Amazon Web Services account an amount based on the
top-level domain. For more information, see Amazon Route 53 Pricing.
# Arguments
- `admin_contact`: Provides detailed contact information. For information about the values
that you specify for each element, see ContactDetail.
- `domain_name`: The domain name that you want to register. The top-level domain (TLD),
such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see
Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.
The domain name can contain only the following characters: Letters a through z. Domain
names are not case sensitive. Numbers 0 through 9. Hyphen (-). You can't specify a
hyphen at the beginning or end of a label. Period (.) to separate the labels in the
name, such as the . in example.com. Internationalized domain names are not supported for
some top-level domains. To determine whether the TLD that you want to use supports
internationalized domain names, see Domains that You Can Register with Amazon Route 53. For
more information, see Formatting Internationalized Domain Names.
- `duration_in_years`: The number of years that you want to register the domain for.
Domains are registered for a minimum of one year. The maximum period depends on the
top-level domain. For the range of valid values for your domain, see Domains that You Can
Register with Amazon Route 53 in the Amazon Route 53 Developer Guide. Default: 1
- `registrant_contact`: Provides detailed contact information. For information about the
values that you specify for each element, see ContactDetail.
- `tech_contact`: Provides detailed contact information. For information about the values
that you specify for each element, see ContactDetail.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AutoRenew"`: Indicates whether the domain will be automatically renewed (true) or not
(false). Auto renewal only takes effect after the account is charged. Default: true
- `"BillingContact"`: Provides detailed contact information. For information about the
values that you specify for each element, see ContactDetail.
- `"IdnLangCode"`: Reserved for future use.
- `"PrivacyProtectAdminContact"`: Whether you want to conceal contact information from
WHOIS queries. If you specify true, WHOIS (\"who is\") queries return contact information
either for Amazon Registrar or for our registrar associate, Gandi. If you specify false,
WHOIS queries return the information that you entered for the admin contact. You must
specify the same privacy setting for the administrative, billing, registrant, and technical
contacts. Default: true
- `"PrivacyProtectBillingContact"`: Whether you want to conceal contact information from
WHOIS queries. If you specify true, WHOIS (\"who is\") queries return contact information
either for Amazon Registrar or for our registrar associate, Gandi. If you specify false,
WHOIS queries return the information that you entered for the billing contact. You must
specify the same privacy setting for the administrative, billing, registrant, and technical
contacts.
- `"PrivacyProtectRegistrantContact"`: Whether you want to conceal contact information from
WHOIS queries. If you specify true, WHOIS (\"who is\") queries return contact information
either for Amazon Registrar or for our registrar associate, Gandi. If you specify false,
WHOIS queries return the information that you entered for the registrant contact (the
domain owner). You must specify the same privacy setting for the administrative, billing,
registrant, and technical contacts. Default: true
- `"PrivacyProtectTechContact"`: Whether you want to conceal contact information from WHOIS
queries. If you specify true, WHOIS (\"who is\") queries return contact information either
for Amazon Registrar or for our registrar associate, Gandi. If you specify false, WHOIS
queries return the information that you entered for the technical contact. You must
specify the same privacy setting for the administrative, billing, registrant, and technical
contacts. Default: true
"""
function register_domain(
AdminContact,
DomainName,
DurationInYears,
RegistrantContact,
TechContact;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"RegisterDomain",
Dict{String,Any}(
"AdminContact" => AdminContact,
"DomainName" => DomainName,
"DurationInYears" => DurationInYears,
"RegistrantContact" => RegistrantContact,
"TechContact" => TechContact,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_domain(
AdminContact,
DomainName,
DurationInYears,
RegistrantContact,
TechContact,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"RegisterDomain",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AdminContact" => AdminContact,
"DomainName" => DomainName,
"DurationInYears" => DurationInYears,
"RegistrantContact" => RegistrantContact,
"TechContact" => TechContact,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reject_domain_transfer_from_another_aws_account(domain_name)
reject_domain_transfer_from_another_aws_account(domain_name, params::Dict{String,<:Any})
Rejects the transfer of a domain from another Amazon Web Services account to the current
Amazon Web Services account. You initiate a transfer betweenAmazon Web Services accounts
using TransferDomainToAnotherAwsAccount. Use either ListOperations or GetOperationDetail
to determine whether the operation succeeded. GetOperationDetail provides additional
information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled.
# Arguments
- `domain_name`: The name of the domain that was specified when another Amazon Web Services
account submitted a TransferDomainToAnotherAwsAccount request.
"""
function reject_domain_transfer_from_another_aws_account(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"RejectDomainTransferFromAnotherAwsAccount",
Dict{String,Any}("DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reject_domain_transfer_from_another_aws_account(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"RejectDomainTransferFromAnotherAwsAccount",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
renew_domain(current_expiry_year, domain_name)
renew_domain(current_expiry_year, domain_name, params::Dict{String,<:Any})
This operation renews a domain for the specified number of years. The cost of renewing your
domain is billed to your Amazon Web Services account. We recommend that you renew your
domain several weeks before the expiration date. Some TLD registries delete domains before
the expiration date if you haven't renewed far enough in advance. For more information
about renewing domain registration, see Renewing Registration for a Domain in the Amazon
Route 53 Developer Guide.
# Arguments
- `current_expiry_year`: The year when the registration for the domain is set to expire.
This value must match the current expiration date for the domain.
- `domain_name`: The name of the domain that you want to renew.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DurationInYears"`: The number of years that you want to renew the domain for. The
maximum number of years depends on the top-level domain. For the range of valid values for
your domain, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53
Developer Guide. Default: 1
"""
function renew_domain(
CurrentExpiryYear, DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"RenewDomain",
Dict{String,Any}(
"CurrentExpiryYear" => CurrentExpiryYear, "DomainName" => DomainName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function renew_domain(
CurrentExpiryYear,
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"RenewDomain",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CurrentExpiryYear" => CurrentExpiryYear, "DomainName" => DomainName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
resend_contact_reachability_email()
resend_contact_reachability_email(params::Dict{String,<:Any})
For operations that require confirmation that the email address for the registrant contact
is valid, such as registering a new domain, this operation resends the confirmation email
to the current email address for the registrant contact.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"domainName"`: The name of the domain for which you want Route 53 to resend a
confirmation email to the registrant contact.
"""
function resend_contact_reachability_email(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"ResendContactReachabilityEmail";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function resend_contact_reachability_email(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"ResendContactReachabilityEmail",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
resend_operation_authorization(operation_id)
resend_operation_authorization(operation_id, params::Dict{String,<:Any})
Resend the form of authorization email for this operation.
# Arguments
- `operation_id`: Operation ID.
"""
function resend_operation_authorization(
OperationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"ResendOperationAuthorization",
Dict{String,Any}("OperationId" => OperationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function resend_operation_authorization(
OperationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"ResendOperationAuthorization",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("OperationId" => OperationId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
retrieve_domain_auth_code(domain_name)
retrieve_domain_auth_code(domain_name, params::Dict{String,<:Any})
This operation returns the authorization code for the domain. To transfer a domain to
another registrar, you provide this value to the new registrar.
# Arguments
- `domain_name`: The name of the domain that you want to get an authorization code for.
"""
function retrieve_domain_auth_code(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"RetrieveDomainAuthCode",
Dict{String,Any}("DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function retrieve_domain_auth_code(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"RetrieveDomainAuthCode",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
transfer_domain(admin_contact, domain_name, duration_in_years, registrant_contact, tech_contact)
transfer_domain(admin_contact, domain_name, duration_in_years, registrant_contact, tech_contact, params::Dict{String,<:Any})
Transfers a domain from another registrar to Amazon Route 53. For more information about
transferring domains, see the following topics: For transfer requirements, a detailed
procedure, and information about viewing the status of a domain that you're transferring to
Route 53, see Transferring Registration for a Domain to Amazon Route 53 in the Amazon Route
53 Developer Guide. For information about how to transfer a domain from one Amazon Web
Services account to another, see TransferDomainToAnotherAwsAccount. For information
about how to transfer a domain to another domain registrar, see Transferring a Domain from
Amazon Route 53 to Another Registrar in the Amazon Route 53 Developer Guide. During the
transfer of any country code top-level domains (ccTLDs) to Route 53, except for .cc and
.tv, updates to the owner contact are ignored and the owner contact data from the registry
is used. You can update the owner contact after the transfer is complete. For more
information, see UpdateDomainContact. If the registrar for your domain is also the DNS
service provider for the domain, we highly recommend that you transfer your DNS service to
Route 53 or to another DNS service provider before you transfer your registration. Some
registrars provide free DNS service when you purchase a domain registration. When you
transfer the registration, the previous registrar will not renew your domain registration
and could end your DNS service at any time. If the registrar for your domain is also the
DNS service provider for the domain and you don't transfer DNS service to another provider,
your website, email, and the web applications associated with the domain might become
unavailable. If the transfer is successful, this method returns an operation ID that you
can use to track the progress and completion of the action. If the transfer doesn't
complete successfully, the domain registrant will be notified by email.
# Arguments
- `admin_contact`: Provides detailed contact information.
- `domain_name`: The name of the domain that you want to transfer to Route 53. The
top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of
supported TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route
53 Developer Guide. The domain name can contain only the following characters: Letters a
through z. Domain names are not case sensitive. Numbers 0 through 9. Hyphen (-). You
can't specify a hyphen at the beginning or end of a label. Period (.) to separate the
labels in the name, such as the . in example.com.
- `duration_in_years`: The number of years that you want to register the domain for.
Domains are registered for a minimum of one year. The maximum period depends on the
top-level domain. Default: 1
- `registrant_contact`: Provides detailed contact information.
- `tech_contact`: Provides detailed contact information.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AuthCode"`: The authorization code for the domain. You get this value from the current
registrar.
- `"AutoRenew"`: Indicates whether the domain will be automatically renewed (true) or not
(false). Auto renewal only takes effect after the account is charged. Default: true
- `"BillingContact"`: Provides detailed contact information.
- `"IdnLangCode"`: Reserved for future use.
- `"Nameservers"`: Contains details for the host and glue IP addresses.
- `"PrivacyProtectAdminContact"`: Whether you want to conceal contact information from
WHOIS queries. If you specify true, WHOIS (\"who is\") queries return contact information
for the registrar, the phrase \"REDACTED FOR PRIVACY\", or \"On behalf of <domain
name> owner.\". While some domains may allow different privacy settings per contact, we
recommend specifying the same privacy setting for all contacts. Default: true
- `"PrivacyProtectBillingContact"`: Whether you want to conceal contact information from
WHOIS queries. If you specify true, WHOIS (\"who is\") queries return contact information
either for Amazon Registrar or for our registrar associate, Gandi. If you specify false,
WHOIS queries return the information that you entered for the billing contact. You must
specify the same privacy setting for the administrative, billing, registrant, and technical
contacts.
- `"PrivacyProtectRegistrantContact"`: Whether you want to conceal contact information from
WHOIS queries. If you specify true, WHOIS (\"who is\") queries return contact information
either for Amazon Registrar or for our registrar associate, Gandi. If you specify false,
WHOIS queries return the information that you entered for the registrant contact (domain
owner). You must specify the same privacy setting for the administrative, billing,
registrant, and technical contacts. Default: true
- `"PrivacyProtectTechContact"`: Whether you want to conceal contact information from WHOIS
queries. If you specify true, WHOIS (\"who is\") queries return contact information either
for Amazon Registrar or for our registrar associate, Gandi. If you specify false, WHOIS
queries return the information that you entered for the technical contact. You must
specify the same privacy setting for the administrative, billing, registrant, and technical
contacts. Default: true
"""
function transfer_domain(
AdminContact,
DomainName,
DurationInYears,
RegistrantContact,
TechContact;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"TransferDomain",
Dict{String,Any}(
"AdminContact" => AdminContact,
"DomainName" => DomainName,
"DurationInYears" => DurationInYears,
"RegistrantContact" => RegistrantContact,
"TechContact" => TechContact,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function transfer_domain(
AdminContact,
DomainName,
DurationInYears,
RegistrantContact,
TechContact,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"TransferDomain",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AdminContact" => AdminContact,
"DomainName" => DomainName,
"DurationInYears" => DurationInYears,
"RegistrantContact" => RegistrantContact,
"TechContact" => TechContact,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
transfer_domain_to_another_aws_account(account_id, domain_name)
transfer_domain_to_another_aws_account(account_id, domain_name, params::Dict{String,<:Any})
Transfers a domain from the current Amazon Web Services account to another Amazon Web
Services account. Note the following: The Amazon Web Services account that you're
transferring the domain to must accept the transfer. If the other account doesn't accept
the transfer within 3 days, we cancel the transfer. See
AcceptDomainTransferFromAnotherAwsAccount. You can cancel the transfer before the other
account accepts it. See CancelDomainTransferToAnotherAwsAccount. The other account can
reject the transfer. See RejectDomainTransferFromAnotherAwsAccount. When you transfer a
domain from one Amazon Web Services account to another, Route 53 doesn't transfer the
hosted zone that is associated with the domain. DNS resolution isn't affected if the domain
and the hosted zone are owned by separate accounts, so transferring the hosted zone is
optional. For information about transferring the hosted zone to another Amazon Web Services
account, see Migrating a Hosted Zone to a Different Amazon Web Services Account in the
Amazon Route 53 Developer Guide. Use either ListOperations or GetOperationDetail to
determine whether the operation succeeded. GetOperationDetail provides additional
information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled.
# Arguments
- `account_id`: The account ID of the Amazon Web Services account that you want to transfer
the domain to, for example, 111122223333.
- `domain_name`: The name of the domain that you want to transfer from the current Amazon
Web Services account to another account.
"""
function transfer_domain_to_another_aws_account(
AccountId, DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"TransferDomainToAnotherAwsAccount",
Dict{String,Any}("AccountId" => AccountId, "DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function transfer_domain_to_another_aws_account(
AccountId,
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"TransferDomainToAnotherAwsAccount",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AccountId" => AccountId, "DomainName" => DomainName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_domain_contact(domain_name)
update_domain_contact(domain_name, params::Dict{String,<:Any})
This operation updates the contact information for a particular domain. You must specify
information for at least one contact: registrant, administrator, or technical. If the
update is successful, this method returns an operation ID that you can use to track the
progress and completion of the operation. If the request is not completed successfully, the
domain registrant will be notified by email.
# Arguments
- `domain_name`: The name of the domain that you want to update contact information for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AdminContact"`: Provides detailed contact information.
- `"BillingContact"`: Provides detailed contact information.
- `"Consent"`: Customer's consent for the owner change request. Required if the domain is
not free (consent price is more than 0.00).
- `"RegistrantContact"`: Provides detailed contact information.
- `"TechContact"`: Provides detailed contact information.
"""
function update_domain_contact(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"UpdateDomainContact",
Dict{String,Any}("DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_domain_contact(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"UpdateDomainContact",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_domain_contact_privacy(domain_name)
update_domain_contact_privacy(domain_name, params::Dict{String,<:Any})
This operation updates the specified domain contact's privacy setting. When privacy
protection is enabled, your contact information is replaced with contact information for
the registrar or with the phrase \"REDACTED FOR PRIVACY\", or \"On behalf of <domain
name> owner.\" While some domains may allow different privacy settings per contact, we
recommend specifying the same privacy setting for all contacts. This operation affects
only the contact information for the specified contact type (administrative, registrant, or
technical). If the request succeeds, Amazon Route 53 returns an operation ID that you can
use with GetOperationDetail to track the progress and completion of the action. If the
request doesn't complete successfully, the domain registrant will be notified by email. By
disabling the privacy service via API, you consent to the publication of the contact
information provided for this domain via the public WHOIS database. You certify that you
are the registrant of this domain name and have the authority to make this decision. You
may withdraw your consent at any time by enabling privacy protection using either
UpdateDomainContactPrivacy or the Route 53 console. Enabling privacy protection removes the
contact information provided for this domain from the WHOIS database. For more information
on our privacy practices, see https://aws.amazon.com/privacy/.
# Arguments
- `domain_name`: The name of the domain that you want to update the privacy setting for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AdminPrivacy"`: Whether you want to conceal contact information from WHOIS queries. If
you specify true, WHOIS (\"who is\") queries return contact information either for Amazon
Registrar or for our registrar associate, Gandi. If you specify false, WHOIS queries return
the information that you entered for the admin contact. You must specify the same privacy
setting for the administrative, billing, registrant, and technical contacts.
- `"BillingPrivacy"`: Whether you want to conceal contact information from WHOIS queries.
If you specify true, WHOIS (\"who is\") queries return contact information either for
Amazon Registrar or for our registrar associate, Gandi. If you specify false, WHOIS queries
return the information that you entered for the billing contact. You must specify the
same privacy setting for the administrative, billing, registrant, and technical contacts.
- `"RegistrantPrivacy"`: Whether you want to conceal contact information from WHOIS
queries. If you specify true, WHOIS (\"who is\") queries return contact information either
for Amazon Registrar or for our registrar associate, Gandi. If you specify false, WHOIS
queries return the information that you entered for the registrant contact (domain owner).
You must specify the same privacy setting for the administrative, billing, registrant, and
technical contacts.
- `"TechPrivacy"`: Whether you want to conceal contact information from WHOIS queries. If
you specify true, WHOIS (\"who is\") queries return contact information either for Amazon
Registrar or for our registrar associate, Gandi. If you specify false, WHOIS queries return
the information that you entered for the technical contact. You must specify the same
privacy setting for the administrative, billing, registrant, and technical contacts.
"""
function update_domain_contact_privacy(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"UpdateDomainContactPrivacy",
Dict{String,Any}("DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_domain_contact_privacy(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"UpdateDomainContactPrivacy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_domain_nameservers(domain_name, nameservers)
update_domain_nameservers(domain_name, nameservers, params::Dict{String,<:Any})
This operation replaces the current set of name servers for the domain with the specified
set of name servers. If you use Amazon Route 53 as your DNS service, specify the four name
servers in the delegation set for the hosted zone for the domain. If successful, this
operation returns an operation ID that you can use to track the progress and completion of
the action. If the request is not completed successfully, the domain registrant will be
notified by email.
# Arguments
- `domain_name`: The name of the domain that you want to change name servers for.
- `nameservers`: A list of new name servers for the domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FIAuthKey"`: The authorization key for .fi domains
"""
function update_domain_nameservers(
DomainName, Nameservers; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"UpdateDomainNameservers",
Dict{String,Any}("DomainName" => DomainName, "Nameservers" => Nameservers);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_domain_nameservers(
DomainName,
Nameservers,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"UpdateDomainNameservers",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DomainName" => DomainName, "Nameservers" => Nameservers),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_tags_for_domain(domain_name)
update_tags_for_domain(domain_name, params::Dict{String,<:Any})
This operation adds or updates tags for a specified domain. All tag operations are
eventually consistent; subsequent operations might not immediately represent all issued
operations.
# Arguments
- `domain_name`: The domain for which you want to add or update tags.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"TagsToUpdate"`: A list of the tag keys and values that you want to add or update. If
you specify a key that already exists, the corresponding value will be replaced.
"""
function update_tags_for_domain(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"UpdateTagsForDomain",
Dict{String,Any}("DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_tags_for_domain(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"UpdateTagsForDomain",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
view_billing()
view_billing(params::Dict{String,<:Any})
Returns all the domain-related billing records for the current Amazon Web Services account
for a specified period
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"End"`: The end date and time for the time period for which you want a list of billing
records. Specify the date and time in Unix time format and Coordinated Universal time (UTC).
- `"Marker"`: For an initial request for a list of billing records, omit this element. If
the number of billing records that are associated with the current Amazon Web Services
account during the specified period is greater than the value that you specified for
MaxItems, you can use Marker to return additional billing records. Get the value of
NextPageMarker from the previous response, and submit another request that includes the
value of NextPageMarker in the Marker element. Constraints: The marker must match the
value of NextPageMarker that was returned in the previous response.
- `"MaxItems"`: The number of billing records to be returned. Default: 20
- `"Start"`: The beginning date and time for the time period for which you want a list of
billing records. Specify the date and time in Unix time format and Coordinated Universal
time (UTC).
"""
function view_billing(; aws_config::AbstractAWSConfig=global_aws_config())
return route_53_domains(
"ViewBilling"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function view_billing(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"ViewBilling", 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 | 33788 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: rum
using AWS.Compat
using AWS.UUIDs
"""
batch_create_rum_metric_definitions(app_monitor_name, destination, metric_definitions)
batch_create_rum_metric_definitions(app_monitor_name, destination, metric_definitions, params::Dict{String,<:Any})
Specifies the extended metrics and custom metrics that you want a CloudWatch RUM app
monitor to send to a destination. Valid destinations include CloudWatch and Evidently. By
default, RUM app monitors send some metrics to CloudWatch. These default metrics are listed
in CloudWatch metrics that you can collect with CloudWatch RUM. In addition to these
default metrics, you can choose to send extended metrics, custom metrics, or both.
Extended metrics let you send metrics with additional dimensions that aren't included in
the default metrics. You can also send extended metrics to both Evidently and CloudWatch.
The valid dimension names for the additional dimensions for extended metrics are
BrowserName, CountryCode, DeviceType, FileType, OSName, and PageId. For more information,
see Extended metrics that you can send to CloudWatch and CloudWatch Evidently. Custom
metrics are metrics that you define. You can send custom metrics to CloudWatch. CloudWatch
Evidently, or both. With custom metrics, you can use any metric name and namespace. To
derive the metrics, you can use any custom events, built-in events, custom attributes, or
default attributes. You can't send custom metrics to the AWS/RUM namespace. You must send
custom metrics to a custom namespace that you define. The namespace that you use can't
start with AWS/. CloudWatch RUM prepends RUM/CustomMetrics/ to the custom namespace that
you define, so the final namespace for your metrics in CloudWatch is
RUM/CustomMetrics/your-custom-namespace . The maximum number of metric definitions that
you can specify in one BatchCreateRumMetricDefinitions operation is 200. The maximum number
of metric definitions that one destination can contain is 2000. Extended metrics sent to
CloudWatch and RUM custom metrics are charged as CloudWatch custom metrics. Each
combination of additional dimension name and dimension value counts as a custom metric. For
more information, see Amazon CloudWatch Pricing. You must have already created a
destination for the metrics before you send them. For more information, see
PutRumMetricsDestination. If some metric definitions specified in a
BatchCreateRumMetricDefinitions operations are not valid, those metric definitions fail and
return errors, but all valid metric definitions in the same operation still succeed.
# Arguments
- `app_monitor_name`: The name of the CloudWatch RUM app monitor that is to send the
metrics.
- `destination`: The destination to send the metrics to. Valid values are CloudWatch and
Evidently. If you specify Evidently, you must also specify the Amazon Resource Name (ARN)
of the CloudWatchEvidently experiment that will receive the metrics and an IAM role that
has permission to write to the experiment.
- `metric_definitions`: An array of structures which define the metrics that you want to
send.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DestinationArn"`: This parameter is required if Destination is Evidently. If
Destination is CloudWatch, do not use this parameter. This parameter specifies the ARN of
the Evidently experiment that is to receive the metrics. You must have already defined this
experiment as a valid destination. For more information, see PutRumMetricsDestination.
"""
function batch_create_rum_metric_definitions(
AppMonitorName,
Destination,
MetricDefinitions;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rum(
"POST",
"/rummetrics/$(AppMonitorName)/metrics",
Dict{String,Any}(
"Destination" => Destination, "MetricDefinitions" => MetricDefinitions
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_create_rum_metric_definitions(
AppMonitorName,
Destination,
MetricDefinitions,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rum(
"POST",
"/rummetrics/$(AppMonitorName)/metrics",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Destination" => Destination, "MetricDefinitions" => MetricDefinitions
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_delete_rum_metric_definitions(app_monitor_name, destination, metric_definition_ids)
batch_delete_rum_metric_definitions(app_monitor_name, destination, metric_definition_ids, params::Dict{String,<:Any})
Removes the specified metrics from being sent to an extended metrics destination. If some
metric definition IDs specified in a BatchDeleteRumMetricDefinitions operations are not
valid, those metric definitions fail and return errors, but all valid metric definition IDs
in the same operation are still deleted. The maximum number of metric definitions that you
can specify in one BatchDeleteRumMetricDefinitions operation is 200.
# Arguments
- `app_monitor_name`: The name of the CloudWatch RUM app monitor that is sending these
metrics.
- `destination`: Defines the destination where you want to stop sending the specified
metrics. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also
specify the ARN of the CloudWatchEvidently experiment that is to be the destination and an
IAM role that has permission to write to the experiment.
- `metric_definition_ids`: An array of structures which define the metrics that you want to
stop sending.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"destinationArn"`: This parameter is required if Destination is Evidently. If
Destination is CloudWatch, do not use this parameter. This parameter specifies the ARN of
the Evidently experiment that was receiving the metrics that are being deleted.
"""
function batch_delete_rum_metric_definitions(
AppMonitorName,
destination,
metricDefinitionIds;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rum(
"DELETE",
"/rummetrics/$(AppMonitorName)/metrics",
Dict{String,Any}(
"destination" => destination, "metricDefinitionIds" => metricDefinitionIds
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_delete_rum_metric_definitions(
AppMonitorName,
destination,
metricDefinitionIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rum(
"DELETE",
"/rummetrics/$(AppMonitorName)/metrics",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"destination" => destination,
"metricDefinitionIds" => metricDefinitionIds,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_rum_metric_definitions(app_monitor_name, destination)
batch_get_rum_metric_definitions(app_monitor_name, destination, params::Dict{String,<:Any})
Retrieves the list of metrics and dimensions that a RUM app monitor is sending to a single
destination.
# Arguments
- `app_monitor_name`: The name of the CloudWatch RUM app monitor that is sending the
metrics.
- `destination`: The type of destination that you want to view metrics for. Valid values
are CloudWatch and Evidently.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"destinationArn"`: This parameter is required if Destination is Evidently. If
Destination is CloudWatch, do not use this parameter. This parameter specifies the ARN of
the Evidently experiment that corresponds to the destination.
- `"maxResults"`: The maximum number of results to return in one operation. The default is
50. The maximum that you can specify is 100. To retrieve the remaining results, make
another call with the returned NextToken value.
- `"nextToken"`: Use the token returned by the previous operation to request the next page
of results.
"""
function batch_get_rum_metric_definitions(
AppMonitorName, destination; aws_config::AbstractAWSConfig=global_aws_config()
)
return rum(
"GET",
"/rummetrics/$(AppMonitorName)/metrics",
Dict{String,Any}("destination" => destination);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_rum_metric_definitions(
AppMonitorName,
destination,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rum(
"GET",
"/rummetrics/$(AppMonitorName)/metrics",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("destination" => destination), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_app_monitor(domain, name)
create_app_monitor(domain, name, params::Dict{String,<:Any})
Creates a Amazon CloudWatch RUM app monitor, which collects telemetry data from your
application and sends that data to RUM. The data includes performance and reliability
information such as page load time, client-side errors, and user behavior. You use this
operation only to create a new app monitor. To update an existing app monitor, use
UpdateAppMonitor instead. After you create an app monitor, sign in to the CloudWatch RUM
console to get the JavaScript code snippet to add to your web application. For more
information, see How do I find a code snippet that I've already generated?
# Arguments
- `domain`: The top-level internet domain name for which your application has
administrative authority.
- `name`: A name for the app monitor.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AppMonitorConfiguration"`: A structure that contains much of the configuration data for
the app monitor. If you are using Amazon Cognito for authorization, you must include this
structure in your request, and it must include the ID of the Amazon Cognito identity pool
to use for authorization. If you don't include AppMonitorConfiguration, you must set up
your own authorization method. For more information, see Authorize your application to send
data to Amazon Web Services. If you omit this argument, the sample rate used for RUM is set
to 10% of the user sessions.
- `"CustomEvents"`: Specifies whether this app monitor allows the web client to define and
send custom events. If you omit this parameter, custom events are DISABLED. For more
information about custom events, see Send custom events.
- `"CwLogEnabled"`: Data collected by RUM is kept by RUM for 30 days and then deleted. This
parameter specifies whether RUM sends a copy of this telemetry data to Amazon CloudWatch
Logs in your account. This enables you to keep the telemetry data for more than 30 days,
but it does incur Amazon CloudWatch Logs charges. If you omit this parameter, the default
is false.
- `"Tags"`: Assigns one or more tags (key-value pairs) to the app monitor. 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 app monitor. For more
information, see Tagging Amazon Web Services resources.
"""
function create_app_monitor(Domain, Name; aws_config::AbstractAWSConfig=global_aws_config())
return rum(
"POST",
"/appmonitor",
Dict{String,Any}("Domain" => Domain, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_app_monitor(
Domain,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rum(
"POST",
"/appmonitor",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Domain" => Domain, "Name" => Name), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_app_monitor(name)
delete_app_monitor(name, params::Dict{String,<:Any})
Deletes an existing app monitor. This immediately stops the collection of data.
# Arguments
- `name`: The name of the app monitor to delete.
"""
function delete_app_monitor(Name; aws_config::AbstractAWSConfig=global_aws_config())
return rum(
"DELETE",
"/appmonitor/$(Name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_app_monitor(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rum(
"DELETE",
"/appmonitor/$(Name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_rum_metrics_destination(app_monitor_name, destination)
delete_rum_metrics_destination(app_monitor_name, destination, params::Dict{String,<:Any})
Deletes a destination for CloudWatch RUM extended metrics, so that the specified app
monitor stops sending extended metrics to that destination.
# Arguments
- `app_monitor_name`: The name of the app monitor that is sending metrics to the
destination that you want to delete.
- `destination`: The type of destination to delete. Valid values are CloudWatch and
Evidently.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"destinationArn"`: This parameter is required if Destination is Evidently. If
Destination is CloudWatch, do not use this parameter. This parameter specifies the ARN of
the Evidently experiment that corresponds to the destination to delete.
"""
function delete_rum_metrics_destination(
AppMonitorName, destination; aws_config::AbstractAWSConfig=global_aws_config()
)
return rum(
"DELETE",
"/rummetrics/$(AppMonitorName)/metricsdestination",
Dict{String,Any}("destination" => destination);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_rum_metrics_destination(
AppMonitorName,
destination,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rum(
"DELETE",
"/rummetrics/$(AppMonitorName)/metricsdestination",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("destination" => destination), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_app_monitor(name)
get_app_monitor(name, params::Dict{String,<:Any})
Retrieves the complete configuration information for one app monitor.
# Arguments
- `name`: The app monitor to retrieve information for.
"""
function get_app_monitor(Name; aws_config::AbstractAWSConfig=global_aws_config())
return rum(
"GET", "/appmonitor/$(Name)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_app_monitor(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rum(
"GET",
"/appmonitor/$(Name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_app_monitor_data(name, time_range)
get_app_monitor_data(name, time_range, params::Dict{String,<:Any})
Retrieves the raw performance events that RUM has collected from your web application, so
that you can do your own processing or analysis of this data.
# Arguments
- `name`: The name of the app monitor that collected the data that you want to retrieve.
- `time_range`: A structure that defines the time range that you want to retrieve results
from.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An array of structures that you can use to filter the results to those that
match one or more sets of key-value pairs that you specify.
- `"MaxResults"`: The maximum number of results to return in one operation.
- `"NextToken"`: Use the token returned by the previous operation to request the next page
of results.
"""
function get_app_monitor_data(
Name, TimeRange; aws_config::AbstractAWSConfig=global_aws_config()
)
return rum(
"POST",
"/appmonitor/$(Name)/data",
Dict{String,Any}("TimeRange" => TimeRange);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_app_monitor_data(
Name,
TimeRange,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rum(
"POST",
"/appmonitor/$(Name)/data",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TimeRange" => TimeRange), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_app_monitors()
list_app_monitors(params::Dict{String,<:Any})
Returns a list of the Amazon CloudWatch RUM app monitors in the 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 one operation. The default is
50. The maximum that you can specify is 100.
- `"nextToken"`: Use the token returned by the previous operation to request the next page
of results.
"""
function list_app_monitors(; aws_config::AbstractAWSConfig=global_aws_config())
return rum(
"POST", "/appmonitors"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_app_monitors(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rum(
"POST",
"/appmonitors",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_rum_metrics_destinations(app_monitor_name)
list_rum_metrics_destinations(app_monitor_name, params::Dict{String,<:Any})
Returns a list of destinations that you have created to receive RUM extended metrics, for
the specified app monitor. For more information about extended metrics, see AddRumMetrics.
# Arguments
- `app_monitor_name`: The name of the app monitor associated with the destinations 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 return in one operation. The default is
50. The maximum that you can specify is 100. To retrieve the remaining results, make
another call with the returned NextToken value.
- `"nextToken"`: Use the token returned by the previous operation to request the next page
of results.
"""
function list_rum_metrics_destinations(
AppMonitorName; aws_config::AbstractAWSConfig=global_aws_config()
)
return rum(
"GET",
"/rummetrics/$(AppMonitorName)/metricsdestination";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_rum_metrics_destinations(
AppMonitorName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rum(
"GET",
"/rummetrics/$(AppMonitorName)/metricsdestination",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Displays the tags associated with a CloudWatch RUM 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 rum(
"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 rum(
"GET",
"/tags/$(ResourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_rum_events(app_monitor_details, batch_id, id, rum_events, user_details)
put_rum_events(app_monitor_details, batch_id, id, rum_events, user_details, params::Dict{String,<:Any})
Sends telemetry events about your application performance and user behavior to CloudWatch
RUM. The code snippet that RUM generates for you to add to your application includes
PutRumEvents operations to send this data to RUM. Each PutRumEvents operation can send a
batch of events from one user session.
# Arguments
- `app_monitor_details`: A structure that contains information about the app monitor that
collected this telemetry information.
- `batch_id`: A unique identifier for this batch of RUM event data.
- `id`: The ID of the app monitor that is sending this data.
- `rum_events`: An array of structures that contain the telemetry event data.
- `user_details`: A structure that contains information about the user session that this
batch of events was collected from.
"""
function put_rum_events(
AppMonitorDetails,
BatchId,
Id,
RumEvents,
UserDetails;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rum(
"POST",
"/appmonitors/$(Id)/",
Dict{String,Any}(
"AppMonitorDetails" => AppMonitorDetails,
"BatchId" => BatchId,
"RumEvents" => RumEvents,
"UserDetails" => UserDetails,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_rum_events(
AppMonitorDetails,
BatchId,
Id,
RumEvents,
UserDetails,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rum(
"POST",
"/appmonitors/$(Id)/",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AppMonitorDetails" => AppMonitorDetails,
"BatchId" => BatchId,
"RumEvents" => RumEvents,
"UserDetails" => UserDetails,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_rum_metrics_destination(app_monitor_name, destination)
put_rum_metrics_destination(app_monitor_name, destination, params::Dict{String,<:Any})
Creates or updates a destination to receive extended metrics from CloudWatch RUM. You can
send extended metrics to CloudWatch or to a CloudWatch Evidently experiment. For more
information about extended metrics, see BatchCreateRumMetricDefinitions.
# Arguments
- `app_monitor_name`: The name of the CloudWatch RUM app monitor that will send the metrics.
- `destination`: Defines the destination to send the metrics to. Valid values are
CloudWatch and Evidently. If you specify Evidently, you must also specify the ARN of the
CloudWatchEvidently experiment that is to be the destination and an IAM role that has
permission to write to the experiment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DestinationArn"`: Use this parameter only if Destination is Evidently. This parameter
specifies the ARN of the Evidently experiment that will receive the extended metrics.
- `"IamRoleArn"`: This parameter is required if Destination is Evidently. If Destination is
CloudWatch, don't use this parameter. This parameter specifies the ARN of an IAM role that
RUM will assume to write to the Evidently experiment that you are sending metrics to. This
role must have permission to write to that experiment. If you specify this parameter, you
must be signed on to a role that has PassRole permissions attached to it, to allow the role
to be passed. The CloudWatchAmazonCloudWatchRUMFullAccess policy doesn't include PassRole
permissions.
"""
function put_rum_metrics_destination(
AppMonitorName, Destination; aws_config::AbstractAWSConfig=global_aws_config()
)
return rum(
"POST",
"/rummetrics/$(AppMonitorName)/metricsdestination",
Dict{String,Any}("Destination" => Destination);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_rum_metrics_destination(
AppMonitorName,
Destination,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rum(
"POST",
"/rummetrics/$(AppMonitorName)/metricsdestination",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Destination" => Destination), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Assigns one or more tags (key-value pairs) to the specified CloudWatch RUM resource.
Currently, the only resources that can be tagged app monitors. 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 RUM 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 rum(
"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 rum(
"POST",
"/tags/$(ResourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Tags" => Tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes one or more tags from the specified resource.
# Arguments
- `resource_arn`: The ARN of the CloudWatch RUM 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 rum(
"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 rum(
"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_app_monitor(name)
update_app_monitor(name, params::Dict{String,<:Any})
Updates the configuration of an existing app monitor. When you use this operation, only the
parts of the app monitor configuration that you specify in this operation are changed. For
any parameters that you omit, the existing values are kept. You can't use this operation to
change the tags of an existing app monitor. To change the tags of an existing app monitor,
use TagResource. To create a new app monitor, use CreateAppMonitor. After you update an app
monitor, sign in to the CloudWatch RUM console to get the updated JavaScript code snippet
to add to your web application. For more information, see How do I find a code snippet that
I've already generated?
# Arguments
- `name`: The name of the app monitor to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AppMonitorConfiguration"`: A structure that contains much of the configuration data for
the app monitor. If you are using Amazon Cognito for authorization, you must include this
structure in your request, and it must include the ID of the Amazon Cognito identity pool
to use for authorization. If you don't include AppMonitorConfiguration, you must set up
your own authorization method. For more information, see Authorize your application to send
data to Amazon Web Services.
- `"CustomEvents"`: Specifies whether this app monitor allows the web client to define and
send custom events. The default is for custom events to be DISABLED. For more information
about custom events, see Send custom events.
- `"CwLogEnabled"`: Data collected by RUM is kept by RUM for 30 days and then deleted. This
parameter specifies whether RUM sends a copy of this telemetry data to Amazon CloudWatch
Logs in your account. This enables you to keep the telemetry data for more than 30 days,
but it does incur Amazon CloudWatch Logs charges.
- `"Domain"`: The top-level internet domain name for which your application has
administrative authority.
"""
function update_app_monitor(Name; aws_config::AbstractAWSConfig=global_aws_config())
return rum(
"PATCH",
"/appmonitor/$(Name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_app_monitor(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return rum(
"PATCH",
"/appmonitor/$(Name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_rum_metric_definition(app_monitor_name, destination, metric_definition, metric_definition_id)
update_rum_metric_definition(app_monitor_name, destination, metric_definition, metric_definition_id, params::Dict{String,<:Any})
Modifies one existing metric definition for CloudWatch RUM extended metrics. For more
information about extended metrics, see BatchCreateRumMetricsDefinitions.
# Arguments
- `app_monitor_name`: The name of the CloudWatch RUM app monitor that sends these metrics.
- `destination`: The destination to send the metrics to. Valid values are CloudWatch and
Evidently. If you specify Evidently, you must also specify the ARN of the
CloudWatchEvidently experiment that will receive the metrics and an IAM role that has
permission to write to the experiment.
- `metric_definition`: A structure that contains the new definition that you want to use
for this metric.
- `metric_definition_id`: The ID of the metric definition to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DestinationArn"`: This parameter is required if Destination is Evidently. If
Destination is CloudWatch, do not use this parameter. This parameter specifies the ARN of
the Evidently experiment that is to receive the metrics. You must have already defined this
experiment as a valid destination. For more information, see PutRumMetricsDestination.
"""
function update_rum_metric_definition(
AppMonitorName,
Destination,
MetricDefinition,
MetricDefinitionId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rum(
"PATCH",
"/rummetrics/$(AppMonitorName)/metrics",
Dict{String,Any}(
"Destination" => Destination,
"MetricDefinition" => MetricDefinition,
"MetricDefinitionId" => MetricDefinitionId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_rum_metric_definition(
AppMonitorName,
Destination,
MetricDefinition,
MetricDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return rum(
"PATCH",
"/rummetrics/$(AppMonitorName)/metrics",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Destination" => Destination,
"MetricDefinition" => MetricDefinition,
"MetricDefinitionId" => MetricDefinitionId,
),
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 | 482189 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: s3
using AWS.Compat
using AWS.UUIDs
"""
abort_multipart_upload(bucket, key, upload_id)
abort_multipart_upload(bucket, key, upload_id, params::Dict{String,<:Any})
This operation aborts a multipart upload. After a multipart upload is aborted, no
additional parts can be uploaded using that upload ID. The storage consumed by any
previously uploaded parts will be freed. However, if any part uploads are currently in
progress, those part uploads might or might not succeed. As a result, it might be necessary
to abort a given multipart upload multiple times in order to completely free all storage
consumed by all parts. To verify that all parts have been removed and prevent getting
charged for the part storage, you should call the ListParts API operation and ensure that
the parts list is empty. Directory buckets - For directory buckets, you must make
requests for this API operation to the Zonal endpoint. These endpoints support
virtual-hosted-style requests in the format
https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are
not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User
Guide. Permissions General purpose bucket permissions - For information about
permissions required to use the multipart upload, see Multipart Upload and Permissions in
the Amazon S3 User Guide. Directory bucket permissions - To grant access to this API
operation on a directory bucket, we recommend that you use the CreateSession API
operation for session-based authorization. Specifically, you grant the
s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM
identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a
session token. With the session token in your request header, you can make API requests to
this operation. After the session token expires, you make another CreateSession API call to
generate a new session token for use. Amazon Web Services CLI or SDKs create session and
refresh the session token automatically to avoid service interruptions when a session
expires. For more information about authorization, see CreateSession . HTTP Host header
syntax Directory buckets - The HTTP Host header syntax is
Bucket_name.s3express-az_id.region.amazonaws.com. The following operations are related to
AbortMultipartUpload: CreateMultipartUpload UploadPart CompleteMultipartUpload
ListParts ListMultipartUploads
# Arguments
- `bucket`: The bucket name to which the upload was taking place. Directory buckets -
When you use this operation with a directory bucket, you must use virtual-hosted-style
requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style
requests are not supported. Directory bucket names must be unique in the chosen
Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for
example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming
restrictions, see Directory bucket naming rules in the Amazon S3 User Guide. Access points
- When you use this action with an access point, you must provide the alias of the access
point in place of the bucket name or specify the access point ARN. When using the access
point ARN, you must direct requests to the access point hostname. The access point hostname
takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using
this action with an access point through the Amazon Web Services SDKs, you provide the
access point ARN in place of the bucket name. For more information about access point ARNs,
see Using access points in the Amazon S3 User Guide. Access points and Object Lambda
access points are not supported by directory buckets. S3 on Outposts - When you use this
action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname.
The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this
action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
access point ARN in place of the bucket name. For more information about S3 on Outposts
ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
- `key`: Key of the object for which the multipart upload was initiated.
- `upload_id`: Upload ID that identifies the multipart upload.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-request-payer"`:
"""
function abort_multipart_upload(
Bucket, Key, uploadId; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"DELETE",
"/$(Bucket)/$(Key)",
Dict{String,Any}("uploadId" => uploadId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function abort_multipart_upload(
Bucket,
Key,
uploadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"DELETE",
"/$(Bucket)/$(Key)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("uploadId" => uploadId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
complete_multipart_upload(bucket, key, upload_id)
complete_multipart_upload(bucket, key, upload_id, params::Dict{String,<:Any})
Completes a multipart upload by assembling previously uploaded parts. You first initiate
the multipart upload and then upload all parts using the UploadPart operation or the
UploadPartCopy operation. After successfully uploading all relevant parts of an upload, you
call this CompleteMultipartUpload operation to complete the upload. Upon receiving this
request, Amazon S3 concatenates all the parts in ascending order by part number to create a
new object. In the CompleteMultipartUpload request, you must provide the parts list and
ensure that the parts list is complete. The CompleteMultipartUpload API operation
concatenates the parts that you provide in the list. For each part in the list, you must
provide the PartNumber value and the ETag value that are returned after that part was
uploaded. The processing of a CompleteMultipartUpload request could take several minutes to
finalize. After Amazon S3 begins processing the request, it sends an HTTP response header
that specifies a 200 OK response. While processing is in progress, Amazon S3 periodically
sends white space characters to keep the connection from timing out. A request could fail
after the initial 200 OK response has been sent. This means that a 200 OK response can
contain either a success or an error. The error response might be embedded in the 200 OK
response. If you call this API operation directly, make sure to design your application to
parse the contents of the response and handle it appropriately. If you use Amazon Web
Services SDKs, SDKs handle this condition. The SDKs detect the embedded error and apply
error handling per your configuration settings (including automatically retrying the
request as appropriate). If the condition persists, the SDKs throw an exception (or, for
the SDKs that don't use exceptions, they return an error). Note that if
CompleteMultipartUpload fails, applications should be prepared to retry any failed requests
(including 500 error responses). For more information, see Amazon S3 Error Best Practices.
You can't use Content-Type: application/x-www-form-urlencoded for the
CompleteMultipartUpload requests. Also, if you don't provide a Content-Type header,
CompleteMultipartUpload can still return a 200 OK response. For more information about
multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User
Guide. Directory buckets - For directory buckets, you must make requests for this API
operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in
the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style
requests are not supported. For more information, see Regional and Zonal endpoints in the
Amazon S3 User Guide. Permissions General purpose bucket permissions - For
information about permissions required to use the multipart upload API, see Multipart
Upload and Permissions in the Amazon S3 User Guide. Directory bucket permissions - To
grant access to this API operation on a directory bucket, we recommend that you use the
CreateSession API operation for session-based authorization. Specifically, you grant the
s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM
identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a
session token. With the session token in your request header, you can make API requests to
this operation. After the session token expires, you make another CreateSession API call to
generate a new session token for use. Amazon Web Services CLI or SDKs create session and
refresh the session token automatically to avoid service interruptions when a session
expires. For more information about authorization, see CreateSession . Special errors
Error Code: EntityTooSmall Description: Your proposed upload is smaller than the
minimum allowed object size. Each part must be at least 5 MB in size, except the last part.
HTTP Status Code: 400 Bad Request Error Code: InvalidPart Description: One or more
of the specified parts could not be found. The part might not have been uploaded, or the
specified ETag might not have matched the uploaded part's ETag. HTTP Status Code: 400 Bad
Request Error Code: InvalidPartOrder Description: The list of parts was not in
ascending order. The parts list must be specified in order by part number. HTTP Status
Code: 400 Bad Request Error Code: NoSuchUpload Description: The specified multipart
upload does not exist. The upload ID might be invalid, or the multipart upload might have
been aborted or completed. HTTP Status Code: 404 Not Found HTTP Host header syntax
Directory buckets - The HTTP Host header syntax is
Bucket_name.s3express-az_id.region.amazonaws.com. The following operations are related to
CompleteMultipartUpload: CreateMultipartUpload UploadPart AbortMultipartUpload
ListParts ListMultipartUploads
# Arguments
- `bucket`: Name of the bucket to which the multipart upload was initiated. Directory
buckets - When you use this operation with a directory bucket, you must use
virtual-hosted-style requests in the format
Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported.
Directory bucket names must be unique in the chosen Availability Zone. Bucket names must
follow the format bucket_base_name--az-id--x-s3 (for example,
DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see
Directory bucket naming rules in the Amazon S3 User Guide. Access points - When you use
this action with an access point, you must provide the alias of the access point in place
of the bucket name or specify the access point ARN. When using the access point ARN, you
must direct requests to the access point hostname. The access point hostname takes the form
AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with
an access point through the Amazon Web Services SDKs, you provide the access point ARN in
place of the bucket name. For more information about access point ARNs, see Using access
points in the Amazon S3 User Guide. Access points and Object Lambda access points are not
supported by directory buckets. S3 on Outposts - When you use this action with Amazon S3
on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts
hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this
action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
access point ARN in place of the bucket name. For more information about S3 on Outposts
ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
- `key`: Object key for which the multipart upload was initiated.
- `upload_id`: ID for the initiated multipart upload.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CompleteMultipartUpload"`: The container for the multipart upload request information.
- `"x-amz-checksum-crc32"`: This header can be used as a data integrity check to verify
that the data received is the same data that was originally sent. This header specifies the
base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking
object integrity in the Amazon S3 User Guide.
- `"x-amz-checksum-crc32c"`: This header can be used as a data integrity check to verify
that the data received is the same data that was originally sent. This header specifies the
base64-encoded, 32-bit CRC32C checksum of the object. For more information, see Checking
object integrity in the Amazon S3 User Guide.
- `"x-amz-checksum-sha1"`: This header can be used as a data integrity check to verify that
the data received is the same data that was originally sent. This header specifies the
base64-encoded, 160-bit SHA-1 digest of the object. For more information, see Checking
object integrity in the Amazon S3 User Guide.
- `"x-amz-checksum-sha256"`: This header can be used as a data integrity check to verify
that the data received is the same data that was originally sent. This header specifies the
base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking
object integrity in the Amazon S3 User Guide.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-request-payer"`:
- `"x-amz-server-side-encryption-customer-algorithm"`: The server-side encryption (SSE)
algorithm used to encrypt the object. This parameter is required only when the object was
created using a checksum algorithm or if your bucket policy requires the use of SSE-C. For
more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide. This
functionality is not supported for directory buckets.
- `"x-amz-server-side-encryption-customer-key"`: The server-side encryption (SSE) customer
managed key. This parameter is needed only when the object was created using a checksum
algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User
Guide. This functionality is not supported for directory buckets.
- `"x-amz-server-side-encryption-customer-key-MD5"`: The MD5 server-side encryption (SSE)
customer managed key. This parameter is needed only when the object was created using a
checksum algorithm. For more information, see Protecting data using SSE-C keys in the
Amazon S3 User Guide. This functionality is not supported for directory buckets.
"""
function complete_multipart_upload(
Bucket, Key, uploadId; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"POST",
"/$(Bucket)/$(Key)",
Dict{String,Any}("uploadId" => uploadId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function complete_multipart_upload(
Bucket,
Key,
uploadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"POST",
"/$(Bucket)/$(Key)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("uploadId" => uploadId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
copy_object(bucket, key, x-amz-copy-source)
copy_object(bucket, key, x-amz-copy-source, params::Dict{String,<:Any})
Creates a copy of an object that is already stored in Amazon S3. You can store individual
objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in
a single atomic action using this API. However, to copy an object greater than 5 GB, you
must use the multipart upload Upload Part - Copy (UploadPartCopy) API. For more
information, see Copy Object Using the REST Multipart Upload API. You can copy individual
objects between general purpose buckets, between directory buckets, and between general
purpose buckets and directory buckets. Directory buckets - For directory buckets, you
must make requests for this API operation to the Zonal endpoint. These endpoints support
virtual-hosted-style requests in the format
https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are
not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User
Guide. Both the Region that you want to copy the object from and the Region that you want
to copy the object to must be enabled for your account. For more information about how to
enable a Region for your account, see Enable or disable a Region for standalone accounts in
the Amazon Web Services Account Management Guide. Amazon S3 transfer acceleration does not
support cross-Region copies. If you request a cross-Region copy using a transfer
acceleration endpoint, you get a 400 Bad Request error. For more information, see Transfer
Acceleration. Authentication and authorization All CopyObject requests must be
authenticated and signed by using IAM credentials (access key ID and secret access key for
the IAM identities). All headers with the x-amz- prefix, including x-amz-copy-source, must
be signed. For more information, see REST Authentication. Directory buckets - You must use
the IAM credentials to authenticate and authorize your access to the CopyObject API
operation, instead of using the temporary security credentials through the CreateSession
API operation. Amazon Web Services CLI or SDKs handles authentication and authorization on
your behalf. Permissions You must have read access to the source object and write access
to the destination bucket. General purpose bucket permissions - You must have
permissions in an IAM policy based on the source and destination bucket types in a
CopyObject operation. If the source object is in a general purpose bucket, you must have
s3:GetObject permission to read the source object that is being copied. If the
destination bucket is a general purpose bucket, you must have s3:PutObject permission to
write the object copy to the destination bucket. Directory bucket permissions - You
must have permissions in a bucket policy or an IAM identity-based policy based on the
source and destination bucket types in a CopyObject operation. If the source object that
you want to copy is in a directory bucket, you must have the s3express:CreateSession
permission in the Action element of a policy to read the object. By default, the session is
in the ReadWrite mode. If you want to restrict the access, you can explicitly set the
s3express:SessionMode condition key to ReadOnly on the copy source bucket. If the copy
destination is a directory bucket, you must have the s3express:CreateSession permission
in the Action element of a policy to write the object to the destination. The
s3express:SessionMode condition key can't be set to ReadOnly on the copy destination
bucket. For example policies, see Example bucket policies for S3 Express One Zone and
Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3
Express One Zone in the Amazon S3 User Guide. Response and special errors When the
request is an HTTP 1.1 request, the response is chunk encoded. When the request is not an
HTTP 1.1 request, the response would not contain the Content-Length. You always need to
read the entire response body to check if the copy succeeds. to keep the connection alive
while we copy the data. If the copy is successful, you receive a response with
information about the copied object. A copy request might return an error when Amazon S3
receives the copy request or while Amazon S3 is copying the files. A 200 OK response can
contain either a success or an error. If the error occurs before the copy action starts,
you receive a standard Amazon S3 error. If the error occurs during the copy operation,
the error response is embedded in the 200 OK response. For example, in a cross-region copy,
you may encounter throttling and receive a 200 OK response. For more information, see
Resolve the Error 200 response when copying objects to Amazon S3. The 200 OK status code
means the copy was accepted, but it doesn't mean the copy is complete. Another example is
when you disconnect from Amazon S3 before the copy is complete, Amazon S3 might cancel the
copy and you may receive a 200 OK response. You must stay connected to Amazon S3 until the
entire response is successfully received and processed. If you call this API operation
directly, make sure to design your application to parse the content of the response and
handle it appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition.
The SDKs detect the embedded error and apply error handling per your configuration settings
(including automatically retrying the request as appropriate). If the condition persists,
the SDKs throw an exception (or, for the SDKs that don't use exceptions, they return an
error). Charge The copy request charge is based on the storage class and Region that
you specify for the destination object. The request can also result in a data retrieval
charge for the source if the source storage class bills for data retrieval. If the copy
source is in a different region, the data transfer is billed to the copy source account.
For pricing information, see Amazon S3 pricing. HTTP Host header syntax Directory
buckets - The HTTP Host header syntax is
Bucket_name.s3express-az_id.region.amazonaws.com. The following operations are related to
CopyObject: PutObject GetObject
# Arguments
- `bucket`: The name of the destination bucket. Directory buckets - When you use this
operation with a directory bucket, you must use virtual-hosted-style requests in the format
Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported.
Directory bucket names must be unique in the chosen Availability Zone. Bucket names must
follow the format bucket_base_name--az-id--x-s3 (for example,
DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see
Directory bucket naming rules in the Amazon S3 User Guide. Access points - When you use
this action with an access point, you must provide the alias of the access point in place
of the bucket name or specify the access point ARN. When using the access point ARN, you
must direct requests to the access point hostname. The access point hostname takes the form
AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with
an access point through the Amazon Web Services SDKs, you provide the access point ARN in
place of the bucket name. For more information about access point ARNs, see Using access
points in the Amazon S3 User Guide. Access points and Object Lambda access points are not
supported by directory buckets. S3 on Outposts - When you use this action with Amazon S3
on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts
hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this
action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
access point ARN in place of the bucket name. For more information about S3 on Outposts
ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
- `key`: The key of the destination object.
- `x-amz-copy-source`: Specifies the source object for the copy operation. The source
object can be up to 5 GB. If the source object is an object that was uploaded by using a
multipart upload, the object copy will be a single part object after the source object is
copied to the destination bucket. You specify the value of the copy source in one of two
formats, depending on whether you want to access the source object through an access point:
For objects not accessed through an access point, specify the name of the source bucket
and the key of the source object, separated by a slash (/). For example, to copy the object
reports/january.pdf from the general purpose bucket awsexamplebucket, use
awsexamplebucket/reports/january.pdf. The value must be URL-encoded. To copy the object
reports/january.pdf from the directory bucket awsexamplebucket--use1-az5--x-s3, use
awsexamplebucket--use1-az5--x-s3/reports/january.pdf. The value must be URL-encoded. For
objects accessed through access points, specify the Amazon Resource Name (ARN) of the
object as accessed through the access point, in the format
arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/&l
t;key>. For example, to copy the object reports/january.pdf through access point
my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf.
The value must be URL encoded. Amazon S3 supports copy operations using Access points
only when the source and destination buckets are in the same Amazon Web Services Region.
Access points are not supported by directory buckets. Alternatively, for objects
accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the
format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<
;key>. For example, to copy the object reports/january.pdf through outpost my-outpost
owned by account 123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf.
The value must be URL-encoded. If your source bucket versioning is enabled, the
x-amz-copy-source header by default identifies the current version of an object to copy. If
the current version is a delete marker, Amazon S3 behaves as if the object was deleted. To
copy a different version, use the versionId query parameter. Specifically, append
?versionId=<version-id> to the value (for example,
awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you
don't specify a version ID, Amazon S3 copies the latest version of the source object. If
you enable versioning on the destination bucket, Amazon S3 generates a unique version ID
for the copied object. This version ID is different from the version ID of the source
object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id
response header in the response. If you do not enable versioning or suspend it on the
destination bucket, the version ID that Amazon S3 generates in the x-amz-version-id
response header is always null. Directory buckets - S3 Versioning isn't enabled and
supported for directory buckets.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Cache-Control"`: Specifies the caching behavior along the request/reply chain.
- `"Content-Disposition"`: Specifies presentational information for the object. Indicates
whether an object should be displayed in a web browser or downloaded as a file. It allows
specifying the desired filename for the downloaded file.
- `"Content-Encoding"`: Specifies what content encodings have been applied to the object
and thus what decoding mechanisms must be applied to obtain the media-type referenced by
the Content-Type header field. For directory buckets, only the aws-chunked value is
supported in this header field.
- `"Content-Language"`: The language the content is in.
- `"Content-Type"`: A standard MIME type that describes the format of the object data.
- `"Expires"`: The date and time at which the object is no longer cacheable.
- `"x-amz-acl"`: The canned access control list (ACL) to apply to the object. When you copy
an object, the ACL metadata is not preserved and is set to private by default. Only the
owner has full access control. To override the default ACL setting, specify a new ACL when
you generate a copy request. For more information, see Using ACLs. If the destination
bucket that you're copying objects to uses the bucket owner enforced setting for S3 Object
Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this
setting only accept PUT requests that don't specify an ACL or PUT requests that specify
bucket owner full control ACLs, such as the bucket-owner-full-control canned ACL or an
equivalent form of this ACL expressed in the XML format. For more information, see
Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide. If your
destination bucket uses the bucket owner enforced setting for Object Ownership, all objects
written to the bucket by any account will be owned by the bucket owner. This
functionality is not supported for directory buckets. This functionality is not supported
for Amazon S3 on Outposts.
- `"x-amz-checksum-algorithm"`: Indicates the algorithm that you want Amazon S3 to use to
create the checksum for the object. For more information, see Checking object integrity in
the Amazon S3 User Guide. When you copy an object, if the source object has a checksum,
that checksum value will be copied to the new object by default. If the CopyObject request
does not include this x-amz-checksum-algorithm header, the checksum algorithm will be
copied from the source object to the destination object (if it's present on the source
object). You can optionally specify a different checksum algorithm to use with the
x-amz-checksum-algorithm header. Unrecognized or unsupported values will respond with the
HTTP status code 400 Bad Request. For directory buckets, when you use Amazon Web Services
SDKs, CRC32 is the default checksum algorithm that's used for performance.
- `"x-amz-copy-source-if-match"`: Copies the object if its entity tag (ETag) matches the
specified tag. If both the x-amz-copy-source-if-match and
x-amz-copy-source-if-unmodified-since headers are present in the request and evaluate as
follows, Amazon S3 returns 200 OK and copies the data: x-amz-copy-source-if-match
condition evaluates to true x-amz-copy-source-if-unmodified-since condition evaluates to
false
- `"x-amz-copy-source-if-modified-since"`: Copies the object if it has been modified since
the specified time. If both the x-amz-copy-source-if-none-match and
x-amz-copy-source-if-modified-since headers are present in the request and evaluate as
follows, Amazon S3 returns the 412 Precondition Failed response code:
x-amz-copy-source-if-none-match condition evaluates to false
x-amz-copy-source-if-modified-since condition evaluates to true
- `"x-amz-copy-source-if-none-match"`: Copies the object if its entity tag (ETag) is
different than the specified ETag. If both the x-amz-copy-source-if-none-match and
x-amz-copy-source-if-modified-since headers are present in the request and evaluate as
follows, Amazon S3 returns the 412 Precondition Failed response code:
x-amz-copy-source-if-none-match condition evaluates to false
x-amz-copy-source-if-modified-since condition evaluates to true
- `"x-amz-copy-source-if-unmodified-since"`: Copies the object if it hasn't been modified
since the specified time. If both the x-amz-copy-source-if-match and
x-amz-copy-source-if-unmodified-since headers are present in the request and evaluate as
follows, Amazon S3 returns 200 OK and copies the data: x-amz-copy-source-if-match
condition evaluates to true x-amz-copy-source-if-unmodified-since condition evaluates to
false
- `"x-amz-copy-source-server-side-encryption-customer-algorithm"`: Specifies the algorithm
to use when decrypting the source object (for example, AES256). If the source object for
the copy is stored in Amazon S3 using SSE-C, you must provide the necessary encryption
information in your request so that Amazon S3 can decrypt the object for copying. This
functionality is not supported when the source object is in a directory bucket.
- `"x-amz-copy-source-server-side-encryption-customer-key"`: Specifies the
customer-provided encryption key for Amazon S3 to use to decrypt the source object. The
encryption key provided in this header must be the same one that was used when the source
object was created. If the source object for the copy is stored in Amazon S3 using SSE-C,
you must provide the necessary encryption information in your request so that Amazon S3 can
decrypt the object for copying. This functionality is not supported when the source object
is in a directory bucket.
- `"x-amz-copy-source-server-side-encryption-customer-key-MD5"`: Specifies the 128-bit MD5
digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a
message integrity check to ensure that the encryption key was transmitted without error. If
the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the
necessary encryption information in your request so that Amazon S3 can decrypt the object
for copying. This functionality is not supported when the source object is in a directory
bucket.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected destination bucket owner.
If the account ID that you provide does not match the actual owner of the destination
bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-grant-full-control"`: Gives the grantee READ, READ_ACP, and WRITE_ACP permissions
on the object. This functionality is not supported for directory buckets. This
functionality is not supported for Amazon S3 on Outposts.
- `"x-amz-grant-read"`: Allows grantee to read the object data and its metadata. This
functionality is not supported for directory buckets. This functionality is not supported
for Amazon S3 on Outposts.
- `"x-amz-grant-read-acp"`: Allows grantee to read the object ACL. This functionality is
not supported for directory buckets. This functionality is not supported for Amazon S3 on
Outposts.
- `"x-amz-grant-write-acp"`: Allows grantee to write the ACL for the applicable object.
This functionality is not supported for directory buckets. This functionality is not
supported for Amazon S3 on Outposts.
- `"x-amz-meta-"`: A map of metadata to store with the object in S3.
- `"x-amz-metadata-directive"`: Specifies whether the metadata is copied from the source
object or replaced with metadata that's provided in the request. When copying an object,
you can preserve all metadata (the default) or specify new metadata. If this header isn’t
specified, COPY is the default behavior. General purpose bucket - For general purpose
buckets, when you grant permissions, you can use the s3:x-amz-metadata-directive condition
key to enforce certain metadata behavior when objects are uploaded. For more information,
see Amazon S3 condition key examples in the Amazon S3 User Guide.
x-amz-website-redirect-location is unique to each object and is not copied when using the
x-amz-metadata-directive header. To copy the value, you must specify
x-amz-website-redirect-location in the request header.
- `"x-amz-object-lock-legal-hold"`: Specifies whether you want to apply a legal hold to the
object copy. This functionality is not supported for directory buckets.
- `"x-amz-object-lock-mode"`: The Object Lock mode that you want to apply to the object
copy. This functionality is not supported for directory buckets.
- `"x-amz-object-lock-retain-until-date"`: The date and time when you want the Object Lock
of the object copy to expire. This functionality is not supported for directory buckets.
- `"x-amz-request-payer"`:
- `"x-amz-server-side-encryption"`: The server-side encryption algorithm used when storing
this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse). Unrecognized or
unsupported values won’t write a destination object and will receive a 400 Bad Request
response. Amazon S3 automatically encrypts all new objects that are copied to an S3
bucket. When copying an object, if you don't specify encryption information in your copy
request, the encryption setting of the target object is set to the default encryption
configuration of the destination bucket. By default, all buckets have a base level of
encryption configuration that uses server-side encryption with Amazon S3 managed keys
(SSE-S3). If the destination bucket has a default encryption configuration that uses
server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer
server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side
encryption with customer-provided encryption keys (SSE-C), Amazon S3 uses the corresponding
KMS key, or a customer-provided key to encrypt the target object copy. When you perform a
CopyObject operation, if you want to use a different type of encryption setting for the
target object, you can specify appropriate encryption-related headers to encrypt the target
object with an Amazon S3 managed key, a KMS key, or a customer-provided key. If the
encryption setting in your request is different from the default encryption configuration
of the destination bucket, the encryption setting in your request takes precedence. With
server-side encryption, Amazon S3 encrypts your data as it writes your data to disks in its
data centers and decrypts the data when you access it. For more information about
server-side encryption, see Using Server-Side Encryption in the Amazon S3 User Guide. For
directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3)
(AES256) is supported.
- `"x-amz-server-side-encryption-aws-kms-key-id"`: Specifies the KMS ID (Key ID, Key ARN,
or Key Alias) to use for object encryption. All GET and PUT requests for an object
protected by KMS will fail if they're not made via SSL or using SigV4. For information
about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web
Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon
S3 User Guide. This functionality is not supported when the destination bucket is a
directory bucket.
- `"x-amz-server-side-encryption-bucket-key-enabled"`: Specifies whether Amazon S3 should
use an S3 Bucket Key for object encryption with server-side encryption using Key Management
Service (KMS) keys (SSE-KMS). If a target object uses SSE-KMS, you can enable an S3 Bucket
Key for the object. Setting this header to true causes Amazon S3 to use an S3 Bucket Key
for object encryption with SSE-KMS. Specifying this header with a COPY action doesn’t
affect bucket-level settings for S3 Bucket Key. For more information, see Amazon S3 Bucket
Keys in the Amazon S3 User Guide. This functionality is not supported when the destination
bucket is a directory bucket.
- `"x-amz-server-side-encryption-context"`: Specifies the Amazon Web Services KMS
Encryption Context to use for object encryption. The value of this header is a
base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. This
value must be explicitly added to specify encryption context for CopyObject requests. This
functionality is not supported when the destination bucket is a directory bucket.
- `"x-amz-server-side-encryption-customer-algorithm"`: Specifies the algorithm to use when
encrypting the object (for example, AES256). When you perform a CopyObject operation, if
you want to use a different type of encryption setting for the target object, you can
specify appropriate encryption-related headers to encrypt the target object with an Amazon
S3 managed key, a KMS key, or a customer-provided key. If the encryption setting in your
request is different from the default encryption configuration of the destination bucket,
the encryption setting in your request takes precedence. This functionality is not
supported when the destination bucket is a directory bucket.
- `"x-amz-server-side-encryption-customer-key"`: Specifies the customer-provided encryption
key for Amazon S3 to use in encrypting data. This value is used to store the object and
then it is discarded. Amazon S3 does not store the encryption key. The key must be
appropriate for use with the algorithm specified in the
x-amz-server-side-encryption-customer-algorithm header. This functionality is not
supported when the destination bucket is a directory bucket.
- `"x-amz-server-side-encryption-customer-key-MD5"`: Specifies the 128-bit MD5 digest of
the encryption key according to RFC 1321. Amazon S3 uses this header for a message
integrity check to ensure that the encryption key was transmitted without error. This
functionality is not supported when the destination bucket is a directory bucket.
- `"x-amz-source-expected-bucket-owner"`: The account ID of the expected source bucket
owner. If the account ID that you provide does not match the actual owner of the source
bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-storage-class"`: If the x-amz-storage-class header is not used, the copied object
will be stored in the STANDARD Storage Class by default. The STANDARD storage class
provides high durability and high availability. Depending on performance needs, you can
specify a different Storage Class. Directory buckets - For directory buckets, only
the S3 Express One Zone storage class is supported to store newly created objects.
Unsupported storage class values won't write a destination object and will respond with the
HTTP status code 400 Bad Request. Amazon S3 on Outposts - S3 on Outposts only uses the
OUTPOSTS Storage Class. You can use the CopyObject action to change the storage class of
an object that is already stored in Amazon S3 by using the x-amz-storage-class header. For
more information, see Storage Classes in the Amazon S3 User Guide. Before using an object
as a source object for the copy operation, you must restore a copy of it if it meets any of
the following conditions: The storage class of the source object is GLACIER or
DEEP_ARCHIVE. The storage class of the source object is INTELLIGENT_TIERING and it's S3
Intelligent-Tiering access tier is Archive Access or Deep Archive Access. For more
information, see RestoreObject and Copying Objects in the Amazon S3 User Guide.
- `"x-amz-tagging"`: The tag-set for the object copy in the destination bucket. This value
must be used in conjunction with the x-amz-tagging-directive if you choose REPLACE for the
x-amz-tagging-directive. If you choose COPY for the x-amz-tagging-directive, you don't need
to set the x-amz-tagging header, because the tag-set will be copied from the source object
directly. The tag-set must be encoded as URL Query parameters. The default value is the
empty value. Directory buckets - For directory buckets in a CopyObject operation, only
the empty tag-set is supported. Any requests that attempt to write non-empty tags into
directory buckets will receive a 501 Not Implemented status code. When the destination
bucket is a directory bucket, you will receive a 501 Not Implemented response in any of the
following situations: When you attempt to COPY the tag-set from an S3 source object that
has non-empty tags. When you attempt to REPLACE the tag-set of a source object and set a
non-empty value to x-amz-tagging. When you don't set the x-amz-tagging-directive header
and the source object has non-empty tags. This is because the default value of
x-amz-tagging-directive is COPY. Because only the empty tag-set is supported for
directory buckets in a CopyObject operation, the following situations are allowed: When
you attempt to COPY the tag-set from a directory bucket source object that has no tags to a
general purpose bucket. It copies an empty tag-set to the destination object. When you
attempt to REPLACE the tag-set of a directory bucket source object and set the
x-amz-tagging value of the directory bucket destination object to empty. When you attempt
to REPLACE the tag-set of a general purpose bucket source object that has non-empty tags
and set the x-amz-tagging value of the directory bucket destination object to empty. When
you attempt to REPLACE the tag-set of a directory bucket source object and don't set the
x-amz-tagging value of the directory bucket destination object. This is because the default
value of x-amz-tagging is the empty value.
- `"x-amz-tagging-directive"`: Specifies whether the object tag-set is copied from the
source object or replaced with the tag-set that's provided in the request. The default
value is COPY. Directory buckets - For directory buckets in a CopyObject operation, only
the empty tag-set is supported. Any requests that attempt to write non-empty tags into
directory buckets will receive a 501 Not Implemented status code. When the destination
bucket is a directory bucket, you will receive a 501 Not Implemented response in any of the
following situations: When you attempt to COPY the tag-set from an S3 source object that
has non-empty tags. When you attempt to REPLACE the tag-set of a source object and set a
non-empty value to x-amz-tagging. When you don't set the x-amz-tagging-directive header
and the source object has non-empty tags. This is because the default value of
x-amz-tagging-directive is COPY. Because only the empty tag-set is supported for
directory buckets in a CopyObject operation, the following situations are allowed: When
you attempt to COPY the tag-set from a directory bucket source object that has no tags to a
general purpose bucket. It copies an empty tag-set to the destination object. When you
attempt to REPLACE the tag-set of a directory bucket source object and set the
x-amz-tagging value of the directory bucket destination object to empty. When you attempt
to REPLACE the tag-set of a general purpose bucket source object that has non-empty tags
and set the x-amz-tagging value of the directory bucket destination object to empty. When
you attempt to REPLACE the tag-set of a directory bucket source object and don't set the
x-amz-tagging value of the directory bucket destination object. This is because the default
value of x-amz-tagging is the empty value.
- `"x-amz-website-redirect-location"`: If the destination bucket is configured as a
website, redirects requests for this object copy to another object in the same bucket or to
an external URL. Amazon S3 stores the value of this header in the object metadata. This
value is unique to each object and is not copied when using the x-amz-metadata-directive
header. Instead, you may opt to provide this header in combination with the
x-amz-metadata-directive header. This functionality is not supported for directory
buckets.
"""
function copy_object(
Bucket, Key, x_amz_copy_source; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"PUT",
"/$(Bucket)/$(Key)",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-copy-source" => x_amz_copy_source)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function copy_object(
Bucket,
Key,
x_amz_copy_source,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"PUT",
"/$(Bucket)/$(Key)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-copy-source" => x_amz_copy_source)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_bucket(bucket)
create_bucket(bucket, params::Dict{String,<:Any})
This action creates an Amazon S3 bucket. To create an Amazon S3 on Outposts bucket, see
CreateBucket . Creates a new S3 bucket. To create a bucket, you must set up Amazon S3 and
have a valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests
are never allowed to create buckets. By creating the bucket, you become the bucket owner.
There are two types of buckets: general purpose buckets and directory buckets. For more
information about these bucket types, see Creating, configuring, and working with Amazon S3
buckets in the Amazon S3 User Guide. General purpose buckets - If you send your
CreateBucket request to the s3.amazonaws.com global endpoint, the request goes to the
us-east-1 Region. So the signature calculations in Signature Version 4 must use us-east-1
as the Region, even if the location constraint in the request specifies another Region
where the bucket is to be created. If you create a bucket in a Region other than US East
(N. Virginia), your application must be able to handle 307 redirect. For more information,
see Virtual hosting of buckets in the Amazon S3 User Guide. Directory buckets - For
directory buckets, you must make requests for this API operation to the Regional endpoint.
These endpoints support path-style requests in the format
https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style
requests aren't supported. For more information, see Regional and Zonal endpoints in the
Amazon S3 User Guide. Permissions General purpose bucket permissions - In addition
to the s3:CreateBucket permission, the following permissions are required in a policy when
your CreateBucket request includes specific headers: Access control lists (ACLs) - In
your CreateBucket request, if you specify an access control list (ACL) and set it to
public-read, public-read-write, authenticated-read, or if you explicitly specify any other
custom ACLs, both s3:CreateBucket and s3:PutBucketAcl permissions are required. In your
CreateBucket request, if you set the ACL to private, or if you don't specify any ACLs, only
the s3:CreateBucket permission is required. Object Lock - In your CreateBucket request,
if you set x-amz-bucket-object-lock-enabled to true, the
s3:PutBucketObjectLockConfiguration and s3:PutBucketVersioning permissions are required.
S3 Object Ownership - If your CreateBucket request includes the x-amz-object-ownership
header, then the s3:PutBucketOwnershipControls permission is required. To set an ACL on a
bucket as part of a CreateBucket request, you must explicitly set S3 Object Ownership for
the bucket to a different value than the default, BucketOwnerEnforced. Additionally, if
your desired bucket ACL grants public access, you must first create the bucket (without the
bucket ACL) and then explicitly disable Block Public Access on the bucket before using
PutBucketAcl to set the ACL. If you try to create a bucket with a public ACL, the request
will fail. For the majority of modern use cases in S3, we recommend that you keep all
Block Public Access settings enabled and keep ACLs disabled. If you would like to share
data with users outside of your account, you can use bucket policies as needed. For more
information, see Controlling ownership of objects and disabling ACLs for your bucket and
Blocking public access to your Amazon S3 storage in the Amazon S3 User Guide. S3
Block Public Access - If your specific use case requires granting public access to your S3
resources, you can disable Block Public Access. Specifically, you can create a new bucket
with Block Public Access enabled, then separately call the DeletePublicAccessBlock API.
To use this operation, you must have the s3:PutBucketPublicAccessBlock permission. For more
information about S3 Block Public Access, see Blocking public access to your Amazon S3
storage in the Amazon S3 User Guide. Directory bucket permissions - You must have
the s3express:CreateBucket permission in an IAM identity-based policy instead of a bucket
policy. Cross-account access to this API operation isn't supported. This operation can only
be performed by the Amazon Web Services account that owns the resource. For more
information about directory bucket policies and permissions, see Amazon Web Services
Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.
The permissions for ACLs, Object Lock, S3 Object Ownership, and S3 Block Public Access are
not supported for directory buckets. For directory buckets, all Block Public Access
settings are enabled at the bucket level and S3 Object Ownership is set to Bucket owner
enforced (ACLs disabled). These settings can't be modified. For more information about
permissions for creating and working with directory buckets, see Directory buckets in the
Amazon S3 User Guide. For more information about supported S3 features for directory
buckets, see Features of S3 Express One Zone in the Amazon S3 User Guide. HTTP Host
header syntax Directory buckets - The HTTP Host header syntax is
s3express-control.region.amazonaws.com. The following operations are related to
CreateBucket: PutObject DeleteBucket
# Arguments
- `bucket`: The name of the bucket to create. General purpose buckets - For information
about bucket naming restrictions, see Bucket naming rules in the Amazon S3 User Guide.
Directory buckets - When you use this operation with a directory bucket, you must use
path-style requests in the format
https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style
requests aren't supported. Directory bucket names must be unique in the chosen Availability
Zone. Bucket names must also follow the format bucket_base_name--az_id--x-s3 (for example,
DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see
Directory bucket naming rules in the Amazon S3 User Guide
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreateBucketConfiguration"`: The configuration information for the bucket.
- `"x-amz-acl"`: The canned ACL to apply to the bucket. This functionality is not
supported for directory buckets.
- `"x-amz-bucket-object-lock-enabled"`: Specifies whether you want S3 Object Lock to be
enabled for the new bucket. This functionality is not supported for directory buckets.
- `"x-amz-grant-full-control"`: Allows grantee the read, write, read ACP, and write ACP
permissions on the bucket. This functionality is not supported for directory buckets.
- `"x-amz-grant-read"`: Allows grantee to list the objects in the bucket. This
functionality is not supported for directory buckets.
- `"x-amz-grant-read-acp"`: Allows grantee to read the bucket ACL. This functionality is
not supported for directory buckets.
- `"x-amz-grant-write"`: Allows grantee to create new objects in the bucket. For the bucket
and object owners of existing objects, also allows deletions and overwrites of those
objects. This functionality is not supported for directory buckets.
- `"x-amz-grant-write-acp"`: Allows grantee to write the ACL for the applicable bucket.
This functionality is not supported for directory buckets.
- `"x-amz-object-ownership"`:
"""
function create_bucket(Bucket; aws_config::AbstractAWSConfig=global_aws_config())
return s3("PUT", "/$(Bucket)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function create_bucket(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"PUT", "/$(Bucket)", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
create_multipart_upload(bucket, key)
create_multipart_upload(bucket, key, params::Dict{String,<:Any})
This action initiates a multipart upload and returns an upload ID. This upload ID is used
to associate all of the parts in the specific multipart upload. You specify this upload ID
in each of your subsequent upload part requests (see UploadPart). You also include this
upload ID in the final request to either complete or abort the multipart upload request.
For more information about multipart uploads, see Multipart Upload Overview in the Amazon
S3 User Guide. After you initiate a multipart upload and upload one or more parts, to stop
being charged for storing the uploaded parts, you must either complete or abort the
multipart upload. Amazon S3 frees up the space used to store the parts and stops charging
you for storing them only after you either complete or abort a multipart upload. If you
have configured a lifecycle rule to abort incomplete multipart uploads, the created
multipart upload must be completed within the number of days specified in the bucket
lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an
abort action and Amazon S3 aborts the multipart upload. For more information, see Aborting
Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration. Directory buckets
- S3 Lifecycle is not supported by directory buckets. Directory buckets - For directory
buckets, you must make requests for this API operation to the Zonal endpoint. These
endpoints support virtual-hosted-style requests in the format
https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are
not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User
Guide. Request signing For request signing, multipart upload is just a series of
regular requests. You initiate a multipart upload, send one or more requests to upload
parts, and then complete the multipart upload process. You sign each request individually.
There is nothing special about signing multipart upload requests. For more information
about signing, see Authenticating Requests (Amazon Web Services Signature Version 4) in the
Amazon S3 User Guide. Permissions General purpose bucket permissions - For information
about the permissions required to use the multipart upload API, see Multipart upload and
permissions in the Amazon S3 User Guide. To perform a multipart upload with encryption by
using an Amazon Web Services KMS key, the requester must have permission to the kms:Decrypt
and kms:GenerateDataKey* actions on the key. These permissions are required because Amazon
S3 must decrypt and read data from the encrypted file parts before it completes the
multipart upload. For more information, see Multipart upload API and permissions and
Protecting data using server-side encryption with Amazon Web Services KMS in the Amazon S3
User Guide. Directory bucket permissions - To grant access to this API operation on a
directory bucket, we recommend that you use the CreateSession API operation for
session-based authorization. Specifically, you grant the s3express:CreateSession permission
to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make
the CreateSession API call on the bucket to obtain a session token. With the session token
in your request header, you can make API requests to this operation. After the session
token expires, you make another CreateSession API call to generate a new session token for
use. Amazon Web Services CLI or SDKs create session and refresh the session token
automatically to avoid service interruptions when a session expires. For more information
about authorization, see CreateSession . Encryption General purpose buckets -
Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it
writes it to disks in its data centers and decrypts it when you access it. Amazon S3
automatically encrypts all new objects that are uploaded to an S3 bucket. When doing a
multipart upload, if you don't specify encryption information in your request, the
encryption setting of the uploaded parts is set to the default encryption configuration of
the destination bucket. By default, all buckets have a base level of encryption
configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the
destination bucket has a default encryption configuration that uses server-side encryption
with an Key Management Service (KMS) key (SSE-KMS), or a customer-provided encryption key
(SSE-C), Amazon S3 uses the corresponding KMS key, or a customer-provided key to encrypt
the uploaded parts. When you perform a CreateMultipartUpload operation, if you want to use
a different type of encryption setting for the uploaded parts, you can request that Amazon
S3 encrypts the object with a different encryption key (such as an Amazon S3 managed key, a
KMS key, or a customer-provided key). When the encryption setting in your request is
different from the default encryption configuration of the destination bucket, the
encryption setting in your request takes precedence. If you choose to provide your own
encryption key, the request headers you provide in UploadPart and UploadPartCopy requests
must match the headers you used in the CreateMultipartUpload request. Use KMS keys
(SSE-KMS) that include the Amazon Web Services managed key (aws/s3) and KMS customer
managed keys stored in Key Management Service (KMS) – If you want Amazon Web Services to
manage the keys used to encrypt data, specify the following headers in the request.
x-amz-server-side-encryption x-amz-server-side-encryption-aws-kms-key-id
x-amz-server-side-encryption-context If you specify
x-amz-server-side-encryption:aws:kms, but don't provide
x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed
key (aws/s3 key) in KMS to protect the data. To perform a multipart upload with
encryption by using an Amazon Web Services KMS key, the requester must have permission to
the kms:Decrypt and kms:GenerateDataKey* actions on the key. These permissions are required
because Amazon S3 must decrypt and read data from the encrypted file parts before it
completes the multipart upload. For more information, see Multipart upload API and
permissions and Protecting data using server-side encryption with Amazon Web Services KMS
in the Amazon S3 User Guide. If your Identity and Access Management (IAM) user or role is
in the same Amazon Web Services account as the KMS key, then you must have these
permissions on the key policy. If your IAM user or role is in a different account from the
key, then you must have the permissions on both the key policy and your IAM user or role.
All GET and PUT requests for an object protected by KMS fail if you don't make them by
using Secure Sockets Layer (SSL), Transport Layer Security (TLS), or Signature Version 4.
For information about configuring any of the officially supported Amazon Web Services SDKs
and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication
in the Amazon S3 User Guide. For more information about server-side encryption with KMS
keys (SSE-KMS), see Protecting Data Using Server-Side Encryption with KMS keys in the
Amazon S3 User Guide. Use customer-provided encryption keys (SSE-C) – If you want to
manage your own encryption keys, provide all the following headers in the request.
x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5
For more information about server-side encryption with customer-provided encryption keys
(SSE-C), see Protecting data using server-side encryption with customer-provided
encryption keys (SSE-C) in the Amazon S3 User Guide. Directory buckets -For directory
buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is
supported. HTTP Host header syntax Directory buckets - The HTTP Host header syntax is
Bucket_name.s3express-az_id.region.amazonaws.com. The following operations are related
to CreateMultipartUpload: UploadPart CompleteMultipartUpload
AbortMultipartUpload ListParts ListMultipartUploads
# Arguments
- `bucket`: The name of the bucket where the multipart upload is initiated and where the
object is uploaded. Directory buckets - When you use this operation with a directory
bucket, you must use virtual-hosted-style requests in the format
Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported.
Directory bucket names must be unique in the chosen Availability Zone. Bucket names must
follow the format bucket_base_name--az-id--x-s3 (for example,
DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see
Directory bucket naming rules in the Amazon S3 User Guide. Access points - When you use
this action with an access point, you must provide the alias of the access point in place
of the bucket name or specify the access point ARN. When using the access point ARN, you
must direct requests to the access point hostname. The access point hostname takes the form
AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with
an access point through the Amazon Web Services SDKs, you provide the access point ARN in
place of the bucket name. For more information about access point ARNs, see Using access
points in the Amazon S3 User Guide. Access points and Object Lambda access points are not
supported by directory buckets. S3 on Outposts - When you use this action with Amazon S3
on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts
hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this
action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
access point ARN in place of the bucket name. For more information about S3 on Outposts
ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
- `key`: Object key for which the multipart upload is to be initiated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Cache-Control"`: Specifies caching behavior along the request/reply chain.
- `"Content-Disposition"`: Specifies presentational information for the object.
- `"Content-Encoding"`: Specifies what content encodings have been applied to the object
and thus what decoding mechanisms must be applied to obtain the media-type referenced by
the Content-Type header field. For directory buckets, only the aws-chunked value is
supported in this header field.
- `"Content-Language"`: The language that the content is in.
- `"Content-Type"`: A standard MIME type describing the format of the object data.
- `"Expires"`: The date and time at which the object is no longer cacheable.
- `"x-amz-acl"`: The canned ACL to apply to the object. Amazon S3 supports a set of
predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and
permissions. For more information, see Canned ACL in the Amazon S3 User Guide. By default,
all objects are private. Only the owner has full access control. When uploading an object,
you can grant access permissions to individual Amazon Web Services accounts or to
predefined groups defined by Amazon S3. These permissions are then added to the access
control list (ACL) on the new object. For more information, see Using ACLs. One way to
grant the permissions using the request headers is to specify a canned ACL with the
x-amz-acl request header. This functionality is not supported for directory buckets.
This functionality is not supported for Amazon S3 on Outposts.
- `"x-amz-checksum-algorithm"`: Indicates the algorithm that you want Amazon S3 to use to
create the checksum for the object. For more information, see Checking object integrity in
the Amazon S3 User Guide.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-grant-full-control"`: Specify access permissions explicitly to give the grantee
READ, READ_ACP, and WRITE_ACP permissions on the object. By default, all objects are
private. Only the owner has full access control. When uploading an object, you can use this
header to explicitly grant access permissions to specific Amazon Web Services accounts or
groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For
more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide. You
specify each grantee as a type=value pair, where the type is one of the following: id
– if the value specified is the canonical user ID of an Amazon Web Services account
uri – if you are granting permissions to a predefined group emailAddress – if the
value specified is the email address of an Amazon Web Services account Using email
addresses to specify a grantee is only supported in the following Amazon Web Services
Regions: US East (N. Virginia) US West (N. California) US West (Oregon) Asia
Pacific (Singapore) Asia Pacific (Sydney) Asia Pacific (Tokyo) Europe (Ireland)
South America (São Paulo) For a list of all the Amazon S3 supported Regions and
endpoints, see Regions and Endpoints in the Amazon Web Services General Reference. For
example, the following x-amz-grant-read header grants the Amazon Web Services accounts
identified by account IDs permissions to read object data and its metadata:
x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" This functionality is not
supported for directory buckets. This functionality is not supported for Amazon S3 on
Outposts.
- `"x-amz-grant-read"`: Specify access permissions explicitly to allow grantee to read the
object data and its metadata. By default, all objects are private. Only the owner has full
access control. When uploading an object, you can use this header to explicitly grant
access permissions to specific Amazon Web Services accounts or groups. This header maps to
specific permissions that Amazon S3 supports in an ACL. For more information, see Access
Control List (ACL) Overview in the Amazon S3 User Guide. You specify each grantee as a
type=value pair, where the type is one of the following: id – if the value specified
is the canonical user ID of an Amazon Web Services account uri – if you are granting
permissions to a predefined group emailAddress – if the value specified is the email
address of an Amazon Web Services account Using email addresses to specify a grantee is
only supported in the following Amazon Web Services Regions: US East (N. Virginia) US
West (N. California) US West (Oregon) Asia Pacific (Singapore) Asia Pacific
(Sydney) Asia Pacific (Tokyo) Europe (Ireland) South America (São Paulo) For a
list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the
Amazon Web Services General Reference. For example, the following x-amz-grant-read
header grants the Amazon Web Services accounts identified by account IDs permissions to
read object data and its metadata: x-amz-grant-read: id=\"11112222333\",
id=\"444455556666\" This functionality is not supported for directory buckets. This
functionality is not supported for Amazon S3 on Outposts.
- `"x-amz-grant-read-acp"`: Specify access permissions explicitly to allows grantee to read
the object ACL. By default, all objects are private. Only the owner has full access
control. When uploading an object, you can use this header to explicitly grant access
permissions to specific Amazon Web Services accounts or groups. This header maps to
specific permissions that Amazon S3 supports in an ACL. For more information, see Access
Control List (ACL) Overview in the Amazon S3 User Guide. You specify each grantee as a
type=value pair, where the type is one of the following: id – if the value specified
is the canonical user ID of an Amazon Web Services account uri – if you are granting
permissions to a predefined group emailAddress – if the value specified is the email
address of an Amazon Web Services account Using email addresses to specify a grantee is
only supported in the following Amazon Web Services Regions: US East (N. Virginia) US
West (N. California) US West (Oregon) Asia Pacific (Singapore) Asia Pacific
(Sydney) Asia Pacific (Tokyo) Europe (Ireland) South America (São Paulo) For a
list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the
Amazon Web Services General Reference. For example, the following x-amz-grant-read
header grants the Amazon Web Services accounts identified by account IDs permissions to
read object data and its metadata: x-amz-grant-read: id=\"11112222333\",
id=\"444455556666\" This functionality is not supported for directory buckets. This
functionality is not supported for Amazon S3 on Outposts.
- `"x-amz-grant-write-acp"`: Specify access permissions explicitly to allows grantee to
allow grantee to write the ACL for the applicable object. By default, all objects are
private. Only the owner has full access control. When uploading an object, you can use this
header to explicitly grant access permissions to specific Amazon Web Services accounts or
groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For
more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide. You
specify each grantee as a type=value pair, where the type is one of the following: id
– if the value specified is the canonical user ID of an Amazon Web Services account
uri – if you are granting permissions to a predefined group emailAddress – if the
value specified is the email address of an Amazon Web Services account Using email
addresses to specify a grantee is only supported in the following Amazon Web Services
Regions: US East (N. Virginia) US West (N. California) US West (Oregon) Asia
Pacific (Singapore) Asia Pacific (Sydney) Asia Pacific (Tokyo) Europe (Ireland)
South America (São Paulo) For a list of all the Amazon S3 supported Regions and
endpoints, see Regions and Endpoints in the Amazon Web Services General Reference. For
example, the following x-amz-grant-read header grants the Amazon Web Services accounts
identified by account IDs permissions to read object data and its metadata:
x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" This functionality is not
supported for directory buckets. This functionality is not supported for Amazon S3 on
Outposts.
- `"x-amz-meta-"`: A map of metadata to store with the object in S3.
- `"x-amz-object-lock-legal-hold"`: Specifies whether you want to apply a legal hold to the
uploaded object. This functionality is not supported for directory buckets.
- `"x-amz-object-lock-mode"`: Specifies the Object Lock mode that you want to apply to the
uploaded object. This functionality is not supported for directory buckets.
- `"x-amz-object-lock-retain-until-date"`: Specifies the date and time when you want the
Object Lock to expire. This functionality is not supported for directory buckets.
- `"x-amz-request-payer"`:
- `"x-amz-server-side-encryption"`: The server-side encryption algorithm used when you
store this object in Amazon S3 (for example, AES256, aws:kms). For directory buckets, only
server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.
- `"x-amz-server-side-encryption-aws-kms-key-id"`: Specifies the ID (Key ID, Key ARN, or
Key Alias) of the symmetric encryption customer managed key to use for object encryption.
This functionality is not supported for directory buckets.
- `"x-amz-server-side-encryption-bucket-key-enabled"`: Specifies whether Amazon S3 should
use an S3 Bucket Key for object encryption with server-side encryption using Key Management
Service (KMS) keys (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3
Bucket Key for object encryption with SSE-KMS. Specifying this header with an object action
doesn’t affect bucket-level settings for S3 Bucket Key. This functionality is not
supported for directory buckets.
- `"x-amz-server-side-encryption-context"`: Specifies the Amazon Web Services KMS
Encryption Context to use for object encryption. The value of this header is a
base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. This
functionality is not supported for directory buckets.
- `"x-amz-server-side-encryption-customer-algorithm"`: Specifies the algorithm to use when
encrypting the object (for example, AES256). This functionality is not supported for
directory buckets.
- `"x-amz-server-side-encryption-customer-key"`: Specifies the customer-provided encryption
key for Amazon S3 to use in encrypting data. This value is used to store the object and
then it is discarded; Amazon S3 does not store the encryption key. The key must be
appropriate for use with the algorithm specified in the
x-amz-server-side-encryption-customer-algorithm header. This functionality is not
supported for directory buckets.
- `"x-amz-server-side-encryption-customer-key-MD5"`: Specifies the 128-bit MD5 digest of
the customer-provided encryption key according to RFC 1321. Amazon S3 uses this header for
a message integrity check to ensure that the encryption key was transmitted without error.
This functionality is not supported for directory buckets.
- `"x-amz-storage-class"`: By default, Amazon S3 uses the STANDARD Storage Class to store
newly created objects. The STANDARD storage class provides high durability and high
availability. Depending on performance needs, you can specify a different Storage Class.
For more information, see Storage Classes in the Amazon S3 User Guide. For directory
buckets, only the S3 Express One Zone storage class is supported to store newly created
objects. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
- `"x-amz-tagging"`: The tag-set for the object. The tag-set must be encoded as URL Query
parameters. This functionality is not supported for directory buckets.
- `"x-amz-website-redirect-location"`: If the bucket is configured as a website, redirects
requests for this object to another object in the same bucket or to an external URL. Amazon
S3 stores the value of this header in the object metadata. This functionality is not
supported for directory buckets.
"""
function create_multipart_upload(
Bucket, Key; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"POST",
"/$(Bucket)/$(Key)?uploads";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_multipart_upload(
Bucket,
Key,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"POST",
"/$(Bucket)/$(Key)?uploads",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_session(bucket)
create_session(bucket, params::Dict{String,<:Any})
Creates a session that establishes temporary security credentials to support fast
authentication and authorization for the Zonal endpoint APIs on directory buckets. For more
information about Zonal endpoint APIs that include the Availability Zone in the request
endpoint, see S3 Express One Zone APIs in the Amazon S3 User Guide. To make Zonal endpoint
API requests on a directory bucket, use the CreateSession API operation. Specifically, you
grant s3express:CreateSession permission to a bucket in a bucket policy or an IAM
identity-based policy. Then, you use IAM credentials to make the CreateSession API request
on the bucket, which returns temporary security credentials that include the access key ID,
secret access key, session token, and expiration. These credentials have associated
permissions to access the Zonal endpoint APIs. After the session is created, you don’t
need to use other policies to grant permissions to each Zonal endpoint API individually.
Instead, in your Zonal endpoint API requests, you sign your requests by applying the
temporary security credentials of the session to the request headers and following the
SigV4 protocol for authentication. You also apply the session token to the
x-amz-s3session-token request header for authorization. Temporary security credentials are
scoped to the bucket and expire after 5 minutes. After the expiration time, any calls that
you make with those credentials will fail. You must use IAM credentials again to make a
CreateSession API request that generates a new set of temporary credentials for use.
Temporary credentials cannot be extended or refreshed beyond the original specified
interval. If you use Amazon Web Services SDKs, SDKs handle the session token refreshes
automatically to avoid service interruptions when a session expires. We recommend that you
use the Amazon Web Services SDKs to initiate and manage requests to the CreateSession API.
For more information, see Performance guidelines and design patterns in the Amazon S3 User
Guide. You must make requests for this API operation to the Zonal endpoint. These
endpoints support virtual-hosted-style requests in the format
https://bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not
supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User
Guide. CopyObject API operation - Unlike other Zonal endpoint APIs, the CopyObject API
operation doesn't use the temporary security credentials returned from the CreateSession
API operation for authentication and authorization. For information about authentication
and authorization of the CopyObject API operation on directory buckets, see CopyObject.
HeadBucket API operation - Unlike other Zonal endpoint APIs, the HeadBucket API operation
doesn't use the temporary security credentials returned from the CreateSession API
operation for authentication and authorization. For information about authentication and
authorization of the HeadBucket API operation on directory buckets, see HeadBucket.
Permissions To obtain temporary security credentials, you must create a bucket policy or
an IAM identity-based policy that grants s3express:CreateSession permission to the bucket.
In a policy, you can have the s3express:SessionMode condition key to control who can create
a ReadWrite or ReadOnly session. For more information about ReadWrite or ReadOnly sessions,
see x-amz-create-session-mode . For example policies, see Example bucket policies for S3
Express One Zone and Amazon Web Services Identity and Access Management (IAM)
identity-based policies for S3 Express One Zone in the Amazon S3 User Guide. To grant
cross-account access to Zonal endpoint APIs, the bucket policy should also grant both
accounts the s3express:CreateSession permission. HTTP Host header syntax Directory
buckets - The HTTP Host header syntax is
Bucket_name.s3express-az_id.region.amazonaws.com.
# Arguments
- `bucket`: The name of the bucket that you create a session for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-create-session-mode"`: Specifies the mode of the session that will be created,
either ReadWrite or ReadOnly. By default, a ReadWrite session is created. A ReadWrite
session is capable of executing all the Zonal endpoint APIs on a directory bucket. A
ReadOnly session is constrained to execute the following Zonal endpoint APIs: GetObject,
HeadObject, ListObjectsV2, GetObjectAttributes, ListParts, and ListMultipartUploads.
"""
function create_session(Bucket; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"GET", "/$(Bucket)?session"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function create_session(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?session",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_bucket(bucket)
delete_bucket(bucket, params::Dict{String,<:Any})
Deletes the S3 bucket. All objects (including all object versions and delete markers) in
the bucket must be deleted before the bucket itself can be deleted. Directory buckets -
If multipart uploads in a directory bucket are in progress, you can't delete the bucket
until all the in-progress multipart uploads are aborted or completed. Directory buckets
- For directory buckets, you must make requests for this API operation to the Regional
endpoint. These endpoints support path-style requests in the format
https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style
requests aren't supported. For more information, see Regional and Zonal endpoints in the
Amazon S3 User Guide. Permissions General purpose bucket permissions - You must
have the s3:DeleteBucket permission on the specified bucket in a policy. Directory
bucket permissions - You must have the s3express:DeleteBucket permission in an IAM
identity-based policy instead of a bucket policy. Cross-account access to this API
operation isn't supported. This operation can only be performed by the Amazon Web Services
account that owns the resource. For more information about directory bucket policies and
permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express
One Zone in the Amazon S3 User Guide. HTTP Host header syntax Directory buckets - The
HTTP Host header syntax is s3express-control.region.amazonaws.com. The following
operations are related to DeleteBucket: CreateBucket DeleteObject
# Arguments
- `bucket`: Specifies the bucket being deleted. Directory buckets - When you use this
operation with a directory bucket, you must use path-style requests in the format
https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style
requests aren't supported. Directory bucket names must be unique in the chosen Availability
Zone. Bucket names must also follow the format bucket_base_name--az_id--x-s3 (for example,
DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see
Directory bucket naming rules in the Amazon S3 User Guide
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied). For directory buckets, this
header is not supported in this API operation. If you specify this header, the request
fails with the HTTP status code 501 Not Implemented.
"""
function delete_bucket(Bucket; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"DELETE", "/$(Bucket)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_bucket(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"DELETE",
"/$(Bucket)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_bucket_analytics_configuration(bucket, id)
delete_bucket_analytics_configuration(bucket, id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Deletes an analytics configuration
for the bucket (specified by the analytics configuration ID). To use this operation, you
must have permissions to perform the s3:PutAnalyticsConfiguration action. The bucket owner
has this permission by default. The bucket owner can grant this permission to others. For
more information about permissions, see Permissions Related to Bucket Subresource
Operations and Managing Access Permissions to Your Amazon S3 Resources. For information
about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.
The following operations are related to DeleteBucketAnalyticsConfiguration:
GetBucketAnalyticsConfiguration ListBucketAnalyticsConfigurations
PutBucketAnalyticsConfiguration
# Arguments
- `bucket`: The name of the bucket from which an analytics configuration is deleted.
- `id`: The ID that identifies the analytics configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function delete_bucket_analytics_configuration(
Bucket, id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"DELETE",
"/$(Bucket)?analytics",
Dict{String,Any}("id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_bucket_analytics_configuration(
Bucket,
id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"DELETE",
"/$(Bucket)?analytics",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("id" => id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_bucket_cors(bucket)
delete_bucket_cors(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Deletes the cors configuration
information set for the bucket. To use this operation, you must have permission to perform
the s3:PutBucketCORS action. The bucket owner has this permission by default and can grant
this permission to others. For information about cors, see Enabling Cross-Origin Resource
Sharing in the Amazon S3 User Guide. Related Resources PutBucketCors
RESTOPTIONSobject
# Arguments
- `bucket`: Specifies the bucket whose cors configuration is being deleted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function delete_bucket_cors(Bucket; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"DELETE", "/$(Bucket)?cors"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_bucket_cors(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"DELETE",
"/$(Bucket)?cors",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_bucket_encryption(bucket)
delete_bucket_encryption(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. This implementation of the DELETE
action resets the default encryption for the bucket as server-side encryption with Amazon
S3 managed keys (SSE-S3). For information about the bucket default encryption feature, see
Amazon S3 Bucket Default Encryption in the Amazon S3 User Guide. To use this operation, you
must have permissions to perform the s3:PutEncryptionConfiguration action. The bucket owner
has this permission by default. The bucket owner can grant this permission to others. For
more information about permissions, see Permissions Related to Bucket Subresource
Operations and Managing Access Permissions to your Amazon S3 Resources in the Amazon S3
User Guide. The following operations are related to DeleteBucketEncryption:
PutBucketEncryption GetBucketEncryption
# Arguments
- `bucket`: The name of the bucket containing the server-side encryption configuration to
delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function delete_bucket_encryption(Bucket; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"DELETE",
"/$(Bucket)?encryption";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_bucket_encryption(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"DELETE",
"/$(Bucket)?encryption",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_bucket_intelligent_tiering_configuration(bucket, id)
delete_bucket_intelligent_tiering_configuration(bucket, id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Deletes the S3 Intelligent-Tiering
configuration from the specified bucket. The S3 Intelligent-Tiering storage class is
designed to optimize storage costs by automatically moving data to the most cost-effective
storage access tier, without performance impact or operational overhead. S3
Intelligent-Tiering delivers automatic cost savings in three low latency and high
throughput access tiers. To get the lowest storage cost on data that can be accessed in
minutes to hours, you can choose to activate additional archiving capabilities. The S3
Intelligent-Tiering storage class is the ideal storage class for data with unknown,
changing, or unpredictable access patterns, independent of object size or retention period.
If the size of an object is less than 128 KB, it is not monitored and not eligible for
auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent
Access tier rates in the S3 Intelligent-Tiering storage class. For more information, see
Storage class for automatically optimizing frequently and infrequently accessed objects.
Operations related to DeleteBucketIntelligentTieringConfiguration include:
GetBucketIntelligentTieringConfiguration PutBucketIntelligentTieringConfiguration
ListBucketIntelligentTieringConfigurations
# Arguments
- `bucket`: The name of the Amazon S3 bucket whose configuration you want to modify or
retrieve.
- `id`: The ID used to identify the S3 Intelligent-Tiering configuration.
"""
function delete_bucket_intelligent_tiering_configuration(
Bucket, id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"DELETE",
"/$(Bucket)?intelligent-tiering",
Dict{String,Any}("id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_bucket_intelligent_tiering_configuration(
Bucket,
id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"DELETE",
"/$(Bucket)?intelligent-tiering",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("id" => id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_bucket_inventory_configuration(bucket, id)
delete_bucket_inventory_configuration(bucket, id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Deletes an inventory configuration
(identified by the inventory ID) from the bucket. To use this operation, you must have
permissions to perform the s3:PutInventoryConfiguration action. The bucket owner has this
permission by default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations and
Managing Access Permissions to Your Amazon S3 Resources. For information about the Amazon
S3 inventory feature, see Amazon S3 Inventory. Operations related to
DeleteBucketInventoryConfiguration include: GetBucketInventoryConfiguration
PutBucketInventoryConfiguration ListBucketInventoryConfigurations
# Arguments
- `bucket`: The name of the bucket containing the inventory configuration to delete.
- `id`: The ID used to identify the inventory configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function delete_bucket_inventory_configuration(
Bucket, id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"DELETE",
"/$(Bucket)?inventory",
Dict{String,Any}("id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_bucket_inventory_configuration(
Bucket,
id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"DELETE",
"/$(Bucket)?inventory",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("id" => id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_bucket_lifecycle(bucket)
delete_bucket_lifecycle(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Deletes the lifecycle configuration
from the specified bucket. Amazon S3 removes all the lifecycle configuration rules in the
lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3
no longer automatically deletes any objects on the basis of rules contained in the deleted
lifecycle configuration. To use this operation, you must have permission to perform the
s3:PutLifecycleConfiguration action. By default, the bucket owner has this permission and
the bucket owner can grant this permission to others. There is usually some time lag before
lifecycle configuration deletion is fully propagated to all the Amazon S3 systems. For more
information about the object expiration, see Elements to Describe Lifecycle Actions.
Related actions include: PutBucketLifecycleConfiguration
GetBucketLifecycleConfiguration
# Arguments
- `bucket`: The bucket name of the lifecycle to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function delete_bucket_lifecycle(Bucket; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"DELETE",
"/$(Bucket)?lifecycle";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_bucket_lifecycle(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"DELETE",
"/$(Bucket)?lifecycle",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_bucket_metrics_configuration(bucket, id)
delete_bucket_metrics_configuration(bucket, id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Deletes a metrics configuration for
the Amazon CloudWatch request metrics (specified by the metrics configuration ID) from the
bucket. Note that this doesn't include the daily storage metrics. To use this operation,
you must have permissions to perform the s3:PutMetricsConfiguration action. The bucket
owner has this permission by default. The bucket owner can grant this permission to others.
For more information about permissions, see Permissions Related to Bucket Subresource
Operations and Managing Access Permissions to Your Amazon S3 Resources. For information
about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon
CloudWatch. The following operations are related to DeleteBucketMetricsConfiguration:
GetBucketMetricsConfiguration PutBucketMetricsConfiguration
ListBucketMetricsConfigurations Monitoring Metrics with Amazon CloudWatch
# Arguments
- `bucket`: The name of the bucket containing the metrics configuration to delete.
- `id`: The ID used to identify the metrics configuration. The ID has a 64 character limit
and can only contain letters, numbers, periods, dashes, and underscores.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function delete_bucket_metrics_configuration(
Bucket, id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"DELETE",
"/$(Bucket)?metrics",
Dict{String,Any}("id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_bucket_metrics_configuration(
Bucket,
id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"DELETE",
"/$(Bucket)?metrics",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("id" => id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_bucket_ownership_controls(bucket)
delete_bucket_ownership_controls(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Removes OwnershipControls for an
Amazon S3 bucket. To use this operation, you must have the s3:PutBucketOwnershipControls
permission. For more information about Amazon S3 permissions, see Specifying Permissions in
a Policy. For information about Amazon S3 Object Ownership, see Using Object Ownership.
The following operations are related to DeleteBucketOwnershipControls:
GetBucketOwnershipControls PutBucketOwnershipControls
# Arguments
- `bucket`: The Amazon S3 bucket whose OwnershipControls you want to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function delete_bucket_ownership_controls(
Bucket; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"DELETE",
"/$(Bucket)?ownershipControls";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_bucket_ownership_controls(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"DELETE",
"/$(Bucket)?ownershipControls",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_bucket_policy(bucket)
delete_bucket_policy(bucket, params::Dict{String,<:Any})
Deletes the policy of a specified bucket. Directory buckets - For directory buckets, you
must make requests for this API operation to the Regional endpoint. These endpoints support
path-style requests in the format
https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style
requests aren't supported. For more information, see Regional and Zonal endpoints in the
Amazon S3 User Guide. Permissions If you are using an identity other than the root user
of the Amazon Web Services account that owns the bucket, the calling identity must both
have the DeleteBucketPolicy permissions on the specified bucket and belong to the bucket
owner's account in order to use this operation. If you don't have DeleteBucketPolicy
permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct
permissions, but you're not using an identity that belongs to the bucket owner's account,
Amazon S3 returns a 405 Method Not Allowed error. To ensure that bucket owners don't
inadvertently lock themselves out of their own buckets, the root principal in a bucket
owner's Amazon Web Services account can perform the GetBucketPolicy, PutBucketPolicy, and
DeleteBucketPolicy API actions, even if their bucket policy explicitly denies the root
principal's access. Bucket owner root principals can only be blocked from performing these
API actions by VPC endpoint policies and Amazon Web Services Organizations policies.
General purpose bucket permissions - The s3:DeleteBucketPolicy permission is required in a
policy. For more information about general purpose buckets bucket policies, see Using
Bucket Policies and User Policies in the Amazon S3 User Guide. Directory bucket
permissions - To grant access to this API operation, you must have the
s3express:DeleteBucketPolicy permission in an IAM identity-based policy instead of a bucket
policy. Cross-account access to this API operation isn't supported. This operation can only
be performed by the Amazon Web Services account that owns the resource. For more
information about directory bucket policies and permissions, see Amazon Web Services
Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.
HTTP Host header syntax Directory buckets - The HTTP Host header syntax is
s3express-control.region.amazonaws.com. The following operations are related to
DeleteBucketPolicy CreateBucket DeleteObject
# Arguments
- `bucket`: The bucket name. Directory buckets - When you use this operation with a
directory bucket, you must use path-style requests in the format
https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style
requests aren't supported. Directory bucket names must be unique in the chosen Availability
Zone. Bucket names must also follow the format bucket_base_name--az_id--x-s3 (for example,
DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see
Directory bucket naming rules in the Amazon S3 User Guide
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied). For directory buckets, this
header is not supported in this API operation. If you specify this header, the request
fails with the HTTP status code 501 Not Implemented.
"""
function delete_bucket_policy(Bucket; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"DELETE",
"/$(Bucket)?policy";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_bucket_policy(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"DELETE",
"/$(Bucket)?policy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_bucket_replication(bucket)
delete_bucket_replication(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Deletes the replication
configuration from the bucket. To use this operation, you must have permissions to perform
the s3:PutReplicationConfiguration action. The bucket owner has these permissions by
default and can grant it to others. For more information about permissions, see Permissions
Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3
Resources. It can take a while for the deletion of a replication configuration to fully
propagate. For information about replication configuration, see Replication in the Amazon
S3 User Guide. The following operations are related to DeleteBucketReplication:
PutBucketReplication GetBucketReplication
# Arguments
- `bucket`: The bucket name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function delete_bucket_replication(
Bucket; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"DELETE",
"/$(Bucket)?replication";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_bucket_replication(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"DELETE",
"/$(Bucket)?replication",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_bucket_tagging(bucket)
delete_bucket_tagging(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Deletes the tags from the bucket.
To use this operation, you must have permission to perform the s3:PutBucketTagging action.
By default, the bucket owner has this permission and can grant this permission to others.
The following operations are related to DeleteBucketTagging: GetBucketTagging
PutBucketTagging
# Arguments
- `bucket`: The bucket that has the tag set to be removed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function delete_bucket_tagging(Bucket; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"DELETE",
"/$(Bucket)?tagging";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_bucket_tagging(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"DELETE",
"/$(Bucket)?tagging",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_bucket_website(bucket)
delete_bucket_website(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. This action removes the website
configuration for a bucket. Amazon S3 returns a 200 OK response upon successfully deleting
a website configuration on the specified bucket. You will get a 200 OK response if the
website configuration you are trying to delete does not exist on the bucket. Amazon S3
returns a 404 response if the bucket specified in the request does not exist. This DELETE
action requires the S3:DeleteBucketWebsite permission. By default, only the bucket owner
can delete the website configuration attached to a bucket. However, bucket owners can grant
other users permission to delete the website configuration by writing a bucket policy
granting them the S3:DeleteBucketWebsite permission. For more information about hosting
websites, see Hosting Websites on Amazon S3. The following operations are related to
DeleteBucketWebsite: GetBucketWebsite PutBucketWebsite
# Arguments
- `bucket`: The bucket name for which you want to remove the website configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function delete_bucket_website(Bucket; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"DELETE",
"/$(Bucket)?website";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_bucket_website(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"DELETE",
"/$(Bucket)?website",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_object(bucket, key)
delete_object(bucket, key, params::Dict{String,<:Any})
Removes an object from a bucket. The behavior depends on the bucket's versioning state:
If bucket versioning is not enabled, the operation permanently deletes the object. If
bucket versioning is enabled, the operation inserts a delete marker, which becomes the
current version of the object. To permanently delete an object in a versioned bucket, you
must include the object’s versionId in the request. For more information about
versioning-enabled buckets, see Deleting object versions from a versioning-enabled bucket.
If bucket versioning is suspended, the operation removes the object that has a null
versionId, if there is one, and inserts a delete marker that becomes the current version of
the object. If there isn't an object with a null versionId, and all versions of the object
have a versionId, Amazon S3 does not remove the object and only inserts a delete marker. To
permanently delete an object that has a versionId, you must include the object’s
versionId in the request. For more information about versioning-suspended buckets, see
Deleting objects from versioning-suspended buckets. Directory buckets - S3 Versioning
isn't enabled and supported for directory buckets. For this API operation, only the null
value of the version ID is supported by directory buckets. You can only specify null to the
versionId query parameter in the request. Directory buckets - For directory buckets, you
must make requests for this API operation to the Zonal endpoint. These endpoints support
virtual-hosted-style requests in the format
https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are
not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User
Guide. To remove a specific version, you must use the versionId query parameter. Using
this query parameter permanently deletes the version. If the object deleted is a delete
marker, Amazon S3 sets the response header x-amz-delete-marker to true. If the object you
want to delete is in a bucket where the bucket versioning configuration is MFA Delete
enabled, you must include the x-amz-mfa request header in the DELETE versionId request.
Requests that include x-amz-mfa must use HTTPS. For more information about MFA Delete, see
Using MFA Delete in the Amazon S3 User Guide. To see sample requests that use versioning,
see Sample Request. Directory buckets - MFA delete is not supported by directory
buckets. You can delete objects by explicitly calling DELETE Object or calling
(PutBucketLifecycle) to enable Amazon S3 to remove them for you. If you want to block users
or accounts from removing or deleting objects from your bucket, you must deny them the
s3:DeleteObject, s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration actions.
Directory buckets - S3 Lifecycle is not supported by directory buckets. Permissions
General purpose bucket permissions - The following permissions are required in your
policies when your DeleteObjects request includes specific headers. s3:DeleteObject -
To delete an object from a bucket, you must always have the s3:DeleteObject permission.
s3:DeleteObjectVersion - To delete a specific version of an object from a
versioning-enabled bucket, you must have the s3:DeleteObjectVersion permission.
Directory bucket permissions - To grant access to this API operation on a directory bucket,
we recommend that you use the CreateSession API operation for session-based
authorization. Specifically, you grant the s3express:CreateSession permission to the
directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the
CreateSession API call on the bucket to obtain a session token. With the session token in
your request header, you can make API requests to this operation. After the session token
expires, you make another CreateSession API call to generate a new session token for use.
Amazon Web Services CLI or SDKs create session and refresh the session token automatically
to avoid service interruptions when a session expires. For more information about
authorization, see CreateSession . HTTP Host header syntax Directory buckets - The
HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com. The
following action is related to DeleteObject: PutObject
# Arguments
- `bucket`: The bucket name of the bucket containing the object. Directory buckets - When
you use this operation with a directory bucket, you must use virtual-hosted-style requests
in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are
not supported. Directory bucket names must be unique in the chosen Availability Zone.
Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example,
DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see
Directory bucket naming rules in the Amazon S3 User Guide. Access points - When you use
this action with an access point, you must provide the alias of the access point in place
of the bucket name or specify the access point ARN. When using the access point ARN, you
must direct requests to the access point hostname. The access point hostname takes the form
AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with
an access point through the Amazon Web Services SDKs, you provide the access point ARN in
place of the bucket name. For more information about access point ARNs, see Using access
points in the Amazon S3 User Guide. Access points and Object Lambda access points are not
supported by directory buckets. S3 on Outposts - When you use this action with Amazon S3
on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts
hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this
action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
access point ARN in place of the bucket name. For more information about S3 on Outposts
ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
- `key`: Key name of the object to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"versionId"`: Version ID used to reference a specific version of the object. For
directory buckets in this API operation, only the null value of the version ID is
supported.
- `"x-amz-bypass-governance-retention"`: Indicates whether S3 Object Lock should bypass
Governance-mode restrictions to process this operation. To use this header, you must have
the s3:BypassGovernanceRetention permission. This functionality is not supported for
directory buckets.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-mfa"`: The concatenation of the authentication device's serial number, a space,
and the value that is displayed on your authentication device. Required to permanently
delete a versioned object if versioning is configured with MFA delete enabled. This
functionality is not supported for directory buckets.
- `"x-amz-request-payer"`:
"""
function delete_object(Bucket, Key; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"DELETE",
"/$(Bucket)/$(Key)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_object(
Bucket,
Key,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"DELETE",
"/$(Bucket)/$(Key)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_object_tagging(bucket, key)
delete_object_tagging(bucket, key, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Removes the entire tag set from the
specified object. For more information about managing object tags, see Object Tagging. To
use this operation, you must have permission to perform the s3:DeleteObjectTagging action.
To delete tags of a specific object version, add the versionId query parameter in the
request. You will need permission for the s3:DeleteObjectVersionTagging action. The
following operations are related to DeleteObjectTagging: PutObjectTagging
GetObjectTagging
# Arguments
- `bucket`: The bucket name containing the objects from which to remove the tags. Access
points - When you use this action with an access point, you must provide the alias of the
access point in place of the bucket name or specify the access point ARN. When using the
access point ARN, you must direct requests to the access point hostname. The access point
hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When
using this action with an access point through the Amazon Web Services SDKs, you provide
the access point ARN in place of the bucket name. For more information about access point
ARNs, see Using access points in the Amazon S3 User Guide. S3 on Outposts - When you use
this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts
hostname. The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this
action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
access point ARN in place of the bucket name. For more information about S3 on Outposts
ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
- `key`: The key that identifies the object in the bucket from which to remove all tags.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"versionId"`: The versionId of the object that the tag-set will be removed from.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function delete_object_tagging(
Bucket, Key; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"DELETE",
"/$(Bucket)/$(Key)?tagging";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_object_tagging(
Bucket,
Key,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"DELETE",
"/$(Bucket)/$(Key)?tagging",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_objects(bucket, delete)
delete_objects(bucket, delete, params::Dict{String,<:Any})
This operation enables you to delete multiple objects from a bucket using a single HTTP
request. If you know the object keys that you want to delete, then this operation provides
a suitable alternative to sending individual delete requests, reducing per-request
overhead. The request can contain a list of up to 1000 keys that you want to delete. In the
XML, you provide the object key names, and optionally, version IDs if you want to delete a
specific version of the object from a versioning-enabled bucket. For each key, Amazon S3
performs a delete operation and returns the result of that delete, success or failure, in
the response. Note that if the object specified in the request is not found, Amazon S3
returns the result as deleted. Directory buckets - S3 Versioning isn't enabled and
supported for directory buckets. Directory buckets - For directory buckets, you must
make requests for this API operation to the Zonal endpoint. These endpoints support
virtual-hosted-style requests in the format
https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are
not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User
Guide. The operation supports two modes for the response: verbose and quiet. By default,
the operation uses verbose mode in which the response includes the result of deletion of
each key in your request. In quiet mode the response includes only keys where the delete
operation encountered an error. For a successful deletion in a quiet mode, the operation
does not return any information about the delete in the response body. When performing this
action on an MFA Delete enabled bucket, that attempts to delete any versioned objects, you
must include an MFA token. If you do not provide one, the entire request will fail, even if
there are non-versioned objects you are trying to delete. If you provide an invalid token,
whether there are versioned keys in the request or not, the entire Multi-Object Delete
request will fail. For information about MFA Delete, see MFA Delete in the Amazon S3 User
Guide. Directory buckets - MFA delete is not supported by directory buckets.
Permissions General purpose bucket permissions - The following permissions are required
in your policies when your DeleteObjects request includes specific headers.
s3:DeleteObject - To delete an object from a bucket, you must always specify the
s3:DeleteObject permission. s3:DeleteObjectVersion - To delete a specific version of
an object from a versiong-enabled bucket, you must specify the s3:DeleteObjectVersion
permission. Directory bucket permissions - To grant access to this API operation on a
directory bucket, we recommend that you use the CreateSession API operation for
session-based authorization. Specifically, you grant the s3express:CreateSession permission
to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make
the CreateSession API call on the bucket to obtain a session token. With the session token
in your request header, you can make API requests to this operation. After the session
token expires, you make another CreateSession API call to generate a new session token for
use. Amazon Web Services CLI or SDKs create session and refresh the session token
automatically to avoid service interruptions when a session expires. For more information
about authorization, see CreateSession . Content-MD5 request header General purpose
bucket - The Content-MD5 request header is required for all Multi-Object Delete requests.
Amazon S3 uses the header value to ensure that your request body has not been altered in
transit. Directory bucket - The Content-MD5 request header or a additional checksum
request header (including x-amz-checksum-crc32, x-amz-checksum-crc32c, x-amz-checksum-sha1,
or x-amz-checksum-sha256) is required for all Multi-Object Delete requests. HTTP Host
header syntax Directory buckets - The HTTP Host header syntax is
Bucket_name.s3express-az_id.region.amazonaws.com. The following operations are related to
DeleteObjects: CreateMultipartUpload UploadPart CompleteMultipartUpload
ListParts AbortMultipartUpload
# Arguments
- `bucket`: The bucket name containing the objects to delete. Directory buckets - When
you use this operation with a directory bucket, you must use virtual-hosted-style requests
in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are
not supported. Directory bucket names must be unique in the chosen Availability Zone.
Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example,
DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see
Directory bucket naming rules in the Amazon S3 User Guide. Access points - When you use
this action with an access point, you must provide the alias of the access point in place
of the bucket name or specify the access point ARN. When using the access point ARN, you
must direct requests to the access point hostname. The access point hostname takes the form
AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with
an access point through the Amazon Web Services SDKs, you provide the access point ARN in
place of the bucket name. For more information about access point ARNs, see Using access
points in the Amazon S3 User Guide. Access points and Object Lambda access points are not
supported by directory buckets. S3 on Outposts - When you use this action with Amazon S3
on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts
hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this
action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
access point ARN in place of the bucket name. For more information about S3 on Outposts
ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
- `delete`: Container for the request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-bypass-governance-retention"`: Specifies whether you want to delete this object
even if it has a Governance-type Object Lock in place. To use this header, you must have
the s3:BypassGovernanceRetention permission. This functionality is not supported for
directory buckets.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-mfa"`: The concatenation of the authentication device's serial number, a space,
and the value that is displayed on your authentication device. Required to permanently
delete a versioned object if versioning is configured with MFA delete enabled. When
performing the DeleteObjects operation on an MFA delete enabled bucket, which attempts to
delete the specified versioned objects, you must include an MFA token. If you don't provide
an MFA token, the entire request will fail, even if there are non-versioned objects that
you are trying to delete. If you provide an invalid token, whether there are versioned
object keys in the request or not, the entire Multi-Object Delete request will fail. For
information about MFA Delete, see MFA Delete in the Amazon S3 User Guide. This
functionality is not supported for directory buckets.
- `"x-amz-request-payer"`:
- `"x-amz-sdk-checksum-algorithm"`: Indicates the algorithm used to create the checksum for
the object when you use the SDK. This header will not provide any additional functionality
if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum-algorithm or x-amz-trailer header sent. Otherwise, Amazon S3 fails the
request with the HTTP status code 400 Bad Request. For the x-amz-checksum-algorithm
header, replace algorithm with the supported algorithm from the following list: CRC32
CRC32C SHA1 SHA256 For more information, see Checking object integrity in the Amazon
S3 User Guide. If the individual checksum value you provide through
x-amz-checksum-algorithm doesn't match the checksum algorithm you set through
x-amz-sdk-checksum-algorithm, Amazon S3 ignores any provided ChecksumAlgorithm parameter
and uses the checksum algorithm that matches the provided value in x-amz-checksum-algorithm
. If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm
parameter.
"""
function delete_objects(Bucket, Delete; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"POST",
"/$(Bucket)?delete",
Dict{String,Any}("Delete" => Delete);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_objects(
Bucket,
Delete,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"POST",
"/$(Bucket)?delete",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Delete" => Delete), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_public_access_block(bucket)
delete_public_access_block(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Removes the PublicAccessBlock
configuration for an Amazon S3 bucket. To use this operation, you must have the
s3:PutBucketPublicAccessBlock permission. For more information about permissions, see
Permissions Related to Bucket Subresource Operations and Managing Access Permissions to
Your Amazon S3 Resources. The following operations are related to DeletePublicAccessBlock:
Using Amazon S3 Block Public Access GetPublicAccessBlock PutPublicAccessBlock
GetBucketPolicyStatus
# Arguments
- `bucket`: The Amazon S3 bucket whose PublicAccessBlock configuration you want to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function delete_public_access_block(
Bucket; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"DELETE",
"/$(Bucket)?publicAccessBlock";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_public_access_block(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"DELETE",
"/$(Bucket)?publicAccessBlock",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bucket_accelerate_configuration(bucket)
get_bucket_accelerate_configuration(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. This implementation of the GET
action uses the accelerate subresource to return the Transfer Acceleration state of a
bucket, which is either Enabled or Suspended. Amazon S3 Transfer Acceleration is a
bucket-level feature that enables you to perform faster data transfers to and from Amazon
S3. To use this operation, you must have permission to perform the
s3:GetAccelerateConfiguration action. The bucket owner has this permission by default. The
bucket owner can grant this permission to others. For more information about permissions,
see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to
your Amazon S3 Resources in the Amazon S3 User Guide. You set the Transfer Acceleration
state of an existing bucket to Enabled or Suspended by using the
PutBucketAccelerateConfiguration operation. A GET accelerate request does not return a
state value for a bucket that has no transfer acceleration state. A bucket has no Transfer
Acceleration state if a state has never been set on the bucket. For more information about
transfer acceleration, see Transfer Acceleration in the Amazon S3 User Guide. The following
operations are related to GetBucketAccelerateConfiguration:
PutBucketAccelerateConfiguration
# Arguments
- `bucket`: The name of the bucket for which the accelerate configuration is retrieved.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-request-payer"`:
"""
function get_bucket_accelerate_configuration(
Bucket; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?accelerate";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_bucket_accelerate_configuration(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?accelerate",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bucket_acl(bucket)
get_bucket_acl(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. This implementation of the GET
action uses the acl subresource to return the access control list (ACL) of a bucket. To use
GET to return the ACL of the bucket, you must have the READ_ACP access to the bucket. If
READ_ACP permission is granted to the anonymous user, you can return the ACL of the bucket
without using an authorization header. When you use this API operation with an access
point, provide the alias of the access point in place of the bucket name. When you use this
API operation with an Object Lambda access point, provide the alias of the Object Lambda
access point in place of the bucket name. If the Object Lambda access point alias in a
request is not valid, the error code InvalidAccessPointAliasError is returned. For more
information about InvalidAccessPointAliasError, see List of Error Codes. If your bucket
uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are
still supported and return the bucket-owner-full-control ACL with the owner being the
account that created the bucket. For more information, see Controlling object ownership
and disabling ACLs in the Amazon S3 User Guide. The following operations are related to
GetBucketAcl: ListObjects
# Arguments
- `bucket`: Specifies the S3 bucket whose ACL is being requested. When you use this API
operation with an access point, provide the alias of the access point in place of the
bucket name. When you use this API operation with an Object Lambda access point, provide
the alias of the Object Lambda access point in place of the bucket name. If the Object
Lambda access point alias in a request is not valid, the error code
InvalidAccessPointAliasError is returned. For more information about
InvalidAccessPointAliasError, see List of Error Codes.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function get_bucket_acl(Bucket; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"GET", "/$(Bucket)?acl"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_bucket_acl(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?acl",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bucket_analytics_configuration(bucket, id)
get_bucket_analytics_configuration(bucket, id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. This implementation of the GET
action returns an analytics configuration (identified by the analytics configuration ID)
from the bucket. To use this operation, you must have permissions to perform the
s3:GetAnalyticsConfiguration action. The bucket owner has this permission by default. The
bucket owner can grant this permission to others. For more information about permissions,
see Permissions Related to Bucket Subresource Operations and Managing Access Permissions
to Your Amazon S3 Resources in the Amazon S3 User Guide. For information about Amazon S3
analytics feature, see Amazon S3 Analytics – Storage Class Analysis in the Amazon S3 User
Guide. The following operations are related to GetBucketAnalyticsConfiguration:
DeleteBucketAnalyticsConfiguration ListBucketAnalyticsConfigurations
PutBucketAnalyticsConfiguration
# Arguments
- `bucket`: The name of the bucket from which an analytics configuration is retrieved.
- `id`: The ID that identifies the analytics configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function get_bucket_analytics_configuration(
Bucket, id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?analytics",
Dict{String,Any}("id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_bucket_analytics_configuration(
Bucket,
id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"GET",
"/$(Bucket)?analytics",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("id" => id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bucket_cors(bucket)
get_bucket_cors(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Returns the Cross-Origin Resource
Sharing (CORS) configuration information set for the bucket. To use this operation, you
must have permission to perform the s3:GetBucketCORS action. By default, the bucket owner
has this permission and can grant it to others. When you use this API operation with an
access point, provide the alias of the access point in place of the bucket name. When you
use this API operation with an Object Lambda access point, provide the alias of the Object
Lambda access point in place of the bucket name. If the Object Lambda access point alias in
a request is not valid, the error code InvalidAccessPointAliasError is returned. For more
information about InvalidAccessPointAliasError, see List of Error Codes. For more
information about CORS, see Enabling Cross-Origin Resource Sharing. The following
operations are related to GetBucketCors: PutBucketCors DeleteBucketCors
# Arguments
- `bucket`: The bucket name for which to get the cors configuration. When you use this API
operation with an access point, provide the alias of the access point in place of the
bucket name. When you use this API operation with an Object Lambda access point, provide
the alias of the Object Lambda access point in place of the bucket name. If the Object
Lambda access point alias in a request is not valid, the error code
InvalidAccessPointAliasError is returned. For more information about
InvalidAccessPointAliasError, see List of Error Codes.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function get_bucket_cors(Bucket; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"GET", "/$(Bucket)?cors"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_bucket_cors(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?cors",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bucket_encryption(bucket)
get_bucket_encryption(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Returns the default encryption
configuration for an Amazon S3 bucket. By default, all buckets have a default encryption
configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). For
information about the bucket default encryption feature, see Amazon S3 Bucket Default
Encryption in the Amazon S3 User Guide. To use this operation, you must have permission to
perform the s3:GetEncryptionConfiguration action. The bucket owner has this permission by
default. The bucket owner can grant this permission to others. For more information about
permissions, see Permissions Related to Bucket Subresource Operations and Managing Access
Permissions to Your Amazon S3 Resources. The following operations are related to
GetBucketEncryption: PutBucketEncryption DeleteBucketEncryption
# Arguments
- `bucket`: The name of the bucket from which the server-side encryption configuration is
retrieved.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function get_bucket_encryption(Bucket; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"GET",
"/$(Bucket)?encryption";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_bucket_encryption(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?encryption",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bucket_intelligent_tiering_configuration(bucket, id)
get_bucket_intelligent_tiering_configuration(bucket, id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Gets the S3 Intelligent-Tiering
configuration from the specified bucket. The S3 Intelligent-Tiering storage class is
designed to optimize storage costs by automatically moving data to the most cost-effective
storage access tier, without performance impact or operational overhead. S3
Intelligent-Tiering delivers automatic cost savings in three low latency and high
throughput access tiers. To get the lowest storage cost on data that can be accessed in
minutes to hours, you can choose to activate additional archiving capabilities. The S3
Intelligent-Tiering storage class is the ideal storage class for data with unknown,
changing, or unpredictable access patterns, independent of object size or retention period.
If the size of an object is less than 128 KB, it is not monitored and not eligible for
auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent
Access tier rates in the S3 Intelligent-Tiering storage class. For more information, see
Storage class for automatically optimizing frequently and infrequently accessed objects.
Operations related to GetBucketIntelligentTieringConfiguration include:
DeleteBucketIntelligentTieringConfiguration PutBucketIntelligentTieringConfiguration
ListBucketIntelligentTieringConfigurations
# Arguments
- `bucket`: The name of the Amazon S3 bucket whose configuration you want to modify or
retrieve.
- `id`: The ID used to identify the S3 Intelligent-Tiering configuration.
"""
function get_bucket_intelligent_tiering_configuration(
Bucket, id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?intelligent-tiering",
Dict{String,Any}("id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_bucket_intelligent_tiering_configuration(
Bucket,
id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"GET",
"/$(Bucket)?intelligent-tiering",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("id" => id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bucket_inventory_configuration(bucket, id)
get_bucket_inventory_configuration(bucket, id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Returns an inventory configuration
(identified by the inventory configuration ID) from the bucket. To use this operation, you
must have permissions to perform the s3:GetInventoryConfiguration action. The bucket owner
has this permission by default and can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations and
Managing Access Permissions to Your Amazon S3 Resources. For information about the Amazon
S3 inventory feature, see Amazon S3 Inventory. The following operations are related to
GetBucketInventoryConfiguration: DeleteBucketInventoryConfiguration
ListBucketInventoryConfigurations PutBucketInventoryConfiguration
# Arguments
- `bucket`: The name of the bucket containing the inventory configuration to retrieve.
- `id`: The ID used to identify the inventory configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function get_bucket_inventory_configuration(
Bucket, id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?inventory",
Dict{String,Any}("id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_bucket_inventory_configuration(
Bucket,
id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"GET",
"/$(Bucket)?inventory",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("id" => id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bucket_lifecycle(bucket)
get_bucket_lifecycle(bucket, params::Dict{String,<:Any})
For an updated version of this API, see GetBucketLifecycleConfiguration. If you configured
a bucket lifecycle using the filter element, you should see the updated version of this
topic. This topic is provided for backward compatibility. This operation is not supported
by directory buckets. Returns the lifecycle configuration information set on the bucket.
For information about lifecycle configuration, see Object Lifecycle Management. To use
this operation, you must have permission to perform the s3:GetLifecycleConfiguration
action. The bucket owner has this permission by default. The bucket owner can grant this
permission to others. For more information about permissions, see Permissions Related to
Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
GetBucketLifecycle has the following special error: Error code:
NoSuchLifecycleConfiguration Description: The lifecycle configuration does not exist.
HTTP Status Code: 404 Not Found SOAP Fault Code Prefix: Client The following
operations are related to GetBucketLifecycle: GetBucketLifecycleConfiguration
PutBucketLifecycle DeleteBucketLifecycle
# Arguments
- `bucket`: The name of the bucket for which to get the lifecycle information.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function get_bucket_lifecycle(Bucket; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"GET",
"/$(Bucket)?lifecycle";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_bucket_lifecycle(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?lifecycle",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bucket_lifecycle_configuration(bucket)
get_bucket_lifecycle_configuration(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Bucket lifecycle configuration now
supports specifying a lifecycle rule using an object key name prefix, one or more object
tags, object size, or any combination of these. Accordingly, this section describes the
latest API. The previous version of the API supported filtering based only on an object key
name prefix, which is supported for backward compatibility. For the related API
description, see GetBucketLifecycle. Accordingly, this section describes the latest API.
The response describes the new filter element that you can use to specify a filter to
select a subset of objects to which the rule applies. If you are using a previous version
of the lifecycle configuration, it still works. For the earlier action, Returns the
lifecycle configuration information set on the bucket. For information about lifecycle
configuration, see Object Lifecycle Management. To use this operation, you must have
permission to perform the s3:GetLifecycleConfiguration action. The bucket owner has this
permission, by default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations and
Managing Access Permissions to Your Amazon S3 Resources. GetBucketLifecycleConfiguration
has the following special error: Error code: NoSuchLifecycleConfiguration Description:
The lifecycle configuration does not exist. HTTP Status Code: 404 Not Found SOAP Fault
Code Prefix: Client The following operations are related to
GetBucketLifecycleConfiguration: GetBucketLifecycle PutBucketLifecycle
DeleteBucketLifecycle
# Arguments
- `bucket`: The name of the bucket for which to get the lifecycle information.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function get_bucket_lifecycle_configuration(
Bucket; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?lifecycle";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_bucket_lifecycle_configuration(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?lifecycle",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bucket_location(bucket)
get_bucket_location(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Returns the Region the bucket
resides in. You set the bucket's Region using the LocationConstraint request parameter in a
CreateBucket request. For more information, see CreateBucket. When you use this API
operation with an access point, provide the alias of the access point in place of the
bucket name. When you use this API operation with an Object Lambda access point, provide
the alias of the Object Lambda access point in place of the bucket name. If the Object
Lambda access point alias in a request is not valid, the error code
InvalidAccessPointAliasError is returned. For more information about
InvalidAccessPointAliasError, see List of Error Codes. We recommend that you use
HeadBucket to return the Region that a bucket resides in. For backward compatibility,
Amazon S3 continues to support GetBucketLocation. The following operations are related to
GetBucketLocation: GetObject CreateBucket
# Arguments
- `bucket`: The name of the bucket for which to get the location. When you use this API
operation with an access point, provide the alias of the access point in place of the
bucket name. When you use this API operation with an Object Lambda access point, provide
the alias of the Object Lambda access point in place of the bucket name. If the Object
Lambda access point alias in a request is not valid, the error code
InvalidAccessPointAliasError is returned. For more information about
InvalidAccessPointAliasError, see List of Error Codes.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function get_bucket_location(Bucket; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"GET", "/$(Bucket)?location"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_bucket_location(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?location",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bucket_logging(bucket)
get_bucket_logging(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Returns the logging status of a
bucket and the permissions users have to view and modify that status. The following
operations are related to GetBucketLogging: CreateBucket PutBucketLogging
# Arguments
- `bucket`: The bucket name for which to get the logging information.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function get_bucket_logging(Bucket; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"GET", "/$(Bucket)?logging"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_bucket_logging(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?logging",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bucket_metrics_configuration(bucket, id)
get_bucket_metrics_configuration(bucket, id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Gets a metrics configuration
(specified by the metrics configuration ID) from the bucket. Note that this doesn't include
the daily storage metrics. To use this operation, you must have permissions to perform the
s3:GetMetricsConfiguration action. The bucket owner has this permission by default. The
bucket owner can grant this permission to others. For more information about permissions,
see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to
Your Amazon S3 Resources. For information about CloudWatch request metrics for Amazon S3,
see Monitoring Metrics with Amazon CloudWatch. The following operations are related to
GetBucketMetricsConfiguration: PutBucketMetricsConfiguration
DeleteBucketMetricsConfiguration ListBucketMetricsConfigurations Monitoring Metrics
with Amazon CloudWatch
# Arguments
- `bucket`: The name of the bucket containing the metrics configuration to retrieve.
- `id`: The ID used to identify the metrics configuration. The ID has a 64 character limit
and can only contain letters, numbers, periods, dashes, and underscores.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function get_bucket_metrics_configuration(
Bucket, id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?metrics",
Dict{String,Any}("id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_bucket_metrics_configuration(
Bucket,
id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"GET",
"/$(Bucket)?metrics",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("id" => id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bucket_notification(bucket)
get_bucket_notification(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. No longer used, see
GetBucketNotificationConfiguration.
# Arguments
- `bucket`: The name of the bucket for which to get the notification configuration. When
you use this API operation with an access point, provide the alias of the access point in
place of the bucket name. When you use this API operation with an Object Lambda access
point, provide the alias of the Object Lambda access point in place of the bucket name. If
the Object Lambda access point alias in a request is not valid, the error code
InvalidAccessPointAliasError is returned. For more information about
InvalidAccessPointAliasError, see List of Error Codes.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function get_bucket_notification(Bucket; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"GET",
"/$(Bucket)?notification";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_bucket_notification(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?notification",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bucket_notification_configuration(bucket)
get_bucket_notification_configuration(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Returns the notification
configuration of a bucket. If notifications are not enabled on the bucket, the action
returns an empty NotificationConfiguration element. By default, you must be the bucket
owner to read the notification configuration of a bucket. However, the bucket owner can use
a bucket policy to grant permission to other users to read this configuration with the
s3:GetBucketNotification permission. When you use this API operation with an access point,
provide the alias of the access point in place of the bucket name. When you use this API
operation with an Object Lambda access point, provide the alias of the Object Lambda access
point in place of the bucket name. If the Object Lambda access point alias in a request is
not valid, the error code InvalidAccessPointAliasError is returned. For more information
about InvalidAccessPointAliasError, see List of Error Codes. For more information about
setting and reading the notification configuration on a bucket, see Setting Up Notification
of Bucket Events. For more information about bucket policies, see Using Bucket Policies.
The following action is related to GetBucketNotification: PutBucketNotification
# Arguments
- `bucket`: The name of the bucket for which to get the notification configuration. When
you use this API operation with an access point, provide the alias of the access point in
place of the bucket name. When you use this API operation with an Object Lambda access
point, provide the alias of the Object Lambda access point in place of the bucket name. If
the Object Lambda access point alias in a request is not valid, the error code
InvalidAccessPointAliasError is returned. For more information about
InvalidAccessPointAliasError, see List of Error Codes.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function get_bucket_notification_configuration(
Bucket; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?notification";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_bucket_notification_configuration(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?notification",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bucket_ownership_controls(bucket)
get_bucket_ownership_controls(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Retrieves OwnershipControls for an
Amazon S3 bucket. To use this operation, you must have the s3:GetBucketOwnershipControls
permission. For more information about Amazon S3 permissions, see Specifying permissions in
a policy. For information about Amazon S3 Object Ownership, see Using Object Ownership.
The following operations are related to GetBucketOwnershipControls:
PutBucketOwnershipControls DeleteBucketOwnershipControls
# Arguments
- `bucket`: The name of the Amazon S3 bucket whose OwnershipControls you want to retrieve.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function get_bucket_ownership_controls(
Bucket; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?ownershipControls";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_bucket_ownership_controls(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?ownershipControls",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bucket_policy(bucket)
get_bucket_policy(bucket, params::Dict{String,<:Any})
Returns the policy of a specified bucket. Directory buckets - For directory buckets, you
must make requests for this API operation to the Regional endpoint. These endpoints support
path-style requests in the format
https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style
requests aren't supported. For more information, see Regional and Zonal endpoints in the
Amazon S3 User Guide. Permissions If you are using an identity other than the root user
of the Amazon Web Services account that owns the bucket, the calling identity must both
have the GetBucketPolicy permissions on the specified bucket and belong to the bucket
owner's account in order to use this operation. If you don't have GetBucketPolicy
permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct
permissions, but you're not using an identity that belongs to the bucket owner's account,
Amazon S3 returns a 405 Method Not Allowed error. To ensure that bucket owners don't
inadvertently lock themselves out of their own buckets, the root principal in a bucket
owner's Amazon Web Services account can perform the GetBucketPolicy, PutBucketPolicy, and
DeleteBucketPolicy API actions, even if their bucket policy explicitly denies the root
principal's access. Bucket owner root principals can only be blocked from performing these
API actions by VPC endpoint policies and Amazon Web Services Organizations policies.
General purpose bucket permissions - The s3:GetBucketPolicy permission is required in a
policy. For more information about general purpose buckets bucket policies, see Using
Bucket Policies and User Policies in the Amazon S3 User Guide. Directory bucket
permissions - To grant access to this API operation, you must have the
s3express:GetBucketPolicy permission in an IAM identity-based policy instead of a bucket
policy. Cross-account access to this API operation isn't supported. This operation can only
be performed by the Amazon Web Services account that owns the resource. For more
information about directory bucket policies and permissions, see Amazon Web Services
Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.
Example bucket policies General purpose buckets example bucket policies - See Bucket
policy examples in the Amazon S3 User Guide. Directory bucket example bucket policies -
See Example bucket policies for S3 Express One Zone in the Amazon S3 User Guide. HTTP Host
header syntax Directory buckets - The HTTP Host header syntax is
s3express-control.region.amazonaws.com. The following action is related to
GetBucketPolicy: GetObject
# Arguments
- `bucket`: The bucket name to get the bucket policy for. Directory buckets - When you
use this operation with a directory bucket, you must use path-style requests in the format
https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style
requests aren't supported. Directory bucket names must be unique in the chosen Availability
Zone. Bucket names must also follow the format bucket_base_name--az_id--x-s3 (for example,
DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see
Directory bucket naming rules in the Amazon S3 User Guide Access points - When you use
this API operation with an access point, provide the alias of the access point in place of
the bucket name. Object Lambda access points - When you use this API operation with an
Object Lambda access point, provide the alias of the Object Lambda access point in place of
the bucket name. If the Object Lambda access point alias in a request is not valid, the
error code InvalidAccessPointAliasError is returned. For more information about
InvalidAccessPointAliasError, see List of Error Codes. Access points and Object Lambda
access points are not supported by directory buckets.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied). For directory buckets, this
header is not supported in this API operation. If you specify this header, the request
fails with the HTTP status code 501 Not Implemented.
"""
function get_bucket_policy(Bucket; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"GET", "/$(Bucket)?policy"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_bucket_policy(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?policy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bucket_policy_status(bucket)
get_bucket_policy_status(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Retrieves the policy status for an
Amazon S3 bucket, indicating whether the bucket is public. In order to use this operation,
you must have the s3:GetBucketPolicyStatus permission. For more information about Amazon S3
permissions, see Specifying Permissions in a Policy. For more information about when
Amazon S3 considers a bucket public, see The Meaning of \"Public\". The following
operations are related to GetBucketPolicyStatus: Using Amazon S3 Block Public Access
GetPublicAccessBlock PutPublicAccessBlock DeletePublicAccessBlock
# Arguments
- `bucket`: The name of the Amazon S3 bucket whose policy status you want to retrieve.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function get_bucket_policy_status(Bucket; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"GET",
"/$(Bucket)?policyStatus";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_bucket_policy_status(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?policyStatus",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bucket_replication(bucket)
get_bucket_replication(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Returns the replication
configuration of a bucket. It can take a while to propagate the put or delete a
replication configuration to all Amazon S3 systems. Therefore, a get request soon after put
or delete can return a wrong result. For information about replication configuration,
see Replication in the Amazon S3 User Guide. This action requires permissions for the
s3:GetReplicationConfiguration action. For more information about permissions, see Using
Bucket Policies and User Policies. If you include the Filter element in a replication
configuration, you must also include the DeleteMarkerReplication and Priority elements. The
response also returns those elements. For information about GetBucketReplication errors,
see List of replication-related error codes The following operations are related to
GetBucketReplication: PutBucketReplication DeleteBucketReplication
# Arguments
- `bucket`: The bucket name for which to get the replication information.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function get_bucket_replication(Bucket; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"GET",
"/$(Bucket)?replication";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_bucket_replication(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?replication",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bucket_request_payment(bucket)
get_bucket_request_payment(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Returns the request payment
configuration of a bucket. To use this version of the operation, you must be the bucket
owner. For more information, see Requester Pays Buckets. The following operations are
related to GetBucketRequestPayment: ListObjects
# Arguments
- `bucket`: The name of the bucket for which to get the payment request configuration
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function get_bucket_request_payment(
Bucket; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?requestPayment";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_bucket_request_payment(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?requestPayment",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bucket_tagging(bucket)
get_bucket_tagging(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Returns the tag set associated with
the bucket. To use this operation, you must have permission to perform the
s3:GetBucketTagging action. By default, the bucket owner has this permission and can grant
this permission to others. GetBucketTagging has the following special error: Error code:
NoSuchTagSet Description: There is no tag set associated with the bucket. The
following operations are related to GetBucketTagging: PutBucketTagging
DeleteBucketTagging
# Arguments
- `bucket`: The name of the bucket for which to get the tagging information.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function get_bucket_tagging(Bucket; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"GET", "/$(Bucket)?tagging"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_bucket_tagging(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?tagging",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bucket_versioning(bucket)
get_bucket_versioning(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Returns the versioning state of a
bucket. To retrieve the versioning state of a bucket, you must be the bucket owner. This
implementation also returns the MFA Delete status of the versioning state. If the MFA
Delete status is enabled, the bucket owner must use an authentication device to change the
versioning state of the bucket. The following operations are related to
GetBucketVersioning: GetObject PutObject DeleteObject
# Arguments
- `bucket`: The name of the bucket for which to get the versioning information.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function get_bucket_versioning(Bucket; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"GET",
"/$(Bucket)?versioning";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_bucket_versioning(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?versioning",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bucket_website(bucket)
get_bucket_website(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Returns the website configuration
for a bucket. To host website on Amazon S3, you can configure a bucket as website by adding
a website configuration. For more information about hosting websites, see Hosting Websites
on Amazon S3. This GET action requires the S3:GetBucketWebsite permission. By default,
only the bucket owner can read the bucket website configuration. However, bucket owners can
allow other users to read the website configuration by writing a bucket policy granting
them the S3:GetBucketWebsite permission. The following operations are related to
GetBucketWebsite: DeleteBucketWebsite PutBucketWebsite
# Arguments
- `bucket`: The bucket name for which to get the website configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function get_bucket_website(Bucket; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"GET", "/$(Bucket)?website"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_bucket_website(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?website",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_object(bucket, key)
get_object(bucket, key, params::Dict{String,<:Any})
Retrieves an object from Amazon S3. In the GetObject request, specify the full key name for
the object. General purpose buckets - Both the virtual-hosted-style requests and the
path-style requests are supported. For a virtual hosted-style request example, if you have
the object photos/2006/February/sample.jpg, specify the object key name as
/photos/2006/February/sample.jpg. For a path-style request example, if you have the object
photos/2006/February/sample.jpg in the bucket named examplebucket, specify the object key
name as /examplebucket/photos/2006/February/sample.jpg. For more information about request
types, see HTTP Host Header Bucket Specification in the Amazon S3 User Guide. Directory
buckets - Only virtual-hosted-style requests are supported. For a virtual hosted-style
request example, if you have the object photos/2006/February/sample.jpg in the bucket named
examplebucket--use1-az5--x-s3, specify the object key name as
/photos/2006/February/sample.jpg. Also, when you make requests to this API operation, your
requests are sent to the Zonal endpoint. These endpoints support virtual-hosted-style
requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name .
Path-style requests are not supported. For more information, see Regional and Zonal
endpoints in the Amazon S3 User Guide. Permissions General purpose bucket permissions
- You must have the required permissions in a policy. To use GetObject, you must have the
READ access to the object (or version). If you grant READ access to the anonymous user, the
GetObject operation returns the object without using an authorization header. For more
information, see Specifying permissions in a policy in the Amazon S3 User Guide. If you
include a versionId in your request header, you must have the s3:GetObjectVersion
permission to access a specific version of an object. The s3:GetObject permission is not
required in this scenario. If you request the current version of an object without a
specific versionId in the request header, only the s3:GetObject permission is required. The
s3:GetObjectVersion permission is not required in this scenario. If the object that you
request doesn’t exist, the error that Amazon S3 returns depends on whether you also have
the s3:ListBucket permission. If you have the s3:ListBucket permission on the bucket,
Amazon S3 returns an HTTP status code 404 Not Found error. If you don’t have the
s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 Access Denied error.
Directory bucket permissions - To grant access to this API operation on a directory
bucket, we recommend that you use the CreateSession API operation for session-based
authorization. Specifically, you grant the s3express:CreateSession permission to the
directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the
CreateSession API call on the bucket to obtain a session token. With the session token in
your request header, you can make API requests to this operation. After the session token
expires, you make another CreateSession API call to generate a new session token for use.
Amazon Web Services CLI or SDKs create session and refresh the session token automatically
to avoid service interruptions when a session expires. For more information about
authorization, see CreateSession . Storage classes If the object you are retrieving is
stored in the S3 Glacier Flexible Retrieval storage class, the S3 Glacier Deep Archive
storage class, the S3 Intelligent-Tiering Archive Access tier, or the S3
Intelligent-Tiering Deep Archive Access tier, before you can retrieve the object you must
first restore a copy using RestoreObject. Otherwise, this operation returns an
InvalidObjectState error. For information about restoring archived objects, see Restoring
Archived Objects in the Amazon S3 User Guide. Directory buckets - For directory buckets,
only the S3 Express One Zone storage class is supported to store newly created objects.
Unsupported storage class values won't write a destination object and will respond with the
HTTP status code 400 Bad Request. Encryption Encryption request headers, like
x-amz-server-side-encryption, should not be sent for the GetObject requests, if your object
uses server-side encryption with Amazon S3 managed encryption keys (SSE-S3), server-side
encryption with Key Management Service (KMS) keys (SSE-KMS), or dual-layer server-side
encryption with Amazon Web Services KMS keys (DSSE-KMS). If you include the header in your
GetObject requests for the object that uses these types of keys, you’ll get an HTTP 400
Bad Request error. Overriding response header values through the request There are times
when you want to override certain response header values of a GetObject response. For
example, you might override the Content-Disposition response header value through your
GetObject request. You can override values for a set of response headers. These modified
response header values are included only in a successful response, that is, when the HTTP
status code 200 OK is returned. The headers you can override using the following query
parameters in the request are a subset of the headers that Amazon S3 accepts when you
create an object. The response headers that you can override for the GetObject response
are Cache-Control, Content-Disposition, Content-Encoding, Content-Language, Content-Type,
and Expires. To override values for a set of response headers in the GetObject response,
you can use the following query parameters in the request. response-cache-control
response-content-disposition response-content-encoding response-content-language
response-content-type response-expires When you use these parameters, you must
sign the request by using either an Authorization header or a presigned URL. These
parameters cannot be used with an unsigned (anonymous) request. HTTP Host header syntax
Directory buckets - The HTTP Host header syntax is
Bucket_name.s3express-az_id.region.amazonaws.com. The following operations are related to
GetObject: ListBuckets GetObjectAcl
# Arguments
- `bucket`: The bucket name containing the object. Directory buckets - When you use this
operation with a directory bucket, you must use virtual-hosted-style requests in the format
Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported.
Directory bucket names must be unique in the chosen Availability Zone. Bucket names must
follow the format bucket_base_name--az-id--x-s3 (for example,
DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see
Directory bucket naming rules in the Amazon S3 User Guide. Access points - When you use
this action with an access point, you must provide the alias of the access point in place
of the bucket name or specify the access point ARN. When using the access point ARN, you
must direct requests to the access point hostname. The access point hostname takes the form
AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with
an access point through the Amazon Web Services SDKs, you provide the access point ARN in
place of the bucket name. For more information about access point ARNs, see Using access
points in the Amazon S3 User Guide. Object Lambda access points - When you use this action
with an Object Lambda access point, you must direct requests to the Object Lambda access
point hostname. The Object Lambda access point hostname takes the form
AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com. Access points and Object
Lambda access points are not supported by directory buckets. S3 on Outposts - When you
use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts
hostname. The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this
action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
access point ARN in place of the bucket name. For more information about S3 on Outposts
ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
- `key`: Key of the object to get.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"If-Match"`: Return the object only if its entity tag (ETag) is the same as the one
specified in this header; otherwise, return a 412 Precondition Failed error. If both of the
If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match
condition evaluates to true, and; If-Unmodified-Since condition evaluates to false; then,
S3 returns 200 OK and the data requested. For more information about conditional requests,
see RFC 7232.
- `"If-Modified-Since"`: Return the object only if it has been modified since the specified
time; otherwise, return a 304 Not Modified error. If both of the If-None-Match and
If-Modified-Since headers are present in the request as follows: If-None-Match condition
evaluates to false, and; If-Modified-Since condition evaluates to true; then, S3 returns
304 Not Modified status code. For more information about conditional requests, see RFC 7232.
- `"If-None-Match"`: Return the object only if its entity tag (ETag) is different from the
one specified in this header; otherwise, return a 304 Not Modified error. If both of the
If-None-Match and If-Modified-Since headers are present in the request as follows:
If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to
true; then, S3 returns 304 Not Modified HTTP status code. For more information about
conditional requests, see RFC 7232.
- `"If-Unmodified-Since"`: Return the object only if it has not been modified since the
specified time; otherwise, return a 412 Precondition Failed error. If both of the If-Match
and If-Unmodified-Since headers are present in the request as follows: If-Match condition
evaluates to true, and; If-Unmodified-Since condition evaluates to false; then, S3 returns
200 OK and the data requested. For more information about conditional requests, see RFC
7232.
- `"Range"`: Downloads the specified byte range of an object. For more information about
the HTTP Range header, see https://www.rfc-editor.org/rfc/rfc9110.html#name-range. Amazon
S3 doesn't support retrieving multiple ranges of data per GET request.
- `"partNumber"`: Part number of the object being read. This is a positive integer between
1 and 10,000. Effectively performs a 'ranged' GET request for the part specified. Useful
for downloading just a part of an object.
- `"response-cache-control"`: Sets the Cache-Control header of the response.
- `"response-content-disposition"`: Sets the Content-Disposition header of the response.
- `"response-content-encoding"`: Sets the Content-Encoding header of the response.
- `"response-content-language"`: Sets the Content-Language header of the response.
- `"response-content-type"`: Sets the Content-Type header of the response.
- `"response-expires"`: Sets the Expires header of the response.
- `"versionId"`: Version ID used to reference a specific version of the object. By default,
the GetObject operation returns the current version of an object. To return a different
version, use the versionId subresource. If you include a versionId in your request
header, you must have the s3:GetObjectVersion permission to access a specific version of an
object. The s3:GetObject permission is not required in this scenario. If you request the
current version of an object without a specific versionId in the request header, only the
s3:GetObject permission is required. The s3:GetObjectVersion permission is not required in
this scenario. Directory buckets - S3 Versioning isn't enabled and supported for
directory buckets. For this API operation, only the null value of the version ID is
supported by directory buckets. You can only specify null to the versionId query parameter
in the request. For more information about versioning, see PutBucketVersioning.
- `"x-amz-checksum-mode"`: To retrieve the checksum, this mode must be enabled.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-request-payer"`:
- `"x-amz-server-side-encryption-customer-algorithm"`: Specifies the algorithm to use when
decrypting the object (for example, AES256). If you encrypt an object by using server-side
encryption with customer-provided encryption keys (SSE-C) when you store the object in
Amazon S3, then when you GET the object, you must use the following headers:
x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided
Encryption Keys) in the Amazon S3 User Guide. This functionality is not supported for
directory buckets.
- `"x-amz-server-side-encryption-customer-key"`: Specifies the customer-provided encryption
key that you originally provided for Amazon S3 to encrypt the data before storing it. This
value is used to decrypt the object when recovering it and must match the one used when
storing the data. The key must be appropriate for use with the algorithm specified in the
x-amz-server-side-encryption-customer-algorithm header. If you encrypt an object by using
server-side encryption with customer-provided encryption keys (SSE-C) when you store the
object in Amazon S3, then when you GET the object, you must use the following headers:
x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided
Encryption Keys) in the Amazon S3 User Guide. This functionality is not supported for
directory buckets.
- `"x-amz-server-side-encryption-customer-key-MD5"`: Specifies the 128-bit MD5 digest of
the customer-provided encryption key according to RFC 1321. Amazon S3 uses this header for
a message integrity check to ensure that the encryption key was transmitted without error.
If you encrypt an object by using server-side encryption with customer-provided encryption
keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must
use the following headers: x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided
Encryption Keys) in the Amazon S3 User Guide. This functionality is not supported for
directory buckets.
"""
function get_object(Bucket, Key; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"GET", "/$(Bucket)/$(Key)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_object(
Bucket,
Key,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"GET",
"/$(Bucket)/$(Key)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_object_acl(bucket, key)
get_object_acl(bucket, key, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Returns the access control list
(ACL) of an object. To use this operation, you must have s3:GetObjectAcl permissions or
READ_ACP access to the object. For more information, see Mapping of ACL permissions and
access policy permissions in the Amazon S3 User Guide This functionality is not supported
for Amazon S3 on Outposts. By default, GET returns ACL information about the current
version of an object. To return ACL information about a different version, use the
versionId subresource. If your bucket uses the bucket owner enforced setting for S3 Object
Ownership, requests to read ACLs are still supported and return the
bucket-owner-full-control ACL with the owner being the account that created the bucket. For
more information, see Controlling object ownership and disabling ACLs in the Amazon S3
User Guide. The following operations are related to GetObjectAcl: GetObject
GetObjectAttributes DeleteObject PutObject
# Arguments
- `bucket`: The bucket name that contains the object for which to get the ACL information.
Access points - When you use this action with an access point, you must provide the alias
of the access point in place of the bucket name or specify the access point ARN. When using
the access point ARN, you must direct requests to the access point hostname. The access
point hostname takes the form
AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with
an access point through the Amazon Web Services SDKs, you provide the access point ARN in
place of the bucket name. For more information about access point ARNs, see Using access
points in the Amazon S3 User Guide.
- `key`: The key of the object for which to get the ACL information.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"versionId"`: Version ID used to reference a specific version of the object. This
functionality is not supported for directory buckets.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-request-payer"`:
"""
function get_object_acl(Bucket, Key; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"GET",
"/$(Bucket)/$(Key)?acl";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_object_acl(
Bucket,
Key,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"GET",
"/$(Bucket)/$(Key)?acl",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_object_attributes(bucket, key, x-amz-object-attributes)
get_object_attributes(bucket, key, x-amz-object-attributes, params::Dict{String,<:Any})
Retrieves all the metadata from an object without returning the object itself. This
operation is useful if you're interested only in an object's metadata.
GetObjectAttributes combines the functionality of HeadObject and ListParts. All of the data
returned with each of those individual calls can be returned with a single call to
GetObjectAttributes. Directory buckets - For directory buckets, you must make requests
for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style
requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name .
Path-style requests are not supported. For more information, see Regional and Zonal
endpoints in the Amazon S3 User Guide. Permissions General purpose bucket permissions
- To use GetObjectAttributes, you must have READ access to the object. The permissions that
you need to use this operation with depend on whether the bucket is versioned. If the
bucket is versioned, you need both the s3:GetObjectVersion and
s3:GetObjectVersionAttributes permissions for this operation. If the bucket is not
versioned, you need the s3:GetObject and s3:GetObjectAttributes permissions. For more
information, see Specifying Permissions in a Policy in the Amazon S3 User Guide. If the
object that you request does not exist, the error Amazon S3 returns depends on whether you
also have the s3:ListBucket permission. If you have the s3:ListBucket permission on the
bucket, Amazon S3 returns an HTTP status code 404 Not Found (\"no such key\") error. If
you don't have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403
Forbidden (\"access denied\") error. Directory bucket permissions - To grant access to
this API operation on a directory bucket, we recommend that you use the CreateSession API
operation for session-based authorization. Specifically, you grant the
s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM
identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a
session token. With the session token in your request header, you can make API requests to
this operation. After the session token expires, you make another CreateSession API call to
generate a new session token for use. Amazon Web Services CLI or SDKs create session and
refresh the session token automatically to avoid service interruptions when a session
expires. For more information about authorization, see CreateSession . Encryption
Encryption request headers, like x-amz-server-side-encryption, should not be sent for HEAD
requests if your object uses server-side encryption with Key Management Service (KMS) keys
(SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS),
or server-side encryption with Amazon S3 managed encryption keys (SSE-S3). The
x-amz-server-side-encryption header is used when you PUT an object to S3 and want to
specify the encryption method. If you include this header in a GET request for an object
that uses these types of keys, you’ll get an HTTP 400 Bad Request error. It's because the
encryption method can't be changed when you retrieve the object. If you encrypt an object
by using server-side encryption with customer-provided encryption keys (SSE-C) when you
store the object in Amazon S3, then when you retrieve the metadata from the object, you
must use the following headers to provide the encryption key for the server to be able to
retrieve the object's metadata. The headers are:
x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided
Encryption Keys) in the Amazon S3 User Guide. Directory bucket permissions - For
directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3)
(AES256) is supported. Versioning Directory buckets - S3 Versioning isn't enabled and
supported for directory buckets. For this API operation, only the null value of the version
ID is supported by directory buckets. You can only specify null to the versionId query
parameter in the request. Conditional request headers Consider the following when using
request headers: If both of the If-Match and If-Unmodified-Since headers are present in
the request as follows, then Amazon S3 returns the HTTP status code 200 OK and the data
requested: If-Match condition evaluates to true. If-Unmodified-Since condition
evaluates to false. For more information about conditional requests, see RFC 7232. If
both of the If-None-Match and If-Modified-Since headers are present in the request as
follows, then Amazon S3 returns the HTTP status code 304 Not Modified: If-None-Match
condition evaluates to false. If-Modified-Since condition evaluates to true. For more
information about conditional requests, see RFC 7232. HTTP Host header syntax
Directory buckets - The HTTP Host header syntax is
Bucket_name.s3express-az_id.region.amazonaws.com. The following actions are related to
GetObjectAttributes: GetObject GetObjectAcl GetObjectLegalHold
GetObjectLockConfiguration GetObjectRetention GetObjectTagging HeadObject
ListParts
# Arguments
- `bucket`: The name of the bucket that contains the object. Directory buckets - When you
use this operation with a directory bucket, you must use virtual-hosted-style requests in
the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not
supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket
names must follow the format bucket_base_name--az-id--x-s3 (for example,
DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see
Directory bucket naming rules in the Amazon S3 User Guide. Access points - When you use
this action with an access point, you must provide the alias of the access point in place
of the bucket name or specify the access point ARN. When using the access point ARN, you
must direct requests to the access point hostname. The access point hostname takes the form
AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with
an access point through the Amazon Web Services SDKs, you provide the access point ARN in
place of the bucket name. For more information about access point ARNs, see Using access
points in the Amazon S3 User Guide. Access points and Object Lambda access points are not
supported by directory buckets. S3 on Outposts - When you use this action with Amazon S3
on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts
hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this
action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
access point ARN in place of the bucket name. For more information about S3 on Outposts
ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
- `key`: The object key.
- `x-amz-object-attributes`: Specifies the fields at the root level that you want returned
in the response. Fields that you do not specify are not returned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"versionId"`: The version ID used to reference a specific version of the object. S3
Versioning isn't enabled and supported for directory buckets. For this API operation, only
the null value of the version ID is supported by directory buckets. You can only specify
null to the versionId query parameter in the request.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-max-parts"`: Sets the maximum number of parts to return.
- `"x-amz-part-number-marker"`: Specifies the part after which listing should begin. Only
parts with higher part numbers will be listed.
- `"x-amz-request-payer"`:
- `"x-amz-server-side-encryption-customer-algorithm"`: Specifies the algorithm to use when
encrypting the object (for example, AES256). This functionality is not supported for
directory buckets.
- `"x-amz-server-side-encryption-customer-key"`: Specifies the customer-provided encryption
key for Amazon S3 to use in encrypting data. This value is used to store the object and
then it is discarded; Amazon S3 does not store the encryption key. The key must be
appropriate for use with the algorithm specified in the
x-amz-server-side-encryption-customer-algorithm header. This functionality is not
supported for directory buckets.
- `"x-amz-server-side-encryption-customer-key-MD5"`: Specifies the 128-bit MD5 digest of
the encryption key according to RFC 1321. Amazon S3 uses this header for a message
integrity check to ensure that the encryption key was transmitted without error. This
functionality is not supported for directory buckets.
"""
function get_object_attributes(
Bucket, Key, x_amz_object_attributes; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)/$(Key)?attributes",
Dict{String,Any}(
"headers" =>
Dict{String,Any}("x-amz-object-attributes" => x_amz_object_attributes),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_object_attributes(
Bucket,
Key,
x_amz_object_attributes,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"GET",
"/$(Bucket)/$(Key)?attributes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}(
"x-amz-object-attributes" => x_amz_object_attributes
),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_object_legal_hold(bucket, key)
get_object_legal_hold(bucket, key, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Gets an object's current legal hold
status. For more information, see Locking Objects. This functionality is not supported for
Amazon S3 on Outposts. The following action is related to GetObjectLegalHold:
GetObjectAttributes
# Arguments
- `bucket`: The bucket name containing the object whose legal hold status you want to
retrieve. Access points - When you use this action with an access point, you must provide
the alias of the access point in place of the bucket name or specify the access point ARN.
When using the access point ARN, you must direct requests to the access point hostname. The
access point hostname takes the form
AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with
an access point through the Amazon Web Services SDKs, you provide the access point ARN in
place of the bucket name. For more information about access point ARNs, see Using access
points in the Amazon S3 User Guide.
- `key`: The key name for the object whose legal hold status you want to retrieve.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"versionId"`: The version ID of the object whose legal hold status you want to retrieve.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-request-payer"`:
"""
function get_object_legal_hold(
Bucket, Key; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)/$(Key)?legal-hold";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_object_legal_hold(
Bucket,
Key,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"GET",
"/$(Bucket)/$(Key)?legal-hold",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_object_lock_configuration(bucket)
get_object_lock_configuration(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Gets the Object Lock configuration
for a bucket. The rule specified in the Object Lock configuration will be applied by
default to every new object placed in the specified bucket. For more information, see
Locking Objects. The following action is related to GetObjectLockConfiguration:
GetObjectAttributes
# Arguments
- `bucket`: The bucket whose Object Lock configuration you want to retrieve. Access points
- When you use this action with an access point, you must provide the alias of the access
point in place of the bucket name or specify the access point ARN. When using the access
point ARN, you must direct requests to the access point hostname. The access point hostname
takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using
this action with an access point through the Amazon Web Services SDKs, you provide the
access point ARN in place of the bucket name. For more information about access point ARNs,
see Using access points in the Amazon S3 User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function get_object_lock_configuration(
Bucket; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?object-lock";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_object_lock_configuration(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?object-lock",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_object_retention(bucket, key)
get_object_retention(bucket, key, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Retrieves an object's retention
settings. For more information, see Locking Objects. This functionality is not supported
for Amazon S3 on Outposts. The following action is related to GetObjectRetention:
GetObjectAttributes
# Arguments
- `bucket`: The bucket name containing the object whose retention settings you want to
retrieve. Access points - When you use this action with an access point, you must provide
the alias of the access point in place of the bucket name or specify the access point ARN.
When using the access point ARN, you must direct requests to the access point hostname. The
access point hostname takes the form
AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with
an access point through the Amazon Web Services SDKs, you provide the access point ARN in
place of the bucket name. For more information about access point ARNs, see Using access
points in the Amazon S3 User Guide.
- `key`: The key name for the object whose retention settings you want to retrieve.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"versionId"`: The version ID for the object whose retention settings you want to
retrieve.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-request-payer"`:
"""
function get_object_retention(
Bucket, Key; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)/$(Key)?retention";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_object_retention(
Bucket,
Key,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"GET",
"/$(Bucket)/$(Key)?retention",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_object_tagging(bucket, key)
get_object_tagging(bucket, key, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Returns the tag-set of an object.
You send the GET request against the tagging subresource associated with the object. To use
this operation, you must have permission to perform the s3:GetObjectTagging action. By
default, the GET action returns information about current version of an object. For a
versioned bucket, you can have multiple versions of an object in your bucket. To retrieve
tags of any other version, use the versionId query parameter. You also need permission for
the s3:GetObjectVersionTagging action. By default, the bucket owner has this permission
and can grant this permission to others. For information about the Amazon S3 object
tagging feature, see Object Tagging. The following actions are related to GetObjectTagging:
DeleteObjectTagging GetObjectAttributes PutObjectTagging
# Arguments
- `bucket`: The bucket name containing the object for which to get the tagging information.
Access points - When you use this action with an access point, you must provide the alias
of the access point in place of the bucket name or specify the access point ARN. When using
the access point ARN, you must direct requests to the access point hostname. The access
point hostname takes the form
AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with
an access point through the Amazon Web Services SDKs, you provide the access point ARN in
place of the bucket name. For more information about access point ARNs, see Using access
points in the Amazon S3 User Guide. S3 on Outposts - When you use this action with Amazon
S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts
hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this
action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
access point ARN in place of the bucket name. For more information about S3 on Outposts
ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
- `key`: Object key for which to get the tagging information.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"versionId"`: The versionId of the object for which to get the tagging information.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-request-payer"`:
"""
function get_object_tagging(Bucket, Key; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"GET",
"/$(Bucket)/$(Key)?tagging";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_object_tagging(
Bucket,
Key,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"GET",
"/$(Bucket)/$(Key)?tagging",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_object_torrent(bucket, key)
get_object_torrent(bucket, key, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Returns torrent files from a
bucket. BitTorrent can save you bandwidth when you're distributing large files. You can
get torrent only for objects that are less than 5 GB in size, and that are not encrypted
using server-side encryption with a customer-provided encryption key. To use GET, you must
have READ access to the object. This functionality is not supported for Amazon S3 on
Outposts. The following action is related to GetObjectTorrent: GetObject
# Arguments
- `bucket`: The name of the bucket containing the object for which to get the torrent files.
- `key`: The object key for which to get the information.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-request-payer"`:
"""
function get_object_torrent(Bucket, Key; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"GET",
"/$(Bucket)/$(Key)?torrent";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_object_torrent(
Bucket,
Key,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"GET",
"/$(Bucket)/$(Key)?torrent",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_public_access_block(bucket)
get_public_access_block(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Retrieves the PublicAccessBlock
configuration for an Amazon S3 bucket. To use this operation, you must have the
s3:GetBucketPublicAccessBlock permission. For more information about Amazon S3 permissions,
see Specifying Permissions in a Policy. When Amazon S3 evaluates the PublicAccessBlock
configuration for a bucket or an object, it checks the PublicAccessBlock configuration for
both the bucket (or the bucket that contains the object) and the bucket owner's account. If
the PublicAccessBlock settings are different between the bucket and the account, Amazon S3
uses the most restrictive combination of the bucket-level and account-level settings. For
more information about when Amazon S3 considers a bucket or an object public, see The
Meaning of \"Public\". The following operations are related to GetPublicAccessBlock:
Using Amazon S3 Block Public Access PutPublicAccessBlock GetPublicAccessBlock
DeletePublicAccessBlock
# Arguments
- `bucket`: The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want
to retrieve.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function get_public_access_block(Bucket; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"GET",
"/$(Bucket)?publicAccessBlock";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_public_access_block(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?publicAccessBlock",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
head_bucket(bucket)
head_bucket(bucket, params::Dict{String,<:Any})
You can use this operation to determine if a bucket exists and if you have permission to
access it. The action returns a 200 OK if the bucket exists and you have permission to
access it. If the bucket does not exist or you do not have permission to access it, the
HEAD request returns a generic 400 Bad Request, 403 Forbidden or 404 Not Found code. A
message body is not included, so you cannot determine the exception beyond these HTTP
response codes. Directory buckets - You must make requests for this API operation to the
Zonal endpoint. These endpoints support virtual-hosted-style requests in the format
https://bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not
supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User
Guide. Authentication and authorization All HeadBucket requests must be authenticated
and signed by using IAM credentials (access key ID and secret access key for the IAM
identities). All headers with the x-amz- prefix, including x-amz-copy-source, must be
signed. For more information, see REST Authentication. Directory bucket - You must use IAM
credentials to authenticate and authorize your access to the HeadBucket API operation,
instead of using the temporary security credentials through the CreateSession API
operation. Amazon Web Services CLI or SDKs handles authentication and authorization on your
behalf. Permissions General purpose bucket permissions - To use this operation, you
must have permissions to perform the s3:ListBucket action. The bucket owner has this
permission by default and can grant this permission to others. For more information about
permissions, see Managing access permissions to your Amazon S3 resources in the Amazon S3
User Guide. Directory bucket permissions - You must have the s3express:CreateSession
permission in the Action element of a policy. By default, the session is in the ReadWrite
mode. If you want to restrict the access, you can explicitly set the s3express:SessionMode
condition key to ReadOnly on the bucket. For more information about example bucket
policies, see Example bucket policies for S3 Express One Zone and Amazon Web Services
Identity and Access Management (IAM) identity-based policies for S3 Express One Zone in the
Amazon S3 User Guide. HTTP Host header syntax Directory buckets - The HTTP Host
header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.
# Arguments
- `bucket`: The bucket name. Directory buckets - When you use this operation with a
directory bucket, you must use virtual-hosted-style requests in the format
Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported.
Directory bucket names must be unique in the chosen Availability Zone. Bucket names must
follow the format bucket_base_name--az-id--x-s3 (for example,
DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see
Directory bucket naming rules in the Amazon S3 User Guide. Access points - When you use
this action with an access point, you must provide the alias of the access point in place
of the bucket name or specify the access point ARN. When using the access point ARN, you
must direct requests to the access point hostname. The access point hostname takes the form
AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with
an access point through the Amazon Web Services SDKs, you provide the access point ARN in
place of the bucket name. For more information about access point ARNs, see Using access
points in the Amazon S3 User Guide. Object Lambda access points - When you use this API
operation with an Object Lambda access point, provide the alias of the Object Lambda access
point in place of the bucket name. If the Object Lambda access point alias in a request is
not valid, the error code InvalidAccessPointAliasError is returned. For more information
about InvalidAccessPointAliasError, see List of Error Codes. Access points and Object
Lambda access points are not supported by directory buckets. S3 on Outposts - When you
use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts
hostname. The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this
action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
access point ARN in place of the bucket name. For more information about S3 on Outposts
ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function head_bucket(Bucket; aws_config::AbstractAWSConfig=global_aws_config())
return s3("HEAD", "/$(Bucket)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function head_bucket(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"HEAD", "/$(Bucket)", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
head_object(bucket, key)
head_object(bucket, key, params::Dict{String,<:Any})
The HEAD operation retrieves metadata from an object without returning the object itself.
This operation is useful if you're interested only in an object's metadata. A HEAD request
has the same options as a GET operation on an object. The response is identical to the GET
response except that there is no response body. Because of this, if the HEAD request
generates an error, it returns a generic code, such as 400 Bad Request, 403 Forbidden, 404
Not Found, 405 Method Not Allowed, 412 Precondition Failed, or 304 Not Modified. It's not
possible to retrieve the exact exception of these error codes. Request headers are limited
to 8 KB in size. For more information, see Common Request Headers. Directory buckets -
For directory buckets, you must make requests for this API operation to the Zonal endpoint.
These endpoints support virtual-hosted-style requests in the format
https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are
not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User
Guide. Permissions General purpose bucket permissions - To use HEAD, you must have
the s3:GetObject permission. You need the relevant read object (or version) permission for
this operation. For more information, see Actions, resources, and condition keys for Amazon
S3 in the Amazon S3 User Guide. If the object you request doesn't exist, the error that
Amazon S3 returns depends on whether you also have the s3:ListBucket permission. If you
have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404
Not Found error. If you don’t have the s3:ListBucket permission, Amazon S3 returns an
HTTP status code 403 Forbidden error. Directory bucket permissions - To grant access
to this API operation on a directory bucket, we recommend that you use the CreateSession
API operation for session-based authorization. Specifically, you grant the
s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM
identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a
session token. With the session token in your request header, you can make API requests to
this operation. After the session token expires, you make another CreateSession API call to
generate a new session token for use. Amazon Web Services CLI or SDKs create session and
refresh the session token automatically to avoid service interruptions when a session
expires. For more information about authorization, see CreateSession . Encryption
Encryption request headers, like x-amz-server-side-encryption, should not be sent for HEAD
requests if your object uses server-side encryption with Key Management Service (KMS) keys
(SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS),
or server-side encryption with Amazon S3 managed encryption keys (SSE-S3). The
x-amz-server-side-encryption header is used when you PUT an object to S3 and want to
specify the encryption method. If you include this header in a HEAD request for an object
that uses these types of keys, you’ll get an HTTP 400 Bad Request error. It's because the
encryption method can't be changed when you retrieve the object. If you encrypt an object
by using server-side encryption with customer-provided encryption keys (SSE-C) when you
store the object in Amazon S3, then when you retrieve the metadata from the object, you
must use the following headers to provide the encryption key for the server to be able to
retrieve the object's metadata. The headers are:
x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key x-amz-server-side-encryption-customer-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided
Encryption Keys) in the Amazon S3 User Guide. Directory bucket permissions - For
directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3)
(AES256) is supported. Versioning If the current version of the object is a delete
marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker:
true in the response. If the specified version is a delete marker, the response returns a
405 Method Not Allowed error and the Last-Modified: timestamp response header.
Directory buckets - Delete marker is not supported by directory buckets. Directory
buckets - S3 Versioning isn't enabled and supported for directory buckets. For this API
operation, only the null value of the version ID is supported by directory buckets. You can
only specify null to the versionId query parameter in the request. HTTP Host header
syntax Directory buckets - The HTTP Host header syntax is
Bucket_name.s3express-az_id.region.amazonaws.com. The following actions are related to
HeadObject: GetObject GetObjectAttributes
# Arguments
- `bucket`: The name of the bucket that contains the object. Directory buckets - When you
use this operation with a directory bucket, you must use virtual-hosted-style requests in
the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not
supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket
names must follow the format bucket_base_name--az-id--x-s3 (for example,
DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see
Directory bucket naming rules in the Amazon S3 User Guide. Access points - When you use
this action with an access point, you must provide the alias of the access point in place
of the bucket name or specify the access point ARN. When using the access point ARN, you
must direct requests to the access point hostname. The access point hostname takes the form
AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with
an access point through the Amazon Web Services SDKs, you provide the access point ARN in
place of the bucket name. For more information about access point ARNs, see Using access
points in the Amazon S3 User Guide. Access points and Object Lambda access points are not
supported by directory buckets. S3 on Outposts - When you use this action with Amazon S3
on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts
hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this
action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
access point ARN in place of the bucket name. For more information about S3 on Outposts
ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
- `key`: The object key.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"If-Match"`: Return the object only if its entity tag (ETag) is the same as the one
specified; otherwise, return a 412 (precondition failed) error. If both of the If-Match and
If-Unmodified-Since headers are present in the request as follows: If-Match condition
evaluates to true, and; If-Unmodified-Since condition evaluates to false; Then Amazon
S3 returns 200 OK and the data requested. For more information about conditional requests,
see RFC 7232.
- `"If-Modified-Since"`: Return the object only if it has been modified since the specified
time; otherwise, return a 304 (not modified) error. If both of the If-None-Match and
If-Modified-Since headers are present in the request as follows: If-None-Match condition
evaluates to false, and; If-Modified-Since condition evaluates to true; Then Amazon S3
returns the 304 Not Modified response code. For more information about conditional
requests, see RFC 7232.
- `"If-None-Match"`: Return the object only if its entity tag (ETag) is different from the
one specified; otherwise, return a 304 (not modified) error. If both of the If-None-Match
and If-Modified-Since headers are present in the request as follows: If-None-Match
condition evaluates to false, and; If-Modified-Since condition evaluates to true; Then
Amazon S3 returns the 304 Not Modified response code. For more information about
conditional requests, see RFC 7232.
- `"If-Unmodified-Since"`: Return the object only if it has not been modified since the
specified time; otherwise, return a 412 (precondition failed) error. If both of the
If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match
condition evaluates to true, and; If-Unmodified-Since condition evaluates to false;
Then Amazon S3 returns 200 OK and the data requested. For more information about
conditional requests, see RFC 7232.
- `"Range"`: HeadObject returns only the metadata for an object. If the Range is
satisfiable, only the ContentLength is affected in the response. If the Range is not
satisfiable, S3 returns a 416 - Requested Range Not Satisfiable error.
- `"partNumber"`: Part number of the object being read. This is a positive integer between
1 and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. Useful
querying about the size of the part and the number of parts in this object.
- `"versionId"`: Version ID used to reference a specific version of the object. For
directory buckets in this API operation, only the null value of the version ID is
supported.
- `"x-amz-checksum-mode"`: To retrieve the checksum, this parameter must be enabled. In
addition, if you enable ChecksumMode and the object is encrypted with Amazon Web Services
Key Management Service (Amazon Web Services KMS), you must have permission to use the
kms:Decrypt action for the request to succeed.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-request-payer"`:
- `"x-amz-server-side-encryption-customer-algorithm"`: Specifies the algorithm to use when
encrypting the object (for example, AES256). This functionality is not supported for
directory buckets.
- `"x-amz-server-side-encryption-customer-key"`: Specifies the customer-provided encryption
key for Amazon S3 to use in encrypting data. This value is used to store the object and
then it is discarded; Amazon S3 does not store the encryption key. The key must be
appropriate for use with the algorithm specified in the
x-amz-server-side-encryption-customer-algorithm header. This functionality is not
supported for directory buckets.
- `"x-amz-server-side-encryption-customer-key-MD5"`: Specifies the 128-bit MD5 digest of
the encryption key according to RFC 1321. Amazon S3 uses this header for a message
integrity check to ensure that the encryption key was transmitted without error. This
functionality is not supported for directory buckets.
"""
function head_object(Bucket, Key; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"HEAD", "/$(Bucket)/$(Key)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function head_object(
Bucket,
Key,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"HEAD",
"/$(Bucket)/$(Key)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_bucket_analytics_configurations(bucket)
list_bucket_analytics_configurations(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Lists the analytics configurations
for the bucket. You can have up to 1,000 analytics configurations per bucket. This action
supports list pagination and does not return more than 100 configurations at a time. You
should always check the IsTruncated element in the response. If there are no more
configurations to list, IsTruncated is set to false. If there are more configurations to
list, IsTruncated is set to true, and there will be a value in NextContinuationToken. You
use the NextContinuationToken value to continue the pagination of the list by passing the
value in continuation-token in the request to GET the next page. To use this operation, you
must have permissions to perform the s3:GetAnalyticsConfiguration action. The bucket owner
has this permission by default. The bucket owner can grant this permission to others. For
more information about permissions, see Permissions Related to Bucket Subresource
Operations and Managing Access Permissions to Your Amazon S3 Resources. For information
about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis. The
following operations are related to ListBucketAnalyticsConfigurations:
GetBucketAnalyticsConfiguration DeleteBucketAnalyticsConfiguration
PutBucketAnalyticsConfiguration
# Arguments
- `bucket`: The name of the bucket from which analytics configurations are retrieved.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"continuation-token"`: The ContinuationToken that represents a placeholder from where
this request should begin.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function list_bucket_analytics_configurations(
Bucket; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?analytics";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_bucket_analytics_configurations(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?analytics",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_bucket_intelligent_tiering_configurations(bucket)
list_bucket_intelligent_tiering_configurations(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Lists the S3 Intelligent-Tiering
configuration from the specified bucket. The S3 Intelligent-Tiering storage class is
designed to optimize storage costs by automatically moving data to the most cost-effective
storage access tier, without performance impact or operational overhead. S3
Intelligent-Tiering delivers automatic cost savings in three low latency and high
throughput access tiers. To get the lowest storage cost on data that can be accessed in
minutes to hours, you can choose to activate additional archiving capabilities. The S3
Intelligent-Tiering storage class is the ideal storage class for data with unknown,
changing, or unpredictable access patterns, independent of object size or retention period.
If the size of an object is less than 128 KB, it is not monitored and not eligible for
auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent
Access tier rates in the S3 Intelligent-Tiering storage class. For more information, see
Storage class for automatically optimizing frequently and infrequently accessed objects.
Operations related to ListBucketIntelligentTieringConfigurations include:
DeleteBucketIntelligentTieringConfiguration PutBucketIntelligentTieringConfiguration
GetBucketIntelligentTieringConfiguration
# Arguments
- `bucket`: The name of the Amazon S3 bucket whose configuration you want to modify or
retrieve.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"continuation-token"`: The ContinuationToken that represents a placeholder from where
this request should begin.
"""
function list_bucket_intelligent_tiering_configurations(
Bucket; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?intelligent-tiering";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_bucket_intelligent_tiering_configurations(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?intelligent-tiering",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_bucket_inventory_configurations(bucket)
list_bucket_inventory_configurations(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Returns a list of inventory
configurations for the bucket. You can have up to 1,000 analytics configurations per
bucket. This action supports list pagination and does not return more than 100
configurations at a time. Always check the IsTruncated element in the response. If there
are no more configurations to list, IsTruncated is set to false. If there are more
configurations to list, IsTruncated is set to true, and there is a value in
NextContinuationToken. You use the NextContinuationToken value to continue the pagination
of the list by passing the value in continuation-token in the request to GET the next page.
To use this operation, you must have permissions to perform the
s3:GetInventoryConfiguration action. The bucket owner has this permission by default. The
bucket owner can grant this permission to others. For more information about permissions,
see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to
Your Amazon S3 Resources. For information about the Amazon S3 inventory feature, see Amazon
S3 Inventory The following operations are related to ListBucketInventoryConfigurations:
GetBucketInventoryConfiguration DeleteBucketInventoryConfiguration
PutBucketInventoryConfiguration
# Arguments
- `bucket`: The name of the bucket containing the inventory configurations to retrieve.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"continuation-token"`: The marker used to continue an inventory configuration listing
that has been truncated. Use the NextContinuationToken from a previously truncated list
response to continue the listing. The continuation token is an opaque value that Amazon S3
understands.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function list_bucket_inventory_configurations(
Bucket; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?inventory";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_bucket_inventory_configurations(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?inventory",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_bucket_metrics_configurations(bucket)
list_bucket_metrics_configurations(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Lists the metrics configurations
for the bucket. The metrics configurations are only for the request metrics of the bucket
and do not provide information on daily storage metrics. You can have up to 1,000
configurations per bucket. This action supports list pagination and does not return more
than 100 configurations at a time. Always check the IsTruncated element in the response. If
there are no more configurations to list, IsTruncated is set to false. If there are more
configurations to list, IsTruncated is set to true, and there is a value in
NextContinuationToken. You use the NextContinuationToken value to continue the pagination
of the list by passing the value in continuation-token in the request to GET the next page.
To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration
action. The bucket owner has this permission by default. The bucket owner can grant this
permission to others. For more information about permissions, see Permissions Related to
Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
For more information about metrics configurations and CloudWatch request metrics, see
Monitoring Metrics with Amazon CloudWatch. The following operations are related to
ListBucketMetricsConfigurations: PutBucketMetricsConfiguration
GetBucketMetricsConfiguration DeleteBucketMetricsConfiguration
# Arguments
- `bucket`: The name of the bucket containing the metrics configurations to retrieve.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"continuation-token"`: The marker that is used to continue a metrics configuration
listing that has been truncated. Use the NextContinuationToken from a previously truncated
list response to continue the listing. The continuation token is an opaque value that
Amazon S3 understands.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function list_bucket_metrics_configurations(
Bucket; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET", "/$(Bucket)?metrics"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_bucket_metrics_configurations(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?metrics",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_buckets()
list_buckets(params::Dict{String,<:Any})
This operation is not supported by directory buckets. Returns a list of all buckets owned
by the authenticated sender of the request. To use this operation, you must have the
s3:ListAllMyBuckets permission. For information about Amazon S3 buckets, see Creating,
configuring, and working with Amazon S3 buckets.
"""
function list_buckets(; aws_config::AbstractAWSConfig=global_aws_config())
return s3("GET", "/"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_buckets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3("GET", "/", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
"""
list_directory_buckets()
list_directory_buckets(params::Dict{String,<:Any})
Returns a list of all Amazon S3 directory buckets owned by the authenticated sender of the
request. For more information about directory buckets, see Directory buckets in the Amazon
S3 User Guide. Directory buckets - For directory buckets, you must make requests for
this API operation to the Regional endpoint. These endpoints support path-style requests in
the format https://s3express-control.region_code.amazonaws.com/bucket-name .
Virtual-hosted-style requests aren't supported. For more information, see Regional and
Zonal endpoints in the Amazon S3 User Guide. Permissions You must have the
s3express:ListAllMyDirectoryBuckets permission in an IAM identity-based policy instead of a
bucket policy. Cross-account access to this API operation isn't supported. This operation
can only be performed by the Amazon Web Services account that owns the resource. For more
information about directory bucket policies and permissions, see Amazon Web Services
Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.
HTTP Host header syntax Directory buckets - The HTTP Host header syntax is
s3express-control.region.amazonaws.com.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"continuation-token"`: ContinuationToken indicates to Amazon S3 that the list is being
continued on this bucket with a token. ContinuationToken is obfuscated and is not a real
key. You can use this ContinuationToken for pagination of the list results.
- `"max-directory-buckets"`: Maximum number of buckets to be returned in response. When the
number is more than the count of buckets that are owned by an Amazon Web Services account,
return all the buckets in response.
"""
function list_directory_buckets(; aws_config::AbstractAWSConfig=global_aws_config())
return s3("GET", "/"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_directory_buckets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3("GET", "/", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
"""
list_multipart_uploads(bucket)
list_multipart_uploads(bucket, params::Dict{String,<:Any})
This operation lists in-progress multipart uploads in a bucket. An in-progress multipart
upload is a multipart upload that has been initiated by the CreateMultipartUpload request,
but has not yet been completed or aborted. Directory buckets - If multipart uploads in a
directory bucket are in progress, you can't delete the bucket until all the in-progress
multipart uploads are aborted or completed. The ListMultipartUploads operation returns a
maximum of 1,000 multipart uploads in the response. The limit of 1,000 multipart uploads is
also the default value. You can further limit the number of uploads in a response by
specifying the max-uploads request parameter. If there are more than 1,000 multipart
uploads that satisfy your ListMultipartUploads request, the response returns an IsTruncated
element with the value of true, a NextKeyMarker element, and a NextUploadIdMarker element.
To list the remaining multipart uploads, you need to make subsequent ListMultipartUploads
requests. In these requests, include two query parameters: key-marker and upload-id-marker.
Set the value of key-marker to the NextKeyMarker value from the previous response.
Similarly, set the value of upload-id-marker to the NextUploadIdMarker value from the
previous response. Directory buckets - The upload-id-marker element and the
NextUploadIdMarker element aren't supported by directory buckets. To list the additional
multipart uploads, you only need to set the value of key-marker to the NextKeyMarker value
from the previous response. For more information about multipart uploads, see Uploading
Objects Using Multipart Upload in the Amazon S3 User Guide. Directory buckets - For
directory buckets, you must make requests for this API operation to the Zonal endpoint.
These endpoints support virtual-hosted-style requests in the format
https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are
not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User
Guide. Permissions General purpose bucket permissions - For information about
permissions required to use the multipart upload API, see Multipart Upload and Permissions
in the Amazon S3 User Guide. Directory bucket permissions - To grant access to this API
operation on a directory bucket, we recommend that you use the CreateSession API
operation for session-based authorization. Specifically, you grant the
s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM
identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a
session token. With the session token in your request header, you can make API requests to
this operation. After the session token expires, you make another CreateSession API call to
generate a new session token for use. Amazon Web Services CLI or SDKs create session and
refresh the session token automatically to avoid service interruptions when a session
expires. For more information about authorization, see CreateSession . Sorting of
multipart uploads in response General purpose bucket - In the ListMultipartUploads
response, the multipart uploads are sorted based on two criteria: Key-based sorting -
Multipart uploads are initially sorted in ascending order based on their object keys.
Time-based sorting - For uploads that share the same object key, they are further sorted in
ascending order based on the upload initiation time. Among uploads with the same key, the
one that was initiated first will appear before the ones that were initiated later.
Directory bucket - In the ListMultipartUploads response, the multipart uploads aren't
sorted lexicographically based on the object keys. HTTP Host header syntax Directory
buckets - The HTTP Host header syntax is
Bucket_name.s3express-az_id.region.amazonaws.com. The following operations are related to
ListMultipartUploads: CreateMultipartUpload UploadPart CompleteMultipartUpload
ListParts AbortMultipartUpload
# Arguments
- `bucket`: The name of the bucket to which the multipart upload was initiated. Directory
buckets - When you use this operation with a directory bucket, you must use
virtual-hosted-style requests in the format
Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported.
Directory bucket names must be unique in the chosen Availability Zone. Bucket names must
follow the format bucket_base_name--az-id--x-s3 (for example,
DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see
Directory bucket naming rules in the Amazon S3 User Guide. Access points - When you use
this action with an access point, you must provide the alias of the access point in place
of the bucket name or specify the access point ARN. When using the access point ARN, you
must direct requests to the access point hostname. The access point hostname takes the form
AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with
an access point through the Amazon Web Services SDKs, you provide the access point ARN in
place of the bucket name. For more information about access point ARNs, see Using access
points in the Amazon S3 User Guide. Access points and Object Lambda access points are not
supported by directory buckets. S3 on Outposts - When you use this action with Amazon S3
on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts
hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this
action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
access point ARN in place of the bucket name. For more information about S3 on Outposts
ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"delimiter"`: Character you use to group keys. All keys that contain the same string
between the prefix, if specified, and the first occurrence of the delimiter after the
prefix are grouped under a single result element, CommonPrefixes. If you don't specify the
prefix parameter, then the substring starts at the beginning of the key. The keys that are
grouped under CommonPrefixes result element are not returned elsewhere in the response.
Directory buckets - For directory buckets, / is the only supported delimiter.
- `"encoding-type"`:
- `"key-marker"`: Specifies the multipart upload after which listing should begin.
General purpose buckets - For general purpose buckets, key-marker is an object key.
Together with upload-id-marker, this parameter specifies the multipart upload after which
listing should begin. If upload-id-marker is not specified, only the keys lexicographically
greater than the specified key-marker will be included in the list. If upload-id-marker is
specified, any multipart uploads for a key equal to the key-marker might also be included,
provided those multipart uploads have upload IDs lexicographically greater than the
specified upload-id-marker. Directory buckets - For directory buckets, key-marker is
obfuscated and isn't a real object key. The upload-id-marker parameter isn't supported by
directory buckets. To list the additional multipart uploads, you only need to set the value
of key-marker to the NextKeyMarker value from the previous response. In the
ListMultipartUploads response, the multipart uploads aren't sorted lexicographically based
on the object keys.
- `"max-uploads"`: Sets the maximum number of multipart uploads, from 1 to 1,000, to return
in the response body. 1,000 is the maximum number of uploads that can be returned in a
response.
- `"prefix"`: Lists in-progress uploads only for those keys that begin with the specified
prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can
think of using prefix to make groups in the same way that you'd use a folder in a file
system.) Directory buckets - For directory buckets, only prefixes that end in a delimiter
(/) are supported.
- `"upload-id-marker"`: Together with key-marker, specifies the multipart upload after
which listing should begin. If key-marker is not specified, the upload-id-marker parameter
is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be
included in the list only if they have an upload ID lexicographically greater than the
specified upload-id-marker. This functionality is not supported for directory buckets.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-request-payer"`:
"""
function list_multipart_uploads(Bucket; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"GET", "/$(Bucket)?uploads"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_multipart_uploads(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?uploads",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_object_versions(bucket)
list_object_versions(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Returns metadata about all versions
of the objects in a bucket. You can also use request parameters as selection criteria to
return metadata about a subset of all the object versions. To use this operation, you
must have permission to perform the s3:ListBucketVersions action. Be aware of the name
difference. A 200 OK response can contain valid or invalid XML. Make sure to design
your application to parse the contents of the response and handle it appropriately. To use
this operation, you must have READ access to the bucket. The following operations are
related to ListObjectVersions: ListObjectsV2 GetObject PutObject
DeleteObject
# Arguments
- `bucket`: The bucket name that contains the objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"delimiter"`: A delimiter is a character that you specify to group keys. All keys that
contain the same string between the prefix and the first occurrence of the delimiter are
grouped under a single result element in CommonPrefixes. These groups are counted as one
result against the max-keys limitation. These keys are not returned elsewhere in the
response.
- `"encoding-type"`:
- `"key-marker"`: Specifies the key to start with when listing objects in a bucket.
- `"max-keys"`: Sets the maximum number of keys returned in the response. By default, the
action returns up to 1,000 key names. The response might contain fewer keys but will never
contain more. If additional keys satisfy the search criteria, but were not returned because
max-keys was exceeded, the response contains <isTruncated>true</isTruncated>.
To return the additional keys, see key-marker and version-id-marker.
- `"prefix"`: Use this parameter to select only those keys that begin with the specified
prefix. You can use prefixes to separate a bucket into different groupings of keys. (You
can think of using prefix to make groups in the same way that you'd use a folder in a file
system.) You can use prefix with delimiter to roll up numerous objects into a single result
under CommonPrefixes.
- `"version-id-marker"`: Specifies the object version you want to start listing from.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-optional-object-attributes"`: Specifies the optional fields that you want
returned in the response. Fields that you do not specify are not returned.
- `"x-amz-request-payer"`:
"""
function list_object_versions(Bucket; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"GET", "/$(Bucket)?versions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_object_versions(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_objects(bucket)
list_objects(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Returns some or all (up to 1,000)
of the objects in a bucket. You can use the request parameters as selection criteria to
return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid
XML. Be sure to design your application to parse the contents of the response and handle it
appropriately. This action has been revised. We recommend that you use the newer version,
ListObjectsV2, when developing applications. For backward compatibility, Amazon S3
continues to support ListObjects. The following operations are related to ListObjects:
ListObjectsV2 GetObject PutObject CreateBucket ListBuckets
# Arguments
- `bucket`: The name of the bucket containing the objects. Directory buckets - When you
use this operation with a directory bucket, you must use virtual-hosted-style requests in
the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not
supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket
names must follow the format bucket_base_name--az-id--x-s3 (for example,
DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see
Directory bucket naming rules in the Amazon S3 User Guide. Access points - When you use
this action with an access point, you must provide the alias of the access point in place
of the bucket name or specify the access point ARN. When using the access point ARN, you
must direct requests to the access point hostname. The access point hostname takes the form
AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with
an access point through the Amazon Web Services SDKs, you provide the access point ARN in
place of the bucket name. For more information about access point ARNs, see Using access
points in the Amazon S3 User Guide. Access points and Object Lambda access points are not
supported by directory buckets. S3 on Outposts - When you use this action with Amazon S3
on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts
hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this
action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
access point ARN in place of the bucket name. For more information about S3 on Outposts
ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"delimiter"`: A delimiter is a character that you use to group keys.
- `"encoding-type"`:
- `"marker"`: Marker is where you want Amazon S3 to start listing from. Amazon S3 starts
listing after this specified key. Marker can be any key in the bucket.
- `"max-keys"`: Sets the maximum number of keys returned in the response. By default, the
action returns up to 1,000 key names. The response might contain fewer keys but will never
contain more.
- `"prefix"`: Limits the response to keys that begin with the specified prefix.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-optional-object-attributes"`: Specifies the optional fields that you want
returned in the response. Fields that you do not specify are not returned.
- `"x-amz-request-payer"`: Confirms that the requester knows that she or he will be charged
for the list objects request. Bucket owners need not specify this parameter in their
requests.
"""
function list_objects(Bucket; aws_config::AbstractAWSConfig=global_aws_config())
return s3("GET", "/$(Bucket)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_objects(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET", "/$(Bucket)", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_objects_v2(bucket)
list_objects_v2(bucket, params::Dict{String,<:Any})
Returns some or all (up to 1,000) of the objects in a bucket with each request. You can use
the request parameters as selection criteria to return a subset of the objects in a bucket.
A 200 OK response can contain valid or invalid XML. Make sure to design your application to
parse the contents of the response and handle it appropriately. For more information about
listing objects, see Listing object keys programmatically in the Amazon S3 User Guide. To
get a list of your buckets, see ListBuckets. Directory buckets - For directory buckets,
you must make requests for this API operation to the Zonal endpoint. These endpoints
support virtual-hosted-style requests in the format
https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are
not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User
Guide. Permissions General purpose bucket permissions - To use this operation, you
must have READ access to the bucket. You must have permission to perform the s3:ListBucket
action. The bucket owner has this permission by default and can grant this permission to
others. For more information about permissions, see Permissions Related to Bucket
Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the
Amazon S3 User Guide. Directory bucket permissions - To grant access to this API
operation on a directory bucket, we recommend that you use the CreateSession API
operation for session-based authorization. Specifically, you grant the
s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM
identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a
session token. With the session token in your request header, you can make API requests to
this operation. After the session token expires, you make another CreateSession API call to
generate a new session token for use. Amazon Web Services CLI or SDKs create session and
refresh the session token automatically to avoid service interruptions when a session
expires. For more information about authorization, see CreateSession . Sorting order of
returned objects General purpose bucket - For general purpose buckets, ListObjectsV2
returns objects in lexicographical order based on their key names. Directory bucket -
For directory buckets, ListObjectsV2 does not return objects in lexicographical order.
HTTP Host header syntax Directory buckets - The HTTP Host header syntax is
Bucket_name.s3express-az_id.region.amazonaws.com. This section describes the latest
revision of this action. We recommend that you use this revised API operation for
application development. For backward compatibility, Amazon S3 continues to support the
prior version of this API operation, ListObjects. The following operations are related to
ListObjectsV2: GetObject PutObject CreateBucket
# Arguments
- `bucket`: Directory buckets - When you use this operation with a directory bucket, you
must use virtual-hosted-style requests in the format
Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported.
Directory bucket names must be unique in the chosen Availability Zone. Bucket names must
follow the format bucket_base_name--az-id--x-s3 (for example,
DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see
Directory bucket naming rules in the Amazon S3 User Guide. Access points - When you use
this action with an access point, you must provide the alias of the access point in place
of the bucket name or specify the access point ARN. When using the access point ARN, you
must direct requests to the access point hostname. The access point hostname takes the form
AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with
an access point through the Amazon Web Services SDKs, you provide the access point ARN in
place of the bucket name. For more information about access point ARNs, see Using access
points in the Amazon S3 User Guide. Access points and Object Lambda access points are not
supported by directory buckets. S3 on Outposts - When you use this action with Amazon S3
on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts
hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this
action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
access point ARN in place of the bucket name. For more information about S3 on Outposts
ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"continuation-token"`: ContinuationToken indicates to Amazon S3 that the list is being
continued on this bucket with a token. ContinuationToken is obfuscated and is not a real
key. You can use this ContinuationToken for pagination of the list results.
- `"delimiter"`: A delimiter is a character that you use to group keys. Directory
buckets - For directory buckets, / is the only supported delimiter. Directory buckets -
When you query ListObjectsV2 with a delimiter during in-progress multipart uploads, the
CommonPrefixes response parameter contains the prefixes that are associated with the
in-progress multipart uploads. For more information about multipart uploads, see Multipart
Upload Overview in the Amazon S3 User Guide.
- `"encoding-type"`: Encoding type used by Amazon S3 to encode object keys in the response.
If using url, non-ASCII characters used in an object's key name will be URL encoded. For
example, the object test_file(3).png will appear as test_file%283%29.png.
- `"fetch-owner"`: The owner field is not present in ListObjectsV2 by default. If you want
to return the owner field with each key in the result, then set the FetchOwner field to
true. Directory buckets - For directory buckets, the bucket owner is returned as the
object owner for all objects.
- `"max-keys"`: Sets the maximum number of keys returned in the response. By default, the
action returns up to 1,000 key names. The response might contain fewer keys but will never
contain more.
- `"prefix"`: Limits the response to keys that begin with the specified prefix. Directory
buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.
- `"start-after"`: StartAfter is where you want Amazon S3 to start listing from. Amazon S3
starts listing after this specified key. StartAfter can be any key in the bucket. This
functionality is not supported for directory buckets.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-optional-object-attributes"`: Specifies the optional fields that you want
returned in the response. Fields that you do not specify are not returned. This
functionality is not supported for directory buckets.
- `"x-amz-request-payer"`: Confirms that the requester knows that she or he will be charged
for the list objects request in V2 style. Bucket owners need not specify this parameter in
their requests. This functionality is not supported for directory buckets.
"""
function list_objects_v2(Bucket; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"GET",
"/$(Bucket)?list-type=2";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_objects_v2(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)?list-type=2",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_parts(bucket, key, upload_id)
list_parts(bucket, key, upload_id, params::Dict{String,<:Any})
Lists the parts that have been uploaded for a specific multipart upload. To use this
operation, you must provide the upload ID in the request. You obtain this uploadID by
sending the initiate multipart upload request through CreateMultipartUpload. The ListParts
request returns a maximum of 1,000 uploaded parts. The limit of 1,000 parts is also the
default value. You can restrict the number of parts in a response by specifying the
max-parts request parameter. If your multipart upload consists of more than 1,000 parts,
the response returns an IsTruncated field with the value of true, and a
NextPartNumberMarker element. To list remaining uploaded parts, in subsequent ListParts
requests, include the part-number-marker query string parameter and set its value to the
NextPartNumberMarker field value from the previous response. For more information on
multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User
Guide. Directory buckets - For directory buckets, you must make requests for this API
operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in
the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style
requests are not supported. For more information, see Regional and Zonal endpoints in the
Amazon S3 User Guide. Permissions General purpose bucket permissions - For
information about permissions required to use the multipart upload API, see Multipart
Upload and Permissions in the Amazon S3 User Guide. If the upload was created using
server-side encryption with Key Management Service (KMS) keys (SSE-KMS) or dual-layer
server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), you must have
permission to the kms:Decrypt action for the ListParts request to succeed. Directory
bucket permissions - To grant access to this API operation on a directory bucket, we
recommend that you use the CreateSession API operation for session-based authorization.
Specifically, you grant the s3express:CreateSession permission to the directory bucket in a
bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on
the bucket to obtain a session token. With the session token in your request header, you
can make API requests to this operation. After the session token expires, you make another
CreateSession API call to generate a new session token for use. Amazon Web Services CLI or
SDKs create session and refresh the session token automatically to avoid service
interruptions when a session expires. For more information about authorization, see
CreateSession . HTTP Host header syntax Directory buckets - The HTTP Host header
syntax is Bucket_name.s3express-az_id.region.amazonaws.com. The following operations are
related to ListParts: CreateMultipartUpload UploadPart CompleteMultipartUpload
AbortMultipartUpload GetObjectAttributes ListMultipartUploads
# Arguments
- `bucket`: The name of the bucket to which the parts are being uploaded. Directory
buckets - When you use this operation with a directory bucket, you must use
virtual-hosted-style requests in the format
Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported.
Directory bucket names must be unique in the chosen Availability Zone. Bucket names must
follow the format bucket_base_name--az-id--x-s3 (for example,
DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see
Directory bucket naming rules in the Amazon S3 User Guide. Access points - When you use
this action with an access point, you must provide the alias of the access point in place
of the bucket name or specify the access point ARN. When using the access point ARN, you
must direct requests to the access point hostname. The access point hostname takes the form
AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with
an access point through the Amazon Web Services SDKs, you provide the access point ARN in
place of the bucket name. For more information about access point ARNs, see Using access
points in the Amazon S3 User Guide. Access points and Object Lambda access points are not
supported by directory buckets. S3 on Outposts - When you use this action with Amazon S3
on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts
hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this
action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
access point ARN in place of the bucket name. For more information about S3 on Outposts
ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
- `key`: Object key for which the multipart upload was initiated.
- `upload_id`: Upload ID identifying the multipart upload whose parts are being listed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max-parts"`: Sets the maximum number of parts to return.
- `"part-number-marker"`: Specifies the part after which listing should begin. Only parts
with higher part numbers will be listed.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-request-payer"`:
- `"x-amz-server-side-encryption-customer-algorithm"`: The server-side encryption (SSE)
algorithm used to encrypt the object. This parameter is needed only when the object was
created using a checksum algorithm. For more information, see Protecting data using SSE-C
keys in the Amazon S3 User Guide. This functionality is not supported for directory
buckets.
- `"x-amz-server-side-encryption-customer-key"`: The server-side encryption (SSE) customer
managed key. This parameter is needed only when the object was created using a checksum
algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User
Guide. This functionality is not supported for directory buckets.
- `"x-amz-server-side-encryption-customer-key-MD5"`: The MD5 server-side encryption (SSE)
customer managed key. This parameter is needed only when the object was created using a
checksum algorithm. For more information, see Protecting data using SSE-C keys in the
Amazon S3 User Guide. This functionality is not supported for directory buckets.
"""
function list_parts(
Bucket, Key, uploadId; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"GET",
"/$(Bucket)/$(Key)",
Dict{String,Any}("uploadId" => uploadId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_parts(
Bucket,
Key,
uploadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"GET",
"/$(Bucket)/$(Key)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("uploadId" => uploadId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_bucket_accelerate_configuration(accelerate_configuration, bucket)
put_bucket_accelerate_configuration(accelerate_configuration, bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Sets the accelerate configuration
of an existing bucket. Amazon S3 Transfer Acceleration is a bucket-level feature that
enables you to perform faster data transfers to Amazon S3. To use this operation, you must
have permission to perform the s3:PutAccelerateConfiguration action. The bucket owner has
this permission by default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations and
Managing Access Permissions to Your Amazon S3 Resources. The Transfer Acceleration state
of a bucket can be set to one of the following two values: Enabled – Enables
accelerated data transfers to the bucket. Suspended – Disables accelerated data
transfers to the bucket. The GetBucketAccelerateConfiguration action returns the transfer
acceleration state of a bucket. After setting the Transfer Acceleration state of a bucket
to Enabled, it might take up to thirty minutes before the data transfer rates to the bucket
increase. The name of the bucket used for Transfer Acceleration must be DNS-compliant and
must not contain periods (\".\"). For more information about transfer acceleration, see
Transfer Acceleration. The following operations are related to
PutBucketAccelerateConfiguration: GetBucketAccelerateConfiguration CreateBucket
# Arguments
- `accelerate_configuration`: Container for setting the transfer acceleration state.
- `bucket`: The name of the bucket for which the accelerate configuration is set.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-sdk-checksum-algorithm"`: Indicates the algorithm used to create the checksum for
the object when you use the SDK. This header will not provide any additional functionality
if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with
the HTTP status code 400 Bad Request. For more information, see Checking object integrity
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any
provided ChecksumAlgorithm parameter.
"""
function put_bucket_accelerate_configuration(
AccelerateConfiguration, Bucket; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"PUT",
"/$(Bucket)?accelerate",
Dict{String,Any}("AccelerateConfiguration" => AccelerateConfiguration);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_bucket_accelerate_configuration(
AccelerateConfiguration,
Bucket,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"PUT",
"/$(Bucket)?accelerate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AccelerateConfiguration" => AccelerateConfiguration),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_bucket_acl(bucket)
put_bucket_acl(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Sets the permissions on an existing
bucket using access control lists (ACL). For more information, see Using ACLs. To set the
ACL of a bucket, you must have the WRITE_ACP permission. You can use one of the following
two ways to set a bucket's permissions: Specify the ACL in the request body Specify
permissions using request headers You cannot specify access permission using both the
body and the request headers. Depending on your application needs, you may choose to set
the ACL on a bucket using either the request body or the headers. For example, if you have
an existing application that updates a bucket ACL using the request body, then you can
continue to use that approach. If your bucket uses the bucket owner enforced setting for
S3 Object Ownership, ACLs are disabled and no longer affect permissions. You must use
policies to grant access to your bucket and the objects in it. Requests to set ACLs or
update ACLs fail and return the AccessControlListNotSupported error code. Requests to read
ACLs are still supported. For more information, see Controlling object ownership in the
Amazon S3 User Guide. Permissions You can set access permissions by using one of the
following methods: Specify a canned ACL with the x-amz-acl request header. Amazon S3
supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined
set of grantees and permissions. Specify the canned ACL name as the value of x-amz-acl. If
you use this header, you cannot use other access control-specific headers in your request.
For more information, see Canned ACL. Specify access permissions explicitly with the
x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control
headers. When using these headers, you specify explicit access permissions and grantees
(Amazon Web Services accounts or Amazon S3 groups) who will receive the permission. If you
use these ACL-specific headers, you cannot use the x-amz-acl header to set a canned ACL.
These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more
information, see Access Control List (ACL) Overview. You specify each grantee as a
type=value pair, where the type is one of the following: id – if the value specified
is the canonical user ID of an Amazon Web Services account uri – if you are granting
permissions to a predefined group emailAddress – if the value specified is the email
address of an Amazon Web Services account Using email addresses to specify a grantee is
only supported in the following Amazon Web Services Regions: US East (N. Virginia) US
West (N. California) US West (Oregon) Asia Pacific (Singapore) Asia Pacific
(Sydney) Asia Pacific (Tokyo) Europe (Ireland) South America (São Paulo) For a
list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the
Amazon Web Services General Reference. For example, the following x-amz-grant-write
header grants create, overwrite, and delete objects permission to LogDelivery group
predefined by Amazon S3 and two Amazon Web Services accounts identified by their email
addresses. x-amz-grant-write: uri=\"http://acs.amazonaws.com/groups/s3/LogDelivery\",
id=\"111122223333\", id=\"555566667777\" You can use either a canned ACL or specify
access permissions explicitly. You cannot do both. Grantee Values You can specify the
person (grantee) to whom you're assigning access rights (using request elements) in the
following ways: By the person's ID: <Grantee
xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"
xsi:type=\"CanonicalUser\"><ID><>ID<></ID><DisplayName><
;>GranteesEmail<></DisplayName> </Grantee> DisplayName is optional
and ignored in the request By URI: <Grantee
xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"
xsi:type=\"Group\"><URI><>http://acs.amazonaws.com/groups/global/Authenticate
dUsers<></URI></Grantee> By Email address: <Grantee
xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"
xsi:type=\"AmazonCustomerByEmail\"><EmailAddress><>[email protected]<>
;</EmailAddress>&</Grantee> The grantee is resolved to the CanonicalUser
and, in a response to a GET Object acl request, appears as the CanonicalUser. Using email
addresses to specify a grantee is only supported in the following Amazon Web Services
Regions: US East (N. Virginia) US West (N. California) US West (Oregon) Asia
Pacific (Singapore) Asia Pacific (Sydney) Asia Pacific (Tokyo) Europe (Ireland)
South America (São Paulo) For a list of all the Amazon S3 supported Regions and
endpoints, see Regions and Endpoints in the Amazon Web Services General Reference. The
following operations are related to PutBucketAcl: CreateBucket DeleteBucket
GetObjectAcl
# Arguments
- `bucket`: The bucket to which to apply the ACL.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccessControlPolicy"`: Contains the elements that set the ACL permissions for an object
per grantee.
- `"Content-MD5"`: The base64-encoded 128-bit MD5 digest of the data. This header must be
used as a message integrity check to verify that the request body was not corrupted in
transit. For more information, go to RFC 1864. For requests made using the Amazon Web
Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated
automatically.
- `"x-amz-acl"`: The canned ACL to apply to the bucket.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-grant-full-control"`: Allows grantee the read, write, read ACP, and write ACP
permissions on the bucket.
- `"x-amz-grant-read"`: Allows grantee to list the objects in the bucket.
- `"x-amz-grant-read-acp"`: Allows grantee to read the bucket ACL.
- `"x-amz-grant-write"`: Allows grantee to create new objects in the bucket. For the bucket
and object owners of existing objects, also allows deletions and overwrites of those
objects.
- `"x-amz-grant-write-acp"`: Allows grantee to write the ACL for the applicable bucket.
- `"x-amz-sdk-checksum-algorithm"`: Indicates the algorithm used to create the checksum for
the object when you use the SDK. This header will not provide any additional functionality
if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with
the HTTP status code 400 Bad Request. For more information, see Checking object integrity
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any
provided ChecksumAlgorithm parameter.
"""
function put_bucket_acl(Bucket; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"PUT", "/$(Bucket)?acl"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function put_bucket_acl(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"PUT",
"/$(Bucket)?acl",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_bucket_analytics_configuration(analytics_configuration, bucket, id)
put_bucket_analytics_configuration(analytics_configuration, bucket, id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Sets an analytics configuration for
the bucket (specified by the analytics configuration ID). You can have up to 1,000
analytics configurations per bucket. You can choose to have storage class analysis export
analysis reports sent to a comma-separated values (CSV) flat file. See the DataExport
request element. Reports are updated daily and are based on the object filters that you
configure. When selecting data export, you specify a destination bucket and an optional
destination prefix where the file is written. You can export the data to a destination
bucket in a different account. However, the destination bucket must be in the same Region
as the bucket that you are making the PUT analytics configuration to. For more information,
see Amazon S3 Analytics – Storage Class Analysis. You must create a bucket policy on
the destination bucket where the exported file is written to grant permissions to Amazon S3
to write objects to the bucket. For an example policy, see Granting Permissions for Amazon
S3 Inventory and Storage Class Analysis. To use this operation, you must have permissions
to perform the s3:PutAnalyticsConfiguration action. The bucket owner has this permission by
default. The bucket owner can grant this permission to others. For more information about
permissions, see Permissions Related to Bucket Subresource Operations and Managing Access
Permissions to Your Amazon S3 Resources. PutBucketAnalyticsConfiguration has the following
special errors: HTTP Error: HTTP 400 Bad Request Code: InvalidArgument Cause:
Invalid argument. HTTP Error: HTTP 400 Bad Request Code: TooManyConfigurations
Cause: You are attempting to create a new configuration but have already reached the
1,000-configuration limit. HTTP Error: HTTP 403 Forbidden Code: AccessDenied
Cause: You are not the owner of the specified bucket, or you do not have the
s3:PutAnalyticsConfiguration bucket permission to set the configuration on the bucket.
The following operations are related to PutBucketAnalyticsConfiguration:
GetBucketAnalyticsConfiguration DeleteBucketAnalyticsConfiguration
ListBucketAnalyticsConfigurations
# Arguments
- `analytics_configuration`: The configuration and any analyses for the analytics filter.
- `bucket`: The name of the bucket to which an analytics configuration is stored.
- `id`: The ID that identifies the analytics configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function put_bucket_analytics_configuration(
AnalyticsConfiguration, Bucket, id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"PUT",
"/$(Bucket)?analytics",
Dict{String,Any}("AnalyticsConfiguration" => AnalyticsConfiguration, "id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_bucket_analytics_configuration(
AnalyticsConfiguration,
Bucket,
id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"PUT",
"/$(Bucket)?analytics",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AnalyticsConfiguration" => AnalyticsConfiguration, "id" => id
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_bucket_cors(bucket, corsconfiguration)
put_bucket_cors(bucket, corsconfiguration, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Sets the cors configuration for
your bucket. If the configuration exists, Amazon S3 replaces it. To use this operation, you
must be allowed to perform the s3:PutBucketCORS action. By default, the bucket owner has
this permission and can grant it to others. You set this configuration on a bucket so that
the bucket can service cross-origin requests. For example, you might want to enable a
request whose origin is http://www.example.com to access your Amazon S3 bucket at
my.example.bucket.com by using the browser's XMLHttpRequest capability. To enable
cross-origin resource sharing (CORS) on a bucket, you add the cors subresource to the
bucket. The cors subresource is an XML document in which you configure rules that identify
origins and the HTTP methods that can be executed on your bucket. The document is limited
to 64 KB in size. When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS
request) against a bucket, it evaluates the cors configuration on the bucket and uses the
first CORSRule rule that matches the incoming browser request to enable a cross-origin
request. For a rule to match, the following conditions must be met: The request's Origin
header must match AllowedOrigin elements. The request method (for example, GET, PUT,
HEAD, and so on) or the Access-Control-Request-Method header in case of a pre-flight
OPTIONS request must be one of the AllowedMethod elements. Every header specified in the
Access-Control-Request-Headers request header of a pre-flight request must match an
AllowedHeader element. For more information about CORS, go to Enabling Cross-Origin
Resource Sharing in the Amazon S3 User Guide. The following operations are related to
PutBucketCors: GetBucketCors DeleteBucketCors RESTOPTIONSobject
# Arguments
- `bucket`: Specifies the bucket impacted by the corsconfiguration.
- `corsconfiguration`: Describes the cross-origin access configuration for objects in an
Amazon S3 bucket. For more information, see Enabling Cross-Origin Resource Sharing in the
Amazon S3 User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Content-MD5"`: The base64-encoded 128-bit MD5 digest of the data. This header must be
used as a message integrity check to verify that the request body was not corrupted in
transit. For more information, go to RFC 1864. For requests made using the Amazon Web
Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated
automatically.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-sdk-checksum-algorithm"`: Indicates the algorithm used to create the checksum for
the object when you use the SDK. This header will not provide any additional functionality
if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with
the HTTP status code 400 Bad Request. For more information, see Checking object integrity
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any
provided ChecksumAlgorithm parameter.
"""
function put_bucket_cors(
Bucket, CORSConfiguration; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"PUT",
"/$(Bucket)?cors",
Dict{String,Any}("CORSConfiguration" => CORSConfiguration);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_bucket_cors(
Bucket,
CORSConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"PUT",
"/$(Bucket)?cors",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("CORSConfiguration" => CORSConfiguration), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_bucket_encryption(bucket, server_side_encryption_configuration)
put_bucket_encryption(bucket, server_side_encryption_configuration, params::Dict{String,<:Any})
This operation is not supported by directory buckets. This action uses the encryption
subresource to configure default encryption and Amazon S3 Bucket Keys for an existing
bucket. By default, all buckets have a default encryption configuration that uses
server-side encryption with Amazon S3 managed keys (SSE-S3). You can optionally configure
default encryption for a bucket by using server-side encryption with Key Management Service
(KMS) keys (SSE-KMS) or dual-layer server-side encryption with Amazon Web Services KMS keys
(DSSE-KMS). If you specify default encryption by using SSE-KMS, you can also configure
Amazon S3 Bucket Keys. If you use PutBucketEncryption to set your default bucket encryption
to SSE-KMS, you should verify that your KMS key ID is correct. Amazon S3 does not validate
the KMS key ID provided in PutBucketEncryption requests. This action requires Amazon Web
Services Signature Version 4. For more information, see Authenticating Requests (Amazon
Web Services Signature Version 4). To use this operation, you must have permission to
perform the s3:PutEncryptionConfiguration action. The bucket owner has this permission by
default. The bucket owner can grant this permission to others. For more information about
permissions, see Permissions Related to Bucket Subresource Operations and Managing Access
Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide. The following
operations are related to PutBucketEncryption: GetBucketEncryption
DeleteBucketEncryption
# Arguments
- `bucket`: Specifies default encryption for a bucket using server-side encryption with
different key options. By default, all buckets have a default encryption configuration that
uses server-side encryption with Amazon S3 managed keys (SSE-S3). You can optionally
configure default encryption for a bucket by using server-side encryption with an Amazon
Web Services KMS key (SSE-KMS) or a customer-provided key (SSE-C). For information about
the bucket default encryption feature, see Amazon S3 Bucket Default Encryption in the
Amazon S3 User Guide.
- `server_side_encryption_configuration`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Content-MD5"`: The base64-encoded 128-bit MD5 digest of the server-side encryption
configuration. For requests made using the Amazon Web Services Command Line Interface (CLI)
or Amazon Web Services SDKs, this field is calculated automatically.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-sdk-checksum-algorithm"`: Indicates the algorithm used to create the checksum for
the object when you use the SDK. This header will not provide any additional functionality
if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with
the HTTP status code 400 Bad Request. For more information, see Checking object integrity
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any
provided ChecksumAlgorithm parameter.
"""
function put_bucket_encryption(
Bucket,
ServerSideEncryptionConfiguration;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"PUT",
"/$(Bucket)?encryption",
Dict{String,Any}(
"ServerSideEncryptionConfiguration" => ServerSideEncryptionConfiguration
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_bucket_encryption(
Bucket,
ServerSideEncryptionConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"PUT",
"/$(Bucket)?encryption",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ServerSideEncryptionConfiguration" => ServerSideEncryptionConfiguration
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_bucket_intelligent_tiering_configuration(bucket, intelligent_tiering_configuration, id)
put_bucket_intelligent_tiering_configuration(bucket, intelligent_tiering_configuration, id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Puts a S3 Intelligent-Tiering
configuration to the specified bucket. You can have up to 1,000 S3 Intelligent-Tiering
configurations per bucket. The S3 Intelligent-Tiering storage class is designed to optimize
storage costs by automatically moving data to the most cost-effective storage access tier,
without performance impact or operational overhead. S3 Intelligent-Tiering delivers
automatic cost savings in three low latency and high throughput access tiers. To get the
lowest storage cost on data that can be accessed in minutes to hours, you can choose to
activate additional archiving capabilities. The S3 Intelligent-Tiering storage class is the
ideal storage class for data with unknown, changing, or unpredictable access patterns,
independent of object size or retention period. If the size of an object is less than 128
KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored,
but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering
storage class. For more information, see Storage class for automatically optimizing
frequently and infrequently accessed objects. Operations related to
PutBucketIntelligentTieringConfiguration include:
DeleteBucketIntelligentTieringConfiguration GetBucketIntelligentTieringConfiguration
ListBucketIntelligentTieringConfigurations You only need S3 Intelligent-Tiering
enabled on a bucket if you want to automatically move objects stored in the S3
Intelligent-Tiering storage class to the Archive Access or Deep Archive Access tier.
PutBucketIntelligentTieringConfiguration has the following special errors: HTTP 400 Bad
Request Error Code: InvalidArgument Cause: Invalid Argument HTTP 400 Bad Request Error
Code: TooManyConfigurations Cause: You are attempting to create a new configuration but
have already reached the 1,000-configuration limit. HTTP 403 Forbidden Error Cause: You
are not the owner of the specified bucket, or you do not have the
s3:PutIntelligentTieringConfiguration bucket permission to set the configuration on the
bucket.
# Arguments
- `bucket`: The name of the Amazon S3 bucket whose configuration you want to modify or
retrieve.
- `intelligent_tiering_configuration`: Container for S3 Intelligent-Tiering configuration.
- `id`: The ID used to identify the S3 Intelligent-Tiering configuration.
"""
function put_bucket_intelligent_tiering_configuration(
Bucket,
IntelligentTieringConfiguration,
id;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"PUT",
"/$(Bucket)?intelligent-tiering",
Dict{String,Any}(
"IntelligentTieringConfiguration" => IntelligentTieringConfiguration, "id" => id
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_bucket_intelligent_tiering_configuration(
Bucket,
IntelligentTieringConfiguration,
id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"PUT",
"/$(Bucket)?intelligent-tiering",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IntelligentTieringConfiguration" => IntelligentTieringConfiguration,
"id" => id,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_bucket_inventory_configuration(bucket, inventory_configuration, id)
put_bucket_inventory_configuration(bucket, inventory_configuration, id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. This implementation of the PUT
action adds an inventory configuration (identified by the inventory ID) to the bucket. You
can have up to 1,000 inventory configurations per bucket. Amazon S3 inventory generates
inventories of the objects in the bucket on a daily or weekly basis, and the results are
published to a flat file. The bucket that is inventoried is called the source bucket, and
the bucket where the inventory flat file is stored is called the destination bucket. The
destination bucket must be in the same Amazon Web Services Region as the source bucket.
When you configure an inventory for a source bucket, you specify the destination bucket
where you want the inventory to be stored, and whether to generate the inventory daily or
weekly. You can also configure what object metadata to include and whether to inventory all
object versions or only current versions. For more information, see Amazon S3 Inventory in
the Amazon S3 User Guide. You must create a bucket policy on the destination bucket to
grant permissions to Amazon S3 to write objects to the bucket in the defined location. For
an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class
Analysis. Permissions To use this operation, you must have permission to perform the
s3:PutInventoryConfiguration action. The bucket owner has this permission by default and
can grant this permission to others. The s3:PutInventoryConfiguration permission allows a
user to create an S3 Inventory report that includes all object metadata fields available
and to specify the destination bucket to store the inventory. A user with read access to
objects in the destination bucket can also access all object metadata fields that are
available in the inventory report. To restrict access to an inventory report, see
Restricting access to an Amazon S3 Inventory report in the Amazon S3 User Guide. For more
information about the metadata fields available in S3 Inventory, see Amazon S3 Inventory
lists in the Amazon S3 User Guide. For more information about permissions, see Permissions
related to bucket subresource operations and Identity and access management in Amazon S3 in
the Amazon S3 User Guide. PutBucketInventoryConfiguration has the following special
errors: HTTP 400 Bad Request Error Code: InvalidArgument Cause: Invalid Argument HTTP
400 Bad Request Error Code: TooManyConfigurations Cause: You are attempting to create a
new configuration but have already reached the 1,000-configuration limit. HTTP 403
Forbidden Error Cause: You are not the owner of the specified bucket, or you do not have
the s3:PutInventoryConfiguration bucket permission to set the configuration on the bucket.
The following operations are related to PutBucketInventoryConfiguration:
GetBucketInventoryConfiguration DeleteBucketInventoryConfiguration
ListBucketInventoryConfigurations
# Arguments
- `bucket`: The name of the bucket where the inventory configuration will be stored.
- `inventory_configuration`: Specifies the inventory configuration.
- `id`: The ID used to identify the inventory configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function put_bucket_inventory_configuration(
Bucket, InventoryConfiguration, id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"PUT",
"/$(Bucket)?inventory",
Dict{String,Any}("InventoryConfiguration" => InventoryConfiguration, "id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_bucket_inventory_configuration(
Bucket,
InventoryConfiguration,
id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"PUT",
"/$(Bucket)?inventory",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InventoryConfiguration" => InventoryConfiguration, "id" => id
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_bucket_lifecycle(bucket)
put_bucket_lifecycle(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. For an updated version of this
API, see PutBucketLifecycleConfiguration. This version has been deprecated. Existing
lifecycle configurations will work. For new lifecycle configurations, use the updated API.
Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle
configuration. For information about lifecycle configuration, see Object Lifecycle
Management in the Amazon S3 User Guide. By default, all Amazon S3 resources, including
buckets, objects, and related subresources (for example, lifecycle configuration and
website configuration) are private. Only the resource owner, the Amazon Web Services
account that created the resource, can access it. The resource owner can optionally grant
access permissions to others by writing an access policy. For this operation, users must
get the s3:PutLifecycleConfiguration permission. You can also explicitly deny permissions.
Explicit denial also supersedes any other permissions. If you want to prevent users or
accounts from removing or deleting objects from your bucket, you must deny them permissions
for the following actions: s3:DeleteObject s3:DeleteObjectVersion
s3:PutLifecycleConfiguration For more information about permissions, see Managing Access
Permissions to your Amazon S3 Resources in the Amazon S3 User Guide. For more examples of
transitioning objects to storage classes such as STANDARD_IA or ONEZONE_IA, see Examples of
Lifecycle Configuration. The following operations are related to PutBucketLifecycle:
GetBucketLifecycle(Deprecated) GetBucketLifecycleConfiguration RestoreObject By
default, a resource owner—in this case, a bucket owner, which is the Amazon Web Services
account that created the bucket—can perform any of the operations. A resource owner can
also grant others permission to perform the operation. For more information, see the
following topics in the Amazon S3 User Guide: Specifying Permissions in a Policy
Managing Access Permissions to your Amazon S3 Resources
# Arguments
- `bucket`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Content-MD5"`: For requests made using the Amazon Web Services Command Line Interface
(CLI) or Amazon Web Services SDKs, this field is calculated automatically.
- `"LifecycleConfiguration"`:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-sdk-checksum-algorithm"`: Indicates the algorithm used to create the checksum for
the object when you use the SDK. This header will not provide any additional functionality
if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with
the HTTP status code 400 Bad Request. For more information, see Checking object integrity
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any
provided ChecksumAlgorithm parameter.
"""
function put_bucket_lifecycle(Bucket; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"PUT",
"/$(Bucket)?lifecycle";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_bucket_lifecycle(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"PUT",
"/$(Bucket)?lifecycle",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_bucket_lifecycle_configuration(bucket)
put_bucket_lifecycle_configuration(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Creates a new lifecycle
configuration for the bucket or replaces an existing lifecycle configuration. Keep in mind
that this will overwrite an existing lifecycle configuration, so if you want to retain any
configuration details, they must be included in the new lifecycle configuration. For
information about lifecycle configuration, see Managing your storage lifecycle. Bucket
lifecycle configuration now supports specifying a lifecycle rule using an object key name
prefix, one or more object tags, object size, or any combination of these. Accordingly,
this section describes the latest API. The previous version of the API supported filtering
based only on an object key name prefix, which is supported for backward compatibility. For
the related API description, see PutBucketLifecycle. Rules You specify the lifecycle
configuration in your request body. The lifecycle configuration is specified as XML
consisting of one or more rules. An Amazon S3 Lifecycle configuration can have up to 1,000
rules. This limit is not adjustable. Each rule consists of the following: A filter
identifying a subset of objects to which the rule applies. The filter can be based on a key
name prefix, object tags, object size, or any combination of these. A status indicating
whether the rule is in effect. One or more lifecycle transition and expiration actions
that you want Amazon S3 to perform on the objects identified by the filter. If the state of
your bucket is versioning-enabled or versioning-suspended, you can have many versions of
the same object (one current version and zero or more noncurrent versions). Amazon S3
provides predefined actions that you can specify for current and noncurrent object
versions. For more information, see Object Lifecycle Management and Lifecycle
Configuration Elements. Permissions By default, all Amazon S3 resources are private,
including buckets, objects, and related subresources (for example, lifecycle configuration
and website configuration). Only the resource owner (that is, the Amazon Web Services
account that created it) can access the resource. The resource owner can optionally grant
access permissions to others by writing an access policy. For this operation, a user must
get the s3:PutLifecycleConfiguration permission. You can also explicitly deny permissions.
An explicit deny also supersedes any other permissions. If you want to block users or
accounts from removing or deleting objects from your bucket, you must deny them permissions
for the following actions: s3:DeleteObject s3:DeleteObjectVersion
s3:PutLifecycleConfiguration For more information about permissions, see Managing Access
Permissions to Your Amazon S3 Resources. The following operations are related to
PutBucketLifecycleConfiguration: Examples of Lifecycle Configuration
GetBucketLifecycleConfiguration DeleteBucketLifecycle
# Arguments
- `bucket`: The name of the bucket for which to set the configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LifecycleConfiguration"`: Container for lifecycle rules. You can add as many as 1,000
rules.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-sdk-checksum-algorithm"`: Indicates the algorithm used to create the checksum for
the object when you use the SDK. This header will not provide any additional functionality
if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with
the HTTP status code 400 Bad Request. For more information, see Checking object integrity
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any
provided ChecksumAlgorithm parameter.
"""
function put_bucket_lifecycle_configuration(
Bucket; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"PUT",
"/$(Bucket)?lifecycle";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_bucket_lifecycle_configuration(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"PUT",
"/$(Bucket)?lifecycle",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_bucket_logging(bucket, bucket_logging_status)
put_bucket_logging(bucket, bucket_logging_status, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Set the logging parameters for a
bucket and to specify permissions for who can view and modify the logging parameters. All
logs are saved to buckets in the same Amazon Web Services Region as the source bucket. To
set the logging status of a bucket, you must be the bucket owner. The bucket owner is
automatically granted FULL_CONTROL to all logs. You use the Grantee request element to
grant access to other people. The Permissions request element specifies the kind of access
the grantee has to the logs. If the target bucket for log delivery uses the bucket owner
enforced setting for S3 Object Ownership, you can't use the Grantee request element to
grant access to others. Permissions can only be granted using policies. For more
information, see Permissions for server access log delivery in the Amazon S3 User Guide.
Grantee Values You can specify the person (grantee) to whom you're assigning access rights
(by using request elements) in the following ways: By the person's ID: <Grantee
xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"
xsi:type=\"CanonicalUser\"><ID><>ID<></ID><DisplayName><
;>GranteesEmail<></DisplayName> </Grantee> DisplayName is optional
and ignored in the request. By Email address: <Grantee
xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"
xsi:type=\"AmazonCustomerByEmail\"><EmailAddress><>[email protected]<>
;</EmailAddress></Grantee> The grantee is resolved to the CanonicalUser and,
in a response to a GETObjectAcl request, appears as the CanonicalUser. By URI:
<Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"
xsi:type=\"Group\"><URI><>http://acs.amazonaws.com/groups/global/Authenticate
dUsers<></URI></Grantee> To enable logging, you use LoggingEnabled
and its children request elements. To disable logging, you use an empty BucketLoggingStatus
request element: <BucketLoggingStatus xmlns=\"http://doc.s3.amazonaws.com/2006-03-01\"
/> For more information about server access logging, see Server Access Logging in the
Amazon S3 User Guide. For more information about creating a bucket, see CreateBucket. For
more information about returning the logging status of a bucket, see GetBucketLogging. The
following operations are related to PutBucketLogging: PutObject DeleteBucket
CreateBucket GetBucketLogging
# Arguments
- `bucket`: The name of the bucket for which to set the logging parameters.
- `bucket_logging_status`: Container for logging status information.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Content-MD5"`: The MD5 hash of the PutBucketLogging request body. For requests made
using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs,
this field is calculated automatically.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-sdk-checksum-algorithm"`: Indicates the algorithm used to create the checksum for
the object when you use the SDK. This header will not provide any additional functionality
if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with
the HTTP status code 400 Bad Request. For more information, see Checking object integrity
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any
provided ChecksumAlgorithm parameter.
"""
function put_bucket_logging(
Bucket, BucketLoggingStatus; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"PUT",
"/$(Bucket)?logging",
Dict{String,Any}("BucketLoggingStatus" => BucketLoggingStatus);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_bucket_logging(
Bucket,
BucketLoggingStatus,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"PUT",
"/$(Bucket)?logging",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("BucketLoggingStatus" => BucketLoggingStatus),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_bucket_metrics_configuration(bucket, metrics_configuration, id)
put_bucket_metrics_configuration(bucket, metrics_configuration, id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Sets a metrics configuration
(specified by the metrics configuration ID) for the bucket. You can have up to 1,000
metrics configurations per bucket. If you're updating an existing metrics configuration,
note that this is a full replacement of the existing metrics configuration. If you don't
include the elements you want to keep, they are erased. To use this operation, you must
have permissions to perform the s3:PutMetricsConfiguration action. The bucket owner has
this permission by default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations and
Managing Access Permissions to Your Amazon S3 Resources. For information about CloudWatch
request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch. The following
operations are related to PutBucketMetricsConfiguration:
DeleteBucketMetricsConfiguration GetBucketMetricsConfiguration
ListBucketMetricsConfigurations PutBucketMetricsConfiguration has the following special
error: Error code: TooManyConfigurations Description: You are attempting to create a
new configuration but have already reached the 1,000-configuration limit. HTTP Status
Code: HTTP 400 Bad Request
# Arguments
- `bucket`: The name of the bucket for which the metrics configuration is set.
- `metrics_configuration`: Specifies the metrics configuration.
- `id`: The ID used to identify the metrics configuration. The ID has a 64 character limit
and can only contain letters, numbers, periods, dashes, and underscores.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function put_bucket_metrics_configuration(
Bucket, MetricsConfiguration, id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"PUT",
"/$(Bucket)?metrics",
Dict{String,Any}("MetricsConfiguration" => MetricsConfiguration, "id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_bucket_metrics_configuration(
Bucket,
MetricsConfiguration,
id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"PUT",
"/$(Bucket)?metrics",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MetricsConfiguration" => MetricsConfiguration, "id" => id
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_bucket_notification(bucket, notification_configuration)
put_bucket_notification(bucket, notification_configuration, params::Dict{String,<:Any})
This operation is not supported by directory buckets. No longer used, see the
PutBucketNotificationConfiguration operation.
# Arguments
- `bucket`: The name of the bucket.
- `notification_configuration`: The container for the configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Content-MD5"`: The MD5 hash of the PutPublicAccessBlock request body. For requests made
using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs,
this field is calculated automatically.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-sdk-checksum-algorithm"`: Indicates the algorithm used to create the checksum for
the object when you use the SDK. This header will not provide any additional functionality
if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with
the HTTP status code 400 Bad Request. For more information, see Checking object integrity
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any
provided ChecksumAlgorithm parameter.
"""
function put_bucket_notification(
Bucket, NotificationConfiguration; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"PUT",
"/$(Bucket)?notification",
Dict{String,Any}("NotificationConfiguration" => NotificationConfiguration);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_bucket_notification(
Bucket,
NotificationConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"PUT",
"/$(Bucket)?notification",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("NotificationConfiguration" => NotificationConfiguration),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_bucket_notification_configuration(bucket, notification_configuration)
put_bucket_notification_configuration(bucket, notification_configuration, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Enables notifications of specified
events for a bucket. For more information about event notifications, see Configuring Event
Notifications. Using this API, you can replace an existing notification configuration. The
configuration is an XML file that defines the event types that you want Amazon S3 to
publish and the destination where you want Amazon S3 to publish an event notification when
it detects an event of the specified type. By default, your bucket has no event
notifications configured. That is, the notification configuration will be an empty
NotificationConfiguration. <NotificationConfiguration>
</NotificationConfiguration> This action replaces the existing notification
configuration with the configuration you include in the request body. After Amazon S3
receives this request, it first verifies that any Amazon Simple Notification Service
(Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the
bucket owner has permission to publish to it by sending a test notification. In the case of
Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon
S3 permission to invoke the function from the Amazon S3 bucket. For more information, see
Configuring Notifications for Amazon S3 Events. You can disable notifications by adding the
empty NotificationConfiguration element. For more information about the number of event
notification configurations that you can create per bucket, see Amazon S3 service quotas in
Amazon Web Services General Reference. By default, only the bucket owner can configure
notifications on a bucket. However, bucket owners can use a bucket policy to grant
permission to other users to set this configuration with the required
s3:PutBucketNotification permission. The PUT notification is an atomic operation. For
example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda
function configurations. When you send a PUT request with this configuration, Amazon S3
sends test messages to your SNS topic. If the message fails, the entire PUT action will
fail, and Amazon S3 will not add the configuration to your bucket. If the configuration in
the request body includes only one TopicConfiguration specifying only the
s3:ReducedRedundancyLostObject event type, the response will also include the
x-amz-sns-test-message-id header containing the message ID of the test notification sent to
the topic. The following action is related to PutBucketNotificationConfiguration:
GetBucketNotificationConfiguration
# Arguments
- `bucket`: The name of the bucket.
- `notification_configuration`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-skip-destination-validation"`: Skips validation of Amazon SQS, Amazon SNS, and
Lambda destinations. True or false value.
"""
function put_bucket_notification_configuration(
Bucket, NotificationConfiguration; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"PUT",
"/$(Bucket)?notification",
Dict{String,Any}("NotificationConfiguration" => NotificationConfiguration);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_bucket_notification_configuration(
Bucket,
NotificationConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"PUT",
"/$(Bucket)?notification",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("NotificationConfiguration" => NotificationConfiguration),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_bucket_ownership_controls(bucket, ownership_controls)
put_bucket_ownership_controls(bucket, ownership_controls, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Creates or modifies
OwnershipControls for an Amazon S3 bucket. To use this operation, you must have the
s3:PutBucketOwnershipControls permission. For more information about Amazon S3 permissions,
see Specifying permissions in a policy. For information about Amazon S3 Object Ownership,
see Using object ownership. The following operations are related to
PutBucketOwnershipControls: GetBucketOwnershipControls DeleteBucketOwnershipControls
# Arguments
- `bucket`: The name of the Amazon S3 bucket whose OwnershipControls you want to set.
- `ownership_controls`: The OwnershipControls (BucketOwnerEnforced, BucketOwnerPreferred,
or ObjectWriter) that you want to apply to this Amazon S3 bucket.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Content-MD5"`: The MD5 hash of the OwnershipControls request body. For requests made
using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs,
this field is calculated automatically.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
"""
function put_bucket_ownership_controls(
Bucket, OwnershipControls; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"PUT",
"/$(Bucket)?ownershipControls",
Dict{String,Any}("OwnershipControls" => OwnershipControls);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_bucket_ownership_controls(
Bucket,
OwnershipControls,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"PUT",
"/$(Bucket)?ownershipControls",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("OwnershipControls" => OwnershipControls), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_bucket_policy(bucket, policy)
put_bucket_policy(bucket, policy, params::Dict{String,<:Any})
Applies an Amazon S3 bucket policy to an Amazon S3 bucket. Directory buckets - For
directory buckets, you must make requests for this API operation to the Regional endpoint.
These endpoints support path-style requests in the format
https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style
requests aren't supported. For more information, see Regional and Zonal endpoints in the
Amazon S3 User Guide. Permissions If you are using an identity other than the root user
of the Amazon Web Services account that owns the bucket, the calling identity must both
have the PutBucketPolicy permissions on the specified bucket and belong to the bucket
owner's account in order to use this operation. If you don't have PutBucketPolicy
permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct
permissions, but you're not using an identity that belongs to the bucket owner's account,
Amazon S3 returns a 405 Method Not Allowed error. To ensure that bucket owners don't
inadvertently lock themselves out of their own buckets, the root principal in a bucket
owner's Amazon Web Services account can perform the GetBucketPolicy, PutBucketPolicy, and
DeleteBucketPolicy API actions, even if their bucket policy explicitly denies the root
principal's access. Bucket owner root principals can only be blocked from performing these
API actions by VPC endpoint policies and Amazon Web Services Organizations policies.
General purpose bucket permissions - The s3:PutBucketPolicy permission is required in a
policy. For more information about general purpose buckets bucket policies, see Using
Bucket Policies and User Policies in the Amazon S3 User Guide. Directory bucket
permissions - To grant access to this API operation, you must have the
s3express:PutBucketPolicy permission in an IAM identity-based policy instead of a bucket
policy. Cross-account access to this API operation isn't supported. This operation can only
be performed by the Amazon Web Services account that owns the resource. For more
information about directory bucket policies and permissions, see Amazon Web Services
Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.
Example bucket policies General purpose buckets example bucket policies - See Bucket
policy examples in the Amazon S3 User Guide. Directory bucket example bucket policies -
See Example bucket policies for S3 Express One Zone in the Amazon S3 User Guide. HTTP Host
header syntax Directory buckets - The HTTP Host header syntax is
s3express-control.region.amazonaws.com. The following operations are related to
PutBucketPolicy: CreateBucket DeleteBucket
# Arguments
- `bucket`: The name of the bucket. Directory buckets - When you use this operation with
a directory bucket, you must use path-style requests in the format
https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style
requests aren't supported. Directory bucket names must be unique in the chosen Availability
Zone. Bucket names must also follow the format bucket_base_name--az_id--x-s3 (for example,
DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see
Directory bucket naming rules in the Amazon S3 User Guide
- `policy`: The bucket policy as a JSON document. For directory buckets, the only IAM
action supported in the bucket policy is s3express:CreateSession.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Content-MD5"`: The MD5 hash of the request body. For requests made using the Amazon Web
Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated
automatically. This functionality is not supported for directory buckets.
- `"x-amz-confirm-remove-self-bucket-access"`: Set this parameter to true to confirm that
you want to remove your permissions to change this bucket policy in the future. This
functionality is not supported for directory buckets.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied). For directory buckets, this
header is not supported in this API operation. If you specify this header, the request
fails with the HTTP status code 501 Not Implemented.
- `"x-amz-sdk-checksum-algorithm"`: Indicates the algorithm used to create the checksum for
the object when you use the SDK. This header will not provide any additional functionality
if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum-algorithm or x-amz-trailer header sent. Otherwise, Amazon S3 fails the
request with the HTTP status code 400 Bad Request. For the x-amz-checksum-algorithm
header, replace algorithm with the supported algorithm from the following list: CRC32
CRC32C SHA1 SHA256 For more information, see Checking object integrity in the Amazon
S3 User Guide. If the individual checksum value you provide through
x-amz-checksum-algorithm doesn't match the checksum algorithm you set through
x-amz-sdk-checksum-algorithm, Amazon S3 ignores any provided ChecksumAlgorithm parameter
and uses the checksum algorithm that matches the provided value in x-amz-checksum-algorithm
. For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default
checksum algorithm that's used for performance.
"""
function put_bucket_policy(
Bucket, Policy; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"PUT",
"/$(Bucket)?policy",
Dict{String,Any}("Policy" => Policy);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_bucket_policy(
Bucket,
Policy,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"PUT",
"/$(Bucket)?policy",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Policy" => Policy), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_bucket_replication(bucket, replication_configuration)
put_bucket_replication(bucket, replication_configuration, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Creates a replication
configuration or replaces an existing one. For more information, see Replication in the
Amazon S3 User Guide. Specify the replication configuration in the request body. In the
replication configuration, you provide the name of the destination bucket or buckets where
you want Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to
replicate objects on your behalf, and other relevant information. You can invoke this
request for a specific Amazon Web Services Region by using the aws:RequestedRegion
condition key. A replication configuration must include at least one rule, and can contain
a maximum of 1,000. Each rule identifies a subset of objects to replicate by filtering the
objects in the source bucket. To choose additional subsets of objects to replicate, add a
rule for each subset. To specify a subset of the objects in the source bucket to apply a
replication rule to, add the Filter element as a child of the Rule element. You can filter
objects based on an object key prefix, one or more object tags, or both. When you add the
Filter element in the configuration, you must also add the following elements:
DeleteMarkerReplication, Status, and Priority. If you are using an earlier version of the
replication configuration, Amazon S3 handles replication of delete markers differently. For
more information, see Backward Compatibility. For information about enabling versioning on
a bucket, see Using Versioning. Handling Replication of Encrypted Objects By default,
Amazon S3 doesn't replicate objects that are stored at rest using server-side encryption
with KMS keys. To replicate Amazon Web Services KMS-encrypted objects, add the following:
SourceSelectionCriteria, SseKmsEncryptedObjects, Status, EncryptionConfiguration, and
ReplicaKmsKeyID. For information about replication configuration, see Replicating Objects
Created with SSE Using KMS keys. For information on PutBucketReplication errors, see List
of replication-related error codes Permissions To create a PutBucketReplication request,
you must have s3:PutReplicationConfiguration permissions for the bucket. By default, a
resource owner, in this case the Amazon Web Services account that created the bucket, can
perform this operation. The resource owner can also grant others permissions to perform the
operation. For more information about permissions, see Specifying Permissions in a Policy
and Managing Access Permissions to Your Amazon S3 Resources. To perform this operation,
the user or role performing the action must have the iam:PassRole permission. The
following operations are related to PutBucketReplication: GetBucketReplication
DeleteBucketReplication
# Arguments
- `bucket`: The name of the bucket
- `replication_configuration`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Content-MD5"`: The base64-encoded 128-bit MD5 digest of the data. You must use this
header as a message integrity check to verify that the request body was not corrupted in
transit. For more information, see RFC 1864. For requests made using the Amazon Web
Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated
automatically.
- `"x-amz-bucket-object-lock-token"`: A token to allow Object Lock to be enabled for an
existing bucket.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-sdk-checksum-algorithm"`: Indicates the algorithm used to create the checksum for
the object when you use the SDK. This header will not provide any additional functionality
if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with
the HTTP status code 400 Bad Request. For more information, see Checking object integrity
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any
provided ChecksumAlgorithm parameter.
"""
function put_bucket_replication(
Bucket, ReplicationConfiguration; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"PUT",
"/$(Bucket)?replication",
Dict{String,Any}("ReplicationConfiguration" => ReplicationConfiguration);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_bucket_replication(
Bucket,
ReplicationConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"PUT",
"/$(Bucket)?replication",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ReplicationConfiguration" => ReplicationConfiguration),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_bucket_request_payment(bucket, request_payment_configuration)
put_bucket_request_payment(bucket, request_payment_configuration, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Sets the request payment
configuration for a bucket. By default, the bucket owner pays for downloads from the
bucket. This configuration parameter enables the bucket owner (only) to specify that the
person requesting the download will be charged for the download. For more information, see
Requester Pays Buckets. The following operations are related to PutBucketRequestPayment:
CreateBucket GetBucketRequestPayment
# Arguments
- `bucket`: The bucket name.
- `request_payment_configuration`: Container for Payer.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Content-MD5"`: The base64-encoded 128-bit MD5 digest of the data. You must use this
header as a message integrity check to verify that the request body was not corrupted in
transit. For more information, see RFC 1864. For requests made using the Amazon Web
Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated
automatically.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-sdk-checksum-algorithm"`: Indicates the algorithm used to create the checksum for
the object when you use the SDK. This header will not provide any additional functionality
if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with
the HTTP status code 400 Bad Request. For more information, see Checking object integrity
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any
provided ChecksumAlgorithm parameter.
"""
function put_bucket_request_payment(
Bucket, RequestPaymentConfiguration; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"PUT",
"/$(Bucket)?requestPayment",
Dict{String,Any}("RequestPaymentConfiguration" => RequestPaymentConfiguration);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_bucket_request_payment(
Bucket,
RequestPaymentConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"PUT",
"/$(Bucket)?requestPayment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"RequestPaymentConfiguration" => RequestPaymentConfiguration
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_bucket_tagging(bucket, tagging)
put_bucket_tagging(bucket, tagging, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Sets the tags for a bucket. Use
tags to organize your Amazon Web Services bill to reflect your own cost structure. To do
this, sign up to get your Amazon Web Services account bill with tag key values included.
Then, to see the cost of combined resources, organize your billing information according to
resources with the same tag key values. For example, you can tag several resources with a
specific application name, and then organize your billing information to see the total cost
of that application across several services. For more information, see Cost Allocation and
Tagging and Using Cost Allocation in Amazon S3 Bucket Tags. When this operation sets the
tags for a bucket, it will overwrite any current tags the bucket already has. You cannot
use this operation to add tags to an existing list of tags. To use this operation, you
must have permissions to perform the s3:PutBucketTagging action. The bucket owner has this
permission by default and can grant this permission to others. For more information about
permissions, see Permissions Related to Bucket Subresource Operations and Managing Access
Permissions to Your Amazon S3 Resources. PutBucketTagging has the following special
errors. For more Amazon S3 errors see, Error Responses. InvalidTag - The tag provided
was not a valid tag. This error can occur if the tag did not pass input validation. For
more information, see Using Cost Allocation in Amazon S3 Bucket Tags. MalformedXML - The
XML provided does not match the schema. OperationAborted - A conflicting conditional
action is currently in progress against this resource. Please try again. InternalError -
The service was unable to apply the provided tag to the bucket. The following operations
are related to PutBucketTagging: GetBucketTagging DeleteBucketTagging
# Arguments
- `bucket`: The bucket name.
- `tagging`: Container for the TagSet and Tag elements.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Content-MD5"`: The base64-encoded 128-bit MD5 digest of the data. You must use this
header as a message integrity check to verify that the request body was not corrupted in
transit. For more information, see RFC 1864. For requests made using the Amazon Web
Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated
automatically.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-sdk-checksum-algorithm"`: Indicates the algorithm used to create the checksum for
the object when you use the SDK. This header will not provide any additional functionality
if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with
the HTTP status code 400 Bad Request. For more information, see Checking object integrity
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any
provided ChecksumAlgorithm parameter.
"""
function put_bucket_tagging(
Bucket, Tagging; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"PUT",
"/$(Bucket)?tagging",
Dict{String,Any}("Tagging" => Tagging);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_bucket_tagging(
Bucket,
Tagging,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"PUT",
"/$(Bucket)?tagging",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Tagging" => Tagging), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_bucket_versioning(bucket, versioning_configuration)
put_bucket_versioning(bucket, versioning_configuration, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Sets the versioning state of an
existing bucket. You can set the versioning state with one of the following values:
Enabled—Enables versioning for the objects in the bucket. All objects added to the bucket
receive a unique version ID. Suspended—Disables versioning for the objects in the
bucket. All objects added to the bucket receive the version ID null. If the versioning
state has never been set on a bucket, it has no versioning state; a GetBucketVersioning
request does not return a versioning state value. In order to enable MFA Delete, you must
be the bucket owner. If you are the bucket owner and want to enable MFA Delete in the
bucket versioning configuration, you must include the x-amz-mfa request header and the
Status and the MfaDelete request elements in a request to set the versioning state of the
bucket. If you have an object expiration lifecycle configuration in your non-versioned
bucket and you want to maintain the same permanent delete behavior when you enable
versioning, you must add a noncurrent expiration policy. The noncurrent expiration
lifecycle configuration will manage the deletes of the noncurrent object versions in the
version-enabled bucket. (A version-enabled bucket maintains one current and zero or more
noncurrent object versions.) For more information, see Lifecycle and Versioning. The
following operations are related to PutBucketVersioning: CreateBucket DeleteBucket
GetBucketVersioning
# Arguments
- `bucket`: The bucket name.
- `versioning_configuration`: Container for setting the versioning state.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Content-MD5"`: >The base64-encoded 128-bit MD5 digest of the data. You must use this
header as a message integrity check to verify that the request body was not corrupted in
transit. For more information, see RFC 1864. For requests made using the Amazon Web
Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated
automatically.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-mfa"`: The concatenation of the authentication device's serial number, a space,
and the value that is displayed on your authentication device.
- `"x-amz-sdk-checksum-algorithm"`: Indicates the algorithm used to create the checksum for
the object when you use the SDK. This header will not provide any additional functionality
if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with
the HTTP status code 400 Bad Request. For more information, see Checking object integrity
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any
provided ChecksumAlgorithm parameter.
"""
function put_bucket_versioning(
Bucket, VersioningConfiguration; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"PUT",
"/$(Bucket)?versioning",
Dict{String,Any}("VersioningConfiguration" => VersioningConfiguration);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_bucket_versioning(
Bucket,
VersioningConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"PUT",
"/$(Bucket)?versioning",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("VersioningConfiguration" => VersioningConfiguration),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_bucket_website(bucket, website_configuration)
put_bucket_website(bucket, website_configuration, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Sets the configuration of the
website that is specified in the website subresource. To configure a bucket as a website,
you can add this subresource on the bucket with website configuration information such as
the file name of the index document and any redirect rules. For more information, see
Hosting Websites on Amazon S3. This PUT action requires the S3:PutBucketWebsite permission.
By default, only the bucket owner can configure the website attached to a bucket; however,
bucket owners can allow other users to set the website configuration by writing a bucket
policy that grants them the S3:PutBucketWebsite permission. To redirect all website
requests sent to the bucket's website endpoint, you add a website configuration with the
following elements. Because all requests are sent to another website, you don't need to
provide index document name for the bucket. WebsiteConfiguration
RedirectAllRequestsTo HostName Protocol If you want granular control over
redirects, you can use the following elements to add routing rules that describe conditions
for redirecting requests and information about the redirect destination. In this case, the
website configuration must provide an index document for the bucket, because some requests
might not be redirected. WebsiteConfiguration IndexDocument Suffix
ErrorDocument Key RoutingRules RoutingRule Condition
HttpErrorCodeReturnedEquals KeyPrefixEquals Redirect Protocol HostName
ReplaceKeyPrefixWith ReplaceKeyWith HttpRedirectCode Amazon S3 has a limitation
of 50 routing rules per website configuration. If you require more than 50 routing rules,
you can use object redirect. For more information, see Configuring an Object Redirect in
the Amazon S3 User Guide. The maximum request length is limited to 128 KB.
# Arguments
- `bucket`: The bucket name.
- `website_configuration`: Container for the request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Content-MD5"`: The base64-encoded 128-bit MD5 digest of the data. You must use this
header as a message integrity check to verify that the request body was not corrupted in
transit. For more information, see RFC 1864. For requests made using the Amazon Web
Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated
automatically.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-sdk-checksum-algorithm"`: Indicates the algorithm used to create the checksum for
the object when you use the SDK. This header will not provide any additional functionality
if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with
the HTTP status code 400 Bad Request. For more information, see Checking object integrity
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any
provided ChecksumAlgorithm parameter.
"""
function put_bucket_website(
Bucket, WebsiteConfiguration; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"PUT",
"/$(Bucket)?website",
Dict{String,Any}("WebsiteConfiguration" => WebsiteConfiguration);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_bucket_website(
Bucket,
WebsiteConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"PUT",
"/$(Bucket)?website",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("WebsiteConfiguration" => WebsiteConfiguration),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_object(bucket, key)
put_object(bucket, key, params::Dict{String,<:Any})
Adds an object to a bucket. Amazon S3 never adds partial objects; if you receive a
success response, Amazon S3 added the entire object to the bucket. You cannot use PutObject
to only update a single piece of metadata for an existing object. You must put the entire
object with updated metadata if you want to update some values. If your bucket uses the
bucket owner enforced setting for Object Ownership, ACLs are disabled and no longer affect
permissions. All objects written to the bucket by any account will be owned by the bucket
owner. Directory buckets - For directory buckets, you must make requests for this API
operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in
the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style
requests are not supported. For more information, see Regional and Zonal endpoints in the
Amazon S3 User Guide. Amazon S3 is a distributed system. If it receives multiple write
requests for the same object simultaneously, it overwrites all but the last object written.
However, Amazon S3 provides features that can modify this behavior: S3 Object Lock - To
prevent objects from being deleted or overwritten, you can use Amazon S3 Object Lock in the
Amazon S3 User Guide. This functionality is not supported for directory buckets. S3
Versioning - When you enable versioning for a bucket, if Amazon S3 receives multiple write
requests for the same object simultaneously, it stores all versions of the objects. For
each write request that is made to the same object, Amazon S3 automatically generates a
unique version ID of that object being stored in Amazon S3. You can retrieve, replace, or
delete any version of the object. For more information about versioning, see Adding Objects
to Versioning-Enabled Buckets in the Amazon S3 User Guide. For information about returning
the versioning state of a bucket, see GetBucketVersioning. This functionality is not
supported for directory buckets. Permissions General purpose bucket permissions -
The following permissions are required in your policies when your PutObject request
includes specific headers. s3:PutObject - To successfully complete the PutObject
request, you must always have the s3:PutObject permission on a bucket to add an object to
it. s3:PutObjectAcl - To successfully change the objects ACL of your PutObject
request, you must have the s3:PutObjectAcl. s3:PutObjectTagging - To successfully set
the tag-set with your PutObject request, you must have the s3:PutObjectTagging.
Directory bucket permissions - To grant access to this API operation on a directory bucket,
we recommend that you use the CreateSession API operation for session-based
authorization. Specifically, you grant the s3express:CreateSession permission to the
directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the
CreateSession API call on the bucket to obtain a session token. With the session token in
your request header, you can make API requests to this operation. After the session token
expires, you make another CreateSession API call to generate a new session token for use.
Amazon Web Services CLI or SDKs create session and refresh the session token automatically
to avoid service interruptions when a session expires. For more information about
authorization, see CreateSession . Data integrity with Content-MD5 General purpose
bucket - To ensure that data is not corrupted traversing the network, use the Content-MD5
header. When you use this header, Amazon S3 checks the object against the provided MD5
value and, if they do not match, Amazon S3 returns an error. Alternatively, when the
object's ETag is its MD5 digest, you can calculate the MD5 while putting the object to
Amazon S3 and compare the returned ETag to the calculated MD5 value. Directory bucket -
This functionality is not supported for directory buckets. HTTP Host header syntax
Directory buckets - The HTTP Host header syntax is
Bucket_name.s3express-az_id.region.amazonaws.com. For more information about related
Amazon S3 APIs, see the following: CopyObject DeleteObject
# Arguments
- `bucket`: The bucket name to which the PUT action was initiated. Directory buckets -
When you use this operation with a directory bucket, you must use virtual-hosted-style
requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style
requests are not supported. Directory bucket names must be unique in the chosen
Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for
example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming
restrictions, see Directory bucket naming rules in the Amazon S3 User Guide. Access points
- When you use this action with an access point, you must provide the alias of the access
point in place of the bucket name or specify the access point ARN. When using the access
point ARN, you must direct requests to the access point hostname. The access point hostname
takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using
this action with an access point through the Amazon Web Services SDKs, you provide the
access point ARN in place of the bucket name. For more information about access point ARNs,
see Using access points in the Amazon S3 User Guide. Access points and Object Lambda
access points are not supported by directory buckets. S3 on Outposts - When you use this
action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname.
The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this
action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
access point ARN in place of the bucket name. For more information about S3 on Outposts
ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
- `key`: Object key for which the PUT action was initiated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Body"`: Object data.
- `"Cache-Control"`: Can be used to specify caching behavior along the request/reply chain.
For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.
- `"Content-Disposition"`: Specifies presentational information for the object. For more
information, see https://www.rfc-editor.org/rfc/rfc6266#section-4.
- `"Content-Encoding"`: Specifies what content encodings have been applied to the object
and thus what decoding mechanisms must be applied to obtain the media-type referenced by
the Content-Type header field. For more information, see
https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding.
- `"Content-Language"`: The language the content is in.
- `"Content-Length"`: Size of the body in bytes. This parameter is useful when the size of
the body cannot be determined automatically. For more information, see
https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length.
- `"Content-MD5"`: The base64-encoded 128-bit MD5 digest of the message (without the
headers) according to RFC 1864. This header can be used as a message integrity check to
verify that the data is the same data that was originally sent. Although it is optional, we
recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more
information about REST request authentication, see REST Authentication. The Content-MD5
header is required for any request to upload an object with a retention period configured
using Amazon S3 Object Lock. For more information about Amazon S3 Object Lock, see Amazon
S3 Object Lock Overview in the Amazon S3 User Guide. This functionality is not supported
for directory buckets.
- `"Content-Type"`: A standard MIME type describing the format of the contents. For more
information, see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type.
- `"Expires"`: The date and time at which the object is no longer cacheable. For more
information, see https://www.rfc-editor.org/rfc/rfc7234#section-5.3.
- `"x-amz-acl"`: The canned ACL to apply to the object. For more information, see Canned
ACL in the Amazon S3 User Guide. When adding a new object, you can use headers to grant
ACL-based permissions to individual Amazon Web Services accounts or to predefined groups
defined by Amazon S3. These permissions are then added to the ACL on the object. By
default, all objects are private. Only the owner has full access control. For more
information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API in
the Amazon S3 User Guide. If the bucket that you're uploading objects to uses the bucket
owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect
permissions. Buckets that use this setting only accept PUT requests that don't specify an
ACL or PUT requests that specify bucket owner full control ACLs, such as the
bucket-owner-full-control canned ACL or an equivalent form of this ACL expressed in the XML
format. PUT requests that contain other ACLs (for example, custom grants to certain Amazon
Web Services accounts) fail and return a 400 error with the error code
AccessControlListNotSupported. For more information, see Controlling ownership of objects
and disabling ACLs in the Amazon S3 User Guide. This functionality is not supported for
directory buckets. This functionality is not supported for Amazon S3 on Outposts.
- `"x-amz-checksum-crc32"`: This header can be used as a data integrity check to verify
that the data received is the same data that was originally sent. This header specifies the
base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking
object integrity in the Amazon S3 User Guide.
- `"x-amz-checksum-crc32c"`: This header can be used as a data integrity check to verify
that the data received is the same data that was originally sent. This header specifies the
base64-encoded, 32-bit CRC32C checksum of the object. For more information, see Checking
object integrity in the Amazon S3 User Guide.
- `"x-amz-checksum-sha1"`: This header can be used as a data integrity check to verify that
the data received is the same data that was originally sent. This header specifies the
base64-encoded, 160-bit SHA-1 digest of the object. For more information, see Checking
object integrity in the Amazon S3 User Guide.
- `"x-amz-checksum-sha256"`: This header can be used as a data integrity check to verify
that the data received is the same data that was originally sent. This header specifies the
base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking
object integrity in the Amazon S3 User Guide.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-grant-full-control"`: Gives the grantee READ, READ_ACP, and WRITE_ACP permissions
on the object. This functionality is not supported for directory buckets. This
functionality is not supported for Amazon S3 on Outposts.
- `"x-amz-grant-read"`: Allows grantee to read the object data and its metadata. This
functionality is not supported for directory buckets. This functionality is not supported
for Amazon S3 on Outposts.
- `"x-amz-grant-read-acp"`: Allows grantee to read the object ACL. This functionality is
not supported for directory buckets. This functionality is not supported for Amazon S3 on
Outposts.
- `"x-amz-grant-write-acp"`: Allows grantee to write the ACL for the applicable object.
This functionality is not supported for directory buckets. This functionality is not
supported for Amazon S3 on Outposts.
- `"x-amz-meta-"`: A map of metadata to store with the object in S3.
- `"x-amz-object-lock-legal-hold"`: Specifies whether a legal hold will be applied to this
object. For more information about S3 Object Lock, see Object Lock in the Amazon S3 User
Guide. This functionality is not supported for directory buckets.
- `"x-amz-object-lock-mode"`: The Object Lock mode that you want to apply to this object.
This functionality is not supported for directory buckets.
- `"x-amz-object-lock-retain-until-date"`: The date and time when you want this object's
Object Lock to expire. Must be formatted as a timestamp parameter. This functionality is
not supported for directory buckets.
- `"x-amz-request-payer"`:
- `"x-amz-sdk-checksum-algorithm"`: Indicates the algorithm used to create the checksum for
the object when you use the SDK. This header will not provide any additional functionality
if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum-algorithm or x-amz-trailer header sent. Otherwise, Amazon S3 fails the
request with the HTTP status code 400 Bad Request. For the x-amz-checksum-algorithm
header, replace algorithm with the supported algorithm from the following list: CRC32
CRC32C SHA1 SHA256 For more information, see Checking object integrity in the Amazon
S3 User Guide. If the individual checksum value you provide through
x-amz-checksum-algorithm doesn't match the checksum algorithm you set through
x-amz-sdk-checksum-algorithm, Amazon S3 ignores any provided ChecksumAlgorithm parameter
and uses the checksum algorithm that matches the provided value in x-amz-checksum-algorithm
. For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default
checksum algorithm that's used for performance.
- `"x-amz-server-side-encryption"`: The server-side encryption algorithm that was used when
you store this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse). General
purpose buckets - You have four mutually exclusive options to protect data using
server-side encryption in Amazon S3, depending on how you choose to manage the encryption
keys. Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon
Web Services KMS keys (SSE-KMS or DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3
encrypts data with server-side encryption by using Amazon S3 managed keys (SSE-S3) by
default. You can optionally tell Amazon S3 to encrypt data at rest by using server-side
encryption with other key options. For more information, see Using Server-Side Encryption
in the Amazon S3 User Guide. Directory buckets - For directory buckets, only the
server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) value is supported.
- `"x-amz-server-side-encryption-aws-kms-key-id"`: If x-amz-server-side-encryption has a
valid value of aws:kms or aws:kms:dsse, this header specifies the ID (Key ID, Key ARN, or
Key Alias) of the Key Management Service (KMS) symmetric encryption customer managed key
that was used for the object. If you specify x-amz-server-side-encryption:aws:kms or
x-amz-server-side-encryption:aws:kms:dsse, but do not provide
x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed
key (aws/s3) to protect the data. If the KMS key does not exist in the same account that's
issuing the command, you must use the full ARN and not just the ID. This functionality is
not supported for directory buckets.
- `"x-amz-server-side-encryption-bucket-key-enabled"`: Specifies whether Amazon S3 should
use an S3 Bucket Key for object encryption with server-side encryption using Key Management
Service (KMS) keys (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3
Bucket Key for object encryption with SSE-KMS. Specifying this header with a PUT action
doesn’t affect bucket-level settings for S3 Bucket Key. This functionality is not
supported for directory buckets.
- `"x-amz-server-side-encryption-context"`: Specifies the Amazon Web Services KMS
Encryption Context to use for object encryption. The value of this header is a
base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. This
value is stored as object metadata and automatically gets passed on to Amazon Web Services
KMS for future GetObject or CopyObject operations on this object. This value must be
explicitly added during CopyObject operations. This functionality is not supported for
directory buckets.
- `"x-amz-server-side-encryption-customer-algorithm"`: Specifies the algorithm to use when
encrypting the object (for example, AES256). This functionality is not supported for
directory buckets.
- `"x-amz-server-side-encryption-customer-key"`: Specifies the customer-provided encryption
key for Amazon S3 to use in encrypting data. This value is used to store the object and
then it is discarded; Amazon S3 does not store the encryption key. The key must be
appropriate for use with the algorithm specified in the
x-amz-server-side-encryption-customer-algorithm header. This functionality is not
supported for directory buckets.
- `"x-amz-server-side-encryption-customer-key-MD5"`: Specifies the 128-bit MD5 digest of
the encryption key according to RFC 1321. Amazon S3 uses this header for a message
integrity check to ensure that the encryption key was transmitted without error. This
functionality is not supported for directory buckets.
- `"x-amz-storage-class"`: By default, Amazon S3 uses the STANDARD Storage Class to store
newly created objects. The STANDARD storage class provides high durability and high
availability. Depending on performance needs, you can specify a different Storage Class.
For more information, see Storage Classes in the Amazon S3 User Guide. For directory
buckets, only the S3 Express One Zone storage class is supported to store newly created
objects. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
- `"x-amz-tagging"`: The tag-set for the object. The tag-set must be encoded as URL Query
parameters. (For example, \"Key1=Value1\") This functionality is not supported for
directory buckets.
- `"x-amz-website-redirect-location"`: If the bucket is configured as a website, redirects
requests for this object to another object in the same bucket or to an external URL. Amazon
S3 stores the value of this header in the object metadata. For information about object
metadata, see Object Key and Metadata in the Amazon S3 User Guide. In the following
example, the request header sets the redirect to an object (anotherPage.html) in the same
bucket: x-amz-website-redirect-location: /anotherPage.html In the following example, the
request header sets the object redirect to another website:
x-amz-website-redirect-location: http://www.example.com/ For more information about
website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure
Website Page Redirects in the Amazon S3 User Guide. This functionality is not supported
for directory buckets.
"""
function put_object(Bucket, Key; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"PUT", "/$(Bucket)/$(Key)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function put_object(
Bucket,
Key,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"PUT",
"/$(Bucket)/$(Key)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_object_acl(bucket, key)
put_object_acl(bucket, key, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Uses the acl subresource to set the
access control list (ACL) permissions for a new or existing object in an S3 bucket. You
must have the WRITE_ACP permission to set the ACL of an object. For more information, see
What permissions can I grant? in the Amazon S3 User Guide. This functionality is not
supported for Amazon S3 on Outposts. Depending on your application needs, you can choose to
set the ACL on an object using either the request body or the headers. For example, if you
have an existing application that updates a bucket ACL using the request body, you can
continue to use that approach. For more information, see Access Control List (ACL) Overview
in the Amazon S3 User Guide. If your bucket uses the bucket owner enforced setting for S3
Object Ownership, ACLs are disabled and no longer affect permissions. You must use policies
to grant access to your bucket and the objects in it. Requests to set ACLs or update ACLs
fail and return the AccessControlListNotSupported error code. Requests to read ACLs are
still supported. For more information, see Controlling object ownership in the Amazon S3
User Guide. Permissions You can set access permissions using one of the following
methods: Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports a set
of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees
and permissions. Specify the canned ACL name as the value of x-amz-acl. If you use this
header, you cannot use other access control-specific headers in your request. For more
information, see Canned ACL. Specify access permissions explicitly with the
x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control
headers. When using these headers, you specify explicit access permissions and grantees
(Amazon Web Services accounts or Amazon S3 groups) who will receive the permission. If you
use these ACL-specific headers, you cannot use x-amz-acl header to set a canned ACL. These
parameters map to the set of permissions that Amazon S3 supports in an ACL. For more
information, see Access Control List (ACL) Overview. You specify each grantee as a
type=value pair, where the type is one of the following: id – if the value specified
is the canonical user ID of an Amazon Web Services account uri – if you are granting
permissions to a predefined group emailAddress – if the value specified is the email
address of an Amazon Web Services account Using email addresses to specify a grantee is
only supported in the following Amazon Web Services Regions: US East (N. Virginia) US
West (N. California) US West (Oregon) Asia Pacific (Singapore) Asia Pacific
(Sydney) Asia Pacific (Tokyo) Europe (Ireland) South America (São Paulo) For a
list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the
Amazon Web Services General Reference. For example, the following x-amz-grant-read
header grants list objects permission to the two Amazon Web Services accounts identified by
their email addresses. x-amz-grant-read: emailAddress=\"[email protected]\",
emailAddress=\"[email protected]\" You can use either a canned ACL or specify access
permissions explicitly. You cannot do both. Grantee Values You can specify the person
(grantee) to whom you're assigning access rights (using request elements) in the following
ways: By the person's ID: <Grantee
xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"
xsi:type=\"CanonicalUser\"><ID><>ID<></ID><DisplayName><
;>GranteesEmail<></DisplayName> </Grantee> DisplayName is optional
and ignored in the request. By URI: <Grantee
xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"
xsi:type=\"Group\"><URI><>http://acs.amazonaws.com/groups/global/Authenticate
dUsers<></URI></Grantee> By Email address: <Grantee
xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"
xsi:type=\"AmazonCustomerByEmail\"><EmailAddress><>[email protected]<>
;</EmailAddress>lt;/Grantee> The grantee is resolved to the CanonicalUser and, in
a response to a GET Object acl request, appears as the CanonicalUser. Using email
addresses to specify a grantee is only supported in the following Amazon Web Services
Regions: US East (N. Virginia) US West (N. California) US West (Oregon) Asia
Pacific (Singapore) Asia Pacific (Sydney) Asia Pacific (Tokyo) Europe (Ireland)
South America (São Paulo) For a list of all the Amazon S3 supported Regions and
endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
Versioning The ACL of an object is set at the object version level. By default, PUT sets
the ACL of the current version of an object. To set the ACL of a different version, use the
versionId subresource. The following operations are related to PutObjectAcl:
CopyObject GetObject
# Arguments
- `bucket`: The bucket name that contains the object to which you want to attach the ACL.
Access points - When you use this action with an access point, you must provide the alias
of the access point in place of the bucket name or specify the access point ARN. When using
the access point ARN, you must direct requests to the access point hostname. The access
point hostname takes the form
AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with
an access point through the Amazon Web Services SDKs, you provide the access point ARN in
place of the bucket name. For more information about access point ARNs, see Using access
points in the Amazon S3 User Guide. S3 on Outposts - When you use this action with Amazon
S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts
hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this
action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
access point ARN in place of the bucket name. For more information about S3 on Outposts
ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
- `key`: Key for which the PUT action was initiated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccessControlPolicy"`: Contains the elements that set the ACL permissions for an object
per grantee.
- `"Content-MD5"`: The base64-encoded 128-bit MD5 digest of the data. This header must be
used as a message integrity check to verify that the request body was not corrupted in
transit. For more information, go to RFC 1864.> For requests made using the Amazon Web
Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated
automatically.
- `"versionId"`: Version ID used to reference a specific version of the object. This
functionality is not supported for directory buckets.
- `"x-amz-acl"`: The canned ACL to apply to the object. For more information, see Canned
ACL.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-grant-full-control"`: Allows grantee the read, write, read ACP, and write ACP
permissions on the bucket. This functionality is not supported for Amazon S3 on Outposts.
- `"x-amz-grant-read"`: Allows grantee to list the objects in the bucket. This
functionality is not supported for Amazon S3 on Outposts.
- `"x-amz-grant-read-acp"`: Allows grantee to read the bucket ACL. This functionality is
not supported for Amazon S3 on Outposts.
- `"x-amz-grant-write"`: Allows grantee to create new objects in the bucket. For the bucket
and object owners of existing objects, also allows deletions and overwrites of those
objects.
- `"x-amz-grant-write-acp"`: Allows grantee to write the ACL for the applicable bucket.
This functionality is not supported for Amazon S3 on Outposts.
- `"x-amz-request-payer"`:
- `"x-amz-sdk-checksum-algorithm"`: Indicates the algorithm used to create the checksum for
the object when you use the SDK. This header will not provide any additional functionality
if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with
the HTTP status code 400 Bad Request. For more information, see Checking object integrity
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any
provided ChecksumAlgorithm parameter.
"""
function put_object_acl(Bucket, Key; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"PUT",
"/$(Bucket)/$(Key)?acl";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_object_acl(
Bucket,
Key,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"PUT",
"/$(Bucket)/$(Key)?acl",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_object_legal_hold(bucket, key)
put_object_legal_hold(bucket, key, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Applies a legal hold configuration
to the specified object. For more information, see Locking Objects. This functionality is
not supported for Amazon S3 on Outposts.
# Arguments
- `bucket`: The bucket name containing the object that you want to place a legal hold on.
Access points - When you use this action with an access point, you must provide the alias
of the access point in place of the bucket name or specify the access point ARN. When using
the access point ARN, you must direct requests to the access point hostname. The access
point hostname takes the form
AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with
an access point through the Amazon Web Services SDKs, you provide the access point ARN in
place of the bucket name. For more information about access point ARNs, see Using access
points in the Amazon S3 User Guide.
- `key`: The key name for the object that you want to place a legal hold on.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Content-MD5"`: The MD5 hash for the request body. For requests made using the Amazon
Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is
calculated automatically.
- `"LegalHold"`: Container element for the legal hold configuration you want to apply to
the specified object.
- `"versionId"`: The version ID of the object that you want to place a legal hold on.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-request-payer"`:
- `"x-amz-sdk-checksum-algorithm"`: Indicates the algorithm used to create the checksum for
the object when you use the SDK. This header will not provide any additional functionality
if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with
the HTTP status code 400 Bad Request. For more information, see Checking object integrity
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any
provided ChecksumAlgorithm parameter.
"""
function put_object_legal_hold(
Bucket, Key; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"PUT",
"/$(Bucket)/$(Key)?legal-hold";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_object_legal_hold(
Bucket,
Key,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"PUT",
"/$(Bucket)/$(Key)?legal-hold",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_object_lock_configuration(bucket)
put_object_lock_configuration(bucket, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Places an Object Lock configuration
on the specified bucket. The rule specified in the Object Lock configuration will be
applied by default to every new object placed in the specified bucket. For more
information, see Locking Objects. The DefaultRetention settings require both a mode and
a period. The DefaultRetention period can be either Days or Years but you must select
one. You cannot specify Days and Years at the same time. You can enable Object Lock for
new or existing buckets. For more information, see Configuring Object Lock.
# Arguments
- `bucket`: The bucket whose Object Lock configuration you want to create or replace.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Content-MD5"`: The MD5 hash for the request body. For requests made using the Amazon
Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is
calculated automatically.
- `"ObjectLockConfiguration"`: The Object Lock configuration that you want to apply to the
specified bucket.
- `"x-amz-bucket-object-lock-token"`: A token to allow Object Lock to be enabled for an
existing bucket.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-request-payer"`:
- `"x-amz-sdk-checksum-algorithm"`: Indicates the algorithm used to create the checksum for
the object when you use the SDK. This header will not provide any additional functionality
if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with
the HTTP status code 400 Bad Request. For more information, see Checking object integrity
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any
provided ChecksumAlgorithm parameter.
"""
function put_object_lock_configuration(
Bucket; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"PUT",
"/$(Bucket)?object-lock";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_object_lock_configuration(
Bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"PUT",
"/$(Bucket)?object-lock",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_object_retention(bucket, key)
put_object_retention(bucket, key, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Places an Object Retention
configuration on an object. For more information, see Locking Objects. Users or accounts
require the s3:PutObjectRetention permission in order to place an Object Retention
configuration on objects. Bypassing a Governance Retention configuration requires the
s3:BypassGovernanceRetention permission. This functionality is not supported for Amazon S3
on Outposts.
# Arguments
- `bucket`: The bucket name that contains the object you want to apply this Object
Retention configuration to. Access points - When you use this action with an access
point, you must provide the alias of the access point in place of the bucket name or
specify the access point ARN. When using the access point ARN, you must direct requests to
the access point hostname. The access point hostname takes the form
AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with
an access point through the Amazon Web Services SDKs, you provide the access point ARN in
place of the bucket name. For more information about access point ARNs, see Using access
points in the Amazon S3 User Guide.
- `key`: The key name for the object that you want to apply this Object Retention
configuration to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Content-MD5"`: The MD5 hash for the request body. For requests made using the Amazon
Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is
calculated automatically.
- `"Retention"`: The container element for the Object Retention configuration.
- `"versionId"`: The version ID for the object that you want to apply this Object Retention
configuration to.
- `"x-amz-bypass-governance-retention"`: Indicates whether this action should bypass
Governance-mode restrictions.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-request-payer"`:
- `"x-amz-sdk-checksum-algorithm"`: Indicates the algorithm used to create the checksum for
the object when you use the SDK. This header will not provide any additional functionality
if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with
the HTTP status code 400 Bad Request. For more information, see Checking object integrity
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any
provided ChecksumAlgorithm parameter.
"""
function put_object_retention(
Bucket, Key; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"PUT",
"/$(Bucket)/$(Key)?retention";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_object_retention(
Bucket,
Key,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"PUT",
"/$(Bucket)/$(Key)?retention",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_object_tagging(bucket, key, tagging)
put_object_tagging(bucket, key, tagging, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Sets the supplied tag-set to an
object that already exists in a bucket. A tag is a key-value pair. For more information,
see Object Tagging. You can associate tags with an object by sending a PUT request against
the tagging subresource that is associated with the object. You can retrieve tags by
sending a GET request. For more information, see GetObjectTagging. For tagging-related
restrictions related to characters and encodings, see Tag Restrictions. Note that Amazon S3
limits the maximum number of tags to 10 tags per object. To use this operation, you must
have permission to perform the s3:PutObjectTagging action. By default, the bucket owner has
this permission and can grant this permission to others. To put tags of any other version,
use the versionId query parameter. You also need permission for the
s3:PutObjectVersionTagging action. PutObjectTagging has the following special errors. For
more Amazon S3 errors see, Error Responses. InvalidTag - The tag provided was not a
valid tag. This error can occur if the tag did not pass input validation. For more
information, see Object Tagging. MalformedXML - The XML provided does not match the
schema. OperationAborted - A conflicting conditional action is currently in progress
against this resource. Please try again. InternalError - The service was unable to apply
the provided tag to the object. The following operations are related to PutObjectTagging:
GetObjectTagging DeleteObjectTagging
# Arguments
- `bucket`: The bucket name containing the object. Access points - When you use this
action with an access point, you must provide the alias of the access point in place of the
bucket name or specify the access point ARN. When using the access point ARN, you must
direct requests to the access point hostname. The access point hostname takes the form
AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with
an access point through the Amazon Web Services SDKs, you provide the access point ARN in
place of the bucket name. For more information about access point ARNs, see Using access
points in the Amazon S3 User Guide. S3 on Outposts - When you use this action with Amazon
S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts
hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this
action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
access point ARN in place of the bucket name. For more information about S3 on Outposts
ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
- `key`: Name of the object key.
- `tagging`: Container for the TagSet and Tag elements
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Content-MD5"`: The MD5 hash for the request body. For requests made using the Amazon
Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is
calculated automatically.
- `"versionId"`: The versionId of the object that the tag-set will be added to.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-request-payer"`:
- `"x-amz-sdk-checksum-algorithm"`: Indicates the algorithm used to create the checksum for
the object when you use the SDK. This header will not provide any additional functionality
if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with
the HTTP status code 400 Bad Request. For more information, see Checking object integrity
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any
provided ChecksumAlgorithm parameter.
"""
function put_object_tagging(
Bucket, Key, Tagging; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"PUT",
"/$(Bucket)/$(Key)?tagging",
Dict{String,Any}("Tagging" => Tagging);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_object_tagging(
Bucket,
Key,
Tagging,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"PUT",
"/$(Bucket)/$(Key)?tagging",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Tagging" => Tagging), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_public_access_block(bucket, public_access_block_configuration)
put_public_access_block(bucket, public_access_block_configuration, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Creates or modifies the
PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must
have the s3:PutBucketPublicAccessBlock permission. For more information about Amazon S3
permissions, see Specifying Permissions in a Policy. When Amazon S3 evaluates the
PublicAccessBlock configuration for a bucket or an object, it checks the PublicAccessBlock
configuration for both the bucket (or the bucket that contains the object) and the bucket
owner's account. If the PublicAccessBlock configurations are different between the bucket
and the account, Amazon S3 uses the most restrictive combination of the bucket-level and
account-level settings. For more information about when Amazon S3 considers a bucket or an
object public, see The Meaning of \"Public\". The following operations are related to
PutPublicAccessBlock: GetPublicAccessBlock DeletePublicAccessBlock
GetBucketPolicyStatus Using Amazon S3 Block Public Access
# Arguments
- `bucket`: The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want
to set.
- `public_access_block_configuration`: The PublicAccessBlock configuration that you want to
apply to this Amazon S3 bucket. You can enable the configuration options in any
combination. For more information about when Amazon S3 considers a bucket or object public,
see The Meaning of \"Public\" in the Amazon S3 User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Content-MD5"`: The MD5 hash of the PutPublicAccessBlock request body. For requests
made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services
SDKs, this field is calculated automatically.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-sdk-checksum-algorithm"`: Indicates the algorithm used to create the checksum for
the object when you use the SDK. This header will not provide any additional functionality
if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with
the HTTP status code 400 Bad Request. For more information, see Checking object integrity
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any
provided ChecksumAlgorithm parameter.
"""
function put_public_access_block(
Bucket,
PublicAccessBlockConfiguration;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"PUT",
"/$(Bucket)?publicAccessBlock",
Dict{String,Any}(
"PublicAccessBlockConfiguration" => PublicAccessBlockConfiguration
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_public_access_block(
Bucket,
PublicAccessBlockConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"PUT",
"/$(Bucket)?publicAccessBlock",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PublicAccessBlockConfiguration" => PublicAccessBlockConfiguration
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restore_object(bucket, key)
restore_object(bucket, key, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Restores an archived copy of an
object back into Amazon S3 This functionality is not supported for Amazon S3 on Outposts.
This action performs the following types of requests: restore an archive - Restore an
archived object For more information about the S3 structure in the request body, see the
following: PutObject Managing Access with ACLs in the Amazon S3 User Guide
Protecting Data Using Server-Side Encryption in the Amazon S3 User Guide Permissions
To use this operation, you must have permissions to perform the s3:RestoreObject action.
The bucket owner has this permission by default and can grant this permission to others.
For more information about permissions, see Permissions Related to Bucket Subresource
Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3
User Guide. Restoring objects Objects that you archive to the S3 Glacier Flexible
Retrieval Flexible Retrieval or S3 Glacier Deep Archive storage class, and S3
Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, are not
accessible in real time. For objects in the S3 Glacier Flexible Retrieval Flexible
Retrieval or S3 Glacier Deep Archive storage classes, you must first initiate a restore
request, and then wait until a temporary copy of the object is available. If you want a
permanent copy of the object, create a copy of it in the Amazon S3 Standard storage class
in your S3 bucket. To access an archived object, you must restore the object for the
duration (number of days) that you specify. For objects in the Archive Access or Deep
Archive Access tiers of S3 Intelligent-Tiering, you must first initiate a restore request,
and then wait until the object is moved into the Frequent Access tier. To restore a
specific object version, you can provide a version ID. If you don't provide a version ID,
Amazon S3 restores the current version. When restoring an archived object, you can specify
one of the following data access tier options in the Tier element of the request body:
Expedited - Expedited retrievals allow you to quickly access your data stored in the S3
Glacier Flexible Retrieval Flexible Retrieval storage class or S3 Intelligent-Tiering
Archive tier when occasional urgent requests for restoring archives are required. For all
but the largest archived objects (250 MB+), data accessed using Expedited retrievals is
typically made available within 1–5 minutes. Provisioned capacity ensures that retrieval
capacity for Expedited retrievals is available when you need it. Expedited retrievals and
provisioned capacity are not available for objects stored in the S3 Glacier Deep Archive
storage class or S3 Intelligent-Tiering Deep Archive tier. Standard - Standard
retrievals allow you to access any of your archived objects within several hours. This is
the default option for retrieval requests that do not specify the retrieval option.
Standard retrievals typically finish within 3–5 hours for objects stored in the S3
Glacier Flexible Retrieval Flexible Retrieval storage class or S3 Intelligent-Tiering
Archive tier. They typically finish within 12 hours for objects stored in the S3 Glacier
Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Standard retrievals
are free for objects stored in S3 Intelligent-Tiering. Bulk - Bulk retrievals free for
objects stored in the S3 Glacier Flexible Retrieval and S3 Intelligent-Tiering storage
classes, enabling you to retrieve large amounts, even petabytes, of data at no cost. Bulk
retrievals typically finish within 5–12 hours for objects stored in the S3 Glacier
Flexible Retrieval Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier.
Bulk retrievals are also the lowest-cost retrieval option when restoring objects from S3
Glacier Deep Archive. They typically finish within 48 hours for objects stored in the S3
Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. For more
information about archive retrieval options and provisioned capacity for Expedited data
access, see Restoring Archived Objects in the Amazon S3 User Guide. You can use Amazon S3
restore speed upgrade to change the restore speed to a faster speed while it is in
progress. For more information, see Upgrading the speed of an in-progress restore in the
Amazon S3 User Guide. To get the status of object restoration, you can send a HEAD
request. Operations return the x-amz-restore header, which provides information about the
restoration status, in the response. You can use Amazon S3 event notifications to notify
you when a restore is initiated or completed. For more information, see Configuring Amazon
S3 Event Notifications in the Amazon S3 User Guide. After restoring an archived object, you
can update the restoration period by reissuing the request with a new period. Amazon S3
updates the restoration period relative to the current time and charges only for the
request-there are no data transfer charges. You cannot update the restoration period when
Amazon S3 is actively processing your current restore request for the object. If your
bucket has a lifecycle configuration with a rule that includes an expiration action, the
object expiration overrides the life span that you specify in a restore request. For
example, if you restore an object copy for 10 days, but the object is scheduled to expire
in 3 days, Amazon S3 deletes the object in 3 days. For more information about lifecycle
configuration, see PutBucketLifecycleConfiguration and Object Lifecycle Management in
Amazon S3 User Guide. Responses A successful action returns either the 200 OK or 202
Accepted status code. If the object is not previously restored, then Amazon S3 returns
202 Accepted in the response. If the object is previously restored, Amazon S3 returns
200 OK in the response. Special errors: Code: RestoreAlreadyInProgress Cause:
Object restore is already in progress. HTTP Status Code: 409 Conflict SOAP Fault
Code Prefix: Client Code: GlacierExpeditedRetrievalNotAvailable Cause:
expedited retrievals are currently not available. Try again later. (Returned if there is
insufficient capacity to process the Expedited request. This error applies only to
Expedited retrievals and not to S3 Standard or Bulk retrievals.) HTTP Status Code: 503
SOAP Fault Code Prefix: N/A The following operations are related to
RestoreObject: PutBucketLifecycleConfiguration GetBucketNotificationConfiguration
# Arguments
- `bucket`: The bucket name containing the object to restore. Access points - When you
use this action with an access point, you must provide the alias of the access point in
place of the bucket name or specify the access point ARN. When using the access point ARN,
you must direct requests to the access point hostname. The access point hostname takes the
form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action
with an access point through the Amazon Web Services SDKs, you provide the access point ARN
in place of the bucket name. For more information about access point ARNs, see Using access
points in the Amazon S3 User Guide. S3 on Outposts - When you use this action with Amazon
S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts
hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this
action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
access point ARN in place of the bucket name. For more information about S3 on Outposts
ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
- `key`: Object key for which the action was initiated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"RestoreRequest"`:
- `"versionId"`: VersionId used to reference a specific version of the object.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-request-payer"`:
- `"x-amz-sdk-checksum-algorithm"`: Indicates the algorithm used to create the checksum for
the object when you use the SDK. This header will not provide any additional functionality
if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with
the HTTP status code 400 Bad Request. For more information, see Checking object integrity
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any
provided ChecksumAlgorithm parameter.
"""
function restore_object(Bucket, Key; aws_config::AbstractAWSConfig=global_aws_config())
return s3(
"POST",
"/$(Bucket)/$(Key)?restore";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function restore_object(
Bucket,
Key,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"POST",
"/$(Bucket)/$(Key)?restore",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
select_object_content(bucket, expression, expression_type, input_serialization, key, output_serialization)
select_object_content(bucket, expression, expression_type, input_serialization, key, output_serialization, params::Dict{String,<:Any})
This operation is not supported by directory buckets. This action filters the contents of
an Amazon S3 object based on a simple structured query language (SQL) statement. In the
request, along with the SQL expression, you must also specify a data serialization format
(JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses this format to parse object
data into records, and returns only records that match the specified SQL expression. You
must also specify the data serialization format for the response. This functionality is not
supported for Amazon S3 on Outposts. For more information about Amazon S3 Select, see
Selecting Content from Objects and SELECT Command in the Amazon S3 User Guide.
Permissions You must have the s3:GetObject permission for this operation. Amazon S3
Select does not support anonymous access. For more information about permissions, see
Specifying Permissions in a Policy in the Amazon S3 User Guide. Object Data Formats You
can use Amazon S3 Select to query objects that have the following format properties:
CSV, JSON, and Parquet - Objects must be in CSV, JSON, or Parquet format. UTF-8 - UTF-8
is the only encoding type Amazon S3 Select supports. GZIP or BZIP2 - CSV and JSON files
can be compressed using GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that
Amazon S3 Select supports for CSV and JSON files. Amazon S3 Select supports columnar
compression for Parquet using GZIP or Snappy. Amazon S3 Select does not support
whole-object compression for Parquet objects. Server-side encryption - Amazon S3 Select
supports querying objects that are protected with server-side encryption. For objects that
are encrypted with customer-provided encryption keys (SSE-C), you must use HTTPS, and you
must use the headers that are documented in the GetObject. For more information about
SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon
S3 User Guide. For objects that are encrypted with Amazon S3 managed keys (SSE-S3) and
Amazon Web Services KMS keys (SSE-KMS), server-side encryption is handled transparently, so
you don't need to specify anything. For more information about server-side encryption,
including SSE-S3 and SSE-KMS, see Protecting Data Using Server-Side Encryption in the
Amazon S3 User Guide. Working with the Response Body Given the response size is
unknown, Amazon S3 Select streams the response as a series of messages and includes a
Transfer-Encoding header with chunked as its value in the response. For more information,
see Appendix: SelectObjectContent Response. GetObject Support The SelectObjectContent
action does not support the following GetObject functionality. For more information, see
GetObject. Range: Although you can specify a scan range for an Amazon S3 Select request
(see SelectObjectContentRequest - ScanRange in the request parameters), you cannot specify
the range of bytes of an object to return. The GLACIER, DEEP_ARCHIVE, and
REDUCED_REDUNDANCY storage classes, or the ARCHIVE_ACCESS and DEEP_ARCHIVE_ACCESS access
tiers of the INTELLIGENT_TIERING storage class: You cannot query objects in the GLACIER,
DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage classes, nor objects in the ARCHIVE_ACCESS or
DEEP_ARCHIVE_ACCESS access tiers of the INTELLIGENT_TIERING storage class. For more
information about storage classes, see Using Amazon S3 storage classes in the Amazon S3
User Guide. Special Errors For a list of special errors for this operation, see List of
SELECT Object Content Error Codes The following operations are related to
SelectObjectContent: GetObject GetBucketLifecycleConfiguration
PutBucketLifecycleConfiguration
# Arguments
- `bucket`: The S3 bucket.
- `expression`: The expression that is used to query the object.
- `expression_type`: The type of the provided expression (for example, SQL).
- `input_serialization`: Describes the format of the data in the object that is being
queried.
- `key`: The object key.
- `output_serialization`: Describes the format of the data that you want Amazon S3 to
return in response.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"RequestProgress"`: Specifies if periodic request progress information should be enabled.
- `"ScanRange"`: Specifies the byte range of the object to get the records from. A record
is processed when its first byte is contained by the range. This parameter is optional, but
when specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify
the start and end of the range. ScanRangemay be used in the following ways:
<scanrange><start>50</start><end>100</end></scanrange>
- process only the records starting between the bytes 50 and 100 (inclusive, counting from
zero) <scanrange><start>50</start></scanrange> - process only
the records starting after the byte 50
<scanrange><end>50</end></scanrange> - process only the records
within the last 50 bytes of the file.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-server-side-encryption-customer-algorithm"`: The server-side encryption (SSE)
algorithm used to encrypt the object. This parameter is needed only when the object was
created using a checksum algorithm. For more information, see Protecting data using SSE-C
keys in the Amazon S3 User Guide.
- `"x-amz-server-side-encryption-customer-key"`: The server-side encryption (SSE) customer
managed key. This parameter is needed only when the object was created using a checksum
algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User
Guide.
- `"x-amz-server-side-encryption-customer-key-MD5"`: The MD5 server-side encryption (SSE)
customer managed key. This parameter is needed only when the object was created using a
checksum algorithm. For more information, see Protecting data using SSE-C keys in the
Amazon S3 User Guide.
"""
function select_object_content(
Bucket,
Expression,
ExpressionType,
InputSerialization,
Key,
OutputSerialization;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"POST",
"/$(Bucket)/$(Key)?select&select-type=2",
Dict{String,Any}(
"Expression" => Expression,
"ExpressionType" => ExpressionType,
"InputSerialization" => InputSerialization,
"OutputSerialization" => OutputSerialization,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function select_object_content(
Bucket,
Expression,
ExpressionType,
InputSerialization,
Key,
OutputSerialization,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"POST",
"/$(Bucket)/$(Key)?select&select-type=2",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Expression" => Expression,
"ExpressionType" => ExpressionType,
"InputSerialization" => InputSerialization,
"OutputSerialization" => OutputSerialization,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
upload_part(bucket, key, part_number, upload_id)
upload_part(bucket, key, part_number, upload_id, params::Dict{String,<:Any})
Uploads a part in a multipart upload. In this operation, you provide new data as a part of
an object in your request. However, you have an option to specify your existing Amazon S3
object as a data source for the part you are uploading. To upload a part from an existing
object, you use the UploadPartCopy operation. You must initiate a multipart upload (see
CreateMultipartUpload) before you can upload any part. In response to your initiate
request, Amazon S3 returns an upload ID, a unique identifier that you must include in your
upload part request. Part numbers can be any number from 1 to 10,000, inclusive. A part
number uniquely identifies a part and also defines its position within the object being
created. If you upload a new part using the same part number that was used with a previous
part, the previously uploaded part is overwritten. For information about maximum and
minimum part sizes and other multipart upload specifications, see Multipart upload limits
in the Amazon S3 User Guide. After you initiate multipart upload and upload one or more
parts, you must either complete or abort multipart upload in order to stop getting charged
for storage of the uploaded parts. Only after you either complete or abort multipart
upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.
For more information on multipart uploads, go to Multipart Upload Overview in the Amazon S3
User Guide . Directory buckets - For directory buckets, you must make requests for this
API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests
in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name .
Path-style requests are not supported. For more information, see Regional and Zonal
endpoints in the Amazon S3 User Guide. Permissions General purpose bucket permissions
- For information on the permissions required to use the multipart upload API, see
Multipart Upload and Permissions in the Amazon S3 User Guide. Directory bucket
permissions - To grant access to this API operation on a directory bucket, we recommend
that you use the CreateSession API operation for session-based authorization.
Specifically, you grant the s3express:CreateSession permission to the directory bucket in a
bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on
the bucket to obtain a session token. With the session token in your request header, you
can make API requests to this operation. After the session token expires, you make another
CreateSession API call to generate a new session token for use. Amazon Web Services CLI or
SDKs create session and refresh the session token automatically to avoid service
interruptions when a session expires. For more information about authorization, see
CreateSession . Data integrity General purpose bucket - To ensure that data is not
corrupted traversing the network, specify the Content-MD5 header in the upload part
request. Amazon S3 checks the part data against the provided MD5 value. If they do not
match, Amazon S3 returns an error. If the upload request is signed with Signature Version
4, then Amazon Web Services S3 uses the x-amz-content-sha256 header as a checksum instead
of Content-MD5. For more information see Authenticating Requests: Using the Authorization
Header (Amazon Web Services Signature Version 4). Directory buckets - MD5 is not
supported by directory buckets. You can use checksum algorithms to check object integrity.
Encryption General purpose bucket - Server-side encryption is for data encryption at
rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and
decrypts it when you access it. You have mutually exclusive options to protect data using
server-side encryption in Amazon S3, depending on how you choose to manage the encryption
keys. Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon
Web Services KMS keys (SSE-KMS), and Customer-Provided Keys (SSE-C). Amazon S3 encrypts
data with server-side encryption using Amazon S3 managed keys (SSE-S3) by default. You can
optionally tell Amazon S3 to encrypt data at rest using server-side encryption with other
key options. The option you use depends on whether you want to use KMS keys (SSE-KMS) or
provide your own encryption key (SSE-C). Server-side encryption is supported by the S3
Multipart Upload operations. Unless you are using a customer-provided encryption key
(SSE-C), you don't need to specify the encryption parameters in each UploadPart request.
Instead, you only need to specify the server-side encryption parameters in the initial
Initiate Multipart request. For more information, see CreateMultipartUpload. If you request
server-side encryption using a customer-provided encryption key (SSE-C) in your initiate
multipart upload request, you must provide identical encryption information in each part
upload using the following request headers.
x-amz-server-side-encryption-customer-algorithm x-amz-server-side-encryption-customer-key
x-amz-server-side-encryption-customer-key-MD5 Directory bucket - For directory
buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is
supported. For more information, see Using Server-Side Encryption in the Amazon S3 User
Guide. Special errors Error Code: NoSuchUpload Description: The specified multipart
upload does not exist. The upload ID might be invalid, or the multipart upload might have
been aborted or completed. HTTP Status Code: 404 Not Found SOAP Fault Code Prefix:
Client HTTP Host header syntax Directory buckets - The HTTP Host header syntax is
Bucket_name.s3express-az_id.region.amazonaws.com. The following operations are related to
UploadPart: CreateMultipartUpload CompleteMultipartUpload AbortMultipartUpload
ListParts ListMultipartUploads
# Arguments
- `bucket`: The name of the bucket to which the multipart upload was initiated. Directory
buckets - When you use this operation with a directory bucket, you must use
virtual-hosted-style requests in the format
Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported.
Directory bucket names must be unique in the chosen Availability Zone. Bucket names must
follow the format bucket_base_name--az-id--x-s3 (for example,
DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see
Directory bucket naming rules in the Amazon S3 User Guide. Access points - When you use
this action with an access point, you must provide the alias of the access point in place
of the bucket name or specify the access point ARN. When using the access point ARN, you
must direct requests to the access point hostname. The access point hostname takes the form
AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with
an access point through the Amazon Web Services SDKs, you provide the access point ARN in
place of the bucket name. For more information about access point ARNs, see Using access
points in the Amazon S3 User Guide. Access points and Object Lambda access points are not
supported by directory buckets. S3 on Outposts - When you use this action with Amazon S3
on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts
hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this
action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
access point ARN in place of the bucket name. For more information about S3 on Outposts
ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
- `key`: Object key for which the multipart upload was initiated.
- `part_number`: Part number of part being uploaded. This is a positive integer between 1
and 10,000.
- `upload_id`: Upload ID identifying the multipart upload whose part is being uploaded.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Body"`: Object data.
- `"Content-Length"`: Size of the body in bytes. This parameter is useful when the size of
the body cannot be determined automatically.
- `"Content-MD5"`: The base64-encoded 128-bit MD5 digest of the part data. This parameter
is auto-populated when using the command from the CLI. This parameter is required if object
lock parameters are specified. This functionality is not supported for directory buckets.
- `"x-amz-checksum-crc32"`: This header can be used as a data integrity check to verify
that the data received is the same data that was originally sent. This header specifies the
base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking
object integrity in the Amazon S3 User Guide.
- `"x-amz-checksum-crc32c"`: This header can be used as a data integrity check to verify
that the data received is the same data that was originally sent. This header specifies the
base64-encoded, 32-bit CRC32C checksum of the object. For more information, see Checking
object integrity in the Amazon S3 User Guide.
- `"x-amz-checksum-sha1"`: This header can be used as a data integrity check to verify that
the data received is the same data that was originally sent. This header specifies the
base64-encoded, 160-bit SHA-1 digest of the object. For more information, see Checking
object integrity in the Amazon S3 User Guide.
- `"x-amz-checksum-sha256"`: This header can be used as a data integrity check to verify
that the data received is the same data that was originally sent. This header specifies the
base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking
object integrity in the Amazon S3 User Guide.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected bucket owner. If the
account ID that you provide does not match the actual owner of the bucket, the request
fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-request-payer"`:
- `"x-amz-sdk-checksum-algorithm"`: Indicates the algorithm used to create the checksum for
the object when you use the SDK. This header will not provide any additional functionality
if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with
the HTTP status code 400 Bad Request. For more information, see Checking object integrity
in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 ignores any
provided ChecksumAlgorithm parameter. This checksum algorithm must be the same for all
parts and it match the checksum value supplied in the CreateMultipartUpload request.
- `"x-amz-server-side-encryption-customer-algorithm"`: Specifies the algorithm to use when
encrypting the object (for example, AES256). This functionality is not supported for
directory buckets.
- `"x-amz-server-side-encryption-customer-key"`: Specifies the customer-provided encryption
key for Amazon S3 to use in encrypting data. This value is used to store the object and
then it is discarded; Amazon S3 does not store the encryption key. The key must be
appropriate for use with the algorithm specified in the
x-amz-server-side-encryption-customer-algorithm header. This must be the same encryption
key specified in the initiate multipart upload request. This functionality is not
supported for directory buckets.
- `"x-amz-server-side-encryption-customer-key-MD5"`: Specifies the 128-bit MD5 digest of
the encryption key according to RFC 1321. Amazon S3 uses this header for a message
integrity check to ensure that the encryption key was transmitted without error. This
functionality is not supported for directory buckets.
"""
function upload_part(
Bucket, Key, partNumber, uploadId; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3(
"PUT",
"/$(Bucket)/$(Key)",
Dict{String,Any}("partNumber" => partNumber, "uploadId" => uploadId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function upload_part(
Bucket,
Key,
partNumber,
uploadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"PUT",
"/$(Bucket)/$(Key)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("partNumber" => partNumber, "uploadId" => uploadId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
upload_part_copy(bucket, key, part_number, upload_id, x-amz-copy-source)
upload_part_copy(bucket, key, part_number, upload_id, x-amz-copy-source, params::Dict{String,<:Any})
Uploads a part by copying data from an existing object as data source. To specify the data
source, you add the request header x-amz-copy-source in your request. To specify a byte
range, you add the request header x-amz-copy-source-range in your request. For information
about maximum and minimum part sizes and other multipart upload specifications, see
Multipart upload limits in the Amazon S3 User Guide. Instead of copying data from an
existing object as part data, you might use the UploadPart action to upload new data as a
part of an object in your request. You must initiate a multipart upload before you can
upload any part. In response to your initiate request, Amazon S3 returns the upload ID, a
unique identifier that you must include in your upload part request. For conceptual
information about multipart uploads, see Uploading Objects Using Multipart Upload in the
Amazon S3 User Guide. For information about copying objects using a single atomic action
vs. a multipart upload, see Operations on Objects in the Amazon S3 User Guide. Directory
buckets - For directory buckets, you must make requests for this API operation to the Zonal
endpoint. These endpoints support virtual-hosted-style requests in the format
https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are
not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User
Guide. Authentication and authorization All UploadPartCopy requests must be
authenticated and signed by using IAM credentials (access key ID and secret access key for
the IAM identities). All headers with the x-amz- prefix, including x-amz-copy-source, must
be signed. For more information, see REST Authentication. Directory buckets - You must use
IAM credentials to authenticate and authorize your access to the UploadPartCopy API
operation, instead of using the temporary security credentials through the CreateSession
API operation. Amazon Web Services CLI or SDKs handles authentication and authorization on
your behalf. Permissions You must have READ access to the source object and WRITE access
to the destination bucket. General purpose bucket permissions - You must have the
permissions in a policy based on the bucket types of your source bucket and destination
bucket in an UploadPartCopy operation. If the source object is in a general purpose
bucket, you must have the s3:GetObject permission to read the source object that is being
copied. If the destination bucket is a general purpose bucket, you must have the
s3:PutObject permission to write the object copy to the destination bucket. For
information about permissions required to use the multipart upload API, see Multipart
Upload and Permissions in the Amazon S3 User Guide. Directory bucket permissions - You
must have permissions in a bucket policy or an IAM identity-based policy based on the
source and destination bucket types in an UploadPartCopy operation. If the source object
that you want to copy is in a directory bucket, you must have the s3express:CreateSession
permission in the Action element of a policy to read the object . By default, the session
is in the ReadWrite mode. If you want to restrict the access, you can explicitly set the
s3express:SessionMode condition key to ReadOnly on the copy source bucket. If the copy
destination is a directory bucket, you must have the s3express:CreateSession permission
in the Action element of a policy to write the object to the destination. The
s3express:SessionMode condition key cannot be set to ReadOnly on the copy destination.
For example policies, see Example bucket policies for S3 Express One Zone and Amazon Web
Services Identity and Access Management (IAM) identity-based policies for S3 Express One
Zone in the Amazon S3 User Guide. Encryption General purpose buckets - For
information about using server-side encryption with customer-provided encryption keys with
the UploadPartCopy operation, see CopyObject and UploadPart. Directory buckets - For
directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3)
(AES256) is supported. Special errors Error Code: NoSuchUpload Description: The
specified multipart upload does not exist. The upload ID might be invalid, or the multipart
upload might have been aborted or completed. HTTP Status Code: 404 Not Found Error
Code: InvalidRequest Description: The specified copy source is not supported as a
byte-range copy source. HTTP Status Code: 400 Bad Request HTTP Host header syntax
Directory buckets - The HTTP Host header syntax is
Bucket_name.s3express-az_id.region.amazonaws.com. The following operations are related to
UploadPartCopy: CreateMultipartUpload UploadPart CompleteMultipartUpload
AbortMultipartUpload ListParts ListMultipartUploads
# Arguments
- `bucket`: The bucket name. Directory buckets - When you use this operation with a
directory bucket, you must use virtual-hosted-style requests in the format
Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported.
Directory bucket names must be unique in the chosen Availability Zone. Bucket names must
follow the format bucket_base_name--az-id--x-s3 (for example,
DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see
Directory bucket naming rules in the Amazon S3 User Guide. Access points - When you use
this action with an access point, you must provide the alias of the access point in place
of the bucket name or specify the access point ARN. When using the access point ARN, you
must direct requests to the access point hostname. The access point hostname takes the form
AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with
an access point through the Amazon Web Services SDKs, you provide the access point ARN in
place of the bucket name. For more information about access point ARNs, see Using access
points in the Amazon S3 User Guide. Access points and Object Lambda access points are not
supported by directory buckets. S3 on Outposts - When you use this action with Amazon S3
on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts
hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this
action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
access point ARN in place of the bucket name. For more information about S3 on Outposts
ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
- `key`: Object key for which the multipart upload was initiated.
- `part_number`: Part number of part being copied. This is a positive integer between 1 and
10,000.
- `upload_id`: Upload ID identifying the multipart upload whose part is being copied.
- `x-amz-copy-source`: Specifies the source object for the copy operation. You specify the
value in one of two formats, depending on whether you want to access the source object
through an access point: For objects not accessed through an access point, specify the
name of the source bucket and key of the source object, separated by a slash (/). For
example, to copy the object reports/january.pdf from the bucket awsexamplebucket, use
awsexamplebucket/reports/january.pdf. The value must be URL-encoded. For objects accessed
through access points, specify the Amazon Resource Name (ARN) of the object as accessed
through the access point, in the format
arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/&l
t;key>. For example, to copy the object reports/january.pdf through access point
my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf.
The value must be URL encoded. Amazon S3 supports copy operations using Access points
only when the source and destination buckets are in the same Amazon Web Services Region.
Access points are not supported by directory buckets. Alternatively, for objects
accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the
format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<
;key>. For example, to copy the object reports/january.pdf through outpost my-outpost
owned by account 123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf.
The value must be URL-encoded. If your bucket has versioning enabled, you could have
multiple versions of the same object. By default, x-amz-copy-source identifies the current
version of the source object to copy. To copy a specific version of the source object to
copy, append ?versionId=<version-id> to the x-amz-copy-source request header (for
example, x-amz-copy-source:
/awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If
the current version is a delete marker and you don't specify a versionId in the
x-amz-copy-source request header, Amazon S3 returns a 404 Not Found error, because the
object does not exist. If you specify versionId in the x-amz-copy-source and the versionId
is a delete marker, Amazon S3 returns an HTTP 400 Bad Request error, because you are not
allowed to specify a delete marker as a version for the x-amz-copy-source. Directory
buckets - S3 Versioning isn't enabled and supported for directory buckets.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-copy-source-if-match"`: Copies the object if its entity tag (ETag) matches the
specified tag. If both of the x-amz-copy-source-if-match and
x-amz-copy-source-if-unmodified-since headers are present in the request as follows:
x-amz-copy-source-if-match condition evaluates to true, and;
x-amz-copy-source-if-unmodified-since condition evaluates to false; Amazon S3 returns 200
OK and copies the data.
- `"x-amz-copy-source-if-modified-since"`: Copies the object if it has been modified since
the specified time. If both of the x-amz-copy-source-if-none-match and
x-amz-copy-source-if-modified-since headers are present in the request as follows:
x-amz-copy-source-if-none-match condition evaluates to false, and;
x-amz-copy-source-if-modified-since condition evaluates to true; Amazon S3 returns 412
Precondition Failed response code.
- `"x-amz-copy-source-if-none-match"`: Copies the object if its entity tag (ETag) is
different than the specified ETag. If both of the x-amz-copy-source-if-none-match and
x-amz-copy-source-if-modified-since headers are present in the request as follows:
x-amz-copy-source-if-none-match condition evaluates to false, and;
x-amz-copy-source-if-modified-since condition evaluates to true; Amazon S3 returns 412
Precondition Failed response code.
- `"x-amz-copy-source-if-unmodified-since"`: Copies the object if it hasn't been modified
since the specified time. If both of the x-amz-copy-source-if-match and
x-amz-copy-source-if-unmodified-since headers are present in the request as follows:
x-amz-copy-source-if-match condition evaluates to true, and;
x-amz-copy-source-if-unmodified-since condition evaluates to false; Amazon S3 returns 200
OK and copies the data.
- `"x-amz-copy-source-range"`: The range of bytes to copy from the source object. The range
value must use the form bytes=first-last, where the first and last are the zero-based byte
offsets to copy. For example, bytes=0-9 indicates that you want to copy the first 10 bytes
of the source. You can copy a range only if the source object is greater than 5 MB.
- `"x-amz-copy-source-server-side-encryption-customer-algorithm"`: Specifies the algorithm
to use when decrypting the source object (for example, AES256). This functionality is not
supported when the source object is in a directory bucket.
- `"x-amz-copy-source-server-side-encryption-customer-key"`: Specifies the
customer-provided encryption key for Amazon S3 to use to decrypt the source object. The
encryption key provided in this header must be one that was used when the source object was
created. This functionality is not supported when the source object is in a directory
bucket.
- `"x-amz-copy-source-server-side-encryption-customer-key-MD5"`: Specifies the 128-bit MD5
digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a
message integrity check to ensure that the encryption key was transmitted without error.
This functionality is not supported when the source object is in a directory bucket.
- `"x-amz-expected-bucket-owner"`: The account ID of the expected destination bucket owner.
If the account ID that you provide does not match the actual owner of the destination
bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
- `"x-amz-request-payer"`:
- `"x-amz-server-side-encryption-customer-algorithm"`: Specifies the algorithm to use when
encrypting the object (for example, AES256). This functionality is not supported when the
destination bucket is a directory bucket.
- `"x-amz-server-side-encryption-customer-key"`: Specifies the customer-provided encryption
key for Amazon S3 to use in encrypting data. This value is used to store the object and
then it is discarded; Amazon S3 does not store the encryption key. The key must be
appropriate for use with the algorithm specified in the
x-amz-server-side-encryption-customer-algorithm header. This must be the same encryption
key specified in the initiate multipart upload request. This functionality is not
supported when the destination bucket is a directory bucket.
- `"x-amz-server-side-encryption-customer-key-MD5"`: Specifies the 128-bit MD5 digest of
the encryption key according to RFC 1321. Amazon S3 uses this header for a message
integrity check to ensure that the encryption key was transmitted without error. This
functionality is not supported when the destination bucket is a directory bucket.
- `"x-amz-source-expected-bucket-owner"`: The account ID of the expected source bucket
owner. If the account ID that you provide does not match the actual owner of the source
bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
"""
function upload_part_copy(
Bucket,
Key,
partNumber,
uploadId,
x_amz_copy_source;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"PUT",
"/$(Bucket)/$(Key)",
Dict{String,Any}(
"partNumber" => partNumber,
"uploadId" => uploadId,
"headers" => Dict{String,Any}("x-amz-copy-source" => x_amz_copy_source),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function upload_part_copy(
Bucket,
Key,
partNumber,
uploadId,
x_amz_copy_source,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"PUT",
"/$(Bucket)/$(Key)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"partNumber" => partNumber,
"uploadId" => uploadId,
"headers" => Dict{String,Any}("x-amz-copy-source" => x_amz_copy_source),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
write_get_object_response(x-amz-request-route, x-amz-request-token)
write_get_object_response(x-amz-request-route, x-amz-request-token, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Passes transformed objects to a
GetObject operation when using Object Lambda access points. For information about Object
Lambda access points, see Transforming objects with Object Lambda access points in the
Amazon S3 User Guide. This operation supports metadata that can be returned by GetObject,
in addition to RequestRoute, RequestToken, StatusCode, ErrorCode, and ErrorMessage. The
GetObject response metadata is supported so that the WriteGetObjectResponse caller,
typically an Lambda function, can provide the same metadata when it internally invokes
GetObject. When WriteGetObjectResponse is called by a customer-owned Lambda function, the
metadata returned to the end user GetObject call might differ from what Amazon S3 would
normally return. You can include any number of metadata headers. When including a metadata
header, it should be prefaced with x-amz-meta. For example, x-amz-meta-my-custom-header:
MyCustomValue. The primary use case for this is to forward GetObject metadata. Amazon Web
Services provides some prebuilt Lambda functions that you can use with S3 Object Lambda to
detect and redact personally identifiable information (PII) and decompress S3 objects.
These Lambda functions are available in the Amazon Web Services Serverless Application
Repository, and can be selected through the Amazon Web Services Management Console when you
create your Object Lambda access point. Example 1: PII Access Control - This Lambda
function uses Amazon Comprehend, a natural language processing (NLP) service using machine
learning to find insights and relationships in text. It automatically detects personally
identifiable information (PII) such as names, addresses, dates, credit card numbers, and
social security numbers from documents in your Amazon S3 bucket. Example 2: PII Redaction
- This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service
using machine learning to find insights and relationships in text. It automatically redacts
personally identifiable information (PII) such as names, addresses, dates, credit card
numbers, and social security numbers from documents in your Amazon S3 bucket. Example 3:
Decompression - The Lambda function S3ObjectLambdaDecompression, is equipped to decompress
objects stored in S3 in one of six compressed file formats including bzip2, gzip, snappy,
zlib, zstandard and ZIP. For information on how to view and use these functions, see Using
Amazon Web Services built Lambda functions in the Amazon S3 User Guide.
# Arguments
- `x-amz-request-route`: Route prefix to the HTTP URL generated.
- `x-amz-request-token`: A single use encrypted token that maps WriteGetObjectResponse to
the end user GetObject request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Body"`: The object data.
- `"Content-Length"`: The size of the content body in bytes.
- `"x-amz-fwd-error-code"`: A string that uniquely identifies an error condition. Returned
in the <Code> tag of the error XML response for a corresponding GetObject call.
Cannot be used with a successful StatusCode header or when the transformed object is
provided in the body. All error codes from S3 are sentence-cased. The regular expression
(regex) value is \"^[A-Z][a-zA-Z]+\".
- `"x-amz-fwd-error-message"`: Contains a generic description of the error condition.
Returned in the <Message> tag of the error XML response for a corresponding GetObject
call. Cannot be used with a successful StatusCode header or when the transformed object is
provided in body.
- `"x-amz-fwd-header-Cache-Control"`: Specifies caching behavior along the request/reply
chain.
- `"x-amz-fwd-header-Content-Disposition"`: Specifies presentational information for the
object.
- `"x-amz-fwd-header-Content-Encoding"`: Specifies what content encodings have been applied
to the object and thus what decoding mechanisms must be applied to obtain the media-type
referenced by the Content-Type header field.
- `"x-amz-fwd-header-Content-Language"`: The language the content is in.
- `"x-amz-fwd-header-Content-Range"`: The portion of the object returned in the response.
- `"x-amz-fwd-header-Content-Type"`: A standard MIME type describing the format of the
object data.
- `"x-amz-fwd-header-ETag"`: An opaque identifier assigned by a web server to a specific
version of a resource found at a URL.
- `"x-amz-fwd-header-Expires"`: The date and time at which the object is no longer
cacheable.
- `"x-amz-fwd-header-Last-Modified"`: The date and time that the object was last modified.
- `"x-amz-fwd-header-accept-ranges"`: Indicates that a range of bytes was specified.
- `"x-amz-fwd-header-x-amz-checksum-crc32"`: This header can be used as a data integrity
check to verify that the data received is the same data that was originally sent. This
specifies the base64-encoded, 32-bit CRC32 checksum of the object returned by the Object
Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon
S3 will perform validation of the checksum values only when the original GetObject request
required checksum validation. For more information about checksums, see Checking object
integrity in the Amazon S3 User Guide. Only one checksum header can be specified at a time.
If you supply multiple checksum headers, this request will fail.
- `"x-amz-fwd-header-x-amz-checksum-crc32c"`: This header can be used as a data integrity
check to verify that the data received is the same data that was originally sent. This
specifies the base64-encoded, 32-bit CRC32C checksum of the object returned by the Object
Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon
S3 will perform validation of the checksum values only when the original GetObject request
required checksum validation. For more information about checksums, see Checking object
integrity in the Amazon S3 User Guide. Only one checksum header can be specified at a time.
If you supply multiple checksum headers, this request will fail.
- `"x-amz-fwd-header-x-amz-checksum-sha1"`: This header can be used as a data integrity
check to verify that the data received is the same data that was originally sent. This
specifies the base64-encoded, 160-bit SHA-1 digest of the object returned by the Object
Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon
S3 will perform validation of the checksum values only when the original GetObject request
required checksum validation. For more information about checksums, see Checking object
integrity in the Amazon S3 User Guide. Only one checksum header can be specified at a time.
If you supply multiple checksum headers, this request will fail.
- `"x-amz-fwd-header-x-amz-checksum-sha256"`: This header can be used as a data integrity
check to verify that the data received is the same data that was originally sent. This
specifies the base64-encoded, 256-bit SHA-256 digest of the object returned by the Object
Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon
S3 will perform validation of the checksum values only when the original GetObject request
required checksum validation. For more information about checksums, see Checking object
integrity in the Amazon S3 User Guide. Only one checksum header can be specified at a time.
If you supply multiple checksum headers, this request will fail.
- `"x-amz-fwd-header-x-amz-delete-marker"`: Specifies whether an object stored in Amazon S3
is (true) or is not (false) a delete marker.
- `"x-amz-fwd-header-x-amz-expiration"`: If the object expiration is configured (see PUT
Bucket lifecycle), the response includes this header. It includes the expiry-date and
rule-id key-value pairs that provide the object expiration information. The value of the
rule-id is URL-encoded.
- `"x-amz-fwd-header-x-amz-missing-meta"`: Set to the number of metadata entries not
returned in x-amz-meta headers. This can happen if you create metadata using an API like
SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you
can create metadata whose values are not legal HTTP headers.
- `"x-amz-fwd-header-x-amz-mp-parts-count"`: The count of parts this object has.
- `"x-amz-fwd-header-x-amz-object-lock-legal-hold"`: Indicates whether an object stored in
Amazon S3 has an active legal hold.
- `"x-amz-fwd-header-x-amz-object-lock-mode"`: Indicates whether an object stored in Amazon
S3 has Object Lock enabled. For more information about S3 Object Lock, see Object Lock.
- `"x-amz-fwd-header-x-amz-object-lock-retain-until-date"`: The date and time when Object
Lock is configured to expire.
- `"x-amz-fwd-header-x-amz-replication-status"`: Indicates if request involves bucket that
is either a source or destination in a Replication rule. For more information about S3
Replication, see Replication.
- `"x-amz-fwd-header-x-amz-request-charged"`:
- `"x-amz-fwd-header-x-amz-restore"`: Provides information about object restoration
operation and expiration time of the restored object copy.
- `"x-amz-fwd-header-x-amz-server-side-encryption"`: The server-side encryption algorithm
used when storing requested object in Amazon S3 (for example, AES256, aws:kms).
- `"x-amz-fwd-header-x-amz-server-side-encryption-aws-kms-key-id"`: If present, specifies
the ID (Key ID, Key ARN, or Key Alias) of the Amazon Web Services Key Management Service
(Amazon Web Services KMS) symmetric encryption customer managed key that was used for
stored in Amazon S3 object.
- `"x-amz-fwd-header-x-amz-server-side-encryption-bucket-key-enabled"`: Indicates whether
the object stored in Amazon S3 uses an S3 bucket key for server-side encryption with Amazon
Web Services KMS (SSE-KMS).
- `"x-amz-fwd-header-x-amz-server-side-encryption-customer-algorithm"`: Encryption
algorithm used if server-side encryption with a customer-provided encryption key was
specified for object stored in Amazon S3.
- `"x-amz-fwd-header-x-amz-server-side-encryption-customer-key-MD5"`: 128-bit MD5 digest
of customer-provided encryption key used in Amazon S3 to encrypt data stored in S3. For
more information, see Protecting data using server-side encryption with customer-provided
encryption keys (SSE-C).
- `"x-amz-fwd-header-x-amz-storage-class"`: Provides storage class information of the
object. Amazon S3 returns this header for all objects except for S3 Standard storage class
objects. For more information, see Storage Classes.
- `"x-amz-fwd-header-x-amz-tagging-count"`: The number of tags, if any, on the object.
- `"x-amz-fwd-header-x-amz-version-id"`: An ID used to reference a specific version of the
object.
- `"x-amz-fwd-status"`: The integer status code for an HTTP response of a corresponding
GetObject request. The following is a list of status codes. 200 - OK 206 - Partial
Content 304 - Not Modified 400 - Bad Request 401 - Unauthorized 403 -
Forbidden 404 - Not Found 405 - Method Not Allowed 409 - Conflict 411 -
Length Required 412 - Precondition Failed 416 - Range Not Satisfiable 500 -
Internal Server Error 503 - Service Unavailable
- `"x-amz-meta-"`: A map of metadata to store with the object in S3.
"""
function write_get_object_response(
x_amz_request_route,
x_amz_request_token;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"POST",
"/WriteGetObjectResponse",
Dict{String,Any}(
"headers" => Dict{String,Any}(
"x-amz-request-route" => x_amz_request_route,
"x-amz-request-token" => x_amz_request_token,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function write_get_object_response(
x_amz_request_route,
x_amz_request_token,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3(
"POST",
"/WriteGetObjectResponse",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}(
"x-amz-request-route" => x_amz_request_route,
"x-amz-request-token" => x_amz_request_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 | 229774 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: s3_control
using AWS.Compat
using AWS.UUIDs
"""
associate_access_grants_identity_center(identity_center_arn, x-amz-account-id)
associate_access_grants_identity_center(identity_center_arn, x-amz-account-id, params::Dict{String,<:Any})
Associate your S3 Access Grants instance with an Amazon Web Services IAM Identity Center
instance. Use this action if you want to create access grants for users or groups from your
corporate identity directory. First, you must add your corporate identity directory to
Amazon Web Services IAM Identity Center. Then, you can associate this IAM Identity Center
instance with your S3 Access Grants instance. Permissions You must have the
s3:AssociateAccessGrantsIdentityCenter permission to use this operation. Additional
Permissions You must also have the following permissions: sso:CreateApplication,
sso:PutApplicationGrant, and sso:PutApplicationAuthenticationMethod.
# Arguments
- `identity_center_arn`: The Amazon Resource Name (ARN) of the Amazon Web Services IAM
Identity Center instance that you are associating with your S3 Access Grants instance. An
IAM Identity Center instance is your corporate identity directory that you added to the IAM
Identity Center. You can use the ListInstances API operation to retrieve a list of your
Identity Center instances and their ARNs.
- `x-amz-account-id`: The ID of the Amazon Web Services account that is making this request.
"""
function associate_access_grants_identity_center(
IdentityCenterArn, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"POST",
"/v20180820/accessgrantsinstance/identitycenter",
Dict{String,Any}(
"IdentityCenterArn" => IdentityCenterArn,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_access_grants_identity_center(
IdentityCenterArn,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"POST",
"/v20180820/accessgrantsinstance/identitycenter",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IdentityCenterArn" => IdentityCenterArn,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_access_grant(access_grants_location_id, grantee, permission, x-amz-account-id)
create_access_grant(access_grants_location_id, grantee, permission, x-amz-account-id, params::Dict{String,<:Any})
Creates an access grant that gives a grantee access to your S3 data. The grantee can be an
IAM user or role or a directory user, or group. Before you can create a grant, you must
have an S3 Access Grants instance in the same Region as the S3 data. You can create an S3
Access Grants instance using the CreateAccessGrantsInstance. You must also have registered
at least one S3 data location in your S3 Access Grants instance using
CreateAccessGrantsLocation. Permissions You must have the s3:CreateAccessGrant
permission to use this operation. Additional Permissions For any directory identity -
sso:DescribeInstance and sso:DescribeApplication For directory users -
identitystore:DescribeUser For directory groups - identitystore:DescribeGroup
# Arguments
- `access_grants_location_id`: The ID of the registered location to which you are granting
access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants
assigns the ID default to the default location s3:// and assigns an auto-generated ID to
other locations that you register. If you are passing the default location, you cannot
create an access grant for the entire default location. You must also specify a bucket or a
bucket and prefix in the Subprefix field.
- `grantee`: The user, group, or role to which you are granting access. You can grant
access to an IAM user or role. If you have added your corporate directory to Amazon Web
Services IAM Identity Center and associated your Identity Center instance with your S3
Access Grants instance, the grantee can also be a corporate directory user or group.
- `permission`: The type of access that you are granting to your S3 data, which can be set
to one of the following values: READ – Grant read-only access to the S3 data. WRITE
– Grant write-only access to the S3 data. READWRITE – Grant both read and write
access to the S3 data.
- `x-amz-account-id`: The ID of the Amazon Web Services account that is making this request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccessGrantsLocationConfiguration"`: The configuration options of the grant location.
The grant location is the S3 path to the data to which you are granting access. It contains
the S3SubPrefix field. The grant scope is the result of appending the subprefix to the
location scope of the registered location.
- `"ApplicationArn"`: The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity
Center application associated with your Identity Center instance. If an application ARN is
included in the request to create an access grant, the grantee can only access the S3 data
through this application.
- `"S3PrefixType"`: The type of S3SubPrefix. The only possible value is Object. Pass this
value if the access grant scope is an object. Do not pass this value if the access grant
scope is a bucket or a bucket and a prefix.
- `"Tags"`: The Amazon Web Services resource tags that you are adding to the access grant.
Each tag is a label consisting of a user-defined key and value. Tags can help you manage,
identify, organize, search for, and filter resources.
"""
function create_access_grant(
AccessGrantsLocationId,
Grantee,
Permission,
x_amz_account_id;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"POST",
"/v20180820/accessgrantsinstance/grant",
Dict{String,Any}(
"AccessGrantsLocationId" => AccessGrantsLocationId,
"Grantee" => Grantee,
"Permission" => Permission,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_access_grant(
AccessGrantsLocationId,
Grantee,
Permission,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"POST",
"/v20180820/accessgrantsinstance/grant",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AccessGrantsLocationId" => AccessGrantsLocationId,
"Grantee" => Grantee,
"Permission" => Permission,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_access_grants_instance(x-amz-account-id)
create_access_grants_instance(x-amz-account-id, params::Dict{String,<:Any})
Creates an S3 Access Grants instance, which serves as a logical grouping for access grants.
You can create one S3 Access Grants instance per Region per account. Permissions You
must have the s3:CreateAccessGrantsInstance permission to use this operation. Additional
Permissions To associate an IAM Identity Center instance with your S3 Access Grants
instance, you must also have the sso:DescribeInstance, sso:CreateApplication,
sso:PutApplicationGrant, and sso:PutApplicationAuthenticationMethod permissions.
# Arguments
- `x-amz-account-id`: The ID of the Amazon Web Services account that is making this request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IdentityCenterArn"`: If you would like to associate your S3 Access Grants instance with
an Amazon Web Services IAM Identity Center instance, use this field to pass the Amazon
Resource Name (ARN) of the Amazon Web Services IAM Identity Center instance that you are
associating with your S3 Access Grants instance. An IAM Identity Center instance is your
corporate identity directory that you added to the IAM Identity Center. You can use the
ListInstances API operation to retrieve a list of your Identity Center instances and their
ARNs.
- `"Tags"`: The Amazon Web Services resource tags that you are adding to the S3 Access
Grants instance. Each tag is a label consisting of a user-defined key and value. Tags can
help you manage, identify, organize, search for, and filter resources.
"""
function create_access_grants_instance(
x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"POST",
"/v20180820/accessgrantsinstance",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_access_grants_instance(
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"POST",
"/v20180820/accessgrantsinstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_access_grants_location(iamrole_arn, location_scope, x-amz-account-id)
create_access_grants_location(iamrole_arn, location_scope, x-amz-account-id, params::Dict{String,<:Any})
The S3 data location that you would like to register in your S3 Access Grants instance.
Your S3 data must be in the same Region as your S3 Access Grants instance. The location can
be one of the following: The default S3 location s3:// A bucket -
S3://<bucket-name> A bucket and prefix - S3://<bucket-name>/<prefix>
When you register a location, you must include the IAM role that has permission to manage
the S3 location that you are registering. Give S3 Access Grants permission to assume this
role using a policy. S3 Access Grants assumes this role to manage access to the location
and to vend temporary credentials to grantees or client applications. Permissions You
must have the s3:CreateAccessGrantsLocation permission to use this operation. Additional
Permissions You must also have the following permission for the specified IAM role:
iam:PassRole
# Arguments
- `iamrole_arn`: The Amazon Resource Name (ARN) of the IAM role for the registered
location. S3 Access Grants assumes this role to manage access to the registered location.
- `location_scope`: The S3 path to the location that you are registering. The location
scope can be the default S3 location s3://, the S3 path to a bucket s3://<bucket>, or
the S3 path to a bucket and prefix s3://<bucket>/<prefix>. A prefix in S3 is a
string of characters at the beginning of an object key name used to organize the objects
that you store in your S3 buckets. For example, object key names that start with the
engineering/ prefix or object key names that start with the marketing/campaigns/ prefix.
- `x-amz-account-id`: The ID of the Amazon Web Services account that is making this request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: The Amazon Web Services resource tags that you are adding to the S3 Access
Grants location. Each tag is a label consisting of a user-defined key and value. Tags can
help you manage, identify, organize, search for, and filter resources.
"""
function create_access_grants_location(
IAMRoleArn,
LocationScope,
x_amz_account_id;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"POST",
"/v20180820/accessgrantsinstance/location",
Dict{String,Any}(
"IAMRoleArn" => IAMRoleArn,
"LocationScope" => LocationScope,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_access_grants_location(
IAMRoleArn,
LocationScope,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"POST",
"/v20180820/accessgrantsinstance/location",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IAMRoleArn" => IAMRoleArn,
"LocationScope" => LocationScope,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_access_point(bucket, name, x-amz-account-id)
create_access_point(bucket, name, x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Creates an access point and
associates it with the specified bucket. For more information, see Managing Data Access
with Amazon S3 Access Points in the Amazon S3 User Guide. S3 on Outposts only supports
VPC-style access points. For more information, see Accessing Amazon S3 on Outposts using
virtual private cloud (VPC) only access points in the Amazon S3 User Guide. All Amazon S3
on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts
endpoint hostname prefix instead of s3-control. For an example of the request syntax for
Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the
x-amz-outpost-id derived by using the access point ARN, see the Examples section. The
following actions are related to CreateAccessPoint: GetAccessPoint DeleteAccessPoint
ListAccessPoints
# Arguments
- `bucket`: The name of the bucket that you want to associate this access point with. For
using this parameter with Amazon S3 on Outposts with the REST API, you must specify the
name and the x-amz-outpost-id as well. For using this parameter with S3 on Outposts with
the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the
format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<
;my-bucket-name>. For example, to access the bucket reports through Outpost my-outpost
owned by account 123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value
must be URL encoded.
- `name`: The name you want to assign to this access point.
- `x-amz-account-id`: The Amazon Web Services account ID for the account that owns the
specified access point.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BucketAccountId"`: The Amazon Web Services account ID associated with the S3 bucket
associated with this access point. For same account access point when your bucket and
access point belong to the same account owner, the BucketAccountId is not required. For
cross-account access point when your bucket and access point are not in the same account,
the BucketAccountId is required.
- `"PublicAccessBlockConfiguration"`: The PublicAccessBlock configuration that you want to
apply to the access point.
- `"VpcConfiguration"`: If you include this field, Amazon S3 restricts access to this
access point to requests from the specified virtual private cloud (VPC). This is required
for creating an access point for Amazon S3 on Outposts buckets.
"""
function create_access_point(
Bucket, name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"PUT",
"/v20180820/accesspoint/$(name)",
Dict{String,Any}(
"Bucket" => Bucket,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_access_point(
Bucket,
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"PUT",
"/v20180820/accesspoint/$(name)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Bucket" => Bucket,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_access_point_for_object_lambda(configuration, name, x-amz-account-id)
create_access_point_for_object_lambda(configuration, name, x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Creates an Object Lambda Access
Point. For more information, see Transforming objects with Object Lambda Access Points in
the Amazon S3 User Guide. The following actions are related to
CreateAccessPointForObjectLambda: DeleteAccessPointForObjectLambda
GetAccessPointForObjectLambda ListAccessPointsForObjectLambda
# Arguments
- `configuration`: Object Lambda Access Point configuration as a JSON document.
- `name`: The name you want to assign to this Object Lambda Access Point.
- `x-amz-account-id`: The Amazon Web Services account ID for owner of the specified Object
Lambda Access Point.
"""
function create_access_point_for_object_lambda(
Configuration, name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"PUT",
"/v20180820/accesspointforobjectlambda/$(name)",
Dict{String,Any}(
"Configuration" => Configuration,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_access_point_for_object_lambda(
Configuration,
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"PUT",
"/v20180820/accesspointforobjectlambda/$(name)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Configuration" => Configuration,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_bucket(name)
create_bucket(name, params::Dict{String,<:Any})
This action creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see Create
Bucket in the Amazon S3 API Reference. Creates a new Outposts bucket. By creating the
bucket, you become the bucket owner. To create an Outposts bucket, you must have S3 on
Outposts. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.
Not every string is an acceptable bucket name. For information on bucket naming
restrictions, see Working with Amazon S3 Buckets. S3 on Outposts buckets support: Tags
LifecycleConfigurations for deleting expired objects For a complete list of restrictions
and Amazon S3 feature limitations on S3 on Outposts, see Amazon S3 on Outposts
Restrictions and Limitations. For an example of the request syntax for Amazon S3 on
Outposts that uses the S3 on Outposts endpoint hostname prefix and x-amz-outpost-id in your
API request, see the Examples section. The following actions are related to CreateBucket
for Amazon S3 on Outposts: PutObject GetBucket DeleteBucket
CreateAccessPoint PutAccessPointPolicy
# Arguments
- `name`: The name of the bucket.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreateBucketConfiguration"`: The configuration information for the bucket. This is not
supported by Amazon S3 on Outposts buckets.
- `"x-amz-acl"`: The canned ACL to apply to the bucket. This is not supported by Amazon S3
on Outposts buckets.
- `"x-amz-bucket-object-lock-enabled"`: Specifies whether you want S3 Object Lock to be
enabled for the new bucket. This is not supported by Amazon S3 on Outposts buckets.
- `"x-amz-grant-full-control"`: Allows grantee the read, write, read ACP, and write ACP
permissions on the bucket. This is not supported by Amazon S3 on Outposts buckets.
- `"x-amz-grant-read"`: Allows grantee to list the objects in the bucket. This is not
supported by Amazon S3 on Outposts buckets.
- `"x-amz-grant-read-acp"`: Allows grantee to read the bucket ACL. This is not supported
by Amazon S3 on Outposts buckets.
- `"x-amz-grant-write"`: Allows grantee to create, overwrite, and delete any object in the
bucket. This is not supported by Amazon S3 on Outposts buckets.
- `"x-amz-grant-write-acp"`: Allows grantee to write the ACL for the applicable bucket.
This is not supported by Amazon S3 on Outposts buckets.
- `"x-amz-outpost-id"`: The ID of the Outposts where the bucket is being created. This ID
is required by Amazon S3 on Outposts buckets.
"""
function create_bucket(name; aws_config::AbstractAWSConfig=global_aws_config())
return s3_control(
"PUT",
"/v20180820/bucket/$(name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_bucket(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"PUT",
"/v20180820/bucket/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_job(client_request_token, operation, priority, report, role_arn, x-amz-account-id)
create_job(client_request_token, operation, priority, report, role_arn, x-amz-account-id, params::Dict{String,<:Any})
This operation creates an S3 Batch Operations job. You can use S3 Batch Operations to
perform large-scale batch actions on Amazon S3 objects. Batch Operations can run a single
action on lists of Amazon S3 objects that you specify. For more information, see S3 Batch
Operations in the Amazon S3 User Guide. Permissions For information about permissions
required to use the Batch Operations, see Granting permissions for S3 Batch Operations in
the Amazon S3 User Guide. Related actions include: DescribeJob ListJobs
UpdateJobPriority UpdateJobStatus JobOperation
# Arguments
- `client_request_token`: An idempotency token to ensure that you don't accidentally submit
the same request twice. You can use any string up to the maximum length.
- `operation`: The action that you want this job to perform on every object listed in the
manifest. For more information about the available actions, see Operations in the Amazon S3
User Guide.
- `priority`: The numerical priority for this job. Higher numbers indicate higher priority.
- `report`: Configuration parameters for the optional job-completion report.
- `role_arn`: The Amazon Resource Name (ARN) for the Identity and Access Management (IAM)
role that Batch Operations will use to run this job's action on every object in the
manifest.
- `x-amz-account-id`: The Amazon Web Services account ID that creates the job.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConfirmationRequired"`: Indicates whether confirmation is required before Amazon S3
runs the job. Confirmation is only required for jobs created through the Amazon S3 console.
- `"Description"`: A description for this job. You can use any string within the permitted
length. Descriptions don't need to be unique and can be used for multiple jobs.
- `"Manifest"`: Configuration parameters for the manifest.
- `"ManifestGenerator"`: The attribute container for the ManifestGenerator details. Jobs
must be created with either a manifest file or a ManifestGenerator, but not both.
- `"Tags"`: A set of tags to associate with the S3 Batch Operations job. This is an
optional parameter.
"""
function create_job(
ClientRequestToken,
Operation,
Priority,
Report,
RoleArn,
x_amz_account_id;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"POST",
"/v20180820/jobs",
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken,
"Operation" => Operation,
"Priority" => Priority,
"Report" => Report,
"RoleArn" => RoleArn,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_job(
ClientRequestToken,
Operation,
Priority,
Report,
RoleArn,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"POST",
"/v20180820/jobs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken,
"Operation" => Operation,
"Priority" => Priority,
"Report" => Report,
"RoleArn" => RoleArn,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_multi_region_access_point(client_token, details, x-amz-account-id)
create_multi_region_access_point(client_token, details, x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Creates a Multi-Region Access Point
and associates it with the specified buckets. For more information about creating
Multi-Region Access Points, see Creating Multi-Region Access Points in the Amazon S3 User
Guide. This action will always be routed to the US West (Oregon) Region. For more
information about the restrictions around working with Multi-Region Access Points, see
Multi-Region Access Point restrictions and limitations in the Amazon S3 User Guide. This
request is asynchronous, meaning that you might receive a response before the command has
completed. When this request provides a response, it provides a token that you can use to
monitor the status of the request with DescribeMultiRegionAccessPointOperation. The
following actions are related to CreateMultiRegionAccessPoint:
DeleteMultiRegionAccessPoint DescribeMultiRegionAccessPointOperation
GetMultiRegionAccessPoint ListMultiRegionAccessPoints
# Arguments
- `client_token`: An idempotency token used to identify the request and guarantee that
requests are unique.
- `details`: A container element containing details about the Multi-Region Access Point.
- `x-amz-account-id`: The Amazon Web Services account ID for the owner of the Multi-Region
Access Point. The owner of the Multi-Region Access Point also must own the underlying
buckets.
"""
function create_multi_region_access_point(
ClientToken,
Details,
x_amz_account_id;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"POST",
"/v20180820/async-requests/mrap/create",
Dict{String,Any}(
"ClientToken" => ClientToken,
"Details" => Details,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_multi_region_access_point(
ClientToken,
Details,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"POST",
"/v20180820/async-requests/mrap/create",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientToken" => ClientToken,
"Details" => Details,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_storage_lens_group(storage_lens_group, x-amz-account-id)
create_storage_lens_group(storage_lens_group, x-amz-account-id, params::Dict{String,<:Any})
Creates a new S3 Storage Lens group and associates it with the specified Amazon Web
Services account ID. An S3 Storage Lens group is a custom grouping of objects based on
prefix, suffix, object tags, object size, object age, or a combination of these filters.
For each Storage Lens group that you’ve created, you can also optionally add Amazon Web
Services resource tags. For more information about S3 Storage Lens groups, see Working with
S3 Storage Lens groups. To use this operation, you must have the permission to perform the
s3:CreateStorageLensGroup action. If you’re trying to create a Storage Lens group with
Amazon Web Services resource tags, you must also have permission to perform the
s3:TagResource action. For more information about the required Storage Lens Groups
permissions, see Setting account permissions to use S3 Storage Lens groups. For information
about Storage Lens groups errors, see List of Amazon S3 Storage Lens error codes.
# Arguments
- `storage_lens_group`: The Storage Lens group configuration.
- `x-amz-account-id`: The Amazon Web Services account ID that the Storage Lens group is
created from and associated with.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: The Amazon Web Services resource tags that you're adding to your Storage Lens
group. This parameter is optional.
"""
function create_storage_lens_group(
StorageLensGroup, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"POST",
"/v20180820/storagelensgroup",
Dict{String,Any}(
"StorageLensGroup" => StorageLensGroup,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_storage_lens_group(
StorageLensGroup,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"POST",
"/v20180820/storagelensgroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"StorageLensGroup" => StorageLensGroup,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_access_grant(id, x-amz-account-id)
delete_access_grant(id, x-amz-account-id, params::Dict{String,<:Any})
Deletes the access grant from the S3 Access Grants instance. You cannot undo an access
grant deletion and the grantee will no longer have access to the S3 data. Permissions You
must have the s3:DeleteAccessGrant permission to use this operation.
# Arguments
- `id`: The ID of the access grant. S3 Access Grants auto-generates this ID when you create
the access grant.
- `x-amz-account-id`: The ID of the Amazon Web Services account that is making this request.
"""
function delete_access_grant(
id, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"DELETE",
"/v20180820/accessgrantsinstance/grant/$(id)",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_access_grant(
id,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"DELETE",
"/v20180820/accessgrantsinstance/grant/$(id)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_access_grants_instance(x-amz-account-id)
delete_access_grants_instance(x-amz-account-id, params::Dict{String,<:Any})
Deletes your S3 Access Grants instance. You must first delete the access grants and
locations before S3 Access Grants can delete the instance. See DeleteAccessGrant and
DeleteAccessGrantsLocation. If you have associated an IAM Identity Center instance with
your S3 Access Grants instance, you must first dissassociate the Identity Center instance
from the S3 Access Grants instance before you can delete the S3 Access Grants instance. See
AssociateAccessGrantsIdentityCenter and DissociateAccessGrantsIdentityCenter. Permissions
You must have the s3:DeleteAccessGrantsInstance permission to use this operation.
# Arguments
- `x-amz-account-id`: The ID of the Amazon Web Services account that is making this request.
"""
function delete_access_grants_instance(
x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"DELETE",
"/v20180820/accessgrantsinstance",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_access_grants_instance(
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"DELETE",
"/v20180820/accessgrantsinstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_access_grants_instance_resource_policy(x-amz-account-id)
delete_access_grants_instance_resource_policy(x-amz-account-id, params::Dict{String,<:Any})
Deletes the resource policy of the S3 Access Grants instance. The resource policy is used
to manage cross-account access to your S3 Access Grants instance. By deleting the resource
policy, you delete any cross-account permissions to your S3 Access Grants instance.
Permissions You must have the s3:DeleteAccessGrantsInstanceResourcePolicy permission to
use this operation.
# Arguments
- `x-amz-account-id`: The ID of the Amazon Web Services account that is making this request.
"""
function delete_access_grants_instance_resource_policy(
x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"DELETE",
"/v20180820/accessgrantsinstance/resourcepolicy",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_access_grants_instance_resource_policy(
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"DELETE",
"/v20180820/accessgrantsinstance/resourcepolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_access_grants_location(id, x-amz-account-id)
delete_access_grants_location(id, x-amz-account-id, params::Dict{String,<:Any})
Deregisters a location from your S3 Access Grants instance. You can only delete a location
registration from an S3 Access Grants instance if there are no grants associated with this
location. See Delete a grant for information on how to delete grants. You need to have at
least one registered location in your S3 Access Grants instance in order to create access
grants. Permissions You must have the s3:DeleteAccessGrantsLocation permission to use
this operation.
# Arguments
- `id`: The ID of the registered location that you are deregistering from your S3 Access
Grants instance. S3 Access Grants assigned this ID when you registered the location. S3
Access Grants assigns the ID default to the default location s3:// and assigns an
auto-generated ID to other locations that you register.
- `x-amz-account-id`: The ID of the Amazon Web Services account that is making this request.
"""
function delete_access_grants_location(
id, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"DELETE",
"/v20180820/accessgrantsinstance/location/$(id)",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_access_grants_location(
id,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"DELETE",
"/v20180820/accessgrantsinstance/location/$(id)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_access_point(name, x-amz-account-id)
delete_access_point(name, x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Deletes the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter
of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on
Outposts endpoint hostname prefix instead of s3-control. For an example of the request
syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and
the x-amz-outpost-id derived by using the access point ARN, see the Examples section. The
following actions are related to DeleteAccessPoint: CreateAccessPoint GetAccessPoint
ListAccessPoints
# Arguments
- `name`: The name of the access point you want to delete. For using this parameter with
Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id
as well. For using this parameter with S3 on Outposts with the Amazon Web Services SDK and
CLI, you must specify the ARN of the access point accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint
/<my-accesspoint-name>. For example, to access the access point reports-ap through
Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding
of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap.
The value must be URL encoded.
- `x-amz-account-id`: The Amazon Web Services account ID for the account that owns the
specified access point.
"""
function delete_access_point(
name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"DELETE",
"/v20180820/accesspoint/$(name)",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_access_point(
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"DELETE",
"/v20180820/accesspoint/$(name)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_access_point_for_object_lambda(name, x-amz-account-id)
delete_access_point_for_object_lambda(name, x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Deletes the specified Object Lambda
Access Point. The following actions are related to DeleteAccessPointForObjectLambda:
CreateAccessPointForObjectLambda GetAccessPointForObjectLambda
ListAccessPointsForObjectLambda
# Arguments
- `name`: The name of the access point you want to delete.
- `x-amz-account-id`: The account ID for the account that owns the specified Object Lambda
Access Point.
"""
function delete_access_point_for_object_lambda(
name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"DELETE",
"/v20180820/accesspointforobjectlambda/$(name)",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_access_point_for_object_lambda(
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"DELETE",
"/v20180820/accesspointforobjectlambda/$(name)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_access_point_policy(name, x-amz-account-id)
delete_access_point_policy(name, x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Deletes the access point policy for
the specified access point. All Amazon S3 on Outposts REST API requests for this action
require an additional parameter of x-amz-outpost-id to be passed with the request. In
addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control.
For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts
endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN,
see the Examples section. The following actions are related to DeleteAccessPointPolicy:
PutAccessPointPolicy GetAccessPointPolicy
# Arguments
- `name`: The name of the access point whose policy you want to delete. For using this
parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the
x-amz-outpost-id as well. For using this parameter with S3 on Outposts with the Amazon Web
Services SDK and CLI, you must specify the ARN of the access point accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint
/<my-accesspoint-name>. For example, to access the access point reports-ap through
Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding
of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap.
The value must be URL encoded.
- `x-amz-account-id`: The account ID for the account that owns the specified access point.
"""
function delete_access_point_policy(
name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"DELETE",
"/v20180820/accesspoint/$(name)/policy",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_access_point_policy(
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"DELETE",
"/v20180820/accesspoint/$(name)/policy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_access_point_policy_for_object_lambda(name, x-amz-account-id)
delete_access_point_policy_for_object_lambda(name, x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Removes the resource policy for an
Object Lambda Access Point. The following actions are related to
DeleteAccessPointPolicyForObjectLambda: GetAccessPointPolicyForObjectLambda
PutAccessPointPolicyForObjectLambda
# Arguments
- `name`: The name of the Object Lambda Access Point you want to delete the policy for.
- `x-amz-account-id`: The account ID for the account that owns the specified Object Lambda
Access Point.
"""
function delete_access_point_policy_for_object_lambda(
name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"DELETE",
"/v20180820/accesspointforobjectlambda/$(name)/policy",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_access_point_policy_for_object_lambda(
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"DELETE",
"/v20180820/accesspointforobjectlambda/$(name)/policy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_bucket(name, x-amz-account-id)
delete_bucket(name, x-amz-account-id, params::Dict{String,<:Any})
This action deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see
DeleteBucket in the Amazon S3 API Reference. Deletes the Amazon S3 on Outposts bucket.
All objects (including all object versions and delete markers) in the bucket must be
deleted before the bucket itself can be deleted. For more information, see Using Amazon S3
on Outposts in Amazon S3 User Guide. All Amazon S3 on Outposts REST API requests for this
action require an additional parameter of x-amz-outpost-id to be passed with the request.
In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control.
For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts
endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN,
see the Examples section. Related Resources CreateBucket GetBucket
DeleteObject
# Arguments
- `name`: Specifies the bucket being deleted. For using this parameter with Amazon S3 on
Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well. For
using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must
specify the ARN of the bucket accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<
;my-bucket-name>. For example, to access the bucket reports through Outpost my-outpost
owned by account 123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value
must be URL encoded.
- `x-amz-account-id`: The account ID that owns the Outposts bucket.
"""
function delete_bucket(
name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"DELETE",
"/v20180820/bucket/$(name)",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_bucket(
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"DELETE",
"/v20180820/bucket/$(name)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_bucket_lifecycle_configuration(name, x-amz-account-id)
delete_bucket_lifecycle_configuration(name, x-amz-account-id, params::Dict{String,<:Any})
This action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete
an S3 bucket's lifecycle configuration, see DeleteBucketLifecycle in the Amazon S3 API
Reference. Deletes the lifecycle configuration from the specified Outposts bucket. Amazon
S3 on Outposts removes all the lifecycle configuration rules in the lifecycle subresource
associated with the bucket. Your objects never expire, and Amazon S3 on Outposts no longer
automatically deletes any objects on the basis of rules contained in the deleted lifecycle
configuration. For more information, see Using Amazon S3 on Outposts in Amazon S3 User
Guide. To use this operation, you must have permission to perform the
s3-outposts:PutLifecycleConfiguration action. By default, the bucket owner has this
permission and the Outposts bucket owner can grant this permission to others. All Amazon S3
on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts
endpoint hostname prefix instead of s3-control. For an example of the request syntax for
Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the
x-amz-outpost-id derived by using the access point ARN, see the Examples section. For more
information about object expiration, see Elements to Describe Lifecycle Actions. Related
actions include: PutBucketLifecycleConfiguration GetBucketLifecycleConfiguration
# Arguments
- `name`: Specifies the bucket. For using this parameter with Amazon S3 on Outposts with
the REST API, you must specify the name and the x-amz-outpost-id as well. For using this
parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify
the ARN of the bucket accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<
;my-bucket-name>. For example, to access the bucket reports through Outpost my-outpost
owned by account 123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value
must be URL encoded.
- `x-amz-account-id`: The account ID of the lifecycle configuration to delete.
"""
function delete_bucket_lifecycle_configuration(
name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"DELETE",
"/v20180820/bucket/$(name)/lifecycleconfiguration",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_bucket_lifecycle_configuration(
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"DELETE",
"/v20180820/bucket/$(name)/lifecycleconfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_bucket_policy(name, x-amz-account-id)
delete_bucket_policy(name, x-amz-account-id, params::Dict{String,<:Any})
This action deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy,
see DeleteBucketPolicy in the Amazon S3 API Reference. This implementation of the DELETE
action uses the policy subresource to delete the policy of a specified Amazon S3 on
Outposts bucket. If you are using an identity other than the root user of the Amazon Web
Services account that owns the bucket, the calling identity must have the
s3-outposts:DeleteBucketPolicy permissions on the specified Outposts bucket and belong to
the bucket owner's account to use this action. For more information, see Using Amazon S3 on
Outposts in Amazon S3 User Guide. If you don't have DeleteBucketPolicy permissions, Amazon
S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not
using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405
Method Not Allowed error. As a security precaution, the root user of the Amazon Web
Services account that owns a bucket can always use this action, even if the policy
explicitly denies the root user the ability to perform this action. For more information
about bucket policies, see Using Bucket Policies and User Policies. All Amazon S3 on
Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts
endpoint hostname prefix instead of s3-control. For an example of the request syntax for
Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the
x-amz-outpost-id derived by using the access point ARN, see the Examples section. The
following actions are related to DeleteBucketPolicy: GetBucketPolicy PutBucketPolicy
# Arguments
- `name`: Specifies the bucket. For using this parameter with Amazon S3 on Outposts with
the REST API, you must specify the name and the x-amz-outpost-id as well. For using this
parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify
the ARN of the bucket accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<
;my-bucket-name>. For example, to access the bucket reports through Outpost my-outpost
owned by account 123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value
must be URL encoded.
- `x-amz-account-id`: The account ID of the Outposts bucket.
"""
function delete_bucket_policy(
name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"DELETE",
"/v20180820/bucket/$(name)/policy",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_bucket_policy(
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"DELETE",
"/v20180820/bucket/$(name)/policy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_bucket_replication(name, x-amz-account-id)
delete_bucket_replication(name, x-amz-account-id, params::Dict{String,<:Any})
This operation deletes an Amazon S3 on Outposts bucket's replication configuration. To
delete an S3 bucket's replication configuration, see DeleteBucketReplication in the Amazon
S3 API Reference. Deletes the replication configuration from the specified S3 on Outposts
bucket. To use this operation, you must have permissions to perform the
s3-outposts:PutReplicationConfiguration action. The Outposts bucket owner has this
permission by default and can grant it to others. For more information about permissions,
see Setting up IAM with S3 on Outposts and Managing access to S3 on Outposts buckets in the
Amazon S3 User Guide. It can take a while to propagate PUT or DELETE requests for a
replication configuration to all S3 on Outposts systems. Therefore, the replication
configuration that's returned by a GET request soon after a PUT or DELETE request might
return a more recent result than what's on the Outpost. If an Outpost is offline, the delay
in updating the replication configuration on that Outpost can be significant. All Amazon
S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts
endpoint hostname prefix instead of s3-control. For an example of the request syntax for
Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the
x-amz-outpost-id derived by using the access point ARN, see the Examples section. For
information about S3 replication on Outposts configuration, see Replicating objects for S3
on Outposts in the Amazon S3 User Guide. The following operations are related to
DeleteBucketReplication: PutBucketReplication GetBucketReplication
# Arguments
- `name`: Specifies the S3 on Outposts bucket to delete the replication configuration for.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the
name and the x-amz-outpost-id as well. For using this parameter with S3 on Outposts with
the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the
format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<
;my-bucket-name>. For example, to access the bucket reports through Outpost my-outpost
owned by account 123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value
must be URL encoded.
- `x-amz-account-id`: The Amazon Web Services account ID of the Outposts bucket to delete
the replication configuration for.
"""
function delete_bucket_replication(
name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"DELETE",
"/v20180820/bucket/$(name)/replication",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_bucket_replication(
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"DELETE",
"/v20180820/bucket/$(name)/replication",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_bucket_tagging(name, x-amz-account-id)
delete_bucket_tagging(name, x-amz-account-id, params::Dict{String,<:Any})
This action deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 bucket tags,
see DeleteBucketTagging in the Amazon S3 API Reference. Deletes the tags from the
Outposts bucket. For more information, see Using Amazon S3 on Outposts in Amazon S3 User
Guide. To use this action, you must have permission to perform the PutBucketTagging action.
By default, the bucket owner has this permission and can grant this permission to others.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter
of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on
Outposts endpoint hostname prefix instead of s3-control. For an example of the request
syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and
the x-amz-outpost-id derived by using the access point ARN, see the Examples section. The
following actions are related to DeleteBucketTagging: GetBucketTagging
PutBucketTagging
# Arguments
- `name`: The bucket ARN that has the tag set to be removed. For using this parameter with
Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id
as well. For using this parameter with S3 on Outposts with the Amazon Web Services SDK and
CLI, you must specify the ARN of the bucket accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<
;my-bucket-name>. For example, to access the bucket reports through Outpost my-outpost
owned by account 123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value
must be URL encoded.
- `x-amz-account-id`: The Amazon Web Services account ID of the Outposts bucket tag set to
be removed.
"""
function delete_bucket_tagging(
name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"DELETE",
"/v20180820/bucket/$(name)/tagging",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_bucket_tagging(
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"DELETE",
"/v20180820/bucket/$(name)/tagging",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_job_tagging(id, x-amz-account-id)
delete_job_tagging(id, x-amz-account-id, params::Dict{String,<:Any})
Removes the entire tag set from the specified S3 Batch Operations job. Permissions To use
the DeleteJobTagging operation, you must have permission to perform the s3:DeleteJobTagging
action. For more information, see Controlling access and labeling jobs using tags in the
Amazon S3 User Guide. Related actions include: CreateJob GetJobTagging
PutJobTagging
# Arguments
- `id`: The ID for the S3 Batch Operations job whose tags you want to delete.
- `x-amz-account-id`: The Amazon Web Services account ID associated with the S3 Batch
Operations job.
"""
function delete_job_tagging(
id, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"DELETE",
"/v20180820/jobs/$(id)/tagging",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_job_tagging(
id,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"DELETE",
"/v20180820/jobs/$(id)/tagging",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_multi_region_access_point(client_token, details, x-amz-account-id)
delete_multi_region_access_point(client_token, details, x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Deletes a Multi-Region Access
Point. This action does not delete the buckets associated with the Multi-Region Access
Point, only the Multi-Region Access Point itself. This action will always be routed to the
US West (Oregon) Region. For more information about the restrictions around working with
Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations in
the Amazon S3 User Guide. This request is asynchronous, meaning that you might receive a
response before the command has completed. When this request provides a response, it
provides a token that you can use to monitor the status of the request with
DescribeMultiRegionAccessPointOperation. The following actions are related to
DeleteMultiRegionAccessPoint: CreateMultiRegionAccessPoint
DescribeMultiRegionAccessPointOperation GetMultiRegionAccessPoint
ListMultiRegionAccessPoints
# Arguments
- `client_token`: An idempotency token used to identify the request and guarantee that
requests are unique.
- `details`: A container element containing details about the Multi-Region Access Point.
- `x-amz-account-id`: The Amazon Web Services account ID for the owner of the Multi-Region
Access Point.
"""
function delete_multi_region_access_point(
ClientToken,
Details,
x_amz_account_id;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"POST",
"/v20180820/async-requests/mrap/delete",
Dict{String,Any}(
"ClientToken" => ClientToken,
"Details" => Details,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_multi_region_access_point(
ClientToken,
Details,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"POST",
"/v20180820/async-requests/mrap/delete",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientToken" => ClientToken,
"Details" => Details,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_public_access_block(x-amz-account-id)
delete_public_access_block(x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Removes the PublicAccessBlock
configuration for an Amazon Web Services account. For more information, see Using Amazon
S3 block public access. Related actions include: GetPublicAccessBlock
PutPublicAccessBlock
# Arguments
- `x-amz-account-id`: The account ID for the Amazon Web Services account whose
PublicAccessBlock configuration you want to remove.
"""
function delete_public_access_block(
x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"DELETE",
"/v20180820/configuration/publicAccessBlock",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_public_access_block(
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"DELETE",
"/v20180820/configuration/publicAccessBlock",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_storage_lens_configuration(storagelensid, x-amz-account-id)
delete_storage_lens_configuration(storagelensid, x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Deletes the Amazon S3 Storage Lens
configuration. For more information about S3 Storage Lens, see Assessing your storage
activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide. To use this
action, you must have permission to perform the s3:DeleteStorageLensConfiguration action.
For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon
S3 User Guide.
# Arguments
- `storagelensid`: The ID of the S3 Storage Lens configuration.
- `x-amz-account-id`: The account ID of the requester.
"""
function delete_storage_lens_configuration(
storagelensid, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"DELETE",
"/v20180820/storagelens/$(storagelensid)",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_storage_lens_configuration(
storagelensid,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"DELETE",
"/v20180820/storagelens/$(storagelensid)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_storage_lens_configuration_tagging(storagelensid, x-amz-account-id)
delete_storage_lens_configuration_tagging(storagelensid, x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Deletes the Amazon S3 Storage Lens
configuration tags. For more information about S3 Storage Lens, see Assessing your storage
activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide. To use this
action, you must have permission to perform the s3:DeleteStorageLensConfigurationTagging
action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the
Amazon S3 User Guide.
# Arguments
- `storagelensid`: The ID of the S3 Storage Lens configuration.
- `x-amz-account-id`: The account ID of the requester.
"""
function delete_storage_lens_configuration_tagging(
storagelensid, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"DELETE",
"/v20180820/storagelens/$(storagelensid)/tagging",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_storage_lens_configuration_tagging(
storagelensid,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"DELETE",
"/v20180820/storagelens/$(storagelensid)/tagging",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_storage_lens_group(name, x-amz-account-id)
delete_storage_lens_group(name, x-amz-account-id, params::Dict{String,<:Any})
Deletes an existing S3 Storage Lens group. To use this operation, you must have the
permission to perform the s3:DeleteStorageLensGroup action. For more information about the
required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage
Lens groups. For information about Storage Lens groups errors, see List of Amazon S3
Storage Lens error codes.
# Arguments
- `name`: The name of the Storage Lens group that you're trying to delete.
- `x-amz-account-id`: The Amazon Web Services account ID used to create the Storage Lens
group that you're trying to delete.
"""
function delete_storage_lens_group(
name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"DELETE",
"/v20180820/storagelensgroup/$(name)",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_storage_lens_group(
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"DELETE",
"/v20180820/storagelensgroup/$(name)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_job(id, x-amz-account-id)
describe_job(id, x-amz-account-id, params::Dict{String,<:Any})
Retrieves the configuration parameters and status for a Batch Operations job. For more
information, see S3 Batch Operations in the Amazon S3 User Guide. Permissions To use the
DescribeJob operation, you must have permission to perform the s3:DescribeJob action.
Related actions include: CreateJob ListJobs UpdateJobPriority
UpdateJobStatus
# Arguments
- `id`: The ID for the job whose information you want to retrieve.
- `x-amz-account-id`: The Amazon Web Services account ID associated with the S3 Batch
Operations job.
"""
function describe_job(
id, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/jobs/$(id)",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_job(
id,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/jobs/$(id)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_multi_region_access_point_operation(request_token, x-amz-account-id)
describe_multi_region_access_point_operation(request_token, x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Retrieves the status of an
asynchronous request to manage a Multi-Region Access Point. For more information about
managing Multi-Region Access Points and how asynchronous requests work, see Using
Multi-Region Access Points in the Amazon S3 User Guide. The following actions are related
to GetMultiRegionAccessPoint: CreateMultiRegionAccessPoint
DeleteMultiRegionAccessPoint GetMultiRegionAccessPoint ListMultiRegionAccessPoints
# Arguments
- `request_token`: The request token associated with the request you want to know about.
This request token is returned as part of the response when you make an asynchronous
request. You provide this token to query about the status of the asynchronous action.
- `x-amz-account-id`: The Amazon Web Services account ID for the owner of the Multi-Region
Access Point.
"""
function describe_multi_region_access_point_operation(
request_token, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/async-requests/mrap/$(request_token)",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_multi_region_access_point_operation(
request_token,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/async-requests/mrap/$(request_token)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
dissociate_access_grants_identity_center(x-amz-account-id)
dissociate_access_grants_identity_center(x-amz-account-id, params::Dict{String,<:Any})
Dissociates the Amazon Web Services IAM Identity Center instance from the S3 Access Grants
instance. Permissions You must have the s3:DissociateAccessGrantsIdentityCenter
permission to use this operation. Additional Permissions You must have the
sso:DeleteApplication permission to use this operation.
# Arguments
- `x-amz-account-id`: The ID of the Amazon Web Services account that is making this request.
"""
function dissociate_access_grants_identity_center(
x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"DELETE",
"/v20180820/accessgrantsinstance/identitycenter",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function dissociate_access_grants_identity_center(
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"DELETE",
"/v20180820/accessgrantsinstance/identitycenter",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_access_grant(id, x-amz-account-id)
get_access_grant(id, x-amz-account-id, params::Dict{String,<:Any})
Get the details of an access grant from your S3 Access Grants instance. Permissions You
must have the s3:GetAccessGrant permission to use this operation.
# Arguments
- `id`: The ID of the access grant. S3 Access Grants auto-generates this ID when you create
the access grant.
- `x-amz-account-id`: The ID of the Amazon Web Services account that is making this request.
"""
function get_access_grant(
id, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/accessgrantsinstance/grant/$(id)",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_access_grant(
id,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/accessgrantsinstance/grant/$(id)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_access_grants_instance(x-amz-account-id)
get_access_grants_instance(x-amz-account-id, params::Dict{String,<:Any})
Retrieves the S3 Access Grants instance for a Region in your account. Permissions You
must have the s3:GetAccessGrantsInstance permission to use this operation.
# Arguments
- `x-amz-account-id`: The ID of the Amazon Web Services account that is making this request.
"""
function get_access_grants_instance(
x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/accessgrantsinstance",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_access_grants_instance(
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/accessgrantsinstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_access_grants_instance_for_prefix(s3prefix, x-amz-account-id)
get_access_grants_instance_for_prefix(s3prefix, x-amz-account-id, params::Dict{String,<:Any})
Retrieve the S3 Access Grants instance that contains a particular prefix. Permissions
You must have the s3:GetAccessGrantsInstanceForPrefix permission for the caller account to
use this operation. Additional Permissions The prefix owner account must grant you the
following permissions to their S3 Access Grants instance:
s3:GetAccessGrantsInstanceForPrefix.
# Arguments
- `s3prefix`: The S3 prefix of the access grants that you would like to retrieve.
- `x-amz-account-id`: The ID of the Amazon Web Services account that is making this request.
"""
function get_access_grants_instance_for_prefix(
s3prefix, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/accessgrantsinstance/prefix",
Dict{String,Any}(
"s3prefix" => s3prefix,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_access_grants_instance_for_prefix(
s3prefix,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/accessgrantsinstance/prefix",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"s3prefix" => s3prefix,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_access_grants_instance_resource_policy(x-amz-account-id)
get_access_grants_instance_resource_policy(x-amz-account-id, params::Dict{String,<:Any})
Returns the resource policy of the S3 Access Grants instance. Permissions You must have
the s3:GetAccessGrantsInstanceResourcePolicy permission to use this operation.
# Arguments
- `x-amz-account-id`: The ID of the Amazon Web Services account that is making this request.
"""
function get_access_grants_instance_resource_policy(
x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/accessgrantsinstance/resourcepolicy",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_access_grants_instance_resource_policy(
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/accessgrantsinstance/resourcepolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_access_grants_location(id, x-amz-account-id)
get_access_grants_location(id, x-amz-account-id, params::Dict{String,<:Any})
Retrieves the details of a particular location registered in your S3 Access Grants
instance. Permissions You must have the s3:GetAccessGrantsLocation permission to use
this operation.
# Arguments
- `id`: The ID of the registered location that you are retrieving. S3 Access Grants assigns
this ID when you register the location. S3 Access Grants assigns the ID default to the
default location s3:// and assigns an auto-generated ID to other locations that you
register.
- `x-amz-account-id`: The ID of the Amazon Web Services account that is making this request.
"""
function get_access_grants_location(
id, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/accessgrantsinstance/location/$(id)",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_access_grants_location(
id,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/accessgrantsinstance/location/$(id)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_access_point(name, x-amz-account-id)
get_access_point(name, x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Returns configuration information
about the specified access point. All Amazon S3 on Outposts REST API requests for this
action require an additional parameter of x-amz-outpost-id to be passed with the request.
In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control.
For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts
endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN,
see the Examples section. The following actions are related to GetAccessPoint:
CreateAccessPoint DeleteAccessPoint ListAccessPoints
# Arguments
- `name`: The name of the access point whose configuration information you want to
retrieve. For using this parameter with Amazon S3 on Outposts with the REST API, you must
specify the name and the x-amz-outpost-id as well. For using this parameter with S3 on
Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the access
point accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint
/<my-accesspoint-name>. For example, to access the access point reports-ap through
Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding
of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap.
The value must be URL encoded.
- `x-amz-account-id`: The Amazon Web Services account ID for the account that owns the
specified access point.
"""
function get_access_point(
name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/accesspoint/$(name)",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_access_point(
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/accesspoint/$(name)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_access_point_configuration_for_object_lambda(name, x-amz-account-id)
get_access_point_configuration_for_object_lambda(name, x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Returns configuration for an Object
Lambda Access Point. The following actions are related to
GetAccessPointConfigurationForObjectLambda: PutAccessPointConfigurationForObjectLambda
# Arguments
- `name`: The name of the Object Lambda Access Point you want to return the configuration
for.
- `x-amz-account-id`: The account ID for the account that owns the specified Object Lambda
Access Point.
"""
function get_access_point_configuration_for_object_lambda(
name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/accesspointforobjectlambda/$(name)/configuration",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_access_point_configuration_for_object_lambda(
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/accesspointforobjectlambda/$(name)/configuration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_access_point_for_object_lambda(name, x-amz-account-id)
get_access_point_for_object_lambda(name, x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Returns configuration information
about the specified Object Lambda Access Point The following actions are related to
GetAccessPointForObjectLambda: CreateAccessPointForObjectLambda
DeleteAccessPointForObjectLambda ListAccessPointsForObjectLambda
# Arguments
- `name`: The name of the Object Lambda Access Point.
- `x-amz-account-id`: The account ID for the account that owns the specified Object Lambda
Access Point.
"""
function get_access_point_for_object_lambda(
name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/accesspointforobjectlambda/$(name)",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_access_point_for_object_lambda(
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/accesspointforobjectlambda/$(name)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_access_point_policy(name, x-amz-account-id)
get_access_point_policy(name, x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Returns the access point policy
associated with the specified access point. The following actions are related to
GetAccessPointPolicy: PutAccessPointPolicy DeleteAccessPointPolicy
# Arguments
- `name`: The name of the access point whose policy you want to retrieve. For using this
parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the
x-amz-outpost-id as well. For using this parameter with S3 on Outposts with the Amazon Web
Services SDK and CLI, you must specify the ARN of the access point accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint
/<my-accesspoint-name>. For example, to access the access point reports-ap through
Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding
of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap.
The value must be URL encoded.
- `x-amz-account-id`: The account ID for the account that owns the specified access point.
"""
function get_access_point_policy(
name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/accesspoint/$(name)/policy",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_access_point_policy(
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/accesspoint/$(name)/policy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_access_point_policy_for_object_lambda(name, x-amz-account-id)
get_access_point_policy_for_object_lambda(name, x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Returns the resource policy for an
Object Lambda Access Point. The following actions are related to
GetAccessPointPolicyForObjectLambda: DeleteAccessPointPolicyForObjectLambda
PutAccessPointPolicyForObjectLambda
# Arguments
- `name`: The name of the Object Lambda Access Point.
- `x-amz-account-id`: The account ID for the account that owns the specified Object Lambda
Access Point.
"""
function get_access_point_policy_for_object_lambda(
name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/accesspointforobjectlambda/$(name)/policy",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_access_point_policy_for_object_lambda(
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/accesspointforobjectlambda/$(name)/policy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_access_point_policy_status(name, x-amz-account-id)
get_access_point_policy_status(name, x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Indicates whether the specified
access point currently has a policy that allows public access. For more information about
public access through access points, see Managing Data Access with Amazon S3 access points
in the Amazon S3 User Guide.
# Arguments
- `name`: The name of the access point whose policy status you want to retrieve.
- `x-amz-account-id`: The account ID for the account that owns the specified access point.
"""
function get_access_point_policy_status(
name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/accesspoint/$(name)/policyStatus",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_access_point_policy_status(
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/accesspoint/$(name)/policyStatus",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_access_point_policy_status_for_object_lambda(name, x-amz-account-id)
get_access_point_policy_status_for_object_lambda(name, x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Returns the status of the resource
policy associated with an Object Lambda Access Point.
# Arguments
- `name`: The name of the Object Lambda Access Point.
- `x-amz-account-id`: The account ID for the account that owns the specified Object Lambda
Access Point.
"""
function get_access_point_policy_status_for_object_lambda(
name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/accesspointforobjectlambda/$(name)/policyStatus",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_access_point_policy_status_for_object_lambda(
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/accesspointforobjectlambda/$(name)/policyStatus",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bucket(name, x-amz-account-id)
get_bucket(name, x-amz-account-id, params::Dict{String,<:Any})
Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on
Outposts in the Amazon S3 User Guide. If you are using an identity other than the root user
of the Amazon Web Services account that owns the Outposts bucket, the calling identity must
have the s3-outposts:GetBucket permissions on the specified Outposts bucket and belong to
the Outposts bucket owner's account in order to use this action. Only users from Outposts
bucket owner account with the right permissions can perform actions on an Outposts bucket.
If you don't have s3-outposts:GetBucket permissions or you're not using an identity that
belongs to the bucket owner's account, Amazon S3 returns a 403 Access Denied error. The
following actions are related to GetBucket for Amazon S3 on Outposts: All Amazon S3 on
Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts
endpoint hostname prefix instead of s3-control. For an example of the request syntax for
Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the
x-amz-outpost-id derived by using the access point ARN, see the Examples section.
PutObject CreateBucket DeleteBucket
# Arguments
- `name`: Specifies the bucket. For using this parameter with Amazon S3 on Outposts with
the REST API, you must specify the name and the x-amz-outpost-id as well. For using this
parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify
the ARN of the bucket accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<
;my-bucket-name>. For example, to access the bucket reports through Outpost my-outpost
owned by account 123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value
must be URL encoded.
- `x-amz-account-id`: The Amazon Web Services account ID of the Outposts bucket.
"""
function get_bucket(
name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/bucket/$(name)",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_bucket(
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/bucket/$(name)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bucket_lifecycle_configuration(name, x-amz-account-id)
get_bucket_lifecycle_configuration(name, x-amz-account-id, params::Dict{String,<:Any})
This action gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an S3
bucket's lifecycle configuration, see GetBucketLifecycleConfiguration in the Amazon S3 API
Reference. Returns the lifecycle configuration information set on the Outposts bucket.
For more information, see Using Amazon S3 on Outposts and for information about lifecycle
configuration, see Object Lifecycle Management in Amazon S3 User Guide. To use this
action, you must have permission to perform the s3-outposts:GetLifecycleConfiguration
action. The Outposts bucket owner has this permission, by default. The bucket owner can
grant this permission to others. For more information about permissions, see Permissions
Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3
Resources. All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id to be passed with the request. In addition, you
must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example
of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the
Examples section. GetBucketLifecycleConfiguration has the following special error: Error
code: NoSuchLifecycleConfiguration Description: The lifecycle configuration does not
exist. HTTP Status Code: 404 Not Found SOAP Fault Code Prefix: Client The following
actions are related to GetBucketLifecycleConfiguration: PutBucketLifecycleConfiguration
DeleteBucketLifecycleConfiguration
# Arguments
- `name`: The Amazon Resource Name (ARN) of the bucket. For using this parameter with
Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id
as well. For using this parameter with S3 on Outposts with the Amazon Web Services SDK and
CLI, you must specify the ARN of the bucket accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<
;my-bucket-name>. For example, to access the bucket reports through Outpost my-outpost
owned by account 123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value
must be URL encoded.
- `x-amz-account-id`: The Amazon Web Services account ID of the Outposts bucket.
"""
function get_bucket_lifecycle_configuration(
name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/bucket/$(name)/lifecycleconfiguration",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_bucket_lifecycle_configuration(
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/bucket/$(name)/lifecycleconfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bucket_policy(name, x-amz-account-id)
get_bucket_policy(name, x-amz-account-id, params::Dict{String,<:Any})
This action gets a bucket policy for an Amazon S3 on Outposts bucket. To get a policy for
an S3 bucket, see GetBucketPolicy in the Amazon S3 API Reference. Returns the policy of a
specified Outposts bucket. For more information, see Using Amazon S3 on Outposts in the
Amazon S3 User Guide. If you are using an identity other than the root user of the Amazon
Web Services account that owns the bucket, the calling identity must have the
GetBucketPolicy permissions on the specified bucket and belong to the bucket owner's
account in order to use this action. Only users from Outposts bucket owner account with the
right permissions can perform actions on an Outposts bucket. If you don't have
s3-outposts:GetBucketPolicy permissions or you're not using an identity that belongs to the
bucket owner's account, Amazon S3 returns a 403 Access Denied error. As a security
precaution, the root user of the Amazon Web Services account that owns a bucket can always
use this action, even if the policy explicitly denies the root user the ability to perform
this action. For more information about bucket policies, see Using Bucket Policies and
User Policies. All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id to be passed with the request. In addition, you
must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example
of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the
Examples section. The following actions are related to GetBucketPolicy: GetObject
PutBucketPolicy DeleteBucketPolicy
# Arguments
- `name`: Specifies the bucket. For using this parameter with Amazon S3 on Outposts with
the REST API, you must specify the name and the x-amz-outpost-id as well. For using this
parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify
the ARN of the bucket accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<
;my-bucket-name>. For example, to access the bucket reports through Outpost my-outpost
owned by account 123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value
must be URL encoded.
- `x-amz-account-id`: The Amazon Web Services account ID of the Outposts bucket.
"""
function get_bucket_policy(
name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/bucket/$(name)/policy",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_bucket_policy(
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/bucket/$(name)/policy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bucket_replication(name, x-amz-account-id)
get_bucket_replication(name, x-amz-account-id, params::Dict{String,<:Any})
This operation gets an Amazon S3 on Outposts bucket's replication configuration. To get an
S3 bucket's replication configuration, see GetBucketReplication in the Amazon S3 API
Reference. Returns the replication configuration of an S3 on Outposts bucket. For more
information about S3 on Outposts, see Using Amazon S3 on Outposts in the Amazon S3 User
Guide. For information about S3 replication on Outposts configuration, see Replicating
objects for S3 on Outposts in the Amazon S3 User Guide. It can take a while to propagate
PUT or DELETE requests for a replication configuration to all S3 on Outposts systems.
Therefore, the replication configuration that's returned by a GET request soon after a PUT
or DELETE request might return a more recent result than what's on the Outpost. If an
Outpost is offline, the delay in updating the replication configuration on that Outpost can
be significant. This action requires permissions for the
s3-outposts:GetReplicationConfiguration action. The Outposts bucket owner has this
permission by default and can grant it to others. For more information about permissions,
see Setting up IAM with S3 on Outposts and Managing access to S3 on Outposts bucket in the
Amazon S3 User Guide. All Amazon S3 on Outposts REST API requests for this action require
an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you
must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example
of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the
Examples section. If you include the Filter element in a replication configuration, you
must also include the DeleteMarkerReplication, Status, and Priority elements. The response
also returns those elements. For information about S3 on Outposts replication failure
reasons, see Replication failure reasons in the Amazon S3 User Guide. The following
operations are related to GetBucketReplication: PutBucketReplication
DeleteBucketReplication
# Arguments
- `name`: Specifies the bucket to get the replication information for. For using this
parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the
x-amz-outpost-id as well. For using this parameter with S3 on Outposts with the Amazon Web
Services SDK and CLI, you must specify the ARN of the bucket accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<
;my-bucket-name>. For example, to access the bucket reports through Outpost my-outpost
owned by account 123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value
must be URL encoded.
- `x-amz-account-id`: The Amazon Web Services account ID of the Outposts bucket.
"""
function get_bucket_replication(
name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/bucket/$(name)/replication",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_bucket_replication(
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/bucket/$(name)/replication",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bucket_tagging(name, x-amz-account-id)
get_bucket_tagging(name, x-amz-account-id, params::Dict{String,<:Any})
This action gets an Amazon S3 on Outposts bucket's tags. To get an S3 bucket tags, see
GetBucketTagging in the Amazon S3 API Reference. Returns the tag set associated with the
Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3
User Guide. To use this action, you must have permission to perform the GetBucketTagging
action. By default, the bucket owner has this permission and can grant this permission to
others. GetBucketTagging has the following special error: Error code: NoSuchTagSetError
Description: There is no tag set associated with the bucket. All Amazon S3 on
Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts
endpoint hostname prefix instead of s3-control. For an example of the request syntax for
Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the
x-amz-outpost-id derived by using the access point ARN, see the Examples section. The
following actions are related to GetBucketTagging: PutBucketTagging
DeleteBucketTagging
# Arguments
- `name`: Specifies the bucket. For using this parameter with Amazon S3 on Outposts with
the REST API, you must specify the name and the x-amz-outpost-id as well. For using this
parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify
the ARN of the bucket accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<
;my-bucket-name>. For example, to access the bucket reports through Outpost my-outpost
owned by account 123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value
must be URL encoded.
- `x-amz-account-id`: The Amazon Web Services account ID of the Outposts bucket.
"""
function get_bucket_tagging(
name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/bucket/$(name)/tagging",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_bucket_tagging(
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/bucket/$(name)/tagging",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bucket_versioning(name, x-amz-account-id)
get_bucket_versioning(name, x-amz-account-id, params::Dict{String,<:Any})
This operation returns the versioning state for S3 on Outposts buckets only. To return the
versioning state for an S3 bucket, see GetBucketVersioning in the Amazon S3 API Reference.
Returns the versioning state for an S3 on Outposts bucket. With S3 Versioning, you can
save multiple distinct copies of your objects and recover from unintended user actions and
application failures. If you've never set versioning on your bucket, it has no versioning
state. In that case, the GetBucketVersioning request does not return a versioning state
value. For more information about versioning, see Versioning in the Amazon S3 User Guide.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter
of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on
Outposts endpoint hostname prefix instead of s3-control. For an example of the request
syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and
the x-amz-outpost-id derived by using the access point ARN, see the Examples section. The
following operations are related to GetBucketVersioning for S3 on Outposts.
PutBucketVersioning PutBucketLifecycleConfiguration GetBucketLifecycleConfiguration
# Arguments
- `name`: The S3 on Outposts bucket to return the versioning state for.
- `x-amz-account-id`: The Amazon Web Services account ID of the S3 on Outposts bucket.
"""
function get_bucket_versioning(
name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/bucket/$(name)/versioning",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_bucket_versioning(
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/bucket/$(name)/versioning",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_data_access(permission, target, x-amz-account-id)
get_data_access(permission, target, x-amz-account-id, params::Dict{String,<:Any})
Returns a temporary access credential from S3 Access Grants to the grantee or client
application. The temporary credential is an Amazon Web Services STS token that grants them
access to the S3 data. Permissions You must have the s3:GetDataAccess permission to use
this operation. Additional Permissions The IAM role that S3 Access Grants assumes must
have the following permissions specified in the trust policy when registering the location:
sts:AssumeRole, for directory users or groups sts:SetContext, and for IAM users or roles
sts:SetSourceIdentity.
# Arguments
- `permission`: The type of permission granted to your S3 data, which can be set to one of
the following values: READ – Grant read-only access to the S3 data. WRITE – Grant
write-only access to the S3 data. READWRITE – Grant both read and write access to the
S3 data.
- `target`: The S3 URI path of the data to which you are requesting temporary access
credentials. If the requesting account has an access grant for this data, S3 Access Grants
vends temporary access credentials in the response.
- `x-amz-account-id`: The ID of the Amazon Web Services account that is making this request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"durationSeconds"`: The session duration, in seconds, of the temporary access credential
that S3 Access Grants vends to the grantee or client application. The default value is 1
hour, but the grantee can specify a range from 900 seconds (15 minutes) up to 43200 seconds
(12 hours). If the grantee requests a value higher than this maximum, the operation fails.
- `"privilege"`: The scope of the temporary access credential that S3 Access Grants vends
to the grantee or client application. Default – The scope of the returned temporary
access token is the scope of the grant that is closest to the target scope. Minimal –
The scope of the returned temporary access token is the same as the requested target scope
as long as the requested scope is the same as or a subset of the grant scope.
- `"targetType"`: The type of Target. The only possible value is Object. Pass this value if
the target data that you would like to access is a path to an object. Do not pass this
value if the target data is a bucket or a bucket and a prefix.
"""
function get_data_access(
permission, target, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/accessgrantsinstance/dataaccess",
Dict{String,Any}(
"permission" => permission,
"target" => target,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_data_access(
permission,
target,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/accessgrantsinstance/dataaccess",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"permission" => permission,
"target" => target,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_job_tagging(id, x-amz-account-id)
get_job_tagging(id, x-amz-account-id, params::Dict{String,<:Any})
Returns the tags on an S3 Batch Operations job. Permissions To use the GetJobTagging
operation, you must have permission to perform the s3:GetJobTagging action. For more
information, see Controlling access and labeling jobs using tags in the Amazon S3 User
Guide. Related actions include: CreateJob PutJobTagging DeleteJobTagging
# Arguments
- `id`: The ID for the S3 Batch Operations job whose tags you want to retrieve.
- `x-amz-account-id`: The Amazon Web Services account ID associated with the S3 Batch
Operations job.
"""
function get_job_tagging(
id, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/jobs/$(id)/tagging",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_job_tagging(
id,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/jobs/$(id)/tagging",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_multi_region_access_point(name, x-amz-account-id)
get_multi_region_access_point(name, x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Returns configuration information
about the specified Multi-Region Access Point. This action will always be routed to the US
West (Oregon) Region. For more information about the restrictions around working with
Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations in
the Amazon S3 User Guide. The following actions are related to GetMultiRegionAccessPoint:
CreateMultiRegionAccessPoint DeleteMultiRegionAccessPoint
DescribeMultiRegionAccessPointOperation ListMultiRegionAccessPoints
# Arguments
- `name`: The name of the Multi-Region Access Point whose configuration information you
want to receive. The name of the Multi-Region Access Point is different from the alias. For
more information about the distinction between the name and the alias of an Multi-Region
Access Point, see Rules for naming Amazon S3 Multi-Region Access Points in the Amazon S3
User Guide.
- `x-amz-account-id`: The Amazon Web Services account ID for the owner of the Multi-Region
Access Point.
"""
function get_multi_region_access_point(
name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/mrap/instances/$(name)",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_multi_region_access_point(
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/mrap/instances/$(name)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_multi_region_access_point_policy(name, x-amz-account-id)
get_multi_region_access_point_policy(name, x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Returns the access control policy
of the specified Multi-Region Access Point. This action will always be routed to the US
West (Oregon) Region. For more information about the restrictions around working with
Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations in
the Amazon S3 User Guide. The following actions are related to
GetMultiRegionAccessPointPolicy: GetMultiRegionAccessPointPolicyStatus
PutMultiRegionAccessPointPolicy
# Arguments
- `name`: Specifies the Multi-Region Access Point. The name of the Multi-Region Access
Point is different from the alias. For more information about the distinction between the
name and the alias of an Multi-Region Access Point, see Rules for naming Amazon S3
Multi-Region Access Points in the Amazon S3 User Guide.
- `x-amz-account-id`: The Amazon Web Services account ID for the owner of the Multi-Region
Access Point.
"""
function get_multi_region_access_point_policy(
name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/mrap/instances/$(name)/policy",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_multi_region_access_point_policy(
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/mrap/instances/$(name)/policy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_multi_region_access_point_policy_status(name, x-amz-account-id)
get_multi_region_access_point_policy_status(name, x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Indicates whether the specified
Multi-Region Access Point has an access control policy that allows public access. This
action will always be routed to the US West (Oregon) Region. For more information about the
restrictions around working with Multi-Region Access Points, see Multi-Region Access Point
restrictions and limitations in the Amazon S3 User Guide. The following actions are related
to GetMultiRegionAccessPointPolicyStatus: GetMultiRegionAccessPointPolicy
PutMultiRegionAccessPointPolicy
# Arguments
- `name`: Specifies the Multi-Region Access Point. The name of the Multi-Region Access
Point is different from the alias. For more information about the distinction between the
name and the alias of an Multi-Region Access Point, see Rules for naming Amazon S3
Multi-Region Access Points in the Amazon S3 User Guide.
- `x-amz-account-id`: The Amazon Web Services account ID for the owner of the Multi-Region
Access Point.
"""
function get_multi_region_access_point_policy_status(
name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/mrap/instances/$(name)/policystatus",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_multi_region_access_point_policy_status(
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/mrap/instances/$(name)/policystatus",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_multi_region_access_point_routes(mrap, x-amz-account-id)
get_multi_region_access_point_routes(mrap, x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Returns the routing configuration
for a Multi-Region Access Point, indicating which Regions are active or passive. To obtain
routing control changes and failover requests, use the Amazon S3 failover control
infrastructure endpoints in these five Amazon Web Services Regions: us-east-1
us-west-2 ap-southeast-2 ap-northeast-1 eu-west-1
# Arguments
- `mrap`: The Multi-Region Access Point ARN.
- `x-amz-account-id`: The Amazon Web Services account ID for the owner of the Multi-Region
Access Point.
"""
function get_multi_region_access_point_routes(
mrap, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/mrap/instances/$(mrap)/routes",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_multi_region_access_point_routes(
mrap,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/mrap/instances/$(mrap)/routes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_public_access_block(x-amz-account-id)
get_public_access_block(x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Retrieves the PublicAccessBlock
configuration for an Amazon Web Services account. For more information, see Using Amazon
S3 block public access. Related actions include: DeletePublicAccessBlock
PutPublicAccessBlock
# Arguments
- `x-amz-account-id`: The account ID for the Amazon Web Services account whose
PublicAccessBlock configuration you want to retrieve.
"""
function get_public_access_block(
x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/configuration/publicAccessBlock",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_public_access_block(
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/configuration/publicAccessBlock",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_storage_lens_configuration(storagelensid, x-amz-account-id)
get_storage_lens_configuration(storagelensid, x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Gets the Amazon S3 Storage Lens
configuration. For more information, see Assessing your storage activity and usage with
Amazon S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens
metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide. To use this
action, you must have permission to perform the s3:GetStorageLensConfiguration action. For
more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3
User Guide.
# Arguments
- `storagelensid`: The ID of the Amazon S3 Storage Lens configuration.
- `x-amz-account-id`: The account ID of the requester.
"""
function get_storage_lens_configuration(
storagelensid, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/storagelens/$(storagelensid)",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_storage_lens_configuration(
storagelensid,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/storagelens/$(storagelensid)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_storage_lens_configuration_tagging(storagelensid, x-amz-account-id)
get_storage_lens_configuration_tagging(storagelensid, x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Gets the tags of Amazon S3 Storage
Lens configuration. For more information about S3 Storage Lens, see Assessing your storage
activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide. To use this
action, you must have permission to perform the s3:GetStorageLensConfigurationTagging
action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the
Amazon S3 User Guide.
# Arguments
- `storagelensid`: The ID of the Amazon S3 Storage Lens configuration.
- `x-amz-account-id`: The account ID of the requester.
"""
function get_storage_lens_configuration_tagging(
storagelensid, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/storagelens/$(storagelensid)/tagging",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_storage_lens_configuration_tagging(
storagelensid,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/storagelens/$(storagelensid)/tagging",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_storage_lens_group(name, x-amz-account-id)
get_storage_lens_group(name, x-amz-account-id, params::Dict{String,<:Any})
Retrieves the Storage Lens group configuration details. To use this operation, you must
have the permission to perform the s3:GetStorageLensGroup action. For more information
about the required Storage Lens Groups permissions, see Setting account permissions to use
S3 Storage Lens groups. For information about Storage Lens groups errors, see List of
Amazon S3 Storage Lens error codes.
# Arguments
- `name`: The name of the Storage Lens group that you're trying to retrieve the
configuration details for.
- `x-amz-account-id`: The Amazon Web Services account ID associated with the Storage Lens
group that you're trying to retrieve the details for.
"""
function get_storage_lens_group(
name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/storagelensgroup/$(name)",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_storage_lens_group(
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/storagelensgroup/$(name)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_access_grants(x-amz-account-id)
list_access_grants(x-amz-account-id, params::Dict{String,<:Any})
Returns the list of access grants in your S3 Access Grants instance. Permissions You must
have the s3:ListAccessGrants permission to use this operation.
# Arguments
- `x-amz-account-id`: The ID of the Amazon Web Services account that is making this request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"application_arn"`: The Amazon Resource Name (ARN) of an Amazon Web Services IAM
Identity Center application associated with your Identity Center instance. If the grant
includes an application ARN, the grantee can only access the S3 data through this
application.
- `"granteeidentifier"`: The unique identifer of the Grantee. If the grantee type is IAM,
the identifier is the IAM Amazon Resource Name (ARN) of the user or role. If the grantee
type is a directory user or group, the identifier is 128-bit universally unique identifier
(UUID) in the format a1b2c3d4-5678-90ab-cdef-EXAMPLE11111. You can obtain this UUID from
your Amazon Web Services IAM Identity Center instance.
- `"granteetype"`: The type of the grantee to which access has been granted. It can be one
of the following values: IAM - An IAM user or role. DIRECTORY_USER - Your corporate
directory user. You can use this option if you have added your corporate identity directory
to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access
Grants instance. DIRECTORY_GROUP - Your corporate directory group. You can use this
option if you have added your corporate identity directory to IAM Identity Center and
associated the IAM Identity Center instance with your S3 Access Grants instance.
- `"grantscope"`: The S3 path of the data to which you are granting access. It is the
result of appending the Subprefix to the location scope.
- `"maxResults"`: The maximum number of access grants that you would like returned in the
List Access Grants response. If the results include the pagination token NextToken, make
another call using the NextToken to determine if there are more results.
- `"nextToken"`: A pagination token to request the next page of results. Pass this value
into a subsequent List Access Grants request in order to retrieve the next page of results.
- `"permission"`: The type of permission granted to your S3 data, which can be set to one
of the following values: READ – Grant read-only access to the S3 data. WRITE –
Grant write-only access to the S3 data. READWRITE – Grant both read and write access
to the S3 data.
"""
function list_access_grants(
x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/accessgrantsinstance/grants",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_access_grants(
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/accessgrantsinstance/grants",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_access_grants_instances(x-amz-account-id)
list_access_grants_instances(x-amz-account-id, params::Dict{String,<:Any})
Returns a list of S3 Access Grants instances. An S3 Access Grants instance serves as a
logical grouping for your individual access grants. You can only have one S3 Access Grants
instance per Region per account. Permissions You must have the
s3:ListAccessGrantsInstances permission to use this operation.
# Arguments
- `x-amz-account-id`: The ID of the Amazon Web Services account that is making this request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of access grants that you would like returned in the
List Access Grants response. If the results include the pagination token NextToken, make
another call using the NextToken to determine if there are more results.
- `"nextToken"`: A pagination token to request the next page of results. Pass this value
into a subsequent List Access Grants Instances request in order to retrieve the next page
of results.
"""
function list_access_grants_instances(
x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/accessgrantsinstances",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_access_grants_instances(
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/accessgrantsinstances",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_access_grants_locations(x-amz-account-id)
list_access_grants_locations(x-amz-account-id, params::Dict{String,<:Any})
Returns a list of the locations registered in your S3 Access Grants instance. Permissions
You must have the s3:ListAccessGrantsLocations permission to use this operation.
# Arguments
- `x-amz-account-id`: The ID of the Amazon Web Services account that is making this request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"locationscope"`: The S3 path to the location that you are registering. The location
scope can be the default S3 location s3://, the S3 path to a bucket s3://<bucket>, or
the S3 path to a bucket and prefix s3://<bucket>/<prefix>. A prefix in S3 is a
string of characters at the beginning of an object key name used to organize the objects
that you store in your S3 buckets. For example, object key names that start with the
engineering/ prefix or object key names that start with the marketing/campaigns/ prefix.
- `"maxResults"`: The maximum number of access grants that you would like returned in the
List Access Grants response. If the results include the pagination token NextToken, make
another call using the NextToken to determine if there are more results.
- `"nextToken"`: A pagination token to request the next page of results. Pass this value
into a subsequent List Access Grants Locations request in order to retrieve the next page
of results.
"""
function list_access_grants_locations(
x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/accessgrantsinstance/locations",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_access_grants_locations(
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/accessgrantsinstance/locations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_access_points(x-amz-account-id)
list_access_points(x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Returns a list of the access points
that are owned by the current account that's associated with the specified bucket. You can
retrieve up to 1000 access points per call. If the specified bucket has more than 1,000
access points (or the number specified in maxResults, whichever is less), the response will
include a continuation token that you can use to list the additional access points. All
Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts
endpoint hostname prefix instead of s3-control. For an example of the request syntax for
Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the
x-amz-outpost-id derived by using the access point ARN, see the Examples section. The
following actions are related to ListAccessPoints: CreateAccessPoint
DeleteAccessPoint GetAccessPoint
# Arguments
- `x-amz-account-id`: The Amazon Web Services account ID for the account that owns the
specified access points.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"bucket"`: The name of the bucket whose associated access points you want to list. For
using this parameter with Amazon S3 on Outposts with the REST API, you must specify the
name and the x-amz-outpost-id as well. For using this parameter with S3 on Outposts with
the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the
format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<
;my-bucket-name>. For example, to access the bucket reports through Outpost my-outpost
owned by account 123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value
must be URL encoded.
- `"maxResults"`: The maximum number of access points that you want to include in the list.
If the specified bucket has more than this number of access points, then the response will
include a continuation token in the NextToken field that you can use to retrieve the next
page of access points.
- `"nextToken"`: A continuation token. If a previous call to ListAccessPoints returned a
continuation token in the NextToken field, then providing that value here causes Amazon S3
to retrieve the next page of results.
"""
function list_access_points(
x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/accesspoint",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_access_points(
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/accesspoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_access_points_for_object_lambda(x-amz-account-id)
list_access_points_for_object_lambda(x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Returns some or all (up to 1,000)
access points associated with the Object Lambda Access Point per call. If there are more
access points than what can be returned in one call, the response will include a
continuation token that you can use to list the additional access points. The following
actions are related to ListAccessPointsForObjectLambda: CreateAccessPointForObjectLambda
DeleteAccessPointForObjectLambda GetAccessPointForObjectLambda
# Arguments
- `x-amz-account-id`: The account ID for the account that owns the specified Object Lambda
Access Point.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of access points that you want to include in the list.
The response may contain fewer access points but will never contain more. If there are more
than this number of access points, then the response will include a continuation token in
the NextToken field that you can use to retrieve the next page of access points.
- `"nextToken"`: If the list has more access points than can be returned in one call to
this API, this field contains a continuation token that you can provide in subsequent calls
to this API to retrieve additional access points.
"""
function list_access_points_for_object_lambda(
x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/accesspointforobjectlambda",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_access_points_for_object_lambda(
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/accesspointforobjectlambda",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_jobs(x-amz-account-id)
list_jobs(x-amz-account-id, params::Dict{String,<:Any})
Lists current S3 Batch Operations jobs as well as the jobs that have ended within the last
90 days for the Amazon Web Services account making the request. For more information, see
S3 Batch Operations in the Amazon S3 User Guide. Permissions To use the ListJobs
operation, you must have permission to perform the s3:ListJobs action. Related actions
include: CreateJob DescribeJob UpdateJobPriority UpdateJobStatus
# Arguments
- `x-amz-account-id`: The Amazon Web Services account ID associated with the S3 Batch
Operations job.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"jobStatuses"`: The List Jobs request returns jobs that match the statuses listed in
this element.
- `"maxResults"`: The maximum number of jobs that Amazon S3 will include in the List Jobs
response. If there are more jobs than this number, the response will include a pagination
token in the NextToken field to enable you to retrieve the next page of results.
- `"nextToken"`: A pagination token to request the next page of results. Use the token that
Amazon S3 returned in the NextToken element of the ListJobsResult from the previous List
Jobs request.
"""
function list_jobs(x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config())
return s3_control(
"GET",
"/v20180820/jobs",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_jobs(
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/jobs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_multi_region_access_points(x-amz-account-id)
list_multi_region_access_points(x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Returns a list of the Multi-Region
Access Points currently associated with the specified Amazon Web Services account. Each
call can return up to 100 Multi-Region Access Points, the maximum number of Multi-Region
Access Points that can be associated with a single account. This action will always be
routed to the US West (Oregon) Region. For more information about the restrictions around
working with Multi-Region Access Points, see Multi-Region Access Point restrictions and
limitations in the Amazon S3 User Guide. The following actions are related to
ListMultiRegionAccessPoint: CreateMultiRegionAccessPoint
DeleteMultiRegionAccessPoint DescribeMultiRegionAccessPointOperation
GetMultiRegionAccessPoint
# Arguments
- `x-amz-account-id`: The Amazon Web Services account ID for the owner of the Multi-Region
Access Point.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Not currently used. Do not use this parameter.
- `"nextToken"`: Not currently used. Do not use this parameter.
"""
function list_multi_region_access_points(
x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/mrap/instances",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_multi_region_access_points(
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/mrap/instances",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_regional_buckets(x-amz-account-id)
list_regional_buckets(x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Returns a list of all Outposts
buckets in an Outpost that are owned by the authenticated sender of the request. For more
information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide. For an example of
the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname
prefix and x-amz-outpost-id in your request, see the Examples section.
# Arguments
- `x-amz-account-id`: The Amazon Web Services account ID of the Outposts bucket.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`:
- `"nextToken"`:
- `"x-amz-outpost-id"`: The ID of the Outposts resource. This ID is required by Amazon S3
on Outposts buckets.
"""
function list_regional_buckets(
x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/bucket",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_regional_buckets(
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/bucket",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_storage_lens_configurations(x-amz-account-id)
list_storage_lens_configurations(x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Gets a list of Amazon S3 Storage
Lens configurations. For more information about S3 Storage Lens, see Assessing your storage
activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide. To use this
action, you must have permission to perform the s3:ListStorageLensConfigurations action.
For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon
S3 User Guide.
# Arguments
- `x-amz-account-id`: The account ID of the requester.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: A pagination token to request the next page of results.
"""
function list_storage_lens_configurations(
x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/storagelens",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_storage_lens_configurations(
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/storagelens",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_storage_lens_groups(x-amz-account-id)
list_storage_lens_groups(x-amz-account-id, params::Dict{String,<:Any})
Lists all the Storage Lens groups in the specified home Region. To use this operation,
you must have the permission to perform the s3:ListStorageLensGroups action. For more
information about the required Storage Lens Groups permissions, see Setting account
permissions to use S3 Storage Lens groups. For information about Storage Lens groups
errors, see List of Amazon S3 Storage Lens error codes.
# Arguments
- `x-amz-account-id`: The Amazon Web Services account ID that owns the Storage Lens
groups.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: The token for the next set of results, or null if there are no more
results.
"""
function list_storage_lens_groups(
x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/storagelensgroup",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_storage_lens_groups(
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/storagelensgroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn, x-amz-account-id)
list_tags_for_resource(resource_arn, x-amz-account-id, params::Dict{String,<:Any})
This operation allows you to list all the Amazon Web Services resource tags for a specified
resource. Each tag is a label consisting of a user-defined key and value. Tags can help you
manage, identify, organize, search for, and filter resources. Permissions You must have
the s3:ListTagsForResource permission to use this operation. This operation is only
supported for S3 Storage Lens groups and for S3 Access Grants. The tagged resource can be
an S3 Storage Lens group or S3 Access Grants instance, registered location, or grant. For
more information about the required Storage Lens Groups permissions, see Setting account
permissions to use S3 Storage Lens groups. For information about S3 Tagging errors, see
List of Amazon S3 Tagging error codes.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the S3 resource that you want to list
the tags for. The tagged resource can be an S3 Storage Lens group or S3 Access Grants
instance, registered location, or grant.
- `x-amz-account-id`: The Amazon Web Services account ID of the resource owner.
"""
function list_tags_for_resource(
resourceArn, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"GET",
"/v20180820/tags/$(resourceArn)",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceArn,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"GET",
"/v20180820/tags/$(resourceArn)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_access_grants_instance_resource_policy(policy, x-amz-account-id)
put_access_grants_instance_resource_policy(policy, x-amz-account-id, params::Dict{String,<:Any})
Updates the resource policy of the S3 Access Grants instance. Permissions You must have
the s3:PutAccessGrantsInstanceResourcePolicy permission to use this operation.
# Arguments
- `policy`: The resource policy of the S3 Access Grants instance that you are updating.
- `x-amz-account-id`: The ID of the Amazon Web Services account that is making this request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Organization"`: The Organization of the resource policy of the S3 Access Grants
instance.
"""
function put_access_grants_instance_resource_policy(
Policy, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"PUT",
"/v20180820/accessgrantsinstance/resourcepolicy",
Dict{String,Any}(
"Policy" => Policy,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_access_grants_instance_resource_policy(
Policy,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"PUT",
"/v20180820/accessgrantsinstance/resourcepolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Policy" => Policy,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_access_point_configuration_for_object_lambda(configuration, name, x-amz-account-id)
put_access_point_configuration_for_object_lambda(configuration, name, x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Replaces configuration for an
Object Lambda Access Point. The following actions are related to
PutAccessPointConfigurationForObjectLambda: GetAccessPointConfigurationForObjectLambda
# Arguments
- `configuration`: Object Lambda Access Point configuration document.
- `name`: The name of the Object Lambda Access Point.
- `x-amz-account-id`: The account ID for the account that owns the specified Object Lambda
Access Point.
"""
function put_access_point_configuration_for_object_lambda(
Configuration, name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"PUT",
"/v20180820/accesspointforobjectlambda/$(name)/configuration",
Dict{String,Any}(
"Configuration" => Configuration,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_access_point_configuration_for_object_lambda(
Configuration,
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"PUT",
"/v20180820/accesspointforobjectlambda/$(name)/configuration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Configuration" => Configuration,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_access_point_policy(policy, name, x-amz-account-id)
put_access_point_policy(policy, name, x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Associates an access policy with
the specified access point. Each access point can have only one policy, so a request made
to this API replaces any existing policy associated with the specified access point. All
Amazon S3 on Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts
endpoint hostname prefix instead of s3-control. For an example of the request syntax for
Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the
x-amz-outpost-id derived by using the access point ARN, see the Examples section. The
following actions are related to PutAccessPointPolicy: GetAccessPointPolicy
DeleteAccessPointPolicy
# Arguments
- `policy`: The policy that you want to apply to the specified access point. For more
information about access point policies, see Managing data access with Amazon S3 access
points in the Amazon S3 User Guide.
- `name`: The name of the access point that you want to associate with the specified
policy. For using this parameter with Amazon S3 on Outposts with the REST API, you must
specify the name and the x-amz-outpost-id as well. For using this parameter with S3 on
Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the access
point accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint
/<my-accesspoint-name>. For example, to access the access point reports-ap through
Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding
of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap.
The value must be URL encoded.
- `x-amz-account-id`: The Amazon Web Services account ID for owner of the bucket associated
with the specified access point.
"""
function put_access_point_policy(
Policy, name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"PUT",
"/v20180820/accesspoint/$(name)/policy",
Dict{String,Any}(
"Policy" => Policy,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_access_point_policy(
Policy,
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"PUT",
"/v20180820/accesspoint/$(name)/policy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Policy" => Policy,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_access_point_policy_for_object_lambda(policy, name, x-amz-account-id)
put_access_point_policy_for_object_lambda(policy, name, x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Creates or replaces resource policy
for an Object Lambda Access Point. For an example policy, see Creating Object Lambda Access
Points in the Amazon S3 User Guide. The following actions are related to
PutAccessPointPolicyForObjectLambda: DeleteAccessPointPolicyForObjectLambda
GetAccessPointPolicyForObjectLambda
# Arguments
- `policy`: Object Lambda Access Point resource policy document.
- `name`: The name of the Object Lambda Access Point.
- `x-amz-account-id`: The account ID for the account that owns the specified Object Lambda
Access Point.
"""
function put_access_point_policy_for_object_lambda(
Policy, name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"PUT",
"/v20180820/accesspointforobjectlambda/$(name)/policy",
Dict{String,Any}(
"Policy" => Policy,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_access_point_policy_for_object_lambda(
Policy,
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"PUT",
"/v20180820/accesspointforobjectlambda/$(name)/policy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Policy" => Policy,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_bucket_lifecycle_configuration(name, x-amz-account-id)
put_bucket_lifecycle_configuration(name, x-amz-account-id, params::Dict{String,<:Any})
This action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. To put a
lifecycle configuration to an S3 bucket, see PutBucketLifecycleConfiguration in the Amazon
S3 API Reference. Creates a new lifecycle configuration for the S3 on Outposts bucket or
replaces an existing lifecycle configuration. Outposts buckets only support lifecycle
configurations that delete/expire objects after a certain period of time and abort
incomplete multipart uploads. All Amazon S3 on Outposts REST API requests for this action
require an additional parameter of x-amz-outpost-id to be passed with the request. In
addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control.
For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts
endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN,
see the Examples section. The following actions are related to
PutBucketLifecycleConfiguration: GetBucketLifecycleConfiguration
DeleteBucketLifecycleConfiguration
# Arguments
- `name`: The name of the bucket for which to set the configuration.
- `x-amz-account-id`: The Amazon Web Services account ID of the Outposts bucket.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LifecycleConfiguration"`: Container for lifecycle rules. You can add as many as 1,000
rules.
"""
function put_bucket_lifecycle_configuration(
name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"PUT",
"/v20180820/bucket/$(name)/lifecycleconfiguration",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_bucket_lifecycle_configuration(
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"PUT",
"/v20180820/bucket/$(name)/lifecycleconfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_bucket_policy(policy, name, x-amz-account-id)
put_bucket_policy(policy, name, x-amz-account-id, params::Dict{String,<:Any})
This action puts a bucket policy to an Amazon S3 on Outposts bucket. To put a policy on an
S3 bucket, see PutBucketPolicy in the Amazon S3 API Reference. Applies an Amazon S3
bucket policy to an Outposts bucket. For more information, see Using Amazon S3 on Outposts
in the Amazon S3 User Guide. If you are using an identity other than the root user of the
Amazon Web Services account that owns the Outposts bucket, the calling identity must have
the PutBucketPolicy permissions on the specified Outposts bucket and belong to the bucket
owner's account in order to use this action. If you don't have PutBucketPolicy permissions,
Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but
you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns
a 405 Method Not Allowed error. As a security precaution, the root user of the Amazon Web
Services account that owns a bucket can always use this action, even if the policy
explicitly denies the root user the ability to perform this action. For more information
about bucket policies, see Using Bucket Policies and User Policies. All Amazon S3 on
Outposts REST API requests for this action require an additional parameter of
x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts
endpoint hostname prefix instead of s3-control. For an example of the request syntax for
Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the
x-amz-outpost-id derived by using the access point ARN, see the Examples section. The
following actions are related to PutBucketPolicy: GetBucketPolicy DeleteBucketPolicy
# Arguments
- `policy`: The bucket policy as a JSON document.
- `name`: Specifies the bucket. For using this parameter with Amazon S3 on Outposts with
the REST API, you must specify the name and the x-amz-outpost-id as well. For using this
parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify
the ARN of the bucket accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<
;my-bucket-name>. For example, to access the bucket reports through Outpost my-outpost
owned by account 123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value
must be URL encoded.
- `x-amz-account-id`: The Amazon Web Services account ID of the Outposts bucket.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-confirm-remove-self-bucket-access"`: Set this parameter to true to confirm that
you want to remove your permissions to change this bucket policy in the future. This is
not supported by Amazon S3 on Outposts buckets.
"""
function put_bucket_policy(
Policy, name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"PUT",
"/v20180820/bucket/$(name)/policy",
Dict{String,Any}(
"Policy" => Policy,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_bucket_policy(
Policy,
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"PUT",
"/v20180820/bucket/$(name)/policy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Policy" => Policy,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_bucket_replication(replication_configuration, name, x-amz-account-id)
put_bucket_replication(replication_configuration, name, x-amz-account-id, params::Dict{String,<:Any})
This action creates an Amazon S3 on Outposts bucket's replication configuration. To create
an S3 bucket's replication configuration, see PutBucketReplication in the Amazon S3 API
Reference. Creates a replication configuration or replaces an existing one. For
information about S3 replication on Outposts configuration, see Replicating objects for S3
on Outposts in the Amazon S3 User Guide. It can take a while to propagate PUT or DELETE
requests for a replication configuration to all S3 on Outposts systems. Therefore, the
replication configuration that's returned by a GET request soon after a PUT or DELETE
request might return a more recent result than what's on the Outpost. If an Outpost is
offline, the delay in updating the replication configuration on that Outpost can be
significant. Specify the replication configuration in the request body. In the replication
configuration, you provide the following information: The name of the destination bucket
or buckets where you want S3 on Outposts to replicate objects The Identity and Access
Management (IAM) role that S3 on Outposts can assume to replicate objects on your behalf
Other relevant information, such as replication rules A replication configuration must
include at least one rule and can contain a maximum of 100. Each rule identifies a subset
of objects to replicate by filtering the objects in the source Outposts bucket. To choose
additional subsets of objects to replicate, add a rule for each subset. To specify a subset
of the objects in the source Outposts bucket to apply a replication rule to, add the Filter
element as a child of the Rule element. You can filter objects based on an object key
prefix, one or more object tags, or both. When you add the Filter element in the
configuration, you must also add the following elements: DeleteMarkerReplication, Status,
and Priority. Using PutBucketReplication on Outposts requires that both the source and
destination buckets must have versioning enabled. For information about enabling versioning
on a bucket, see Managing S3 Versioning for your S3 on Outposts bucket. For information
about S3 on Outposts replication failure reasons, see Replication failure reasons in the
Amazon S3 User Guide. Handling Replication of Encrypted Objects Outposts buckets are
encrypted at all times. All the objects in the source Outposts bucket are encrypted and can
be replicated. Also, all the replicas in the destination Outposts bucket are encrypted with
the same encryption key as the objects in the source Outposts bucket. Permissions To
create a PutBucketReplication request, you must have
s3-outposts:PutReplicationConfiguration permissions for the bucket. The Outposts bucket
owner has this permission by default and can grant it to others. For more information about
permissions, see Setting up IAM with S3 on Outposts and Managing access to S3 on Outposts
buckets. To perform this operation, the user or role must also have the iam:CreateRole
and iam:PassRole permissions. For more information, see Granting a user permissions to pass
a role to an Amazon Web Services service. All Amazon S3 on Outposts REST API requests for
this action require an additional parameter of x-amz-outpost-id to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of
s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3
on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access
point ARN, see the Examples section. The following operations are related to
PutBucketReplication: GetBucketReplication DeleteBucketReplication
# Arguments
- `replication_configuration`:
- `name`: Specifies the S3 on Outposts bucket to set the configuration for. For using this
parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the
x-amz-outpost-id as well. For using this parameter with S3 on Outposts with the Amazon Web
Services SDK and CLI, you must specify the ARN of the bucket accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<
;my-bucket-name>. For example, to access the bucket reports through Outpost my-outpost
owned by account 123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value
must be URL encoded.
- `x-amz-account-id`: The Amazon Web Services account ID of the Outposts bucket.
"""
function put_bucket_replication(
ReplicationConfiguration,
name,
x_amz_account_id;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"PUT",
"/v20180820/bucket/$(name)/replication",
Dict{String,Any}(
"ReplicationConfiguration" => ReplicationConfiguration,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_bucket_replication(
ReplicationConfiguration,
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"PUT",
"/v20180820/bucket/$(name)/replication",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ReplicationConfiguration" => ReplicationConfiguration,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_bucket_tagging(tagging, name, x-amz-account-id)
put_bucket_tagging(tagging, name, x-amz-account-id, params::Dict{String,<:Any})
This action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see
PutBucketTagging in the Amazon S3 API Reference. Sets the tags for an S3 on Outposts
bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To
do this, sign up to get your Amazon Web Services account bill with tag key values included.
Then, to see the cost of combined resources, organize your billing information according to
resources with the same tag key values. For example, you can tag several resources with a
specific application name, and then organize your billing information to see the total cost
of that application across several services. For more information, see Cost allocation and
tagging. Within a bucket, if you add a tag that has the same key as an existing tag, the
new value overwrites the old value. For more information, see Using cost allocation in
Amazon S3 bucket tags. To use this action, you must have permissions to perform the
s3-outposts:PutBucketTagging action. The Outposts bucket owner has this permission by
default and can grant this permission to others. For more information about permissions,
see Permissions Related to Bucket Subresource Operations and Managing access permissions
to your Amazon S3 resources. PutBucketTagging has the following special errors: Error
code: InvalidTagError Description: The tag provided was not a valid tag. This error can
occur if the tag did not pass input validation. For information about tag restrictions, see
User-Defined Tag Restrictions and Amazon Web Services-Generated Cost Allocation Tag
Restrictions. Error code: MalformedXMLError Description: The XML provided does not
match the schema. Error code: OperationAbortedError Description: A conflicting
conditional action is currently in progress against this resource. Try again. Error
code: InternalError Description: The service was unable to apply the provided tag to the
bucket. All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id to be passed with the request. In addition, you
must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example
of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint
hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the
Examples section. The following actions are related to PutBucketTagging:
GetBucketTagging DeleteBucketTagging
# Arguments
- `tagging`:
- `name`: The Amazon Resource Name (ARN) of the bucket. For using this parameter with
Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id
as well. For using this parameter with S3 on Outposts with the Amazon Web Services SDK and
CLI, you must specify the ARN of the bucket accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<
;my-bucket-name>. For example, to access the bucket reports through Outpost my-outpost
owned by account 123456789012 in Region us-west-2, use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value
must be URL encoded.
- `x-amz-account-id`: The Amazon Web Services account ID of the Outposts bucket.
"""
function put_bucket_tagging(
Tagging, name, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"PUT",
"/v20180820/bucket/$(name)/tagging",
Dict{String,Any}(
"Tagging" => Tagging,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_bucket_tagging(
Tagging,
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"PUT",
"/v20180820/bucket/$(name)/tagging",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Tagging" => Tagging,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_bucket_versioning(versioning_configuration, name, x-amz-account-id)
put_bucket_versioning(versioning_configuration, name, x-amz-account-id, params::Dict{String,<:Any})
This operation sets the versioning state for S3 on Outposts buckets only. To set the
versioning state for an S3 bucket, see PutBucketVersioning in the Amazon S3 API Reference.
Sets the versioning state for an S3 on Outposts bucket. With S3 Versioning, you can save
multiple distinct copies of your objects and recover from unintended user actions and
application failures. You can set the versioning state to one of the following: Enabled
- Enables versioning for the objects in the bucket. All objects added to the bucket receive
a unique version ID. Suspended - Suspends versioning for the objects in the bucket. All
objects added to the bucket receive the version ID null. If you've never set versioning
on your bucket, it has no versioning state. In that case, a GetBucketVersioning request
does not return a versioning state value. When you enable S3 Versioning, for each object in
your bucket, you have a current version and zero or more noncurrent versions. You can
configure your bucket S3 Lifecycle rules to expire noncurrent versions after a specified
time period. For more information, see Creating and managing a lifecycle configuration for
your S3 on Outposts bucket in the Amazon S3 User Guide. If you have an object expiration
lifecycle configuration in your non-versioned bucket and you want to maintain the same
permanent delete behavior when you enable versioning, you must add a noncurrent expiration
policy. The noncurrent expiration lifecycle configuration will manage the deletes of the
noncurrent object versions in the version-enabled bucket. For more information, see
Versioning in the Amazon S3 User Guide. All Amazon S3 on Outposts REST API requests for
this action require an additional parameter of x-amz-outpost-id to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of
s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3
on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access
point ARN, see the Examples section. The following operations are related to
PutBucketVersioning for S3 on Outposts. GetBucketVersioning
PutBucketLifecycleConfiguration GetBucketLifecycleConfiguration
# Arguments
- `versioning_configuration`: The root-level tag for the VersioningConfiguration parameters.
- `name`: The S3 on Outposts bucket to set the versioning state for.
- `x-amz-account-id`: The Amazon Web Services account ID of the S3 on Outposts bucket.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-mfa"`: The concatenation of the authentication device's serial number, a space,
and the value that is displayed on your authentication device.
"""
function put_bucket_versioning(
VersioningConfiguration,
name,
x_amz_account_id;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"PUT",
"/v20180820/bucket/$(name)/versioning",
Dict{String,Any}(
"VersioningConfiguration" => VersioningConfiguration,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_bucket_versioning(
VersioningConfiguration,
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"PUT",
"/v20180820/bucket/$(name)/versioning",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"VersioningConfiguration" => VersioningConfiguration,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_job_tagging(tags, id, x-amz-account-id)
put_job_tagging(tags, id, x-amz-account-id, params::Dict{String,<:Any})
Sets the supplied tag-set on an S3 Batch Operations job. A tag is a key-value pair. You can
associate S3 Batch Operations tags with any job by sending a PUT request against the
tagging subresource that is associated with the job. To modify the existing tag set, you
can either replace the existing tag set entirely, or make changes within the existing tag
set by retrieving the existing tag set using GetJobTagging, modify that tag set, and use
this operation to replace the tag set with the one you modified. For more information, see
Controlling access and labeling jobs using tags in the Amazon S3 User Guide. If you
send this request with an empty tag set, Amazon S3 deletes the existing tag set on the
Batch Operations job. If you use this method, you are charged for a Tier 1 Request (PUT).
For more information, see Amazon S3 pricing. For deleting existing tags for your Batch
Operations job, a DeleteJobTagging request is preferred because it achieves the same result
without incurring charges. A few things to consider about using tags: Amazon S3 limits
the maximum number of tags to 50 tags per job. You can associate up to 50 tags with a job
as long as they have unique tag keys. A tag key can be up to 128 Unicode characters in
length, and tag values can be up to 256 Unicode characters in length. The key and values
are case sensitive. For tagging-related restrictions related to characters and encodings,
see User-Defined Tag Restrictions in the Billing and Cost Management User Guide.
Permissions To use the PutJobTagging operation, you must have permission to perform the
s3:PutJobTagging action. Related actions include: CreateJob GetJobTagging
DeleteJobTagging
# Arguments
- `tags`: The set of tags to associate with the S3 Batch Operations job.
- `id`: The ID for the S3 Batch Operations job whose tags you want to replace.
- `x-amz-account-id`: The Amazon Web Services account ID associated with the S3 Batch
Operations job.
"""
function put_job_tagging(
Tags, id, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"PUT",
"/v20180820/jobs/$(id)/tagging",
Dict{String,Any}(
"Tags" => Tags,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_job_tagging(
Tags,
id,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"PUT",
"/v20180820/jobs/$(id)/tagging",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Tags" => Tags,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_multi_region_access_point_policy(client_token, details, x-amz-account-id)
put_multi_region_access_point_policy(client_token, details, x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Associates an access control policy
with the specified Multi-Region Access Point. Each Multi-Region Access Point can have only
one policy, so a request made to this action replaces any existing policy that is
associated with the specified Multi-Region Access Point. This action will always be routed
to the US West (Oregon) Region. For more information about the restrictions around working
with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations
in the Amazon S3 User Guide. The following actions are related to
PutMultiRegionAccessPointPolicy: GetMultiRegionAccessPointPolicy
GetMultiRegionAccessPointPolicyStatus
# Arguments
- `client_token`: An idempotency token used to identify the request and guarantee that
requests are unique.
- `details`: A container element containing the details of the policy for the Multi-Region
Access Point.
- `x-amz-account-id`: The Amazon Web Services account ID for the owner of the Multi-Region
Access Point.
"""
function put_multi_region_access_point_policy(
ClientToken,
Details,
x_amz_account_id;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"POST",
"/v20180820/async-requests/mrap/put-policy",
Dict{String,Any}(
"ClientToken" => ClientToken,
"Details" => Details,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_multi_region_access_point_policy(
ClientToken,
Details,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"POST",
"/v20180820/async-requests/mrap/put-policy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientToken" => ClientToken,
"Details" => Details,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_public_access_block(public_access_block_configuration, x-amz-account-id)
put_public_access_block(public_access_block_configuration, x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Creates or modifies the
PublicAccessBlock configuration for an Amazon Web Services account. For this operation,
users must have the s3:PutAccountPublicAccessBlock permission. For more information, see
Using Amazon S3 block public access. Related actions include: GetPublicAccessBlock
DeletePublicAccessBlock
# Arguments
- `public_access_block_configuration`: The PublicAccessBlock configuration that you want to
apply to the specified Amazon Web Services account.
- `x-amz-account-id`: The account ID for the Amazon Web Services account whose
PublicAccessBlock configuration you want to set.
"""
function put_public_access_block(
PublicAccessBlockConfiguration,
x_amz_account_id;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"PUT",
"/v20180820/configuration/publicAccessBlock",
Dict{String,Any}(
"PublicAccessBlockConfiguration" => PublicAccessBlockConfiguration,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_public_access_block(
PublicAccessBlockConfiguration,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"PUT",
"/v20180820/configuration/publicAccessBlock",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PublicAccessBlockConfiguration" => PublicAccessBlockConfiguration,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_storage_lens_configuration(storage_lens_configuration, storagelensid, x-amz-account-id)
put_storage_lens_configuration(storage_lens_configuration, storagelensid, x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Puts an Amazon S3 Storage Lens
configuration. For more information about S3 Storage Lens, see Working with Amazon S3
Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics,
see S3 Storage Lens metrics glossary in the Amazon S3 User Guide. To use this action, you
must have permission to perform the s3:PutStorageLensConfiguration action. For more
information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User
Guide.
# Arguments
- `storage_lens_configuration`: The S3 Storage Lens configuration.
- `storagelensid`: The ID of the S3 Storage Lens configuration.
- `x-amz-account-id`: The account ID of the requester.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: The tag set of the S3 Storage Lens configuration. You can set up to a maximum
of 50 tags.
"""
function put_storage_lens_configuration(
StorageLensConfiguration,
storagelensid,
x_amz_account_id;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"PUT",
"/v20180820/storagelens/$(storagelensid)",
Dict{String,Any}(
"StorageLensConfiguration" => StorageLensConfiguration,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_storage_lens_configuration(
StorageLensConfiguration,
storagelensid,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"PUT",
"/v20180820/storagelens/$(storagelensid)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"StorageLensConfiguration" => StorageLensConfiguration,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_storage_lens_configuration_tagging(tag, storagelensid, x-amz-account-id)
put_storage_lens_configuration_tagging(tag, storagelensid, x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Put or replace tags on an existing
Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see
Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3
User Guide. To use this action, you must have permission to perform the
s3:PutStorageLensConfigurationTagging action. For more information, see Setting permissions
to use Amazon S3 Storage Lens in the Amazon S3 User Guide.
# Arguments
- `tag`: The tag set of the S3 Storage Lens configuration. You can set up to a maximum of
50 tags.
- `storagelensid`: The ID of the S3 Storage Lens configuration.
- `x-amz-account-id`: The account ID of the requester.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: The tag set of the S3 Storage Lens configuration. You can set up to a maximum
of 50 tags.
"""
function put_storage_lens_configuration_tagging(
Tag, storagelensid, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"PUT",
"/v20180820/storagelens/$(storagelensid)/tagging",
Dict{String,Any}(
"Tag" => Tag,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_storage_lens_configuration_tagging(
Tag,
storagelensid,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"PUT",
"/v20180820/storagelens/$(storagelensid)/tagging",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Tag" => Tag,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
submit_multi_region_access_point_routes(route, mrap, x-amz-account-id)
submit_multi_region_access_point_routes(route, mrap, x-amz-account-id, params::Dict{String,<:Any})
This operation is not supported by directory buckets. Submits an updated route
configuration for a Multi-Region Access Point. This API operation updates the routing
status for the specified Regions from active to passive, or from passive to active. A value
of 0 indicates a passive status, which means that traffic won't be routed to the specified
Region. A value of 100 indicates an active status, which means that traffic will be routed
to the specified Region. At least one Region must be active at all times. When the routing
configuration is changed, any in-progress operations (uploads, copies, deletes, and so on)
to formerly active Regions will continue to run to their final completion state (success or
failure). The routing configurations of any Regions that aren’t specified remain
unchanged. Updated routing configurations might not be immediately applied. It can take up
to 2 minutes for your changes to take effect. To submit routing control changes and
failover requests, use the Amazon S3 failover control infrastructure endpoints in these
five Amazon Web Services Regions: us-east-1 us-west-2 ap-southeast-2
ap-northeast-1 eu-west-1
# Arguments
- `route`: The different routes that make up the new route configuration. Active routes
return a value of 100, and passive routes return a value of 0.
- `mrap`: The Multi-Region Access Point ARN.
- `x-amz-account-id`: The Amazon Web Services account ID for the owner of the Multi-Region
Access Point.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"RouteUpdates"`: The different routes that make up the new route configuration. Active
routes return a value of 100, and passive routes return a value of 0.
"""
function submit_multi_region_access_point_routes(
Route, mrap, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"PATCH",
"/v20180820/mrap/instances/$(mrap)/routes",
Dict{String,Any}(
"Route" => Route,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function submit_multi_region_access_point_routes(
Route,
mrap,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"PATCH",
"/v20180820/mrap/instances/$(mrap)/routes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Route" => Route,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(tag, resource_arn, x-amz-account-id)
tag_resource(tag, resource_arn, x-amz-account-id, params::Dict{String,<:Any})
Creates a new Amazon Web Services resource tag or updates an existing resource tag. Each
tag is a label consisting of a user-defined key and value. Tags can help you manage,
identify, organize, search for, and filter resources. You can add up to 50 Amazon Web
Services resource tags for each S3 resource. This operation is only supported for S3
Storage Lens groups and for S3 Access Grants. The tagged resource can be an S3 Storage Lens
group or S3 Access Grants instance, registered location, or grant. Permissions You must
have the s3:TagResource permission to use this operation. For more information about the
required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage
Lens groups. For information about S3 Tagging errors, see List of Amazon S3 Tagging error
codes.
# Arguments
- `tag`: The Amazon Web Services resource tags that you want to add to the specified S3
resource.
- `resource_arn`: The Amazon Resource Name (ARN) of the S3 resource that you're trying to
add tags to. The tagged resource can be an S3 Storage Lens group or S3 Access Grants
instance, registered location, or grant.
- `x-amz-account-id`: The Amazon Web Services account ID that created the S3 resource that
you're trying to add tags to or the requester's account ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: The Amazon Web Services resource tags that you want to add to the specified S3
resource.
"""
function tag_resource(
Tag, resourceArn, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"POST",
"/v20180820/tags/$(resourceArn)",
Dict{String,Any}(
"Tag" => Tag,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
Tag,
resourceArn,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"POST",
"/v20180820/tags/$(resourceArn)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Tag" => Tag,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys, x-amz-account-id)
untag_resource(resource_arn, tag_keys, x-amz-account-id, params::Dict{String,<:Any})
This operation removes the specified Amazon Web Services resource tags from an S3
resource. Each tag is a label consisting of a user-defined key and value. Tags can help you
manage, identify, organize, search for, and filter resources. This operation is only
supported for S3 Storage Lens groups and for S3 Access Grants. The tagged resource can be
an S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.
Permissions You must have the s3:UntagResource permission to use this operation. For
more information about the required Storage Lens Groups permissions, see Setting account
permissions to use S3 Storage Lens groups. For information about S3 Tagging errors, see
List of Amazon S3 Tagging error codes.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the S3 resource that you're trying to
remove the tags from.
- `tag_keys`: The array of tag key-value pairs that you're trying to remove from of the S3
resource.
- `x-amz-account-id`: The Amazon Web Services account ID that owns the resource that
you're trying to remove the tags from.
"""
function untag_resource(
resourceArn,
tagKeys,
x_amz_account_id;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"DELETE",
"/v20180820/tags/$(resourceArn)",
Dict{String,Any}(
"tagKeys" => tagKeys,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceArn,
tagKeys,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"DELETE",
"/v20180820/tags/$(resourceArn)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"tagKeys" => tagKeys,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_access_grants_location(iamrole_arn, id, x-amz-account-id)
update_access_grants_location(iamrole_arn, id, x-amz-account-id, params::Dict{String,<:Any})
Updates the IAM role of a registered location in your S3 Access Grants instance.
Permissions You must have the s3:UpdateAccessGrantsLocation permission to use this
operation. Additional Permissions You must also have the following permission:
iam:PassRole
# Arguments
- `iamrole_arn`: The Amazon Resource Name (ARN) of the IAM role for the registered
location. S3 Access Grants assumes this role to manage access to the registered location.
- `id`: The ID of the registered location that you are updating. S3 Access Grants assigns
this ID when you register the location. S3 Access Grants assigns the ID default to the
default location s3:// and assigns an auto-generated ID to other locations that you
register. The ID of the registered location to which you are granting access. S3 Access
Grants assigned this ID when you registered the location. S3 Access Grants assigns the ID
default to the default location s3:// and assigns an auto-generated ID to other locations
that you register. If you are passing the default location, you cannot create an access
grant for the entire default location. You must also specify a bucket or a bucket and
prefix in the Subprefix field.
- `x-amz-account-id`: The ID of the Amazon Web Services account that is making this request.
"""
function update_access_grants_location(
IAMRoleArn, id, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"PUT",
"/v20180820/accessgrantsinstance/location/$(id)",
Dict{String,Any}(
"IAMRoleArn" => IAMRoleArn,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_access_grants_location(
IAMRoleArn,
id,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"PUT",
"/v20180820/accessgrantsinstance/location/$(id)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IAMRoleArn" => IAMRoleArn,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_job_priority(id, priority, x-amz-account-id)
update_job_priority(id, priority, x-amz-account-id, params::Dict{String,<:Any})
Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch
Operations in the Amazon S3 User Guide. Permissions To use the UpdateJobPriority
operation, you must have permission to perform the s3:UpdateJobPriority action. Related
actions include: CreateJob ListJobs DescribeJob UpdateJobStatus
# Arguments
- `id`: The ID for the job whose priority you want to update.
- `priority`: The priority you want to assign to this job.
- `x-amz-account-id`: The Amazon Web Services account ID associated with the S3 Batch
Operations job.
"""
function update_job_priority(
id, priority, x_amz_account_id; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3_control(
"POST",
"/v20180820/jobs/$(id)/priority",
Dict{String,Any}(
"priority" => priority,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_job_priority(
id,
priority,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"POST",
"/v20180820/jobs/$(id)/priority",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"priority" => priority,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_job_status(id, requested_job_status, x-amz-account-id)
update_job_status(id, requested_job_status, x-amz-account-id, params::Dict{String,<:Any})
Updates the status for the specified job. Use this operation to confirm that you want to
run a job or to cancel an existing job. For more information, see S3 Batch Operations in
the Amazon S3 User Guide. Permissions To use the UpdateJobStatus operation, you must have
permission to perform the s3:UpdateJobStatus action. Related actions include:
CreateJob ListJobs DescribeJob UpdateJobStatus
# Arguments
- `id`: The ID of the job whose status you want to update.
- `requested_job_status`: The status that you want to move the specified job to.
- `x-amz-account-id`: The Amazon Web Services account ID associated with the S3 Batch
Operations job.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"statusUpdateReason"`: A description of the reason why you want to change the specified
job's status. This field can be any string up to the maximum length.
"""
function update_job_status(
id,
requestedJobStatus,
x_amz_account_id;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"POST",
"/v20180820/jobs/$(id)/status",
Dict{String,Any}(
"requestedJobStatus" => requestedJobStatus,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_job_status(
id,
requestedJobStatus,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"POST",
"/v20180820/jobs/$(id)/status",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"requestedJobStatus" => requestedJobStatus,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_storage_lens_group(storage_lens_group, name, x-amz-account-id)
update_storage_lens_group(storage_lens_group, name, x-amz-account-id, params::Dict{String,<:Any})
Updates the existing Storage Lens group. To use this operation, you must have the
permission to perform the s3:UpdateStorageLensGroup action. For more information about the
required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage
Lens groups. For information about Storage Lens groups errors, see List of Amazon S3
Storage Lens error codes.
# Arguments
- `storage_lens_group`: The JSON file that contains the Storage Lens group configuration.
- `name`: The name of the Storage Lens group that you want to update.
- `x-amz-account-id`: The Amazon Web Services account ID of the Storage Lens group owner.
"""
function update_storage_lens_group(
StorageLensGroup,
name,
x_amz_account_id;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"PUT",
"/v20180820/storagelensgroup/$(name)",
Dict{String,Any}(
"StorageLensGroup" => StorageLensGroup,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_id),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_storage_lens_group(
StorageLensGroup,
name,
x_amz_account_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3_control(
"PUT",
"/v20180820/storagelensgroup/$(name)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"StorageLensGroup" => StorageLensGroup,
"headers" => Dict{String,Any}("x-amz-account-id" => x_amz_account_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 | 7522 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: s3outposts
using AWS.Compat
using AWS.UUIDs
"""
create_endpoint(outpost_id, security_group_id, subnet_id)
create_endpoint(outpost_id, security_group_id, subnet_id, params::Dict{String,<:Any})
Creates an endpoint and associates it with the specified Outpost. It can take up to 5
minutes for this action to finish. Related actions include: DeleteEndpoint
ListEndpoints
# Arguments
- `outpost_id`: The ID of the Outposts.
- `security_group_id`: The ID of the security group to use with the endpoint.
- `subnet_id`: The ID of the subnet in the selected VPC. The endpoint subnet must belong to
the Outpost that has Amazon S3 on Outposts provisioned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccessType"`: The type of access for the network connectivity for the Amazon S3 on
Outposts endpoint. To use the Amazon Web Services VPC, choose Private. To use the endpoint
with an on-premises network, choose CustomerOwnedIp. If you choose CustomerOwnedIp, you
must also provide the customer-owned IP address pool (CoIP pool). Private is the default
access type value.
- `"CustomerOwnedIpv4Pool"`: The ID of the customer-owned IPv4 address pool (CoIP pool) for
the endpoint. IP addresses are allocated from this pool for the endpoint.
"""
function create_endpoint(
OutpostId, SecurityGroupId, SubnetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3outposts(
"POST",
"/S3Outposts/CreateEndpoint",
Dict{String,Any}(
"OutpostId" => OutpostId,
"SecurityGroupId" => SecurityGroupId,
"SubnetId" => SubnetId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_endpoint(
OutpostId,
SecurityGroupId,
SubnetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3outposts(
"POST",
"/S3Outposts/CreateEndpoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"OutpostId" => OutpostId,
"SecurityGroupId" => SecurityGroupId,
"SubnetId" => SubnetId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_endpoint(endpoint_id, outpost_id)
delete_endpoint(endpoint_id, outpost_id, params::Dict{String,<:Any})
Deletes an endpoint. It can take up to 5 minutes for this action to finish. Related
actions include: CreateEndpoint ListEndpoints
# Arguments
- `endpoint_id`: The ID of the endpoint.
- `outpost_id`: The ID of the Outposts.
"""
function delete_endpoint(
endpointId, outpostId; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3outposts(
"DELETE",
"/S3Outposts/DeleteEndpoint",
Dict{String,Any}("endpointId" => endpointId, "outpostId" => outpostId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_endpoint(
endpointId,
outpostId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3outposts(
"DELETE",
"/S3Outposts/DeleteEndpoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("endpointId" => endpointId, "outpostId" => outpostId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_endpoints()
list_endpoints(params::Dict{String,<:Any})
Lists endpoints associated with the specified Outpost. Related actions include:
CreateEndpoint DeleteEndpoint
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of endpoints that will be returned in the response.
- `"nextToken"`: If a previous response from this operation included a NextToken value,
provide that value here to retrieve the next page of results.
"""
function list_endpoints(; aws_config::AbstractAWSConfig=global_aws_config())
return s3outposts(
"GET",
"/S3Outposts/ListEndpoints";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_endpoints(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3outposts(
"GET",
"/S3Outposts/ListEndpoints",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_outposts_with_s3()
list_outposts_with_s3(params::Dict{String,<:Any})
Lists the Outposts with S3 on Outposts capacity for your Amazon Web Services account.
Includes S3 on Outposts that you have access to as the Outposts owner, or as a shared user
from Resource Access Manager (RAM).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of Outposts to return. The limit is 100.
- `"nextToken"`: When you can get additional results from the ListOutpostsWithS3 call, a
NextToken parameter is returned in the output. You can then pass in a subsequent command to
the NextToken parameter to continue listing additional Outposts.
"""
function list_outposts_with_s3(; aws_config::AbstractAWSConfig=global_aws_config())
return s3outposts(
"GET",
"/S3Outposts/ListOutpostsWithS3";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_outposts_with_s3(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return s3outposts(
"GET",
"/S3Outposts/ListOutpostsWithS3",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_shared_endpoints(outpost_id)
list_shared_endpoints(outpost_id, params::Dict{String,<:Any})
Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services
Resource Access Manager (RAM). Related actions include: CreateEndpoint
DeleteEndpoint
# Arguments
- `outpost_id`: The ID of the Amazon Web Services Outpost.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of endpoints that will be returned in the response.
- `"nextToken"`: If a previous response from this operation included a NextToken value, you
can provide that value here to retrieve the next page of results.
"""
function list_shared_endpoints(outpostId; aws_config::AbstractAWSConfig=global_aws_config())
return s3outposts(
"GET",
"/S3Outposts/ListSharedEndpoints",
Dict{String,Any}("outpostId" => outpostId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_shared_endpoints(
outpostId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return s3outposts(
"GET",
"/S3Outposts/ListSharedEndpoints",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("outpostId" => outpostId), 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 | 603760 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: sagemaker
using AWS.Compat
using AWS.UUIDs
"""
add_association(destination_arn, source_arn)
add_association(destination_arn, source_arn, params::Dict{String,<:Any})
Creates an association between the source and the destination. A source can be associated
with multiple destinations, and a destination can be associated with multiple sources. An
association is a lineage tracking entity. For more information, see Amazon SageMaker ML
Lineage Tracking.
# Arguments
- `destination_arn`: The Amazon Resource Name (ARN) of the destination.
- `source_arn`: The ARN of the source.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AssociationType"`: The type of association. The following are suggested uses for each
type. Amazon SageMaker places no restrictions on their use. ContributedTo - The source
contributed to the destination or had a part in enabling the destination. For example, the
training data contributed to the training job. AssociatedWith - The source is connected
to the destination. For example, an approval workflow is associated with a model
deployment. DerivedFrom - The destination is a modification of the source. For example, a
digest output of a channel input for a processing job is derived from the original inputs.
Produced - The source generated the destination. For example, a training job produced a
model artifact.
"""
function add_association(
DestinationArn, SourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"AddAssociation",
Dict{String,Any}("DestinationArn" => DestinationArn, "SourceArn" => SourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_association(
DestinationArn,
SourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"AddAssociation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DestinationArn" => DestinationArn, "SourceArn" => SourceArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_tags(resource_arn, tags)
add_tags(resource_arn, tags, params::Dict{String,<:Any})
Adds or overwrites one or more tags for the specified SageMaker resource. You can add tags
to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs,
models, labeling jobs, work teams, endpoint configurations, and endpoints. Each tag
consists of a key and an optional value. Tag keys must be unique per resource. For more
information about tags, see For more information, see Amazon Web Services Tagging
Strategies. Tags that you add to a hyperparameter tuning job by calling this API are also
added to any training jobs that the hyperparameter tuning job launches after you call this
API, but not to training jobs that the hyperparameter tuning job launched before you called
this API. To make sure that the tags associated with a hyperparameter tuning job are also
added to all training jobs that the hyperparameter tuning job launches, add the tags when
you first create the tuning job by specifying them in the Tags parameter of
CreateHyperParameterTuningJob Tags that you add to a SageMaker Domain or User Profile by
calling this API are also added to any Apps that the Domain or User Profile launches after
you call this API, but not to Apps that the Domain or User Profile launched before you
called this API. To make sure that the tags associated with a Domain or User Profile are
also added to all Apps that the Domain or User Profile launches, add the tags when you
first create the Domain or User Profile by specifying them in the Tags parameter of
CreateDomain or CreateUserProfile.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource that you want to tag.
- `tags`: An array of key-value pairs. You can use tags to categorize your Amazon Web
Services resources in different ways, for example, by purpose, owner, or environment. For
more information, see Tagging Amazon Web Services Resources.
"""
function add_tags(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"AddTags",
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_tags(
ResourceArn,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"AddTags",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_trial_component(trial_component_name, trial_name)
associate_trial_component(trial_component_name, trial_name, params::Dict{String,<:Any})
Associates a trial component with a trial. A trial component can be associated with
multiple trials. To disassociate a trial component from a trial, call the
DisassociateTrialComponent API.
# Arguments
- `trial_component_name`: The name of the component to associated with the trial.
- `trial_name`: The name of the trial to associate with.
"""
function associate_trial_component(
TrialComponentName, TrialName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"AssociateTrialComponent",
Dict{String,Any}(
"TrialComponentName" => TrialComponentName, "TrialName" => TrialName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_trial_component(
TrialComponentName,
TrialName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"AssociateTrialComponent",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TrialComponentName" => TrialComponentName, "TrialName" => TrialName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_describe_model_package(model_package_arn_list)
batch_describe_model_package(model_package_arn_list, params::Dict{String,<:Any})
This action batch describes a list of versioned model packages
# Arguments
- `model_package_arn_list`: The list of Amazon Resource Name (ARN) of the model package
groups.
"""
function batch_describe_model_package(
ModelPackageArnList; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"BatchDescribeModelPackage",
Dict{String,Any}("ModelPackageArnList" => ModelPackageArnList);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_describe_model_package(
ModelPackageArnList,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"BatchDescribeModelPackage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ModelPackageArnList" => ModelPackageArnList),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_action(action_name, action_type, source)
create_action(action_name, action_type, source, params::Dict{String,<:Any})
Creates an action. An action is a lineage tracking entity that represents an action or
activity. For example, a model deployment or an HPO job. Generally, an action involves at
least one input or output artifact. For more information, see Amazon SageMaker ML Lineage
Tracking.
# Arguments
- `action_name`: The name of the action. Must be unique to your account in an Amazon Web
Services Region.
- `action_type`: The action type.
- `source`: The source type, ID, and URI.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description of the action.
- `"MetadataProperties"`:
- `"Properties"`: A list of properties to add to the action.
- `"Status"`: The status of the action.
- `"Tags"`: A list of tags to apply to the action.
"""
function create_action(
ActionName, ActionType, Source; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"CreateAction",
Dict{String,Any}(
"ActionName" => ActionName, "ActionType" => ActionType, "Source" => Source
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_action(
ActionName,
ActionType,
Source,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateAction",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ActionName" => ActionName,
"ActionType" => ActionType,
"Source" => Source,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_algorithm(algorithm_name, training_specification)
create_algorithm(algorithm_name, training_specification, params::Dict{String,<:Any})
Create a machine learning algorithm that you can use in SageMaker and list in the Amazon
Web Services Marketplace.
# Arguments
- `algorithm_name`: The name of the algorithm.
- `training_specification`: Specifies details about training jobs run by this algorithm,
including the following: The Amazon ECR path of the container and the version digest of
the algorithm. The hyperparameters that the algorithm supports. The instance types that
the algorithm supports for training. Whether the algorithm supports distributed training.
The metrics that the algorithm emits to Amazon CloudWatch. Which metrics that the
algorithm emits can be used as the objective metric for hyperparameter tuning jobs. The
input channels that the algorithm supports for training data. For example, an algorithm
might support train, validation, and test channels.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AlgorithmDescription"`: A description of the algorithm.
- `"CertifyForMarketplace"`: Whether to certify the algorithm so that it can be listed in
Amazon Web Services Marketplace.
- `"InferenceSpecification"`: Specifies details about inference jobs that the algorithm
runs, including the following: The Amazon ECR paths of containers that contain the
inference code and model artifacts. The instance types that the algorithm supports for
transform jobs and real-time endpoints used for inference. The input and output content
formats that the algorithm supports for inference.
- `"Tags"`: An array of key-value pairs. You can use tags to categorize your Amazon Web
Services resources in different ways, for example, by purpose, owner, or environment. For
more information, see Tagging Amazon Web Services Resources.
- `"ValidationSpecification"`: Specifies configurations for one or more training jobs and
that SageMaker runs to test the algorithm's training code and, optionally, one or more
batch transform jobs that SageMaker runs to test the algorithm's inference code.
"""
function create_algorithm(
AlgorithmName, TrainingSpecification; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"CreateAlgorithm",
Dict{String,Any}(
"AlgorithmName" => AlgorithmName,
"TrainingSpecification" => TrainingSpecification,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_algorithm(
AlgorithmName,
TrainingSpecification,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateAlgorithm",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AlgorithmName" => AlgorithmName,
"TrainingSpecification" => TrainingSpecification,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_app(app_name, app_type, domain_id)
create_app(app_name, app_type, domain_id, params::Dict{String,<:Any})
Creates a running app for the specified UserProfile. This operation is automatically
invoked by Amazon SageMaker upon access to the associated Domain, and when new kernel
configurations are selected by the user. A user may have multiple Apps active
simultaneously.
# Arguments
- `app_name`: The name of the app.
- `app_type`: The type of app.
- `domain_id`: The domain ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ResourceSpec"`: The instance type and the Amazon Resource Name (ARN) of the SageMaker
image created on the instance. The value of InstanceType passed as part of the
ResourceSpec in the CreateApp call overrides the value passed as part of the ResourceSpec
configured for the user profile or the domain. If InstanceType is not specified in any of
those three ResourceSpec values for a KernelGateway app, the CreateApp call fails with a
request validation error.
- `"SpaceName"`: The name of the space. If this value is not set, then UserProfileName must
be set.
- `"Tags"`: Each tag consists of a key and an optional value. Tag keys must be unique per
resource.
- `"UserProfileName"`: The user profile name. If this value is not set, then SpaceName must
be set.
"""
function create_app(
AppName, AppType, DomainId; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"CreateApp",
Dict{String,Any}(
"AppName" => AppName, "AppType" => AppType, "DomainId" => DomainId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_app(
AppName,
AppType,
DomainId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateApp",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AppName" => AppName, "AppType" => AppType, "DomainId" => DomainId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_app_image_config(app_image_config_name)
create_app_image_config(app_image_config_name, params::Dict{String,<:Any})
Creates a configuration for running a SageMaker image as a KernelGateway app. The
configuration specifies the Amazon Elastic File System storage volume on the image, and a
list of the kernels in the image.
# Arguments
- `app_image_config_name`: The name of the AppImageConfig. Must be unique to your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CodeEditorAppImageConfig"`: The CodeEditorAppImageConfig. You can only specify one
image kernel in the AppImageConfig API. This kernel is shown to users before the image
starts. After the image runs, all kernels are visible in Code Editor.
- `"JupyterLabAppImageConfig"`: The JupyterLabAppImageConfig. You can only specify one
image kernel in the AppImageConfig API. This kernel is shown to users before the image
starts. After the image runs, all kernels are visible in JupyterLab.
- `"KernelGatewayImageConfig"`: The KernelGatewayImageConfig. You can only specify one
image kernel in the AppImageConfig API. This kernel will be shown to users before the image
starts. Once the image runs, all kernels are visible in JupyterLab.
- `"Tags"`: A list of tags to apply to the AppImageConfig.
"""
function create_app_image_config(
AppImageConfigName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"CreateAppImageConfig",
Dict{String,Any}("AppImageConfigName" => AppImageConfigName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_app_image_config(
AppImageConfigName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateAppImageConfig",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("AppImageConfigName" => AppImageConfigName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_artifact(artifact_type, source)
create_artifact(artifact_type, source, params::Dict{String,<:Any})
Creates an artifact. An artifact is a lineage tracking entity that represents a URI
addressable object or data. Some examples are the S3 URI of a dataset and the ECR registry
path of an image. For more information, see Amazon SageMaker ML Lineage Tracking.
# Arguments
- `artifact_type`: The artifact type.
- `source`: The ID, ID type, and URI of the source.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ArtifactName"`: The name of the artifact. Must be unique to your account in an Amazon
Web Services Region.
- `"MetadataProperties"`:
- `"Properties"`: A list of properties to add to the artifact.
- `"Tags"`: A list of tags to apply to the artifact.
"""
function create_artifact(
ArtifactType, Source; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"CreateArtifact",
Dict{String,Any}("ArtifactType" => ArtifactType, "Source" => Source);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_artifact(
ArtifactType,
Source,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateArtifact",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ArtifactType" => ArtifactType, "Source" => Source),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_auto_mljob(auto_mljob_name, input_data_config, output_data_config, role_arn)
create_auto_mljob(auto_mljob_name, input_data_config, output_data_config, role_arn, params::Dict{String,<:Any})
Creates an Autopilot job also referred to as Autopilot experiment or AutoML job. We
recommend using the new versions CreateAutoMLJobV2 and DescribeAutoMLJobV2, which offer
backward compatibility. CreateAutoMLJobV2 can manage tabular problem types identical to
those of its previous version CreateAutoMLJob, as well as time-series forecasting,
non-tabular problem types such as image or text classification, and text generation (LLMs
fine-tuning). Find guidelines about how to migrate a CreateAutoMLJob to CreateAutoMLJobV2
in Migrate a CreateAutoMLJob to CreateAutoMLJobV2. You can find the best-performing model
after you run an AutoML job by calling DescribeAutoMLJobV2 (recommended) or
DescribeAutoMLJob.
# Arguments
- `auto_mljob_name`: Identifies an Autopilot job. The name must be unique to your account
and is case insensitive.
- `input_data_config`: An array of channel objects that describes the input data and its
location. Each channel is a named input source. Similar to InputDataConfig supported by
HyperParameterTrainingJobDefinition. Format(s) supported: CSV, Parquet. A minimum of 500
rows is required for the training dataset. There is not a minimum number of rows required
for the validation dataset.
- `output_data_config`: Provides information about encryption and the Amazon S3 output path
needed to store artifacts from an AutoML job. Format(s) supported: CSV.
- `role_arn`: The ARN of the role that is used to access the data.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AutoMLJobConfig"`: A collection of settings used to configure an AutoML job.
- `"AutoMLJobObjective"`: Specifies a metric to minimize or maximize as the objective of a
job. If not specified, the default objective metric depends on the problem type. See
AutoMLJobObjective for the default values.
- `"GenerateCandidateDefinitionsOnly"`: Generates possible candidates without training the
models. A candidate is a combination of data preprocessors, algorithms, and algorithm
parameter settings.
- `"ModelDeployConfig"`: Specifies how to generate the endpoint name for an automatic
one-click Autopilot model deployment.
- `"ProblemType"`: Defines the type of supervised learning problem available for the
candidates. For more information, see SageMaker Autopilot problem types.
- `"Tags"`: An array of key-value pairs. You can use tags to categorize your Amazon Web
Services resources in different ways, for example, by purpose, owner, or environment. For
more information, see Tagging Amazon Web ServicesResources. Tag keys must be unique per
resource.
"""
function create_auto_mljob(
AutoMLJobName,
InputDataConfig,
OutputDataConfig,
RoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateAutoMLJob",
Dict{String,Any}(
"AutoMLJobName" => AutoMLJobName,
"InputDataConfig" => InputDataConfig,
"OutputDataConfig" => OutputDataConfig,
"RoleArn" => RoleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_auto_mljob(
AutoMLJobName,
InputDataConfig,
OutputDataConfig,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateAutoMLJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AutoMLJobName" => AutoMLJobName,
"InputDataConfig" => InputDataConfig,
"OutputDataConfig" => OutputDataConfig,
"RoleArn" => RoleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_auto_mljob_v2(auto_mljob_input_data_config, auto_mljob_name, auto_mlproblem_type_config, output_data_config, role_arn)
create_auto_mljob_v2(auto_mljob_input_data_config, auto_mljob_name, auto_mlproblem_type_config, output_data_config, role_arn, params::Dict{String,<:Any})
Creates an Autopilot job also referred to as Autopilot experiment or AutoML job V2.
CreateAutoMLJobV2 and DescribeAutoMLJobV2 are new versions of CreateAutoMLJob and
DescribeAutoMLJob which offer backward compatibility. CreateAutoMLJobV2 can manage tabular
problem types identical to those of its previous version CreateAutoMLJob, as well as
time-series forecasting, non-tabular problem types such as image or text classification,
and text generation (LLMs fine-tuning). Find guidelines about how to migrate a
CreateAutoMLJob to CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.
For the list of available problem types supported by CreateAutoMLJobV2, see
AutoMLProblemTypeConfig. You can find the best-performing model after you run an AutoML job
V2 by calling DescribeAutoMLJobV2.
# Arguments
- `auto_mljob_input_data_config`: An array of channel objects describing the input data and
their location. Each channel is a named input source. Similar to the InputDataConfig
attribute in the CreateAutoMLJob input parameters. The supported formats depend on the
problem type: For tabular problem types: S3Prefix, ManifestFile. For image
classification: S3Prefix, ManifestFile, AugmentedManifestFile. For text classification:
S3Prefix. For time-series forecasting: S3Prefix. For text generation (LLMs
fine-tuning): S3Prefix.
- `auto_mljob_name`: Identifies an Autopilot job. The name must be unique to your account
and is case insensitive.
- `auto_mlproblem_type_config`: Defines the configuration settings of one of the supported
problem types.
- `output_data_config`: Provides information about encryption and the Amazon S3 output path
needed to store artifacts from an AutoML job.
- `role_arn`: The ARN of the role that is used to access the data.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AutoMLJobObjective"`: Specifies a metric to minimize or maximize as the objective of a
job. If not specified, the default objective metric depends on the problem type. For the
list of default values per problem type, see AutoMLJobObjective. For tabular problem
types: You must either provide both the AutoMLJobObjective and indicate the type of
supervised learning problem in AutoMLProblemTypeConfig (TabularJobConfig.ProblemType), or
none at all. For text generation problem types (LLMs fine-tuning): Fine-tuning language
models in Autopilot does not require setting the AutoMLJobObjective field. Autopilot
fine-tunes LLMs without requiring multiple candidates to be trained and evaluated. Instead,
using your dataset, Autopilot directly fine-tunes your target model to enhance a default
objective metric, the cross-entropy loss. After fine-tuning a language model, you can
evaluate the quality of its generated text using different metrics. For a list of the
available metrics, see Metrics for fine-tuning LLMs in Autopilot.
- `"DataSplitConfig"`: This structure specifies how to split the data into train and
validation datasets. The validation and training datasets must contain the same headers.
For jobs created by calling CreateAutoMLJob, the validation dataset must be less than 2 GB
in size. This attribute must not be set for the time-series forecasting problem type, as
Autopilot automatically splits the input dataset into training and validation sets.
- `"ModelDeployConfig"`: Specifies how to generate the endpoint name for an automatic
one-click Autopilot model deployment.
- `"SecurityConfig"`: The security configuration for traffic encryption or Amazon VPC
settings.
- `"Tags"`: An array of key-value pairs. You can use tags to categorize your Amazon Web
Services resources in different ways, such as by purpose, owner, or environment. For more
information, see Tagging Amazon Web ServicesResources. Tag keys must be unique per resource.
"""
function create_auto_mljob_v2(
AutoMLJobInputDataConfig,
AutoMLJobName,
AutoMLProblemTypeConfig,
OutputDataConfig,
RoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateAutoMLJobV2",
Dict{String,Any}(
"AutoMLJobInputDataConfig" => AutoMLJobInputDataConfig,
"AutoMLJobName" => AutoMLJobName,
"AutoMLProblemTypeConfig" => AutoMLProblemTypeConfig,
"OutputDataConfig" => OutputDataConfig,
"RoleArn" => RoleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_auto_mljob_v2(
AutoMLJobInputDataConfig,
AutoMLJobName,
AutoMLProblemTypeConfig,
OutputDataConfig,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateAutoMLJobV2",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AutoMLJobInputDataConfig" => AutoMLJobInputDataConfig,
"AutoMLJobName" => AutoMLJobName,
"AutoMLProblemTypeConfig" => AutoMLProblemTypeConfig,
"OutputDataConfig" => OutputDataConfig,
"RoleArn" => RoleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_cluster(cluster_name, instance_groups)
create_cluster(cluster_name, instance_groups, params::Dict{String,<:Any})
Creates a SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for
creating and managing persistent clusters for developing large machine learning models,
such as large language models (LLMs) and diffusion models. To learn more, see Amazon
SageMaker HyperPod in the Amazon SageMaker Developer Guide.
# Arguments
- `cluster_name`: The name for the new SageMaker HyperPod cluster.
- `instance_groups`: The instance groups to be created in the SageMaker HyperPod cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web
Services resource. You can add tags to your cluster in the same way you add them in other
Amazon Web Services services that support tagging. To learn more about tagging Amazon Web
Services resources in general, see Tagging Amazon Web Services Resources User Guide.
- `"VpcConfig"`:
"""
function create_cluster(
ClusterName, InstanceGroups; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"CreateCluster",
Dict{String,Any}("ClusterName" => ClusterName, "InstanceGroups" => InstanceGroups);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_cluster(
ClusterName,
InstanceGroups,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClusterName" => ClusterName, "InstanceGroups" => InstanceGroups
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_code_repository(code_repository_name, git_config)
create_code_repository(code_repository_name, git_config, params::Dict{String,<:Any})
Creates a Git repository as a resource in your SageMaker account. You can associate the
repository with notebook instances so that you can use Git source control for the notebooks
you create. The Git repository is a resource in your SageMaker account, so it can be
associated with more than one notebook instance, and it persists independently from the
lifecycle of any notebook instances it is associated with. The repository can be hosted
either in Amazon Web Services CodeCommit or in any other Git repository.
# Arguments
- `code_repository_name`: The name of the Git repository. The name must have 1 to 63
characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).
- `git_config`: Specifies details about the repository, including the URL where the
repository is located, the default branch, and credentials to use to access the repository.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: An array of key-value pairs. You can use tags to categorize your Amazon Web
Services resources in different ways, for example, by purpose, owner, or environment. For
more information, see Tagging Amazon Web Services Resources.
"""
function create_code_repository(
CodeRepositoryName, GitConfig; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"CreateCodeRepository",
Dict{String,Any}(
"CodeRepositoryName" => CodeRepositoryName, "GitConfig" => GitConfig
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_code_repository(
CodeRepositoryName,
GitConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateCodeRepository",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CodeRepositoryName" => CodeRepositoryName, "GitConfig" => GitConfig
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_compilation_job(compilation_job_name, output_config, role_arn, stopping_condition)
create_compilation_job(compilation_job_name, output_config, role_arn, stopping_condition, params::Dict{String,<:Any})
Starts a model compilation job. After the model has been compiled, Amazon SageMaker saves
the resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that
you specify. If you choose to host your model using Amazon SageMaker hosting services, you
can use the resulting model artifacts as part of the model. You can also use the artifacts
with Amazon Web Services IoT Greengrass. In that case, deploy them as an ML resource. In
the request body, you provide the following: A name for the compilation job
Information about the input model artifacts The output location for the compiled model
and the device (target) that the model runs on The Amazon Resource Name (ARN) of the IAM
role that Amazon SageMaker assumes to perform the model compilation job. You can also
provide a Tag to track the model compilation job's resource use and costs. The response
body contains the CompilationJobArn for the compiled job. To stop a model compilation job,
use StopCompilationJob. To get information about a particular model compilation job, use
DescribeCompilationJob. To get information about multiple model compilation jobs, use
ListCompilationJobs.
# Arguments
- `compilation_job_name`: A name for the model compilation job. The name must be unique
within the Amazon Web Services Region and within your Amazon Web Services account.
- `output_config`: Provides information about the output location for the compiled model
and the target device the model runs on.
- `role_arn`: The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker
to perform tasks on your behalf. During model compilation, Amazon SageMaker needs your
permission to: Read input data from an S3 bucket Write model artifacts to an S3 bucket
Write logs to Amazon CloudWatch Logs Publish metrics to Amazon CloudWatch You grant
permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker,
the caller of this API must have the iam:PassRole permission. For more information, see
Amazon SageMaker Roles.
- `stopping_condition`: Specifies a limit to how long a model compilation job can run. When
the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to
cap model training costs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InputConfig"`: Provides information about the location of input model artifacts, the
name and shape of the expected data inputs, and the framework in which the model was
trained.
- `"ModelPackageVersionArn"`: The Amazon Resource Name (ARN) of a versioned model package.
Provide either a ModelPackageVersionArn or an InputConfig object in the request syntax. The
presence of both objects in the CreateCompilationJob request will return an exception.
- `"Tags"`: An array of key-value pairs. You can use tags to categorize your Amazon Web
Services resources in different ways, for example, by purpose, owner, or environment. For
more information, see Tagging Amazon Web Services Resources.
- `"VpcConfig"`: A VpcConfig object that specifies the VPC that you want your compilation
job to connect to. Control access to your models by configuring the VPC. For more
information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.
"""
function create_compilation_job(
CompilationJobName,
OutputConfig,
RoleArn,
StoppingCondition;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateCompilationJob",
Dict{String,Any}(
"CompilationJobName" => CompilationJobName,
"OutputConfig" => OutputConfig,
"RoleArn" => RoleArn,
"StoppingCondition" => StoppingCondition,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_compilation_job(
CompilationJobName,
OutputConfig,
RoleArn,
StoppingCondition,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateCompilationJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CompilationJobName" => CompilationJobName,
"OutputConfig" => OutputConfig,
"RoleArn" => RoleArn,
"StoppingCondition" => StoppingCondition,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_context(context_name, context_type, source)
create_context(context_name, context_type, source, params::Dict{String,<:Any})
Creates a context. A context is a lineage tracking entity that represents a logical
grouping of other tracking or experiment entities. Some examples are an endpoint and a
model package. For more information, see Amazon SageMaker ML Lineage Tracking.
# Arguments
- `context_name`: The name of the context. Must be unique to your account in an Amazon Web
Services Region.
- `context_type`: The context type.
- `source`: The source type, ID, and URI.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description of the context.
- `"Properties"`: A list of properties to add to the context.
- `"Tags"`: A list of tags to apply to the context.
"""
function create_context(
ContextName, ContextType, Source; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"CreateContext",
Dict{String,Any}(
"ContextName" => ContextName, "ContextType" => ContextType, "Source" => Source
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_context(
ContextName,
ContextType,
Source,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateContext",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ContextName" => ContextName,
"ContextType" => ContextType,
"Source" => Source,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_data_quality_job_definition(data_quality_app_specification, data_quality_job_input, data_quality_job_output_config, job_definition_name, job_resources, role_arn)
create_data_quality_job_definition(data_quality_app_specification, data_quality_job_input, data_quality_job_output_config, job_definition_name, job_resources, role_arn, params::Dict{String,<:Any})
Creates a definition for a job that monitors data quality and drift. For information about
model monitor, see Amazon SageMaker Model Monitor.
# Arguments
- `data_quality_app_specification`: Specifies the container that runs the monitoring job.
- `data_quality_job_input`: A list of inputs for the monitoring job. Currently endpoints
are supported as monitoring inputs.
- `data_quality_job_output_config`:
- `job_definition_name`: The name for the monitoring job definition.
- `job_resources`:
- `role_arn`: The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can
assume to perform tasks on your behalf.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataQualityBaselineConfig"`: Configures the constraints and baselines for the
monitoring job.
- `"NetworkConfig"`: Specifies networking configuration for the monitoring job.
- `"StoppingCondition"`:
- `"Tags"`: (Optional) An array of key-value pairs. For more information, see Using Cost
Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
"""
function create_data_quality_job_definition(
DataQualityAppSpecification,
DataQualityJobInput,
DataQualityJobOutputConfig,
JobDefinitionName,
JobResources,
RoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateDataQualityJobDefinition",
Dict{String,Any}(
"DataQualityAppSpecification" => DataQualityAppSpecification,
"DataQualityJobInput" => DataQualityJobInput,
"DataQualityJobOutputConfig" => DataQualityJobOutputConfig,
"JobDefinitionName" => JobDefinitionName,
"JobResources" => JobResources,
"RoleArn" => RoleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_data_quality_job_definition(
DataQualityAppSpecification,
DataQualityJobInput,
DataQualityJobOutputConfig,
JobDefinitionName,
JobResources,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateDataQualityJobDefinition",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DataQualityAppSpecification" => DataQualityAppSpecification,
"DataQualityJobInput" => DataQualityJobInput,
"DataQualityJobOutputConfig" => DataQualityJobOutputConfig,
"JobDefinitionName" => JobDefinitionName,
"JobResources" => JobResources,
"RoleArn" => RoleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_device_fleet(device_fleet_name, output_config)
create_device_fleet(device_fleet_name, output_config, params::Dict{String,<:Any})
Creates a device fleet.
# Arguments
- `device_fleet_name`: The name of the fleet that the device belongs to.
- `output_config`: The output configuration for storing sample data collected by the fleet.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the fleet.
- `"EnableIotRoleAlias"`: Whether to create an Amazon Web Services IoT Role Alias during
device fleet creation. The name of the role alias generated will match this pattern:
\"SageMakerEdge-{DeviceFleetName}\". For example, if your device fleet is called
\"demo-fleet\", the name of the role alias will be \"SageMakerEdge-demo-fleet\".
- `"RoleArn"`: The Amazon Resource Name (ARN) that has access to Amazon Web Services
Internet of Things (IoT).
- `"Tags"`: Creates tags for the specified fleet.
"""
function create_device_fleet(
DeviceFleetName, OutputConfig; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"CreateDeviceFleet",
Dict{String,Any}(
"DeviceFleetName" => DeviceFleetName, "OutputConfig" => OutputConfig
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_device_fleet(
DeviceFleetName,
OutputConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateDeviceFleet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DeviceFleetName" => DeviceFleetName, "OutputConfig" => OutputConfig
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_domain(auth_mode, default_user_settings, domain_name, subnet_ids, vpc_id)
create_domain(auth_mode, default_user_settings, domain_name, subnet_ids, vpc_id, params::Dict{String,<:Any})
Creates a Domain. A domain consists of an associated Amazon Elastic File System volume, a
list of authorized users, and a variety of security, application, policy, and Amazon
Virtual Private Cloud (VPC) configurations. Users within a domain can share notebook files
and other artifacts with each other. EFS storage When a domain is created, an EFS volume
is created for use by all of the users within the domain. Each user receives a private home
directory within the EFS volume for notebooks, Git repositories, and data files. SageMaker
uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt
the EFS volume attached to the domain with an Amazon Web Services managed key by default.
For more control, you can specify a customer managed key. For more information, see Protect
Data at Rest Using Encryption. VPC configuration All traffic between the domain and the
Amazon EFS volume is through the specified VPC and subnets. For other traffic, you can
specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network
access type that you choose when you onboard to the domain. The following options are
available: PublicInternetOnly - Non-EFS traffic goes through a VPC managed by Amazon
SageMaker, which allows internet access. This is the default value. VpcOnly - All
traffic is through the specified VPC and subnets. Internet access is disabled by default.
To allow internet access, you must specify a NAT gateway. When internet access is disabled,
you won't be able to run a Amazon SageMaker Studio notebook or to train or host models
unless your VPC has an interface endpoint to the SageMaker API and runtime or a NAT gateway
and your security groups allow outbound connections. NFS traffic over TCP on port 2049
needs to be allowed in both inbound and outbound rules in order to launch a Amazon
SageMaker Studio app successfully. For more information, see Connect Amazon SageMaker
Studio Notebooks to Resources in a VPC.
# Arguments
- `auth_mode`: The mode of authentication that members use to access the domain.
- `default_user_settings`: The default settings to use to create a user profile when
UserSettings isn't specified in the call to the CreateUserProfile API. SecurityGroups is
aggregated when specified in both calls. For all other settings in UserSettings, the values
specified in CreateUserProfile take precedence over those specified in CreateDomain.
- `domain_name`: A name for the domain.
- `subnet_ids`: The VPC subnets that the domain uses for communication.
- `vpc_id`: The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for
communication.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AppNetworkAccessType"`: Specifies the VPC used for non-EFS traffic. The default value
is PublicInternetOnly. PublicInternetOnly - Non-EFS traffic is through a VPC managed by
Amazon SageMaker, which allows direct internet access VpcOnly - All traffic is through
the specified VPC and subnets
- `"AppSecurityGroupManagement"`: The entity that creates and manages the required security
groups for inter-app communication in VPCOnly mode. Required when
CreateDomain.AppNetworkAccessType is VPCOnly and
DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. If
setting up the domain for use with RStudio, this value must be set to Service.
- `"DefaultSpaceSettings"`: The default settings used to create a space.
- `"DomainSettings"`: A collection of Domain settings.
- `"HomeEfsFileSystemKmsKeyId"`: Use KmsKeyId.
- `"KmsKeyId"`: SageMaker uses Amazon Web Services KMS to encrypt EFS and EBS volumes
attached to the domain with an Amazon Web Services managed key by default. For more
control, specify a customer managed key.
- `"Tags"`: Tags to associated with the Domain. Each tag consists of a key and an optional
value. Tag keys must be unique per resource. Tags are searchable using the Search API. Tags
that you specify for the Domain are also added to all Apps that the Domain launches.
"""
function create_domain(
AuthMode,
DefaultUserSettings,
DomainName,
SubnetIds,
VpcId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateDomain",
Dict{String,Any}(
"AuthMode" => AuthMode,
"DefaultUserSettings" => DefaultUserSettings,
"DomainName" => DomainName,
"SubnetIds" => SubnetIds,
"VpcId" => VpcId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_domain(
AuthMode,
DefaultUserSettings,
DomainName,
SubnetIds,
VpcId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateDomain",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AuthMode" => AuthMode,
"DefaultUserSettings" => DefaultUserSettings,
"DomainName" => DomainName,
"SubnetIds" => SubnetIds,
"VpcId" => VpcId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_edge_deployment_plan(device_fleet_name, edge_deployment_plan_name, model_configs)
create_edge_deployment_plan(device_fleet_name, edge_deployment_plan_name, model_configs, params::Dict{String,<:Any})
Creates an edge deployment plan, consisting of multiple stages. Each stage may have a
different deployment configuration and devices.
# Arguments
- `device_fleet_name`: The device fleet used for this edge deployment plan.
- `edge_deployment_plan_name`: The name of the edge deployment plan.
- `model_configs`: List of models associated with the edge deployment plan.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Stages"`: List of stages of the edge deployment plan. The number of stages is limited
to 10 per deployment.
- `"Tags"`: List of tags with which to tag the edge deployment plan.
"""
function create_edge_deployment_plan(
DeviceFleetName,
EdgeDeploymentPlanName,
ModelConfigs;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateEdgeDeploymentPlan",
Dict{String,Any}(
"DeviceFleetName" => DeviceFleetName,
"EdgeDeploymentPlanName" => EdgeDeploymentPlanName,
"ModelConfigs" => ModelConfigs,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_edge_deployment_plan(
DeviceFleetName,
EdgeDeploymentPlanName,
ModelConfigs,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateEdgeDeploymentPlan",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DeviceFleetName" => DeviceFleetName,
"EdgeDeploymentPlanName" => EdgeDeploymentPlanName,
"ModelConfigs" => ModelConfigs,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_edge_deployment_stage(edge_deployment_plan_name, stages)
create_edge_deployment_stage(edge_deployment_plan_name, stages, params::Dict{String,<:Any})
Creates a new stage in an existing edge deployment plan.
# Arguments
- `edge_deployment_plan_name`: The name of the edge deployment plan.
- `stages`: List of stages to be added to the edge deployment plan.
"""
function create_edge_deployment_stage(
EdgeDeploymentPlanName, Stages; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"CreateEdgeDeploymentStage",
Dict{String,Any}(
"EdgeDeploymentPlanName" => EdgeDeploymentPlanName, "Stages" => Stages
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_edge_deployment_stage(
EdgeDeploymentPlanName,
Stages,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateEdgeDeploymentStage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EdgeDeploymentPlanName" => EdgeDeploymentPlanName, "Stages" => Stages
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_edge_packaging_job(compilation_job_name, edge_packaging_job_name, model_name, model_version, output_config, role_arn)
create_edge_packaging_job(compilation_job_name, edge_packaging_job_name, model_name, model_version, output_config, role_arn, params::Dict{String,<:Any})
Starts a SageMaker Edge Manager model packaging job. Edge Manager will use the model
artifacts from the Amazon Simple Storage Service bucket that you specify. After the model
has been packaged, Amazon SageMaker saves the resulting artifacts to an S3 bucket that you
specify.
# Arguments
- `compilation_job_name`: The name of the SageMaker Neo compilation job that will be used
to locate model artifacts for packaging.
- `edge_packaging_job_name`: The name of the edge packaging job.
- `model_name`: The name of the model.
- `model_version`: The version of the model.
- `output_config`: Provides information about the output location for the packaged model.
- `role_arn`: The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker
to download and upload the model, and to contact SageMaker Neo.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ResourceKey"`: The Amazon Web Services KMS key to use when encrypting the EBS volume
the edge packaging job runs on.
- `"Tags"`: Creates tags for the packaging job.
"""
function create_edge_packaging_job(
CompilationJobName,
EdgePackagingJobName,
ModelName,
ModelVersion,
OutputConfig,
RoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateEdgePackagingJob",
Dict{String,Any}(
"CompilationJobName" => CompilationJobName,
"EdgePackagingJobName" => EdgePackagingJobName,
"ModelName" => ModelName,
"ModelVersion" => ModelVersion,
"OutputConfig" => OutputConfig,
"RoleArn" => RoleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_edge_packaging_job(
CompilationJobName,
EdgePackagingJobName,
ModelName,
ModelVersion,
OutputConfig,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateEdgePackagingJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CompilationJobName" => CompilationJobName,
"EdgePackagingJobName" => EdgePackagingJobName,
"ModelName" => ModelName,
"ModelVersion" => ModelVersion,
"OutputConfig" => OutputConfig,
"RoleArn" => RoleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_endpoint(endpoint_config_name, endpoint_name)
create_endpoint(endpoint_config_name, endpoint_name, params::Dict{String,<:Any})
Creates an endpoint using the endpoint configuration specified in the request. SageMaker
uses the endpoint to provision resources and deploy models. You create the endpoint
configuration with the CreateEndpointConfig API. Use this API to deploy models using
SageMaker hosting services. You must not delete an EndpointConfig that is in use by an
endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being
performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.
The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web
Services account. When it receives the request, SageMaker creates the endpoint, launches
the resources (ML compute instances), and deploys the model(s) on them. When you call
CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration
exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads ,
the response might not reflect the results of a recently completed write operation. The
response might include some stale data. If the dependent entities are not yet in DynamoDB,
this causes a validation error. If you repeat your read request after a short time, the
response should return the latest data. So retry logic is recommended to handle these
possible issues. We also recommend that customers call DescribeEndpointConfig before
calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent
read. When SageMaker receives the request, it sets the endpoint status to Creating. After
it creates the endpoint, it sets the status to InService. SageMaker can then process
incoming requests for inferences. To check the status of an endpoint, use the
DescribeEndpoint API. If any of the models hosted at this endpoint get model data from an
Amazon S3 location, SageMaker uses Amazon Web Services Security Token Service to download
model artifacts from the S3 path you provided. Amazon Web Services STS is activated in your
Amazon Web Services account by default. If you previously deactivated Amazon Web Services
STS for a region, you need to reactivate Amazon Web Services STS for that region. For more
information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web
Services Region in the Amazon Web Services Identity and Access Management User Guide. To
add the IAM role policies for using this API operation, go to the IAM console, and choose
Roles in the left navigation pane. Search the IAM role that you want to grant access to use
the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to
the role. Option 1: For a full SageMaker access, search and attach the
AmazonSageMakerFullAccess policy. Option 2: For granting a limited access to an IAM role,
paste the following Action elements manually into the JSON file of the IAM role:
\"Action\": [\"sagemaker:CreateEndpoint\", \"sagemaker:CreateEndpointConfig\"]
\"Resource\": [ \"arn:aws:sagemaker:region:account-id:endpoint/endpointName\"
\"arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName\" ] For more
information, see SageMaker API Permissions: Actions, Permissions, and Resources Reference.
# Arguments
- `endpoint_config_name`: The name of an endpoint configuration. For more information, see
CreateEndpointConfig.
- `endpoint_name`: The name of the endpoint.The name must be unique within an Amazon Web
Services Region in your Amazon Web Services account. The name is case-insensitive in
CreateEndpoint, but the case is preserved and must be matched in InvokeEndpoint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeploymentConfig"`:
- `"Tags"`: An array of key-value pairs. You can use tags to categorize your Amazon Web
Services resources in different ways, for example, by purpose, owner, or environment. For
more information, see Tagging Amazon Web Services Resources.
"""
function create_endpoint(
EndpointConfigName, EndpointName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"CreateEndpoint",
Dict{String,Any}(
"EndpointConfigName" => EndpointConfigName, "EndpointName" => EndpointName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_endpoint(
EndpointConfigName,
EndpointName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateEndpoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EndpointConfigName" => EndpointConfigName,
"EndpointName" => EndpointName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_endpoint_config(endpoint_config_name, production_variants)
create_endpoint_config(endpoint_config_name, production_variants, params::Dict{String,<:Any})
Creates an endpoint configuration that SageMaker hosting services uses to deploy models. In
the configuration, you identify one or more models, created using the CreateModel API, to
deploy and the resources that you want SageMaker to provision. Then you call the
CreateEndpoint API. Use this API if you want to use SageMaker hosting services to deploy
models into production. In the request, you define a ProductionVariant, for each model
that you want to deploy. Each ProductionVariant parameter also describes the resources that
you want SageMaker to provision. This includes the number and type of ML compute instances
to deploy. If you are hosting multiple models, you also assign a VariantWeight to specify
how much traffic you want to allocate to each model. For example, suppose that you want to
host two models, A and B, and you assign traffic weight 2 for model A and 1 for model B.
SageMaker distributes two-thirds of the traffic to Model A, and one-third to model B.
When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint
configuration exists. When you read data from a DynamoDB table supporting Eventually
Consistent Reads , the response might not reflect the results of a recently completed write
operation. The response might include some stale data. If the dependent entities are not
yet in DynamoDB, this causes a validation error. If you repeat your read request after a
short time, the response should return the latest data. So retry logic is recommended to
handle these possible issues. We also recommend that customers call DescribeEndpointConfig
before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually
consistent read.
# Arguments
- `endpoint_config_name`: The name of the endpoint configuration. You specify this name in
a CreateEndpoint request.
- `production_variants`: An array of ProductionVariant objects, one for each model that you
want to host at this endpoint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AsyncInferenceConfig"`: Specifies configuration for how an endpoint performs
asynchronous inference. This is a required field in order for your Endpoint to be invoked
using InvokeEndpointAsync.
- `"DataCaptureConfig"`:
- `"EnableNetworkIsolation"`: Sets whether all model containers deployed to the endpoint
are isolated. If they are, no inbound or outbound network calls can be made to or from the
model containers.
- `"ExecutionRoleArn"`: The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker
can assume to perform actions on your behalf. For more information, see SageMaker Roles.
To be able to pass this role to Amazon SageMaker, the caller of this action must have the
iam:PassRole permission.
- `"ExplainerConfig"`: A member of CreateEndpointConfig that enables explainers.
- `"KmsKeyId"`: The Amazon Resource Name (ARN) of a Amazon Web Services Key Management
Service key that SageMaker uses to encrypt data on the storage volume attached to the ML
compute instance that hosts the endpoint. The KmsKeyId can be any of the following formats:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN:
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name:
alias/ExampleAlias Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
The KMS key policy must grant permission to the IAM role that you specify in your
CreateEndpoint, UpdateEndpoint requests. For more information, refer to the Amazon Web
Services Key Management Service section Using Key Policies in Amazon Web Services KMS
Certain Nitro-based instances include local storage, dependent on the instance type. Local
storage volumes are encrypted using a hardware module on the instance. You can't request a
KmsKeyId when using an instance type with local storage. If any of the models that you
specify in the ProductionVariants parameter use nitro-based instances with local storage,
do not specify a value for the KmsKeyId parameter. If you specify a value for KmsKeyId when
using any nitro-based instances with local storage, the call to CreateEndpointConfig fails.
For a list of instance types that support local instance storage, see Instance Store
Volumes. For more information about local instance storage encryption, see SSD Instance
Store Volumes.
- `"ShadowProductionVariants"`: An array of ProductionVariant objects, one for each model
that you want to host at this endpoint in shadow mode with production traffic replicated
from the model specified on ProductionVariants. If you use this field, you can only specify
one variant for ProductionVariants and one variant for ShadowProductionVariants.
- `"Tags"`: An array of key-value pairs. You can use tags to categorize your Amazon Web
Services resources in different ways, for example, by purpose, owner, or environment. For
more information, see Tagging Amazon Web Services Resources.
- `"VpcConfig"`:
"""
function create_endpoint_config(
EndpointConfigName,
ProductionVariants;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateEndpointConfig",
Dict{String,Any}(
"EndpointConfigName" => EndpointConfigName,
"ProductionVariants" => ProductionVariants,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_endpoint_config(
EndpointConfigName,
ProductionVariants,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateEndpointConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EndpointConfigName" => EndpointConfigName,
"ProductionVariants" => ProductionVariants,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_experiment(experiment_name)
create_experiment(experiment_name, params::Dict{String,<:Any})
Creates a SageMaker experiment. An experiment is a collection of trials that are observed,
compared and evaluated as a group. A trial is a set of steps, called trial components, that
produce a machine learning model. In the Studio UI, trials are referred to as run groups
and trial components are referred to as runs. The goal of an experiment is to determine
the components that produce the best model. Multiple trials are performed, each one
isolating and measuring the impact of a change to one or more inputs, while keeping the
remaining inputs constant. When you use SageMaker Studio or the SageMaker Python SDK, all
experiments, trials, and trial components are automatically tracked, logged, and indexed.
When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs
provided by the SDK. You can add tags to experiments, trials, trial components and then use
the Search API to search for the tags. To add a description to an experiment, specify the
optional Description parameter. To add a description later, or to change the description,
call the UpdateExperiment API. To get a list of all your experiments, call the
ListExperiments API. To view an experiment's properties, call the DescribeExperiment API.
To get a list of all the trials associated with an experiment, call the ListTrials API. To
create a trial call the CreateTrial API.
# Arguments
- `experiment_name`: The name of the experiment. The name must be unique in your Amazon Web
Services account and is not case-sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description of the experiment.
- `"DisplayName"`: The name of the experiment as displayed. The name doesn't need to be
unique. If you don't specify DisplayName, the value in ExperimentName is displayed.
- `"Tags"`: A list of tags to associate with the experiment. You can use Search API to
search on the tags.
"""
function create_experiment(
ExperimentName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"CreateExperiment",
Dict{String,Any}("ExperimentName" => ExperimentName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_experiment(
ExperimentName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateExperiment",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ExperimentName" => ExperimentName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_feature_group(event_time_feature_name, feature_definitions, feature_group_name, record_identifier_feature_name)
create_feature_group(event_time_feature_name, feature_definitions, feature_group_name, record_identifier_feature_name, params::Dict{String,<:Any})
Create a new FeatureGroup. A FeatureGroup is a group of Features defined in the
FeatureStore to describe a Record. The FeatureGroup defines the schema and features
contained in the FeatureGroup. A FeatureGroup definition is composed of a list of Features,
a RecordIdentifierFeatureName, an EventTimeFeatureName and configurations for its
OnlineStore and OfflineStore. Check Amazon Web Services service quotas to see the
FeatureGroups quota for your Amazon Web Services account. Note that it can take
approximately 10-15 minutes to provision an OnlineStore FeatureGroup with the InMemory
StorageType. You must include at least one of OnlineStoreConfig and OfflineStoreConfig to
create a FeatureGroup.
# Arguments
- `event_time_feature_name`: The name of the feature that stores the EventTime of a Record
in a FeatureGroup. An EventTime is a point in time when a new event occurs that corresponds
to the creation or update of a Record in a FeatureGroup. All Records in the FeatureGroup
must have a corresponding EventTime. An EventTime can be a String or Fractional.
Fractional: EventTime feature values must be a Unix timestamp in seconds. String:
EventTime feature values must be an ISO-8601 string in the format. The following formats
are supported yyyy-MM-dd'T'HH:mm:ssZ and yyyy-MM-dd'T'HH:mm:ss.SSSZ where yyyy, MM, and dd
represent the year, month, and day respectively and HH, mm, ss, and if applicable, SSS
represent the hour, month, second and milliseconds respsectively. 'T' and Z are constants.
- `feature_definitions`: A list of Feature names and types. Name and Type is compulsory per
Feature. Valid feature FeatureTypes are Integral, Fractional and String. FeatureNames
cannot be any of the following: is_deleted, write_time, api_invocation_time You can create
up to 2,500 FeatureDefinitions per FeatureGroup.
- `feature_group_name`: The name of the FeatureGroup. The name must be unique within an
Amazon Web Services Region in an Amazon Web Services account. The name: Must start with
an alphanumeric character. Can only include alphanumeric characters, underscores, and
hyphens. Spaces are not allowed.
- `record_identifier_feature_name`: The name of the Feature whose value uniquely identifies
a Record defined in the FeatureStore. Only the latest record per identifier value will be
stored in the OnlineStore. RecordIdentifierFeatureName must be one of feature definitions'
names. You use the RecordIdentifierFeatureName to access data in a FeatureStore. This name:
Must start with an alphanumeric character. Can only contains alphanumeric characters,
hyphens, underscores. Spaces are not allowed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A free-form description of a FeatureGroup.
- `"OfflineStoreConfig"`: Use this to configure an OfflineFeatureStore. This parameter
allows you to specify: The Amazon Simple Storage Service (Amazon S3) location of an
OfflineStore. A configuration for an Amazon Web Services Glue or Amazon Web Services Hive
data catalog. An KMS encryption key to encrypt the Amazon S3 location used for
OfflineStore. If KMS encryption key is not specified, by default we encrypt all data at
rest using Amazon Web Services KMS key. By defining your bucket-level key for SSE, you can
reduce Amazon Web Services KMS requests costs by up to 99 percent. Format for the offline
store table. Supported formats are Glue (Default) and Apache Iceberg. To learn more about
this parameter, see OfflineStoreConfig.
- `"OnlineStoreConfig"`: You can turn the OnlineStore on or off by specifying True for the
EnableOnlineStore flag in OnlineStoreConfig. You can also include an Amazon Web Services
KMS key ID (KMSKeyId) for at-rest encryption of the OnlineStore. The default value is False.
- `"RoleArn"`: The Amazon Resource Name (ARN) of the IAM execution role used to persist
data into the OfflineStore if an OfflineStoreConfig is provided.
- `"Tags"`: Tags used to identify Features in each FeatureGroup.
- `"ThroughputConfig"`:
"""
function create_feature_group(
EventTimeFeatureName,
FeatureDefinitions,
FeatureGroupName,
RecordIdentifierFeatureName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateFeatureGroup",
Dict{String,Any}(
"EventTimeFeatureName" => EventTimeFeatureName,
"FeatureDefinitions" => FeatureDefinitions,
"FeatureGroupName" => FeatureGroupName,
"RecordIdentifierFeatureName" => RecordIdentifierFeatureName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_feature_group(
EventTimeFeatureName,
FeatureDefinitions,
FeatureGroupName,
RecordIdentifierFeatureName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateFeatureGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EventTimeFeatureName" => EventTimeFeatureName,
"FeatureDefinitions" => FeatureDefinitions,
"FeatureGroupName" => FeatureGroupName,
"RecordIdentifierFeatureName" => RecordIdentifierFeatureName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_flow_definition(flow_definition_name, output_config, role_arn)
create_flow_definition(flow_definition_name, output_config, role_arn, params::Dict{String,<:Any})
Creates a flow definition.
# Arguments
- `flow_definition_name`: The name of your flow definition.
- `output_config`: An object containing information about where the human review results
will be uploaded.
- `role_arn`: The Amazon Resource Name (ARN) of the role needed to call other services on
your behalf. For example,
arn:aws:iam::1234567890:role/service-role/AmazonSageMaker-ExecutionRole-20180111T151298.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"HumanLoopActivationConfig"`: An object containing information about the events that
trigger a human workflow.
- `"HumanLoopConfig"`: An object containing information about the tasks the human reviewers
will perform.
- `"HumanLoopRequestSource"`: Container for configuring the source of human task requests.
Use to specify if Amazon Rekognition or Amazon Textract is used as an integration source.
- `"Tags"`: An array of key-value pairs that contain metadata to help you categorize and
organize a flow definition. Each tag consists of a key and a value, both of which you
define.
"""
function create_flow_definition(
FlowDefinitionName,
OutputConfig,
RoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateFlowDefinition",
Dict{String,Any}(
"FlowDefinitionName" => FlowDefinitionName,
"OutputConfig" => OutputConfig,
"RoleArn" => RoleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_flow_definition(
FlowDefinitionName,
OutputConfig,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateFlowDefinition",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FlowDefinitionName" => FlowDefinitionName,
"OutputConfig" => OutputConfig,
"RoleArn" => RoleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_hub(hub_description, hub_name)
create_hub(hub_description, hub_name, params::Dict{String,<:Any})
Create a hub.
# Arguments
- `hub_description`: A description of the hub.
- `hub_name`: The name of the hub to create.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"HubDisplayName"`: The display name of the hub.
- `"HubSearchKeywords"`: The searchable keywords for the hub.
- `"S3StorageConfig"`: The Amazon S3 storage configuration for the hub.
- `"Tags"`: Any tags to associate with the hub.
"""
function create_hub(
HubDescription, HubName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"CreateHub",
Dict{String,Any}("HubDescription" => HubDescription, "HubName" => HubName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_hub(
HubDescription,
HubName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateHub",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("HubDescription" => HubDescription, "HubName" => HubName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_hub_content_reference(hub_name, sage_maker_public_hub_content_arn)
create_hub_content_reference(hub_name, sage_maker_public_hub_content_arn, params::Dict{String,<:Any})
Create a hub content reference in order to add a model in the JumpStart public hub to a
private hub.
# Arguments
- `hub_name`: The name of the hub to add the hub content reference to.
- `sage_maker_public_hub_content_arn`: The ARN of the public hub content to reference.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"HubContentName"`: The name of the hub content to reference.
- `"MinVersion"`: The minimum version of the hub content to reference.
- `"Tags"`: Any tags associated with the hub content to reference.
"""
function create_hub_content_reference(
HubName, SageMakerPublicHubContentArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"CreateHubContentReference",
Dict{String,Any}(
"HubName" => HubName,
"SageMakerPublicHubContentArn" => SageMakerPublicHubContentArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_hub_content_reference(
HubName,
SageMakerPublicHubContentArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateHubContentReference",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"HubName" => HubName,
"SageMakerPublicHubContentArn" => SageMakerPublicHubContentArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_human_task_ui(human_task_ui_name, ui_template)
create_human_task_ui(human_task_ui_name, ui_template, params::Dict{String,<:Any})
Defines the settings you will use for the human review workflow user interface. Reviewers
will see a three-panel interface with an instruction area, the item to review, and an input
area.
# Arguments
- `human_task_ui_name`: The name of the user interface you are creating.
- `ui_template`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: An array of key-value pairs that contain metadata to help you categorize and
organize a human review workflow user interface. Each tag consists of a key and a value,
both of which you define.
"""
function create_human_task_ui(
HumanTaskUiName, UiTemplate; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"CreateHumanTaskUi",
Dict{String,Any}("HumanTaskUiName" => HumanTaskUiName, "UiTemplate" => UiTemplate);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_human_task_ui(
HumanTaskUiName,
UiTemplate,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateHumanTaskUi",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"HumanTaskUiName" => HumanTaskUiName, "UiTemplate" => UiTemplate
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_hyper_parameter_tuning_job(hyper_parameter_tuning_job_config, hyper_parameter_tuning_job_name)
create_hyper_parameter_tuning_job(hyper_parameter_tuning_job_config, hyper_parameter_tuning_job_name, params::Dict{String,<:Any})
Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version of a
model by running many training jobs on your dataset using the algorithm you choose and
values for hyperparameters within ranges that you specify. It then chooses the
hyperparameter values that result in a model that performs the best, as measured by an
objective metric that you choose. A hyperparameter tuning job automatically creates Amazon
SageMaker experiments, trials, and trial components for each training job that it runs. You
can view these entities in Amazon SageMaker Studio. For more information, see View
Experiments, Trials, and Trial Components. Do not include any security-sensitive
information including account access IDs, secrets or tokens in any hyperparameter field. If
the use of security-sensitive credentials are detected, SageMaker will reject your training
job request and return an exception error.
# Arguments
- `hyper_parameter_tuning_job_config`: The HyperParameterTuningJobConfig object that
describes the tuning job, including the search strategy, the objective metric used to
evaluate training jobs, ranges of parameters to search, and resource limits for the tuning
job. For more information, see How Hyperparameter Tuning Works.
- `hyper_parameter_tuning_job_name`: The name of the tuning job. This name is the prefix
for the names of all training jobs that this tuning job launches. The name must be unique
within the same Amazon Web Services account and Amazon Web Services Region. The name must
have 1 to 32 characters. Valid characters are a-z, A-Z, 0-9, and : + = @ _ % - (hyphen).
The name is not case sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Autotune"`: Configures SageMaker Automatic model tuning (AMT) to automatically find
optimal parameters for the following fields: ParameterRanges: The names and ranges of
parameters that a hyperparameter tuning job can optimize. ResourceLimits: The maximum
resources that can be used for a training job. These resources include the maximum number
of training jobs, the maximum runtime of a tuning job, and the maximum number of training
jobs to run at the same time. TrainingJobEarlyStoppingType: A flag that specifies
whether or not to use early stopping for training jobs launched by a hyperparameter tuning
job. RetryStrategy: The number of times to retry a training job. Strategy: Specifies
how hyperparameter tuning chooses the combinations of hyperparameter values to use for the
training jobs that it launches. ConvergenceDetected: A flag to indicate that Automatic
model tuning (AMT) has detected model convergence.
- `"Tags"`: An array of key-value pairs. You can use tags to categorize your Amazon Web
Services resources in different ways, for example, by purpose, owner, or environment. For
more information, see Tagging Amazon Web Services Resources. Tags that you specify for the
tuning job are also added to all training jobs that the tuning job launches.
- `"TrainingJobDefinition"`: The HyperParameterTrainingJobDefinition object that describes
the training jobs that this tuning job launches, including static hyperparameters, input
data configuration, output data configuration, resource configuration, and stopping
condition.
- `"TrainingJobDefinitions"`: A list of the HyperParameterTrainingJobDefinition objects
launched for this tuning job.
- `"WarmStartConfig"`: Specifies the configuration for starting the hyperparameter tuning
job using one or more previous tuning jobs as a starting point. The results of previous
tuning jobs are used to inform which combinations of hyperparameters to search over in the
new tuning job. All training jobs launched by the new hyperparameter tuning job are
evaluated by using the objective metric. If you specify IDENTICAL_DATA_AND_ALGORITHM as the
WarmStartType value for the warm start configuration, the training job that performs the
best in the new tuning job is compared to the best training jobs from the parent tuning
jobs. From these, the training job that performs the best as measured by the objective
metric is returned as the overall best training job. All training jobs launched by parent
hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit
of training jobs for the tuning job.
"""
function create_hyper_parameter_tuning_job(
HyperParameterTuningJobConfig,
HyperParameterTuningJobName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateHyperParameterTuningJob",
Dict{String,Any}(
"HyperParameterTuningJobConfig" => HyperParameterTuningJobConfig,
"HyperParameterTuningJobName" => HyperParameterTuningJobName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_hyper_parameter_tuning_job(
HyperParameterTuningJobConfig,
HyperParameterTuningJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateHyperParameterTuningJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"HyperParameterTuningJobConfig" => HyperParameterTuningJobConfig,
"HyperParameterTuningJobName" => HyperParameterTuningJobName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_image(image_name, role_arn)
create_image(image_name, role_arn, params::Dict{String,<:Any})
Creates a custom SageMaker image. A SageMaker image is a set of image versions. Each image
version represents a container image stored in Amazon ECR. For more information, see Bring
your own SageMaker image.
# Arguments
- `image_name`: The name of the image. Must be unique to your account.
- `role_arn`: The ARN of an IAM role that enables Amazon SageMaker to perform tasks on your
behalf.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description of the image.
- `"DisplayName"`: The display name of the image. If not provided, ImageName is displayed.
- `"Tags"`: A list of tags to apply to the image.
"""
function create_image(ImageName, RoleArn; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"CreateImage",
Dict{String,Any}("ImageName" => ImageName, "RoleArn" => RoleArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_image(
ImageName,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateImage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ImageName" => ImageName, "RoleArn" => RoleArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_image_version(base_image, client_token, image_name)
create_image_version(base_image, client_token, image_name, params::Dict{String,<:Any})
Creates a version of the SageMaker image specified by ImageName. The version represents the
Amazon ECR container image specified by BaseImage.
# Arguments
- `base_image`: The registry path of the container image to use as the starting point for
this version. The path is an Amazon ECR URI in the following format:
<acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]>
- `client_token`: A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web
Services SDKs, such as the SDK for Python (Boto3), add a unique value to the call.
- `image_name`: The ImageName of the Image to create a version of.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Aliases"`: A list of aliases created with the image version.
- `"Horovod"`: Indicates Horovod compatibility.
- `"JobType"`: Indicates SageMaker job type compatibility. TRAINING: The image version
is compatible with SageMaker training jobs. INFERENCE: The image version is compatible
with SageMaker inference jobs. NOTEBOOK_KERNEL: The image version is compatible with
SageMaker notebook kernels.
- `"MLFramework"`: The machine learning framework vended in the image version.
- `"Processor"`: Indicates CPU or GPU compatibility. CPU: The image version is
compatible with CPU. GPU: The image version is compatible with GPU.
- `"ProgrammingLang"`: The supported programming language and its version.
- `"ReleaseNotes"`: The maintainer description of the image version.
- `"VendorGuidance"`: The stability of the image version, specified by the maintainer.
NOT_PROVIDED: The maintainers did not provide a status for image version stability.
STABLE: The image version is stable. TO_BE_ARCHIVED: The image version is set to be
archived. Custom image versions that are set to be archived are automatically archived
after three months. ARCHIVED: The image version is archived. Archived image versions are
not searchable and are no longer actively supported.
"""
function create_image_version(
BaseImage, ClientToken, ImageName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"CreateImageVersion",
Dict{String,Any}(
"BaseImage" => BaseImage, "ClientToken" => ClientToken, "ImageName" => ImageName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_image_version(
BaseImage,
ClientToken,
ImageName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateImageVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"BaseImage" => BaseImage,
"ClientToken" => ClientToken,
"ImageName" => ImageName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_inference_component(endpoint_name, inference_component_name, runtime_config, specification, variant_name)
create_inference_component(endpoint_name, inference_component_name, runtime_config, specification, variant_name, params::Dict{String,<:Any})
Creates an inference component, which is a SageMaker hosting object that you can use to
deploy a model to an endpoint. In the inference component settings, you specify the model,
the endpoint, and how the model utilizes the resources that the endpoint hosts. You can
optimize resource utilization by tailoring how the required CPU cores, accelerators, and
memory are allocated. You can deploy multiple inference components to an endpoint, where
each inference component contains one model and the resource utilization needs for that
individual model. After you deploy an inference component, you can directly invoke the
associated model when you use the InvokeEndpoint API action.
# Arguments
- `endpoint_name`: The name of an existing endpoint where you host the inference component.
- `inference_component_name`: A unique name to assign to the inference component.
- `runtime_config`: Runtime settings for a model that is deployed with an inference
component.
- `specification`: Details about the resources to deploy with this inference component,
including the model, container, and compute resources.
- `variant_name`: The name of an existing production variant where you host the inference
component.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: A list of key-value pairs associated with the model. For more information, see
Tagging Amazon Web Services resources in the Amazon Web Services General Reference.
"""
function create_inference_component(
EndpointName,
InferenceComponentName,
RuntimeConfig,
Specification,
VariantName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateInferenceComponent",
Dict{String,Any}(
"EndpointName" => EndpointName,
"InferenceComponentName" => InferenceComponentName,
"RuntimeConfig" => RuntimeConfig,
"Specification" => Specification,
"VariantName" => VariantName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_inference_component(
EndpointName,
InferenceComponentName,
RuntimeConfig,
Specification,
VariantName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateInferenceComponent",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EndpointName" => EndpointName,
"InferenceComponentName" => InferenceComponentName,
"RuntimeConfig" => RuntimeConfig,
"Specification" => Specification,
"VariantName" => VariantName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_inference_experiment(endpoint_name, model_variants, name, role_arn, shadow_mode_config, type)
create_inference_experiment(endpoint_name, model_variants, name, role_arn, shadow_mode_config, type, params::Dict{String,<:Any})
Creates an inference experiment using the configurations specified in the request. Use
this API to setup and schedule an experiment to compare model variants on a Amazon
SageMaker inference endpoint. For more information about inference experiments, see Shadow
tests. Amazon SageMaker begins your experiment at the scheduled time and routes traffic
to your endpoint's model variants based on your specified configuration. While the
experiment is in progress or after it has concluded, you can view metrics that compare your
model variants. For more information, see View, monitor, and edit shadow tests.
# Arguments
- `endpoint_name`: The name of the Amazon SageMaker endpoint on which you want to run the
inference experiment.
- `model_variants`: An array of ModelVariantConfig objects. There is one for each variant
in the inference experiment. Each ModelVariantConfig object in the array describes the
infrastructure configuration for the corresponding variant.
- `name`: The name for the inference experiment.
- `role_arn`: The ARN of the IAM role that Amazon SageMaker can assume to access model
artifacts and container images, and manage Amazon SageMaker Inference endpoints for model
deployment.
- `shadow_mode_config`: The configuration of ShadowMode inference experiment type. Use
this field to specify a production variant which takes all the inference requests, and a
shadow variant to which Amazon SageMaker replicates a percentage of the inference requests.
For the shadow variant also specify the percentage of requests that Amazon SageMaker
replicates.
- `type`: The type of the inference experiment that you want to run. The following types
of experiments are possible: ShadowMode: You can use this type to validate a shadow
variant. For more information, see Shadow tests.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataStorageConfig"`: The Amazon S3 location and configuration for storing inference
request and response data. This is an optional parameter that you can use for data
capture. For more information, see Capture data.
- `"Description"`: A description for the inference experiment.
- `"KmsKey"`: The Amazon Web Services Key Management Service (Amazon Web Services KMS) key
that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute
instance that hosts the endpoint. The KmsKey can be any 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\" KMS key
Alias \"alias/ExampleAlias\" Amazon Resource Name (ARN) of a KMS key Alias
\"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\" If you use a KMS key ID or an
alias of your KMS key, the Amazon SageMaker execution role must include permissions to call
kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key
for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with
KMS managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject
permission that only allows objects with server-side encryption, set the condition key of
s3:x-amz-server-side-encryption to \"aws:kms\". For more information, see KMS managed
Encryption Keys in the Amazon Simple Storage Service Developer Guide. The KMS key policy
must grant permission to the IAM role that you specify in your CreateEndpoint and
UpdateEndpoint requests. For more information, see Using Key Policies in Amazon Web
Services KMS in the Amazon Web Services Key Management Service Developer Guide.
- `"Schedule"`: The duration for which you want the inference experiment to run. If you
don't specify this field, the experiment automatically starts immediately upon creation and
concludes after 7 days.
- `"Tags"`: Array of key-value pairs. You can use tags to categorize your Amazon Web
Services resources in different ways, for example, by purpose, owner, or environment. For
more information, see Tagging your Amazon Web Services Resources.
"""
function create_inference_experiment(
EndpointName,
ModelVariants,
Name,
RoleArn,
ShadowModeConfig,
Type;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateInferenceExperiment",
Dict{String,Any}(
"EndpointName" => EndpointName,
"ModelVariants" => ModelVariants,
"Name" => Name,
"RoleArn" => RoleArn,
"ShadowModeConfig" => ShadowModeConfig,
"Type" => Type,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_inference_experiment(
EndpointName,
ModelVariants,
Name,
RoleArn,
ShadowModeConfig,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateInferenceExperiment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EndpointName" => EndpointName,
"ModelVariants" => ModelVariants,
"Name" => Name,
"RoleArn" => RoleArn,
"ShadowModeConfig" => ShadowModeConfig,
"Type" => Type,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_inference_recommendations_job(input_config, job_name, job_type, role_arn)
create_inference_recommendations_job(input_config, job_name, job_type, role_arn, params::Dict{String,<:Any})
Starts a recommendation job. You can create either an instance recommendation or load test
job.
# Arguments
- `input_config`: Provides information about the versioned model package Amazon Resource
Name (ARN), the traffic pattern, and endpoint configurations.
- `job_name`: A name for the recommendation job. The name must be unique within the Amazon
Web Services Region and within your Amazon Web Services account. The job name is passed
down to the resources created by the recommendation job. The names of resources (such as
the model, endpoint configuration, endpoint, and compilation) that are prefixed with the
job name are truncated at 40 characters.
- `job_type`: Defines the type of recommendation job. Specify Default to initiate an
instance recommendation and Advanced to initiate a load test. If left unspecified, Amazon
SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job.
- `role_arn`: The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker
to perform tasks on your behalf.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"JobDescription"`: Description of the recommendation job.
- `"OutputConfig"`: Provides information about the output artifacts and the KMS key to use
for Amazon S3 server-side encryption.
- `"StoppingConditions"`: A set of conditions for stopping a recommendation job. If any of
the conditions are met, the job is automatically stopped.
- `"Tags"`: The metadata that you apply to Amazon Web Services resources to help you
categorize and organize them. Each tag consists of a key and a value, both of which you
define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web
Services General Reference.
"""
function create_inference_recommendations_job(
InputConfig,
JobName,
JobType,
RoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateInferenceRecommendationsJob",
Dict{String,Any}(
"InputConfig" => InputConfig,
"JobName" => JobName,
"JobType" => JobType,
"RoleArn" => RoleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_inference_recommendations_job(
InputConfig,
JobName,
JobType,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateInferenceRecommendationsJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InputConfig" => InputConfig,
"JobName" => JobName,
"JobType" => JobType,
"RoleArn" => RoleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_labeling_job(human_task_config, input_config, label_attribute_name, labeling_job_name, output_config, role_arn)
create_labeling_job(human_task_config, input_config, label_attribute_name, labeling_job_name, output_config, role_arn, params::Dict{String,<:Any})
Creates a job that uses workers to label the data objects in your input dataset. You can
use the labeled data to train machine learning models. You can select your workforce from
one of three providers: A private workforce that you create. It can include employees,
contractors, and outside experts. Use a private workforce when want the data to stay within
your organization or when a specific set of skills is required. One or more vendors that
you select from the Amazon Web Services Marketplace. Vendors provide expertise in specific
areas. The Amazon Mechanical Turk workforce. This is the largest workforce, but it
should only be used for public data or data that has been stripped of any personally
identifiable information. You can also use automated data labeling to reduce the number
of data objects that need to be labeled by a human. Automated data labeling uses active
learning to determine if a data object can be labeled by machine or if it needs to be sent
to a human worker. For more information, see Using Automated Data Labeling. The data
objects to be labeled are contained in an Amazon S3 bucket. You create a manifest file that
describes the location of each object. For more information, see Using Input and Output
Data. The output can be used as the manifest file for another labeling job or as training
data for your machine learning models. You can use this operation to create a static
labeling job or a streaming labeling job. A static labeling job stops if all data objects
in the input manifest file identified in ManifestS3Uri have been labeled. A streaming
labeling job runs perpetually until it is manually stopped, or remains idle for 10 days.
You can send new data objects to an active (InProgress) streaming labeling job in real
time. To learn how to create a static labeling job, see Create a Labeling Job (API) in the
Amazon SageMaker Developer Guide. To learn how to create a streaming labeling job, see
Create a Streaming Labeling Job.
# Arguments
- `human_task_config`: Configures the labeling task and how it is presented to workers;
including, but not limited to price, keywords, and batch size (task count).
- `input_config`: Input data for the labeling job, such as the Amazon S3 location of the
data objects and the location of the manifest file that describes the data objects. You
must specify at least one of the following: S3DataSource or SnsDataSource. Use
SnsDataSource to specify an SNS input topic for a streaming labeling job. If you do not
specify and SNS input topic ARN, Ground Truth will create a one-time labeling job that
stops after all data objects in the input manifest file have been labeled. Use
S3DataSource to specify an input manifest file for both streaming and one-time labeling
jobs. Adding an S3DataSource is optional if you use SnsDataSource to create a streaming
labeling job. If you use the Amazon Mechanical Turk workforce, your input data should not
include confidential information, personal information or protected health information. Use
ContentClassifiers to specify that your data is free of personally identifiable information
and adult content.
- `label_attribute_name`: The attribute name to use for the label in the output manifest
file. This is the key for the key/value pair formed with the label that a worker assigns to
the object. The LabelAttributeName must meet the following requirements. The name can't
end with \"-metadata\". If you are using one of the following built-in task types, the
attribute name must end with \"-ref\". If the task type you are using is not listed below,
the attribute name must not end with \"-ref\". Image semantic segmentation
(SemanticSegmentation), and adjustment (AdjustmentSemanticSegmentation) and verification
(VerificationSemanticSegmentation) labeling jobs for this task type. Video frame object
detection (VideoObjectDetection), and adjustment and verification
(AdjustmentVideoObjectDetection) labeling jobs for this task type. Video frame object
tracking (VideoObjectTracking), and adjustment and verification
(AdjustmentVideoObjectTracking) labeling jobs for this task type. 3D point cloud semantic
segmentation (3DPointCloudSemanticSegmentation), and adjustment and verification
(Adjustment3DPointCloudSemanticSegmentation) labeling jobs for this task type. 3D point
cloud object tracking (3DPointCloudObjectTracking), and adjustment and verification
(Adjustment3DPointCloudObjectTracking) labeling jobs for this task type. If you are
creating an adjustment or verification labeling job, you must use a different
LabelAttributeName than the one used in the original labeling job. The original labeling
job is the Ground Truth labeling job that produced the labels that you want verified or
adjusted. To learn more about adjustment and verification labeling jobs, see Verify and
Adjust Labels.
- `labeling_job_name`: The name of the labeling job. This name is used to identify the job
in a list of labeling jobs. Labeling job names must be unique within an Amazon Web Services
account and region. LabelingJobName is not case sensitive. For example, Example-job and
example-job are considered the same labeling job name by Ground Truth.
- `output_config`: The location of the output data and the Amazon Web Services Key
Management Service key ID for the key used to encrypt the output data, if any.
- `role_arn`: The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform
tasks on your behalf during data labeling. You must grant this role the necessary
permissions so that Amazon SageMaker can successfully complete data labeling.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LabelCategoryConfigS3Uri"`: The S3 URI of the file, referred to as a label category
configuration file, that defines the categories used to label the data objects. For 3D
point cloud and video frame task types, you can add label category attributes and frame
attributes to your label category configuration file. To learn how, see Create a Labeling
Category Configuration File for 3D Point Cloud Labeling Jobs. For named entity recognition
jobs, in addition to \"labels\", you must provide worker instructions in the label category
configuration file using the \"instructions\" parameter: \"instructions\":
{\"shortInstruction\":\"<h1>Add header</h1><p>Add
Instructions</p>\", \"fullInstruction\":\"<p>Add additional
instructions.</p>\"}. For details and an example, see Create a Named Entity
Recognition Labeling Job (API) . For all other built-in task types and custom tasks, your
label category configuration file must be a JSON file in the following format. Identify the
labels you want to use by replacing label_1, label_2,...,label_n with your label
categories. { \"document-version\": \"2018-11-28\", \"labels\": [{\"label\":
\"label_1\"},{\"label\": \"label_2\"},...{\"label\": \"label_n\"}] } Note the following
about the label category configuration file: For image classification and text
classification (single and multi-label) you must specify at least two label categories. For
all other task types, the minimum number of label categories required is one. Each label
category must be unique, you cannot specify duplicate label categories. If you create a
3D point cloud or video frame adjustment or verification labeling job, you must include
auditLabelAttributeName in the label category configuration. Use this parameter to enter
the LabelAttributeName of the labeling job you want to adjust or verify annotations of.
- `"LabelingJobAlgorithmsConfig"`: Configures the information required to perform automated
data labeling.
- `"StoppingConditions"`: A set of conditions for stopping the labeling job. If any of the
conditions are met, the job is automatically stopped. You can use these conditions to
control the cost of data labeling.
- `"Tags"`: An array of key/value pairs. For more information, see Using Cost Allocation
Tags in the Amazon Web Services Billing and Cost Management User Guide.
"""
function create_labeling_job(
HumanTaskConfig,
InputConfig,
LabelAttributeName,
LabelingJobName,
OutputConfig,
RoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateLabelingJob",
Dict{String,Any}(
"HumanTaskConfig" => HumanTaskConfig,
"InputConfig" => InputConfig,
"LabelAttributeName" => LabelAttributeName,
"LabelingJobName" => LabelingJobName,
"OutputConfig" => OutputConfig,
"RoleArn" => RoleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_labeling_job(
HumanTaskConfig,
InputConfig,
LabelAttributeName,
LabelingJobName,
OutputConfig,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateLabelingJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"HumanTaskConfig" => HumanTaskConfig,
"InputConfig" => InputConfig,
"LabelAttributeName" => LabelAttributeName,
"LabelingJobName" => LabelingJobName,
"OutputConfig" => OutputConfig,
"RoleArn" => RoleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_mlflow_tracking_server(artifact_store_uri, role_arn, tracking_server_name)
create_mlflow_tracking_server(artifact_store_uri, role_arn, tracking_server_name, params::Dict{String,<:Any})
Creates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact
store. For more information, see Create an MLflow Tracking Server.
# Arguments
- `artifact_store_uri`: The S3 URI for a general purpose bucket to use as the MLflow
Tracking Server artifact store.
- `role_arn`: The Amazon Resource Name (ARN) for an IAM role in your account that the
MLflow Tracking Server uses to access the artifact store in Amazon S3. The role should have
AmazonS3FullAccess permissions. For more information on IAM permissions for tracking server
creation, see Set up IAM permissions for MLflow.
- `tracking_server_name`: A unique string identifying the tracking server name. This string
is part of the tracking server ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AutomaticModelRegistration"`: Whether to enable or disable automatic registration of
new MLflow models to the SageMaker Model Registry. To enable automatic model registration,
set this value to True. To disable automatic model registration, set this value to False.
If not specified, AutomaticModelRegistration defaults to False.
- `"MlflowVersion"`: The version of MLflow that the tracking server uses. To see which
MLflow versions are available to use, see How it works.
- `"Tags"`: Tags consisting of key-value pairs used to manage metadata for the tracking
server.
- `"TrackingServerSize"`: The size of the tracking server you want to create. You can
choose between \"Small\", \"Medium\", and \"Large\". The default MLflow Tracking Server
configuration size is \"Small\". You can choose a size depending on the projected use of
the tracking server such as the volume of data logged, number of users, and frequency of
use. We recommend using a small tracking server for teams of up to 25 users, a medium
tracking server for teams of up to 50 users, and a large tracking server for teams of up to
100 users.
- `"WeeklyMaintenanceWindowStart"`: The day and time of the week in Coordinated Universal
Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For
example: TUE:03:30.
"""
function create_mlflow_tracking_server(
ArtifactStoreUri,
RoleArn,
TrackingServerName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateMlflowTrackingServer",
Dict{String,Any}(
"ArtifactStoreUri" => ArtifactStoreUri,
"RoleArn" => RoleArn,
"TrackingServerName" => TrackingServerName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_mlflow_tracking_server(
ArtifactStoreUri,
RoleArn,
TrackingServerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateMlflowTrackingServer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ArtifactStoreUri" => ArtifactStoreUri,
"RoleArn" => RoleArn,
"TrackingServerName" => TrackingServerName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_model(model_name)
create_model(model_name, params::Dict{String,<:Any})
Creates a model in SageMaker. In the request, you name the model and describe a primary
container. For the primary container, you specify the Docker image that contains inference
code, artifacts (from prior training), and a custom environment map that the inference code
uses when you deploy the model for predictions. Use this API to create a model if you want
to use SageMaker hosting services or run a batch transform job. To host your model, you
create an endpoint configuration with the CreateEndpointConfig API, and then create an
endpoint with the CreateEndpoint API. SageMaker then deploys all of the containers that you
defined for the model in the hosting environment. To run a batch transform using your
model, you start a job with the CreateTransformJob API. SageMaker uses your model and your
dataset to get inferences which are then saved to a specified S3 location. In the request,
you also provide an IAM role that SageMaker can assume to access model artifacts and docker
image for deployment on ML compute hosting instances or for batch transform jobs. In
addition, you also use the IAM role to manage permissions the inference code needs. For
example, if the inference code access any other Amazon Web Services resources, you grant
necessary permissions via this role.
# Arguments
- `model_name`: The name of the new model.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Containers"`: Specifies the containers in the inference pipeline.
- `"EnableNetworkIsolation"`: Isolates the model container. No inbound or outbound network
calls can be made to or from the model container.
- `"ExecutionRoleArn"`: The Amazon Resource Name (ARN) of the IAM role that SageMaker can
assume to access model artifacts and docker image for deployment on ML compute instances or
for batch transform jobs. Deploying on ML compute instances is part of model hosting. For
more information, see SageMaker Roles. To be able to pass this role to SageMaker, the
caller of this API must have the iam:PassRole permission.
- `"InferenceExecutionConfig"`: Specifies details of how containers in a multi-container
endpoint are called.
- `"PrimaryContainer"`: The location of the primary docker image containing inference code,
associated artifacts, and custom environment map that the inference code uses when the
model is deployed for predictions.
- `"Tags"`: An array of key-value pairs. You can use tags to categorize your Amazon Web
Services resources in different ways, for example, by purpose, owner, or environment. For
more information, see Tagging Amazon Web Services Resources.
- `"VpcConfig"`: A VpcConfig object that specifies the VPC that you want your model to
connect to. Control access to and from your model container by configuring the VPC.
VpcConfig is used in hosting services and in batch transform. For more information, see
Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch
Transform Jobs by Using an Amazon Virtual Private Cloud.
"""
function create_model(ModelName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"CreateModel",
Dict{String,Any}("ModelName" => ModelName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_model(
ModelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateModel",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ModelName" => ModelName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_model_bias_job_definition(job_definition_name, job_resources, model_bias_app_specification, model_bias_job_input, model_bias_job_output_config, role_arn)
create_model_bias_job_definition(job_definition_name, job_resources, model_bias_app_specification, model_bias_job_input, model_bias_job_output_config, role_arn, params::Dict{String,<:Any})
Creates the definition for a model bias job.
# Arguments
- `job_definition_name`: The name of the bias job definition. The name must be unique
within an Amazon Web Services Region in the Amazon Web Services account.
- `job_resources`:
- `model_bias_app_specification`: Configures the model bias job to run a specified Docker
container image.
- `model_bias_job_input`: Inputs for the model bias job.
- `model_bias_job_output_config`:
- `role_arn`: The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can
assume to perform tasks on your behalf.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ModelBiasBaselineConfig"`: The baseline configuration for a model bias job.
- `"NetworkConfig"`: Networking options for a model bias job.
- `"StoppingCondition"`:
- `"Tags"`: (Optional) An array of key-value pairs. For more information, see Using Cost
Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
"""
function create_model_bias_job_definition(
JobDefinitionName,
JobResources,
ModelBiasAppSpecification,
ModelBiasJobInput,
ModelBiasJobOutputConfig,
RoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateModelBiasJobDefinition",
Dict{String,Any}(
"JobDefinitionName" => JobDefinitionName,
"JobResources" => JobResources,
"ModelBiasAppSpecification" => ModelBiasAppSpecification,
"ModelBiasJobInput" => ModelBiasJobInput,
"ModelBiasJobOutputConfig" => ModelBiasJobOutputConfig,
"RoleArn" => RoleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_model_bias_job_definition(
JobDefinitionName,
JobResources,
ModelBiasAppSpecification,
ModelBiasJobInput,
ModelBiasJobOutputConfig,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateModelBiasJobDefinition",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"JobDefinitionName" => JobDefinitionName,
"JobResources" => JobResources,
"ModelBiasAppSpecification" => ModelBiasAppSpecification,
"ModelBiasJobInput" => ModelBiasJobInput,
"ModelBiasJobOutputConfig" => ModelBiasJobOutputConfig,
"RoleArn" => RoleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_model_card(content, model_card_name, model_card_status)
create_model_card(content, model_card_name, model_card_status, params::Dict{String,<:Any})
Creates an Amazon SageMaker Model Card. For information about how to use model cards, see
Amazon SageMaker Model Card.
# Arguments
- `content`: The content of the model card. Content must be in model card JSON schema and
provided as a string.
- `model_card_name`: The unique name of the model card.
- `model_card_status`: The approval status of the model card within your organization.
Different organizations might have different criteria for model card review and approval.
Draft: The model card is a work in progress. PendingReview: The model card is pending
review. Approved: The model card is approved. Archived: The model card is archived.
No more updates should be made to the model card, but it can still be exported.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SecurityConfig"`: An optional Key Management Service key to encrypt, decrypt, and
re-encrypt model card content for regulated workloads with highly sensitive data.
- `"Tags"`: Key-value pairs used to manage metadata for model cards.
"""
function create_model_card(
Content,
ModelCardName,
ModelCardStatus;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateModelCard",
Dict{String,Any}(
"Content" => Content,
"ModelCardName" => ModelCardName,
"ModelCardStatus" => ModelCardStatus,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_model_card(
Content,
ModelCardName,
ModelCardStatus,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateModelCard",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Content" => Content,
"ModelCardName" => ModelCardName,
"ModelCardStatus" => ModelCardStatus,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_model_card_export_job(model_card_export_job_name, model_card_name, output_config)
create_model_card_export_job(model_card_export_job_name, model_card_name, output_config, params::Dict{String,<:Any})
Creates an Amazon SageMaker Model Card export job.
# Arguments
- `model_card_export_job_name`: The name of the model card export job.
- `model_card_name`: The name or Amazon Resource Name (ARN) of the model card to export.
- `output_config`: The model card output configuration that specifies the Amazon S3 path
for exporting.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ModelCardVersion"`: The version of the model card to export. If a version is not
provided, then the latest version of the model card is exported.
"""
function create_model_card_export_job(
ModelCardExportJobName,
ModelCardName,
OutputConfig;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateModelCardExportJob",
Dict{String,Any}(
"ModelCardExportJobName" => ModelCardExportJobName,
"ModelCardName" => ModelCardName,
"OutputConfig" => OutputConfig,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_model_card_export_job(
ModelCardExportJobName,
ModelCardName,
OutputConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateModelCardExportJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ModelCardExportJobName" => ModelCardExportJobName,
"ModelCardName" => ModelCardName,
"OutputConfig" => OutputConfig,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_model_explainability_job_definition(job_definition_name, job_resources, model_explainability_app_specification, model_explainability_job_input, model_explainability_job_output_config, role_arn)
create_model_explainability_job_definition(job_definition_name, job_resources, model_explainability_app_specification, model_explainability_job_input, model_explainability_job_output_config, role_arn, params::Dict{String,<:Any})
Creates the definition for a model explainability job.
# Arguments
- `job_definition_name`: The name of the model explainability job definition. The name
must be unique within an Amazon Web Services Region in the Amazon Web Services account.
- `job_resources`:
- `model_explainability_app_specification`: Configures the model explainability job to run
a specified Docker container image.
- `model_explainability_job_input`: Inputs for the model explainability job.
- `model_explainability_job_output_config`:
- `role_arn`: The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can
assume to perform tasks on your behalf.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ModelExplainabilityBaselineConfig"`: The baseline configuration for a model
explainability job.
- `"NetworkConfig"`: Networking options for a model explainability job.
- `"StoppingCondition"`:
- `"Tags"`: (Optional) An array of key-value pairs. For more information, see Using Cost
Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
"""
function create_model_explainability_job_definition(
JobDefinitionName,
JobResources,
ModelExplainabilityAppSpecification,
ModelExplainabilityJobInput,
ModelExplainabilityJobOutputConfig,
RoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateModelExplainabilityJobDefinition",
Dict{String,Any}(
"JobDefinitionName" => JobDefinitionName,
"JobResources" => JobResources,
"ModelExplainabilityAppSpecification" => ModelExplainabilityAppSpecification,
"ModelExplainabilityJobInput" => ModelExplainabilityJobInput,
"ModelExplainabilityJobOutputConfig" => ModelExplainabilityJobOutputConfig,
"RoleArn" => RoleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_model_explainability_job_definition(
JobDefinitionName,
JobResources,
ModelExplainabilityAppSpecification,
ModelExplainabilityJobInput,
ModelExplainabilityJobOutputConfig,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateModelExplainabilityJobDefinition",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"JobDefinitionName" => JobDefinitionName,
"JobResources" => JobResources,
"ModelExplainabilityAppSpecification" =>
ModelExplainabilityAppSpecification,
"ModelExplainabilityJobInput" => ModelExplainabilityJobInput,
"ModelExplainabilityJobOutputConfig" =>
ModelExplainabilityJobOutputConfig,
"RoleArn" => RoleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_model_package()
create_model_package(params::Dict{String,<:Any})
Creates a model package that you can use to create SageMaker models or list on Amazon Web
Services Marketplace, or a versioned model that is part of a model group. Buyers can
subscribe to model packages listed on Amazon Web Services Marketplace to create models in
SageMaker. To create a model package by specifying a Docker container that contains your
inference code and the Amazon S3 location of your model artifacts, provide values for
InferenceSpecification. To create a model from an algorithm resource that you created or
subscribed to in Amazon Web Services Marketplace, provide a value for
SourceAlgorithmSpecification. There are two types of model packages: Versioned - a model
that is part of a model group in the model registry. Unversioned - a model package that
is not part of a model group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AdditionalInferenceSpecifications"`: An array of additional Inference Specification
objects. Each additional Inference Specification specifies artifacts based on this model
package that can be used on inference endpoints. Generally used with SageMaker Neo to store
the compiled artifacts.
- `"CertifyForMarketplace"`: Whether to certify the model package for listing on Amazon Web
Services Marketplace. This parameter is optional for unversioned models, and does not apply
to versioned models.
- `"ClientToken"`: A unique token that guarantees that the call to this API is idempotent.
- `"CustomerMetadataProperties"`: The metadata properties associated with the model package
versions.
- `"Domain"`: The machine learning domain of your model package and its components. Common
machine learning domains include computer vision and natural language processing.
- `"DriftCheckBaselines"`: Represents the drift check baselines that can be used when the
model monitor is set using the model package. For more information, see the topic on Drift
Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker
Developer Guide.
- `"InferenceSpecification"`: Specifies details about inference jobs that you can run with
models based on this model package, including the following information: The Amazon ECR
paths of containers that contain the inference code and model artifacts. The instance
types that the model package supports for transform jobs and real-time endpoints used for
inference. The input and output content formats that the model package supports for
inference.
- `"MetadataProperties"`:
- `"ModelApprovalStatus"`: Whether the model is approved for deployment. This parameter is
optional for versioned models, and does not apply to unversioned models. For versioned
models, the value of this parameter must be set to Approved to deploy the model.
- `"ModelCard"`: The model card associated with the model package. Since
ModelPackageModelCard is tied to a model package, it is a specific usage of a model card
and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard
schema does not include model_package_details, and model_overview is composed of the
model_creator and model_artifact properties. For more information about the model package
model card schema, see Model package model card schema. For more information about the
model card associated with the model package, see View the Details of a Model Version.
- `"ModelMetrics"`: A structure that contains model metrics reports.
- `"ModelPackageDescription"`: A description of the model package.
- `"ModelPackageGroupName"`: The name or Amazon Resource Name (ARN) of the model package
group that this model version belongs to. This parameter is required for versioned models,
and does not apply to unversioned models.
- `"ModelPackageName"`: The name of the model package. The name must have 1 to 63
characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen). This parameter is required
for unversioned models. It is not applicable to versioned models.
- `"SamplePayloadUrl"`: The Amazon Simple Storage Service (Amazon S3) path where the sample
payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz
suffix). This archive can hold multiple files that are all equally used in the load test.
Each file in the archive must satisfy the size constraints of the InvokeEndpoint call.
- `"SecurityConfig"`: The KMS Key ID (KMSKeyId) used for encryption of model package
information.
- `"SkipModelValidation"`: Indicates if you want to skip model validation.
- `"SourceAlgorithmSpecification"`: Details about the algorithm that was used to create the
model package.
- `"SourceUri"`: The URI of the source for the model package. If you want to clone a model
package, set it to the model package Amazon Resource Name (ARN). If you want to register a
model, set it to the model ARN.
- `"Tags"`: A list of key value pairs associated with the model. For more information, see
Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
If you supply ModelPackageGroupName, your model package belongs to the model group you
specify and uses the tags associated with the model group. In this case, you cannot supply
a tag argument.
- `"Task"`: The machine learning task your model package accomplishes. Common machine
learning tasks include object detection and image classification. The following tasks are
supported by Inference Recommender: \"IMAGE_CLASSIFICATION\" | \"OBJECT_DETECTION\" |
\"TEXT_GENERATION\" |\"IMAGE_SEGMENTATION\" | \"FILL_MASK\" | \"CLASSIFICATION\" |
\"REGRESSION\" | \"OTHER\". Specify \"OTHER\" if none of the tasks listed fit your use case.
- `"ValidationSpecification"`: Specifies configurations for one or more transform jobs that
SageMaker runs to test the model package.
"""
function create_model_package(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"CreateModelPackage",
Dict{String,Any}("ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_model_package(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"CreateModelPackage",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_model_package_group(model_package_group_name)
create_model_package_group(model_package_group_name, params::Dict{String,<:Any})
Creates a model group. A model group contains a group of model versions.
# Arguments
- `model_package_group_name`: The name of the model group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ModelPackageGroupDescription"`: A description for the model group.
- `"Tags"`: A list of key value pairs associated with the model group. For more
information, see Tagging Amazon Web Services resources in the Amazon Web Services General
Reference Guide.
"""
function create_model_package_group(
ModelPackageGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"CreateModelPackageGroup",
Dict{String,Any}("ModelPackageGroupName" => ModelPackageGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_model_package_group(
ModelPackageGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateModelPackageGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ModelPackageGroupName" => ModelPackageGroupName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_model_quality_job_definition(job_definition_name, job_resources, model_quality_app_specification, model_quality_job_input, model_quality_job_output_config, role_arn)
create_model_quality_job_definition(job_definition_name, job_resources, model_quality_app_specification, model_quality_job_input, model_quality_job_output_config, role_arn, params::Dict{String,<:Any})
Creates a definition for a job that monitors model quality and drift. For information about
model monitor, see Amazon SageMaker Model Monitor.
# Arguments
- `job_definition_name`: The name of the monitoring job definition.
- `job_resources`:
- `model_quality_app_specification`: The container that runs the monitoring job.
- `model_quality_job_input`: A list of the inputs that are monitored. Currently endpoints
are supported.
- `model_quality_job_output_config`:
- `role_arn`: The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can
assume to perform tasks on your behalf.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ModelQualityBaselineConfig"`: Specifies the constraints and baselines for the
monitoring job.
- `"NetworkConfig"`: Specifies the network configuration for the monitoring job.
- `"StoppingCondition"`:
- `"Tags"`: (Optional) An array of key-value pairs. For more information, see Using Cost
Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
"""
function create_model_quality_job_definition(
JobDefinitionName,
JobResources,
ModelQualityAppSpecification,
ModelQualityJobInput,
ModelQualityJobOutputConfig,
RoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateModelQualityJobDefinition",
Dict{String,Any}(
"JobDefinitionName" => JobDefinitionName,
"JobResources" => JobResources,
"ModelQualityAppSpecification" => ModelQualityAppSpecification,
"ModelQualityJobInput" => ModelQualityJobInput,
"ModelQualityJobOutputConfig" => ModelQualityJobOutputConfig,
"RoleArn" => RoleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_model_quality_job_definition(
JobDefinitionName,
JobResources,
ModelQualityAppSpecification,
ModelQualityJobInput,
ModelQualityJobOutputConfig,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateModelQualityJobDefinition",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"JobDefinitionName" => JobDefinitionName,
"JobResources" => JobResources,
"ModelQualityAppSpecification" => ModelQualityAppSpecification,
"ModelQualityJobInput" => ModelQualityJobInput,
"ModelQualityJobOutputConfig" => ModelQualityJobOutputConfig,
"RoleArn" => RoleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_monitoring_schedule(monitoring_schedule_config, monitoring_schedule_name)
create_monitoring_schedule(monitoring_schedule_config, monitoring_schedule_name, params::Dict{String,<:Any})
Creates a schedule that regularly starts Amazon SageMaker Processing Jobs to monitor the
data captured for an Amazon SageMaker Endpoint.
# Arguments
- `monitoring_schedule_config`: The configuration object that specifies the monitoring
schedule and defines the monitoring job.
- `monitoring_schedule_name`: The name of the monitoring schedule. The name must be unique
within an Amazon Web Services Region within an Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: (Optional) An array of key-value pairs. For more information, see Using Cost
Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
"""
function create_monitoring_schedule(
MonitoringScheduleConfig,
MonitoringScheduleName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateMonitoringSchedule",
Dict{String,Any}(
"MonitoringScheduleConfig" => MonitoringScheduleConfig,
"MonitoringScheduleName" => MonitoringScheduleName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_monitoring_schedule(
MonitoringScheduleConfig,
MonitoringScheduleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateMonitoringSchedule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MonitoringScheduleConfig" => MonitoringScheduleConfig,
"MonitoringScheduleName" => MonitoringScheduleName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_notebook_instance(instance_type, notebook_instance_name, role_arn)
create_notebook_instance(instance_type, notebook_instance_name, role_arn, params::Dict{String,<:Any})
Creates an SageMaker notebook instance. A notebook instance is a machine learning (ML)
compute instance running on a Jupyter notebook. In a CreateNotebookInstance request,
specify the type of ML compute instance that you want to run. SageMaker launches the
instance, installs common libraries that you can use to explore datasets for model
training, and attaches an ML storage volume to the notebook instance. SageMaker also
provides a set of example notebooks. Each notebook demonstrates how to use SageMaker with a
specific algorithm or with a machine learning framework. After receiving the request,
SageMaker does the following: Creates a network interface in the SageMaker VPC.
(Option) If you specified SubnetId, SageMaker creates a network interface in your own VPC,
which is inferred from the subnet ID that you provide in the input. When creating this
network interface, SageMaker attaches the security group that you specified in the request
to the network interface that it creates in your VPC. Launches an EC2 instance of the
type specified in the request in the SageMaker VPC. If you specified SubnetId of your VPC,
SageMaker specifies both network interfaces when launching this instance. This enables
inbound traffic from your own VPC to the notebook instance, assuming that the security
groups allow it. After creating the notebook instance, SageMaker returns its Amazon
Resource Name (ARN). You can't change the name of a notebook instance after you create it.
After SageMaker creates the notebook instance, you can connect to the Jupyter server and
work in Jupyter notebooks. For example, you can write code to explore a dataset that you
can use for model training, train a model, host models by creating SageMaker endpoints, and
validate hosted models. For more information, see How It Works.
# Arguments
- `instance_type`: The type of ML compute instance to launch for the notebook instance.
- `notebook_instance_name`: The name of the new notebook instance.
- `role_arn`: When you send any requests to Amazon Web Services resources from the
notebook instance, SageMaker assumes this role to perform tasks on your behalf. You must
grant this role necessary permissions so SageMaker can perform these tasks. The policy must
allow the SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this
role. For more information, see SageMaker Roles. To be able to pass this role to
SageMaker, the caller of this API must have the iam:PassRole permission.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceleratorTypes"`: A list of Elastic Inference (EI) instance types to associate with
this notebook instance. Currently, only one instance type can be associated with a notebook
instance. For more information, see Using Elastic Inference in Amazon SageMaker.
- `"AdditionalCodeRepositories"`: An array of up to three Git repositories to associate
with the notebook instance. These can be either the names of Git repositories stored as
resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit
or in any other Git repository. These repositories are cloned at the same level as the
default repository of your notebook instance. For more information, see Associating Git
Repositories with SageMaker Notebook Instances.
- `"DefaultCodeRepository"`: A Git repository to associate with the notebook instance as
its default code repository. This can be either the name of a Git repository stored as a
resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit
or in any other Git repository. When you open a notebook instance, it opens in the
directory that contains this repository. For more information, see Associating Git
Repositories with SageMaker Notebook Instances.
- `"DirectInternetAccess"`: Sets whether SageMaker provides internet access to the notebook
instance. If you set this to Disabled this notebook instance is able to access resources
only in your VPC, and is not be able to connect to SageMaker training and endpoint services
unless you configure a NAT Gateway in your VPC. For more information, see Notebook
Instances Are Internet-Enabled by Default. You can set the value of this parameter to
Disabled only if you set a value for the SubnetId parameter.
- `"InstanceMetadataServiceConfiguration"`: Information on the IMDS configuration of the
notebook instance
- `"KmsKeyId"`: The Amazon Resource Name (ARN) of a Amazon Web Services Key Management
Service key that SageMaker uses to encrypt data on the storage volume attached to your
notebook instance. The KMS key you provide must be enabled. For information, see Enabling
and Disabling Keys in the Amazon Web Services Key Management Service Developer Guide.
- `"LifecycleConfigName"`: The name of a lifecycle configuration to associate with the
notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional)
Customize a Notebook Instance.
- `"PlatformIdentifier"`: The platform identifier of the notebook instance runtime
environment.
- `"RootAccess"`: Whether root access is enabled or disabled for users of the notebook
instance. The default value is Enabled. Lifecycle configurations need root access to be
able to set up a notebook instance. Because of this, lifecycle configurations associated
with a notebook instance always run with root access even if you disable root access for
users.
- `"SecurityGroupIds"`: The VPC security group IDs, in the form sg-xxxxxxxx. The security
groups must be for the same VPC as specified in the subnet.
- `"SubnetId"`: The ID of the subnet in a VPC to which you would like to have a
connectivity from your ML compute instance.
- `"Tags"`: An array of key-value pairs. You can use tags to categorize your Amazon Web
Services resources in different ways, for example, by purpose, owner, or environment. For
more information, see Tagging Amazon Web Services Resources.
- `"VolumeSizeInGB"`: The size, in GB, of the ML storage volume to attach to the notebook
instance. The default value is 5 GB.
"""
function create_notebook_instance(
InstanceType,
NotebookInstanceName,
RoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateNotebookInstance",
Dict{String,Any}(
"InstanceType" => InstanceType,
"NotebookInstanceName" => NotebookInstanceName,
"RoleArn" => RoleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_notebook_instance(
InstanceType,
NotebookInstanceName,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateNotebookInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceType" => InstanceType,
"NotebookInstanceName" => NotebookInstanceName,
"RoleArn" => RoleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_notebook_instance_lifecycle_config(notebook_instance_lifecycle_config_name)
create_notebook_instance_lifecycle_config(notebook_instance_lifecycle_config_name, params::Dict{String,<:Any})
Creates a lifecycle configuration that you can associate with a notebook instance. A
lifecycle configuration is a collection of shell scripts that run when you create or start
a notebook instance. Each lifecycle configuration script has a limit of 16384 characters.
The value of the PATH environment variable that is available to both scripts is
/sbin:bin:/usr/sbin:/usr/bin. View Amazon CloudWatch Logs for notebook instance lifecycle
configurations in log group /aws/sagemaker/NotebookInstances in log stream
[notebook-instance-name]/[LifecycleConfigHook]. Lifecycle configuration scripts cannot run
for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the
notebook instance is not created or started. For information about notebook instance
lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.
# Arguments
- `notebook_instance_lifecycle_config_name`: The name of the lifecycle configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"OnCreate"`: A shell script that runs only once, when you create a notebook instance.
The shell script must be a base64-encoded string.
- `"OnStart"`: A shell script that runs every time you start a notebook instance, including
when you create the notebook instance. The shell script must be a base64-encoded string.
"""
function create_notebook_instance_lifecycle_config(
NotebookInstanceLifecycleConfigName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"CreateNotebookInstanceLifecycleConfig",
Dict{String,Any}(
"NotebookInstanceLifecycleConfigName" => NotebookInstanceLifecycleConfigName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_notebook_instance_lifecycle_config(
NotebookInstanceLifecycleConfigName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateNotebookInstanceLifecycleConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"NotebookInstanceLifecycleConfigName" =>
NotebookInstanceLifecycleConfigName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_pipeline(client_request_token, pipeline_name, role_arn)
create_pipeline(client_request_token, pipeline_name, role_arn, params::Dict{String,<:Any})
Creates a pipeline using a JSON pipeline definition.
# Arguments
- `client_request_token`: A unique, case-sensitive identifier that you provide to ensure
the idempotency of the operation. An idempotent operation completes no more than one time.
- `pipeline_name`: The name of the pipeline.
- `role_arn`: The Amazon Resource Name (ARN) of the role used by the pipeline to access and
create resources.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ParallelismConfiguration"`: This is the configuration that controls the parallelism of
the pipeline. If specified, it applies to all runs of this pipeline by default.
- `"PipelineDefinition"`: The JSON pipeline definition of the pipeline.
- `"PipelineDefinitionS3Location"`: The location of the pipeline definition stored in
Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.
- `"PipelineDescription"`: A description of the pipeline.
- `"PipelineDisplayName"`: The display name of the pipeline.
- `"Tags"`: A list of tags to apply to the created pipeline.
"""
function create_pipeline(
ClientRequestToken,
PipelineName,
RoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreatePipeline",
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken,
"PipelineName" => PipelineName,
"RoleArn" => RoleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_pipeline(
ClientRequestToken,
PipelineName,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreatePipeline",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken,
"PipelineName" => PipelineName,
"RoleArn" => RoleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_presigned_domain_url(domain_id, user_profile_name)
create_presigned_domain_url(domain_id, user_profile_name, params::Dict{String,<:Any})
Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the
user will be automatically signed in to the domain, and granted access to all of the Apps
and files associated with the Domain's Amazon Elastic File System volume. This operation
can only be called when the authentication mode equals IAM. The IAM role or user passed to
this API defines the permissions to access the app. Once the presigned URL is created, no
additional permission is required to access this URL. IAM authorization policies for this
API are also enforced for every HTTP request and WebSocket frame that attempts to connect
to the app. You can restrict access to this API and to the URL that it returns to a list of
IP addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more information,
see Connect to Amazon SageMaker Studio Through an Interface VPC Endpoint . The URL that
you get from a call to CreatePresignedDomainUrl has a default timeout of 5 minutes. You can
configure this value using ExpiresInSeconds. If you try to use the URL after the timeout
limit expires, you are directed to the Amazon Web Services console sign-in page.
# Arguments
- `domain_id`: The domain ID.
- `user_profile_name`: The name of the UserProfile to sign-in as.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExpiresInSeconds"`: The number of seconds until the pre-signed URL expires. This value
defaults to 300.
- `"LandingUri"`: The landing page that the user is directed to when accessing the
presigned URL. Using this value, users can access Studio or Studio Classic, even if it is
not the default experience for the domain. The supported values are:
studio::relative/path: Directs users to the relative path in Studio.
app:JupyterServer:relative/path: Directs users to the relative path in the Studio Classic
application. app:JupyterLab:relative/path: Directs users to the relative path in the
JupyterLab application. app:RStudioServerPro:relative/path: Directs users to the
relative path in the RStudio application. app:CodeEditor:relative/path: Directs users to
the relative path in the Code Editor, based on Code-OSS, Visual Studio Code - Open Source
application. app:Canvas:relative/path: Directs users to the relative path in the Canvas
application.
- `"SessionExpirationDurationInSeconds"`: The session expiration duration in seconds. This
value defaults to 43200.
- `"SpaceName"`: The name of the space.
"""
function create_presigned_domain_url(
DomainId, UserProfileName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"CreatePresignedDomainUrl",
Dict{String,Any}("DomainId" => DomainId, "UserProfileName" => UserProfileName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_presigned_domain_url(
DomainId,
UserProfileName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreatePresignedDomainUrl",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DomainId" => DomainId, "UserProfileName" => UserProfileName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_presigned_mlflow_tracking_server_url(tracking_server_name)
create_presigned_mlflow_tracking_server_url(tracking_server_name, params::Dict{String,<:Any})
Returns a presigned URL that you can use to connect to the MLflow UI attached to your
tracking server. For more information, see Launch the MLflow UI using a presigned URL.
# Arguments
- `tracking_server_name`: The name of the tracking server to connect to your MLflow UI.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExpiresInSeconds"`: The duration in seconds that your presigned URL is valid. The
presigned URL can be used only once.
- `"SessionExpirationDurationInSeconds"`: The duration in seconds that your MLflow UI
session is valid.
"""
function create_presigned_mlflow_tracking_server_url(
TrackingServerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"CreatePresignedMlflowTrackingServerUrl",
Dict{String,Any}("TrackingServerName" => TrackingServerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_presigned_mlflow_tracking_server_url(
TrackingServerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreatePresignedMlflowTrackingServerUrl",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("TrackingServerName" => TrackingServerName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_presigned_notebook_instance_url(notebook_instance_name)
create_presigned_notebook_instance_url(notebook_instance_name, params::Dict{String,<:Any})
Returns a URL that you can use to connect to the Jupyter server from a notebook instance.
In the SageMaker console, when you choose Open next to a notebook instance, SageMaker opens
a new tab showing the Jupyter server home page from the notebook instance. The console uses
this API to get the URL and show the page. The IAM role or user used to call this API
defines the permissions to access the notebook instance. Once the presigned URL is created,
no additional permission is required to access this URL. IAM authorization policies for
this API are also enforced for every HTTP request and WebSocket frame that attempts to
connect to the notebook instance. You can restrict access to this API and to the URL that
it returns to a list of IP addresses that you specify. Use the NotIpAddress condition
operator and the aws:SourceIP condition context key to specify the list of IP addresses
that you want to have access to the notebook instance. For more information, see Limit
Access to a Notebook Instance by IP Address. The URL that you get from a call to
CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If you try to use the URL
after the 5-minute limit expires, you are directed to the Amazon Web Services console
sign-in page.
# Arguments
- `notebook_instance_name`: The name of the notebook instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SessionExpirationDurationInSeconds"`: The duration of the session, in seconds. The
default is 12 hours.
"""
function create_presigned_notebook_instance_url(
NotebookInstanceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"CreatePresignedNotebookInstanceUrl",
Dict{String,Any}("NotebookInstanceName" => NotebookInstanceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_presigned_notebook_instance_url(
NotebookInstanceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreatePresignedNotebookInstanceUrl",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("NotebookInstanceName" => NotebookInstanceName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_processing_job(app_specification, processing_job_name, processing_resources, role_arn)
create_processing_job(app_specification, processing_job_name, processing_resources, role_arn, params::Dict{String,<:Any})
Creates a processing job.
# Arguments
- `app_specification`: Configures the processing job to run a specified Docker container
image.
- `processing_job_name`: The name of the processing job. The name must be unique within an
Amazon Web Services Region in the Amazon Web Services account.
- `processing_resources`: Identifies the resources, ML compute instances, and ML storage
volumes to deploy for a processing job. In distributed training, you specify more than one
instance.
- `role_arn`: The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can
assume to perform tasks on your behalf.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Environment"`: The environment variables to set in the Docker container. Up to 100 key
and values entries in the map are supported.
- `"ExperimentConfig"`:
- `"NetworkConfig"`: Networking options for a processing job, such as whether to allow
inbound and outbound network calls to and from processing containers, and the VPC subnets
and security groups to use for VPC-enabled processing jobs.
- `"ProcessingInputs"`: An array of inputs configuring the data to download into the
processing container.
- `"ProcessingOutputConfig"`: Output configuration for the processing job.
- `"StoppingCondition"`: The time limit for how long the processing job is allowed to run.
- `"Tags"`: (Optional) An array of key-value pairs. For more information, see Using Cost
Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
"""
function create_processing_job(
AppSpecification,
ProcessingJobName,
ProcessingResources,
RoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateProcessingJob",
Dict{String,Any}(
"AppSpecification" => AppSpecification,
"ProcessingJobName" => ProcessingJobName,
"ProcessingResources" => ProcessingResources,
"RoleArn" => RoleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_processing_job(
AppSpecification,
ProcessingJobName,
ProcessingResources,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateProcessingJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AppSpecification" => AppSpecification,
"ProcessingJobName" => ProcessingJobName,
"ProcessingResources" => ProcessingResources,
"RoleArn" => RoleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_project(project_name, service_catalog_provisioning_details)
create_project(project_name, service_catalog_provisioning_details, params::Dict{String,<:Any})
Creates a machine learning (ML) project that can contain one or more templates that set up
an ML pipeline from training to deploying an approved model.
# Arguments
- `project_name`: The name of the project.
- `service_catalog_provisioning_details`: The product ID and provisioning artifact ID to
provision a service catalog. The provisioning artifact ID will default to the latest
provisioning artifact ID of the product, if you don't provide the provisioning artifact ID.
For more information, see What is Amazon Web Services Service Catalog.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ProjectDescription"`: A description for the project.
- `"Tags"`: An array of key-value pairs that you want to use to organize and track your
Amazon Web Services resource costs. For more information, see Tagging Amazon Web Services
resources in the Amazon Web Services General Reference Guide.
"""
function create_project(
ProjectName,
ServiceCatalogProvisioningDetails;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateProject",
Dict{String,Any}(
"ProjectName" => ProjectName,
"ServiceCatalogProvisioningDetails" => ServiceCatalogProvisioningDetails,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_project(
ProjectName,
ServiceCatalogProvisioningDetails,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateProject",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ProjectName" => ProjectName,
"ServiceCatalogProvisioningDetails" =>
ServiceCatalogProvisioningDetails,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_space(domain_id, space_name)
create_space(domain_id, space_name, params::Dict{String,<:Any})
Creates a private space or a space used for real time collaboration in a domain.
# Arguments
- `domain_id`: The ID of the associated domain.
- `space_name`: The name of the space.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"OwnershipSettings"`: A collection of ownership settings.
- `"SpaceDisplayName"`: The name of the space that appears in the SageMaker Studio UI.
- `"SpaceSettings"`: A collection of space settings.
- `"SpaceSharingSettings"`: A collection of space sharing settings.
- `"Tags"`: Tags to associated with the space. Each tag consists of a key and an optional
value. Tag keys must be unique for each resource. Tags are searchable using the Search API.
"""
function create_space(
DomainId, SpaceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"CreateSpace",
Dict{String,Any}("DomainId" => DomainId, "SpaceName" => SpaceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_space(
DomainId,
SpaceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateSpace",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DomainId" => DomainId, "SpaceName" => SpaceName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_studio_lifecycle_config(studio_lifecycle_config_app_type, studio_lifecycle_config_content, studio_lifecycle_config_name)
create_studio_lifecycle_config(studio_lifecycle_config_app_type, studio_lifecycle_config_content, studio_lifecycle_config_name, params::Dict{String,<:Any})
Creates a new Amazon SageMaker Studio Lifecycle Configuration.
# Arguments
- `studio_lifecycle_config_app_type`: The App type that the Lifecycle Configuration is
attached to.
- `studio_lifecycle_config_content`: The content of your Amazon SageMaker Studio Lifecycle
Configuration script. This content must be base64 encoded.
- `studio_lifecycle_config_name`: The name of the Amazon SageMaker Studio Lifecycle
Configuration to create.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: Tags to be associated with the Lifecycle Configuration. Each tag consists of a
key and an optional value. Tag keys must be unique per resource. Tags are searchable using
the Search API.
"""
function create_studio_lifecycle_config(
StudioLifecycleConfigAppType,
StudioLifecycleConfigContent,
StudioLifecycleConfigName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateStudioLifecycleConfig",
Dict{String,Any}(
"StudioLifecycleConfigAppType" => StudioLifecycleConfigAppType,
"StudioLifecycleConfigContent" => StudioLifecycleConfigContent,
"StudioLifecycleConfigName" => StudioLifecycleConfigName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_studio_lifecycle_config(
StudioLifecycleConfigAppType,
StudioLifecycleConfigContent,
StudioLifecycleConfigName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateStudioLifecycleConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"StudioLifecycleConfigAppType" => StudioLifecycleConfigAppType,
"StudioLifecycleConfigContent" => StudioLifecycleConfigContent,
"StudioLifecycleConfigName" => StudioLifecycleConfigName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_training_job(algorithm_specification, output_data_config, resource_config, role_arn, stopping_condition, training_job_name)
create_training_job(algorithm_specification, output_data_config, resource_config, role_arn, stopping_condition, training_job_name, params::Dict{String,<:Any})
Starts a model training job. After training completes, SageMaker saves the resulting model
artifacts to an Amazon S3 location that you specify. If you choose to host your model
using SageMaker hosting services, you can use the resulting model artifacts as part of the
model. You can also use the artifacts in a machine learning service other than SageMaker,
provided that you know how to use them for inference. In the request body, you provide the
following: AlgorithmSpecification - Identifies the training algorithm to use.
HyperParameters - Specify these algorithm-specific parameters to enable the estimation of
model parameters during training. Hyperparameters can be tuned to optimize this learning
process. For a list of hyperparameters for each training algorithm provided by SageMaker,
see Algorithms. Do not include any security-sensitive information including account
access IDs, secrets or tokens in any hyperparameter field. If the use of security-sensitive
credentials are detected, SageMaker will reject your training job request and return an
exception error. InputDataConfig - Describes the input required by the training job and
the Amazon S3, EFS, or FSx location where it is stored. OutputDataConfig - Identifies
the Amazon S3 bucket where you want SageMaker to save the results of model training.
ResourceConfig - Identifies the resources, ML compute instances, and ML storage volumes to
deploy for model training. In distributed training, you specify more than one instance.
EnableManagedSpotTraining - Optimize the cost of training machine learning models by up to
80% by using Amazon EC2 Spot instances. For more information, see Managed Spot Training.
RoleArn - The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your
behalf during model training. You must grant this role the necessary permissions so that
SageMaker can successfully complete model training. StoppingCondition - To help cap
training costs, use MaxRuntimeInSeconds to set a time limit for training. Use
MaxWaitTimeInSeconds to specify how long a managed spot training job has to complete.
Environment - The environment variables to set in the Docker container. RetryStrategy -
The number of times to retry the job when the job fails due to an InternalServerError.
For more information about SageMaker, see How It Works.
# Arguments
- `algorithm_specification`: The registry path of the Docker image that contains the
training algorithm and algorithm-specific metadata, including the input mode. For more
information about algorithms provided by SageMaker, see Algorithms. For information about
providing your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.
- `output_data_config`: Specifies the path to the S3 location where you want to store model
artifacts. SageMaker creates subfolders for the artifacts.
- `resource_config`: The resources, including the ML compute instances and ML storage
volumes, to use for model training. ML storage volumes store model artifacts and
incremental states. Training algorithms might also use ML storage volumes for scratch
space. If you want SageMaker to use the ML storage volume to store the training data,
choose File as the TrainingInputMode in the algorithm specification. For distributed
training algorithms, specify an instance count greater than 1.
- `role_arn`: The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to
perform tasks on your behalf. During model training, SageMaker needs your permission to
read input data from an S3 bucket, download a Docker image that contains training code,
write model artifacts to an S3 bucket, write logs to Amazon CloudWatch Logs, and publish
metrics to Amazon CloudWatch. You grant permissions for all of these tasks to an IAM role.
For more information, see SageMaker Roles. To be able to pass this role to SageMaker, the
caller of this API must have the iam:PassRole permission.
- `stopping_condition`: Specifies a limit to how long a model training job can run. It also
specifies how long a managed Spot training job has to complete. When the job reaches the
time limit, SageMaker ends the training job. Use this API to cap model training costs. To
stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination
for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so
the results of training are not lost.
- `training_job_name`: The name of the training job. The name must be unique within an
Amazon Web Services Region in an Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CheckpointConfig"`: Contains information about the output location for managed spot
training checkpoint data.
- `"DebugHookConfig"`:
- `"DebugRuleConfigurations"`: Configuration information for Amazon SageMaker Debugger
rules for debugging output tensors.
- `"EnableInterContainerTrafficEncryption"`: To encrypt all communications between ML
compute instances in distributed training, choose True. Encryption provides greater
security for distributed training, but training might take longer. How long it takes
depends on the amount of communication between compute instances, especially if you use a
deep learning algorithm in distributed training. For more information, see Protect
Communications Between ML Compute Instances in a Distributed Training Job.
- `"EnableManagedSpotTraining"`: To train models using managed spot training, choose True.
Managed spot training provides a fully managed and scalable infrastructure for training
machine learning models. this option is useful when training jobs can be interrupted and
when there is flexibility when the training job is run. The complete and intermediate
results of jobs are stored in an Amazon S3 bucket, and can be used as a starting point to
train models incrementally. Amazon SageMaker provides metrics and logs in CloudWatch. They
can be used to see when managed spot training jobs are running, interrupted, resumed, or
completed.
- `"EnableNetworkIsolation"`: Isolates the training container. No inbound or outbound
network calls can be made, except for calls between peers within a training cluster for
distributed training. If you enable network isolation for training jobs that are configured
to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the
specified VPC, but the training container does not have network access.
- `"Environment"`: The environment variables to set in the Docker container.
- `"ExperimentConfig"`:
- `"HyperParameters"`: Algorithm-specific parameters that influence the quality of the
model. You set hyperparameters before you start the learning process. For a list of
hyperparameters for each training algorithm provided by SageMaker, see Algorithms. You can
specify a maximum of 100 hyperparameters. Each hyperparameter is a key-value pair. Each key
and value is limited to 256 characters, as specified by the Length Constraint. Do not
include any security-sensitive information including account access IDs, secrets or tokens
in any hyperparameter field. If the use of security-sensitive credentials are detected,
SageMaker will reject your training job request and return an exception error.
- `"InfraCheckConfig"`: Contains information about the infrastructure health check
configuration for the training job.
- `"InputDataConfig"`: An array of Channel objects. Each channel is a named input source.
InputDataConfig describes the input data and its location. Algorithms can accept input
data from one or more channels. For example, an algorithm might have two channels of input
data, training_data and validation_data. The configuration for each channel provides the
S3, EFS, or FSx location where the input data is stored. It also provides information about
the stored data: the MIME type, compression method, and whether the data is wrapped in
RecordIO format. Depending on the input mode that the algorithm supports, SageMaker either
copies input data files from an S3 bucket to a local directory in the Docker container, or
makes it available as input streams. For example, if you specify an EFS location, input
data files are available as input streams. They do not need to be downloaded. Your input
must be in the same Amazon Web Services region as your training job.
- `"ProfilerConfig"`:
- `"ProfilerRuleConfigurations"`: Configuration information for Amazon SageMaker Debugger
rules for profiling system and framework metrics.
- `"RemoteDebugConfig"`: Configuration for remote debugging. To learn more about the remote
debugging functionality of SageMaker, see Access a training container through Amazon Web
Services Systems Manager (SSM) for remote debugging.
- `"RetryStrategy"`: The number of times to retry the job when the job fails due to an
InternalServerError.
- `"SessionChainingConfig"`: Contains information about attribute-based access control
(ABAC) for the training job.
- `"Tags"`: An array of key-value pairs. You can use tags to categorize your Amazon Web
Services resources in different ways, for example, by purpose, owner, or environment. For
more information, see Tagging Amazon Web Services Resources.
- `"TensorBoardOutputConfig"`:
- `"VpcConfig"`: A VpcConfig object that specifies the VPC that you want your training job
to connect to. Control access to and from your training container by configuring the VPC.
For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.
"""
function create_training_job(
AlgorithmSpecification,
OutputDataConfig,
ResourceConfig,
RoleArn,
StoppingCondition,
TrainingJobName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateTrainingJob",
Dict{String,Any}(
"AlgorithmSpecification" => AlgorithmSpecification,
"OutputDataConfig" => OutputDataConfig,
"ResourceConfig" => ResourceConfig,
"RoleArn" => RoleArn,
"StoppingCondition" => StoppingCondition,
"TrainingJobName" => TrainingJobName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_training_job(
AlgorithmSpecification,
OutputDataConfig,
ResourceConfig,
RoleArn,
StoppingCondition,
TrainingJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateTrainingJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AlgorithmSpecification" => AlgorithmSpecification,
"OutputDataConfig" => OutputDataConfig,
"ResourceConfig" => ResourceConfig,
"RoleArn" => RoleArn,
"StoppingCondition" => StoppingCondition,
"TrainingJobName" => TrainingJobName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_transform_job(model_name, transform_input, transform_job_name, transform_output, transform_resources)
create_transform_job(model_name, transform_input, transform_job_name, transform_output, transform_resources, params::Dict{String,<:Any})
Starts a transform job. A transform job uses a trained model to get inferences on a dataset
and saves these results to an Amazon S3 location that you specify. To perform batch
transformations, you create a transform job and use the data that you have readily
available. In the request body, you provide the following: TransformJobName - Identifies
the transform job. The name must be unique within an Amazon Web Services Region in an
Amazon Web Services account. ModelName - Identifies the model to use. ModelName must be
the name of an existing Amazon SageMaker model in the same Amazon Web Services Region and
Amazon Web Services account. For information on creating a model, see CreateModel.
TransformInput - Describes the dataset to be transformed and the Amazon S3 location where
it is stored. TransformOutput - Identifies the Amazon S3 location where you want Amazon
SageMaker to save the results from the transform job. TransformResources - Identifies
the ML compute instances for the transform job. For more information about how batch
transformation works, see Batch Transform.
# Arguments
- `model_name`: The name of the model that you want to use for the transform job. ModelName
must be the name of an existing Amazon SageMaker model within an Amazon Web Services Region
in an Amazon Web Services account.
- `transform_input`: Describes the input source and the way the transform job consumes it.
- `transform_job_name`: The name of the transform job. The name must be unique within an
Amazon Web Services Region in an Amazon Web Services account.
- `transform_output`: Describes the results of the transform job.
- `transform_resources`: Describes the resources, including ML instance types and ML
instance count, to use for the transform job.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BatchStrategy"`: Specifies the number of records to include in a mini-batch for an HTTP
inference request. A record is a single unit of input data that inference can be made on.
For example, a single line in a CSV file is a record. To enable the batch strategy, you
must set the SplitType property to Line, RecordIO, or TFRecord. To use only one record when
making an HTTP invocation request to a container, set BatchStrategy to SingleRecord and
SplitType to Line. To fit as many records in a mini-batch as can fit within the
MaxPayloadInMB limit, set BatchStrategy to MultiRecord and SplitType to Line.
- `"DataCaptureConfig"`: Configuration to control how SageMaker captures inference data.
- `"DataProcessing"`: The data structure used to specify the data to be used for inference
in a batch transform job and to associate the data that is relevant to the prediction
results in the output. The input filter provided allows you to exclude input data that is
not needed for inference in a batch transform job. The output filter provided allows you to
include input data relevant to interpreting the predictions in the output from the job. For
more information, see Associate Prediction Results with their Corresponding Input Records.
- `"Environment"`: The environment variables to set in the Docker container. We support up
to 16 key and values entries in the map.
- `"ExperimentConfig"`:
- `"MaxConcurrentTransforms"`: The maximum number of parallel requests that can be sent to
each instance in a transform job. If MaxConcurrentTransforms is set to 0 or left unset,
Amazon SageMaker checks the optional execution-parameters to determine the settings for
your chosen algorithm. If the execution-parameters endpoint is not enabled, the default
value is 1. For more information on execution-parameters, see How Containers Serve
Requests. For built-in algorithms, you don't need to set a value for
MaxConcurrentTransforms.
- `"MaxPayloadInMB"`: The maximum allowed size of the payload, in MB. A payload is the data
portion of a record (without metadata). The value in MaxPayloadInMB must be greater than,
or equal to, the size of a single record. To estimate the size of a record in MB, divide
the size of your dataset by the number of records. To ensure that the records fit within
the maximum payload size, we recommend using a slightly larger value. The default value is
6 MB. The value of MaxPayloadInMB cannot be greater than 100 MB. If you specify the
MaxConcurrentTransforms parameter, the value of (MaxConcurrentTransforms * MaxPayloadInMB)
also cannot exceed 100 MB. For cases where the payload might be arbitrarily large and is
transmitted using HTTP chunked encoding, set the value to 0. This feature works only in
supported algorithms. Currently, Amazon SageMaker built-in algorithms do not support HTTP
chunked encoding.
- `"ModelClientConfig"`: Configures the timeout and maximum number of retries for
processing a transform job invocation.
- `"Tags"`: (Optional) An array of key-value pairs. For more information, see Using Cost
Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
"""
function create_transform_job(
ModelName,
TransformInput,
TransformJobName,
TransformOutput,
TransformResources;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateTransformJob",
Dict{String,Any}(
"ModelName" => ModelName,
"TransformInput" => TransformInput,
"TransformJobName" => TransformJobName,
"TransformOutput" => TransformOutput,
"TransformResources" => TransformResources,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_transform_job(
ModelName,
TransformInput,
TransformJobName,
TransformOutput,
TransformResources,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateTransformJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ModelName" => ModelName,
"TransformInput" => TransformInput,
"TransformJobName" => TransformJobName,
"TransformOutput" => TransformOutput,
"TransformResources" => TransformResources,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_trial(experiment_name, trial_name)
create_trial(experiment_name, trial_name, params::Dict{String,<:Any})
Creates an SageMaker trial. A trial is a set of steps called trial components that produce
a machine learning model. A trial is part of a single SageMaker experiment. When you use
SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components
are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK
for Python (Boto), you must use the logging APIs provided by the SDK. You can add tags to a
trial and then use the Search API to search for the tags. To get a list of all your trials,
call the ListTrials API. To view a trial's properties, call the DescribeTrial API. To
create a trial component, call the CreateTrialComponent API.
# Arguments
- `experiment_name`: The name of the experiment to associate the trial with.
- `trial_name`: The name of the trial. The name must be unique in your Amazon Web Services
account and is not case-sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DisplayName"`: The name of the trial as displayed. The name doesn't need to be unique.
If DisplayName isn't specified, TrialName is displayed.
- `"MetadataProperties"`:
- `"Tags"`: A list of tags to associate with the trial. You can use Search API to search on
the tags.
"""
function create_trial(
ExperimentName, TrialName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"CreateTrial",
Dict{String,Any}("ExperimentName" => ExperimentName, "TrialName" => TrialName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_trial(
ExperimentName,
TrialName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateTrial",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ExperimentName" => ExperimentName, "TrialName" => TrialName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_trial_component(trial_component_name)
create_trial_component(trial_component_name, params::Dict{String,<:Any})
Creates a trial component, which is a stage of a machine learning trial. A trial is
composed of one or more trial components. A trial component can be used in multiple trials.
Trial components include pre-processing jobs, training jobs, and batch transform jobs. When
you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial
components are automatically tracked, logged, and indexed. When you use the Amazon Web
Services SDK for Python (Boto), you must use the logging APIs provided by the SDK. You can
add tags to a trial component and then use the Search API to search for the tags.
# Arguments
- `trial_component_name`: The name of the component. The name must be unique in your Amazon
Web Services account and is not case-sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DisplayName"`: The name of the component as displayed. The name doesn't need to be
unique. If DisplayName isn't specified, TrialComponentName is displayed.
- `"EndTime"`: When the component ended.
- `"InputArtifacts"`: The input artifacts for the component. Examples of input artifacts
are datasets, algorithms, hyperparameters, source code, and instance types.
- `"MetadataProperties"`:
- `"OutputArtifacts"`: The output artifacts for the component. Examples of output artifacts
are metrics, snapshots, logs, and images.
- `"Parameters"`: The hyperparameters for the component.
- `"StartTime"`: When the component started.
- `"Status"`: The status of the component. States include: InProgress Completed
Failed
- `"Tags"`: A list of tags to associate with the component. You can use Search API to
search on the tags.
"""
function create_trial_component(
TrialComponentName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"CreateTrialComponent",
Dict{String,Any}("TrialComponentName" => TrialComponentName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_trial_component(
TrialComponentName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateTrialComponent",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("TrialComponentName" => TrialComponentName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_user_profile(domain_id, user_profile_name)
create_user_profile(domain_id, user_profile_name, params::Dict{String,<:Any})
Creates a user profile. A user profile represents a single user within a domain, and is the
main way to reference a \"person\" for the purposes of sharing, reporting, and other
user-oriented features. This entity is created when a user onboards to a domain. If an
administrator invites a person by email or imports them from IAM Identity Center, a user
profile is automatically created. A user profile is the primary holder of settings for an
individual user and has a reference to the user's private Amazon Elastic File System home
directory.
# Arguments
- `domain_id`: The ID of the associated Domain.
- `user_profile_name`: A name for the UserProfile. This value is not case sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SingleSignOnUserIdentifier"`: A specifier for the type of value specified in
SingleSignOnUserValue. Currently, the only supported value is \"UserName\". If the Domain's
AuthMode is IAM Identity Center, this field is required. If the Domain's AuthMode is not
IAM Identity Center, this field cannot be specified.
- `"SingleSignOnUserValue"`: The username of the associated Amazon Web Services Single
Sign-On User for this UserProfile. If the Domain's AuthMode is IAM Identity Center, this
field is required, and must match a valid username of a user in your directory. If the
Domain's AuthMode is not IAM Identity Center, this field cannot be specified.
- `"Tags"`: Each tag consists of a key and an optional value. Tag keys must be unique per
resource. Tags that you specify for the User Profile are also added to all Apps that the
User Profile launches.
- `"UserSettings"`: A collection of settings.
"""
function create_user_profile(
DomainId, UserProfileName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"CreateUserProfile",
Dict{String,Any}("DomainId" => DomainId, "UserProfileName" => UserProfileName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_user_profile(
DomainId,
UserProfileName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateUserProfile",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DomainId" => DomainId, "UserProfileName" => UserProfileName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_workforce(workforce_name)
create_workforce(workforce_name, params::Dict{String,<:Any})
Use this operation to create a workforce. This operation will return an error if a
workforce already exists in the Amazon Web Services Region that you specify. You can only
create one workforce in each Amazon Web Services Region per Amazon Web Services account. If
you want to create a new workforce in an Amazon Web Services Region where a workforce
already exists, use the DeleteWorkforce API operation to delete the existing workforce and
then use CreateWorkforce to create a new workforce. To create a private workforce using
Amazon Cognito, you must specify a Cognito user pool in CognitoConfig. You can also create
an Amazon Cognito workforce using the Amazon SageMaker console. For more information, see
Create a Private Workforce (Amazon Cognito). To create a private workforce using your own
OIDC Identity Provider (IdP), specify your IdP configuration in OidcConfig. Your OIDC IdP
must support groups because groups are used by Ground Truth and Amazon A2I to create work
teams. For more information, see Create a Private Workforce (OIDC IdP).
# Arguments
- `workforce_name`: The name of the private workforce.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CognitoConfig"`: Use this parameter to configure an Amazon Cognito private workforce. A
single Cognito workforce is created using and corresponds to a single Amazon Cognito user
pool. Do not use OidcConfig if you specify values for CognitoConfig.
- `"OidcConfig"`: Use this parameter to configure a private workforce using your own OIDC
Identity Provider. Do not use CognitoConfig if you specify values for OidcConfig.
- `"SourceIpConfig"`:
- `"Tags"`: An array of key-value pairs that contain metadata to help you categorize and
organize our workforce. Each tag consists of a key and a value, both of which you define.
- `"WorkforceVpcConfig"`: Use this parameter to configure a workforce using VPC.
"""
function create_workforce(WorkforceName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"CreateWorkforce",
Dict{String,Any}("WorkforceName" => WorkforceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_workforce(
WorkforceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateWorkforce",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("WorkforceName" => WorkforceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_workteam(description, member_definitions, workteam_name)
create_workteam(description, member_definitions, workteam_name, params::Dict{String,<:Any})
Creates a new work team for labeling your data. A work team is defined by one or more
Amazon Cognito user pools. You must first create the user pools before you can create a
work team. You cannot create more than 25 work teams in an account and region.
# Arguments
- `description`: A description of the work team.
- `member_definitions`: A list of MemberDefinition objects that contains objects that
identify the workers that make up the work team. Workforces can be created using Amazon
Cognito or your own OIDC Identity Provider (IdP). For private workforces created using
Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC
identity provider (IdP) use OidcMemberDefinition. Do not provide input for both of these
parameters in a single request. For workforces created using Amazon Cognito, private work
teams correspond to Amazon Cognito user groups within the user pool used to create a
workforce. All of the CognitoMemberDefinition objects that make up the member definition
must have the same ClientId and UserPool values. To add a Amazon Cognito user group to an
existing worker pool, see Adding groups to a User Pool. For more information about user
pools, see Amazon Cognito User Pools. For workforces created using your own OIDC IdP,
specify the user groups that you want to include in your private work team in
OidcMemberDefinition by listing those groups in Groups.
- `workteam_name`: The name of the work team. Use this name to identify the work team.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NotificationConfiguration"`: Configures notification of workers regarding available or
expiring work items.
- `"Tags"`: An array of key-value pairs. For more information, see Resource Tag and Using
Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
- `"WorkerAccessConfiguration"`: Use this optional parameter to constrain access to an
Amazon S3 resource based on the IP address using supported IAM global condition keys. The
Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL.
- `"WorkforceName"`: The name of the workforce.
"""
function create_workteam(
Description,
MemberDefinitions,
WorkteamName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateWorkteam",
Dict{String,Any}(
"Description" => Description,
"MemberDefinitions" => MemberDefinitions,
"WorkteamName" => WorkteamName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_workteam(
Description,
MemberDefinitions,
WorkteamName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"CreateWorkteam",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Description" => Description,
"MemberDefinitions" => MemberDefinitions,
"WorkteamName" => WorkteamName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_action(action_name)
delete_action(action_name, params::Dict{String,<:Any})
Deletes an action.
# Arguments
- `action_name`: The name of the action to delete.
"""
function delete_action(ActionName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"DeleteAction",
Dict{String,Any}("ActionName" => ActionName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_action(
ActionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteAction",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ActionName" => ActionName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_algorithm(algorithm_name)
delete_algorithm(algorithm_name, params::Dict{String,<:Any})
Removes the specified algorithm from your account.
# Arguments
- `algorithm_name`: The name of the algorithm to delete.
"""
function delete_algorithm(AlgorithmName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"DeleteAlgorithm",
Dict{String,Any}("AlgorithmName" => AlgorithmName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_algorithm(
AlgorithmName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteAlgorithm",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AlgorithmName" => AlgorithmName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_app(app_name, app_type, domain_id)
delete_app(app_name, app_type, domain_id, params::Dict{String,<:Any})
Used to stop and delete an app.
# Arguments
- `app_name`: The name of the app.
- `app_type`: The type of app.
- `domain_id`: The domain ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SpaceName"`: The name of the space. If this value is not set, then UserProfileName must
be set.
- `"UserProfileName"`: The user profile name. If this value is not set, then SpaceName must
be set.
"""
function delete_app(
AppName, AppType, DomainId; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteApp",
Dict{String,Any}(
"AppName" => AppName, "AppType" => AppType, "DomainId" => DomainId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_app(
AppName,
AppType,
DomainId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteApp",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AppName" => AppName, "AppType" => AppType, "DomainId" => DomainId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_app_image_config(app_image_config_name)
delete_app_image_config(app_image_config_name, params::Dict{String,<:Any})
Deletes an AppImageConfig.
# Arguments
- `app_image_config_name`: The name of the AppImageConfig to delete.
"""
function delete_app_image_config(
AppImageConfigName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteAppImageConfig",
Dict{String,Any}("AppImageConfigName" => AppImageConfigName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_app_image_config(
AppImageConfigName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteAppImageConfig",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("AppImageConfigName" => AppImageConfigName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_artifact()
delete_artifact(params::Dict{String,<:Any})
Deletes an artifact. Either ArtifactArn or Source must be specified.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ArtifactArn"`: The Amazon Resource Name (ARN) of the artifact to delete.
- `"Source"`: The URI of the source.
"""
function delete_artifact(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"DeleteArtifact"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_artifact(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteArtifact", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
delete_association(destination_arn, source_arn)
delete_association(destination_arn, source_arn, params::Dict{String,<:Any})
Deletes an association.
# Arguments
- `destination_arn`: The Amazon Resource Name (ARN) of the destination.
- `source_arn`: The ARN of the source.
"""
function delete_association(
DestinationArn, SourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteAssociation",
Dict{String,Any}("DestinationArn" => DestinationArn, "SourceArn" => SourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_association(
DestinationArn,
SourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteAssociation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DestinationArn" => DestinationArn, "SourceArn" => SourceArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_cluster(cluster_name)
delete_cluster(cluster_name, params::Dict{String,<:Any})
Delete a SageMaker HyperPod cluster.
# Arguments
- `cluster_name`: The string name or the Amazon Resource Name (ARN) of the SageMaker
HyperPod cluster to delete.
"""
function delete_cluster(ClusterName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"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 sagemaker(
"DeleteCluster",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClusterName" => ClusterName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_code_repository(code_repository_name)
delete_code_repository(code_repository_name, params::Dict{String,<:Any})
Deletes the specified Git repository from your account.
# Arguments
- `code_repository_name`: The name of the Git repository to delete.
"""
function delete_code_repository(
CodeRepositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteCodeRepository",
Dict{String,Any}("CodeRepositoryName" => CodeRepositoryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_code_repository(
CodeRepositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteCodeRepository",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("CodeRepositoryName" => CodeRepositoryName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_compilation_job(compilation_job_name)
delete_compilation_job(compilation_job_name, params::Dict{String,<:Any})
Deletes the specified compilation job. This action deletes only the compilation job
resource in Amazon SageMaker. It doesn't delete other resources that are related to that
job, such as the model artifacts that the job creates, the compilation logs in CloudWatch,
the compiled model, or the IAM role. You can delete a compilation job only if its current
status is COMPLETED, FAILED, or STOPPED. If the job status is STARTING or INPROGRESS, stop
the job, and then delete it after its status becomes STOPPED.
# Arguments
- `compilation_job_name`: The name of the compilation job to delete.
"""
function delete_compilation_job(
CompilationJobName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteCompilationJob",
Dict{String,Any}("CompilationJobName" => CompilationJobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_compilation_job(
CompilationJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteCompilationJob",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("CompilationJobName" => CompilationJobName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_context(context_name)
delete_context(context_name, params::Dict{String,<:Any})
Deletes an context.
# Arguments
- `context_name`: The name of the context to delete.
"""
function delete_context(ContextName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"DeleteContext",
Dict{String,Any}("ContextName" => ContextName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_context(
ContextName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteContext",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ContextName" => ContextName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_data_quality_job_definition(job_definition_name)
delete_data_quality_job_definition(job_definition_name, params::Dict{String,<:Any})
Deletes a data quality monitoring job definition.
# Arguments
- `job_definition_name`: The name of the data quality monitoring job definition to delete.
"""
function delete_data_quality_job_definition(
JobDefinitionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteDataQualityJobDefinition",
Dict{String,Any}("JobDefinitionName" => JobDefinitionName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_data_quality_job_definition(
JobDefinitionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteDataQualityJobDefinition",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("JobDefinitionName" => JobDefinitionName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_device_fleet(device_fleet_name)
delete_device_fleet(device_fleet_name, params::Dict{String,<:Any})
Deletes a fleet.
# Arguments
- `device_fleet_name`: The name of the fleet to delete.
"""
function delete_device_fleet(
DeviceFleetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteDeviceFleet",
Dict{String,Any}("DeviceFleetName" => DeviceFleetName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_device_fleet(
DeviceFleetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteDeviceFleet",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("DeviceFleetName" => DeviceFleetName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_domain(domain_id)
delete_domain(domain_id, params::Dict{String,<:Any})
Used to delete a domain. If you onboarded with IAM mode, you will need to delete your
domain to onboard again using IAM Identity Center. Use with caution. All of the members of
the domain will lose access to their EFS volume, including data, notebooks, and other
artifacts.
# Arguments
- `domain_id`: The domain ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"RetentionPolicy"`: The retention policy for this domain, which specifies whether
resources will be retained after the Domain is deleted. By default, all resources are
retained (not automatically deleted).
"""
function delete_domain(DomainId; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"DeleteDomain",
Dict{String,Any}("DomainId" => 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 sagemaker(
"DeleteDomain",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainId" => DomainId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_edge_deployment_plan(edge_deployment_plan_name)
delete_edge_deployment_plan(edge_deployment_plan_name, params::Dict{String,<:Any})
Deletes an edge deployment plan if (and only if) all the stages in the plan are inactive or
there are no stages in the plan.
# Arguments
- `edge_deployment_plan_name`: The name of the edge deployment plan to delete.
"""
function delete_edge_deployment_plan(
EdgeDeploymentPlanName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteEdgeDeploymentPlan",
Dict{String,Any}("EdgeDeploymentPlanName" => EdgeDeploymentPlanName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_edge_deployment_plan(
EdgeDeploymentPlanName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteEdgeDeploymentPlan",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("EdgeDeploymentPlanName" => EdgeDeploymentPlanName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_edge_deployment_stage(edge_deployment_plan_name, stage_name)
delete_edge_deployment_stage(edge_deployment_plan_name, stage_name, params::Dict{String,<:Any})
Delete a stage in an edge deployment plan if (and only if) the stage is inactive.
# Arguments
- `edge_deployment_plan_name`: The name of the edge deployment plan from which the stage
will be deleted.
- `stage_name`: The name of the stage.
"""
function delete_edge_deployment_stage(
EdgeDeploymentPlanName, StageName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteEdgeDeploymentStage",
Dict{String,Any}(
"EdgeDeploymentPlanName" => EdgeDeploymentPlanName, "StageName" => StageName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_edge_deployment_stage(
EdgeDeploymentPlanName,
StageName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteEdgeDeploymentStage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EdgeDeploymentPlanName" => EdgeDeploymentPlanName,
"StageName" => StageName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_endpoint(endpoint_name)
delete_endpoint(endpoint_name, params::Dict{String,<:Any})
Deletes an endpoint. SageMaker frees up all of the resources that were deployed when the
endpoint was created. SageMaker retires any custom KMS key grants associated with the
endpoint, meaning you don't need to use the RevokeGrant API call. When you delete your
endpoint, SageMaker asynchronously deletes associated endpoint resources such as KMS key
grants. You might still see these resources in your account for a few minutes after
deleting your endpoint. Do not delete or revoke the permissions for your ExecutionRoleArn
, otherwise SageMaker cannot delete these resources.
# Arguments
- `endpoint_name`: The name of the endpoint that you want to delete.
"""
function delete_endpoint(EndpointName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"DeleteEndpoint",
Dict{String,Any}("EndpointName" => EndpointName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_endpoint(
EndpointName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteEndpoint",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EndpointName" => EndpointName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_endpoint_config(endpoint_config_name)
delete_endpoint_config(endpoint_config_name, params::Dict{String,<:Any})
Deletes an endpoint configuration. The DeleteEndpointConfig API deletes only the specified
configuration. It does not delete endpoints created using the configuration. You must not
delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or
CreateEndpoint operations are being performed on the endpoint. If you delete the
EndpointConfig of an endpoint that is active or being created or updated you may lose
visibility into the instance type the endpoint is using. The endpoint must be deleted in
order to stop incurring charges.
# Arguments
- `endpoint_config_name`: The name of the endpoint configuration that you want to delete.
"""
function delete_endpoint_config(
EndpointConfigName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteEndpointConfig",
Dict{String,Any}("EndpointConfigName" => EndpointConfigName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_endpoint_config(
EndpointConfigName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteEndpointConfig",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("EndpointConfigName" => EndpointConfigName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_experiment(experiment_name)
delete_experiment(experiment_name, params::Dict{String,<:Any})
Deletes an SageMaker experiment. All trials associated with the experiment must be deleted
first. Use the ListTrials API to get a list of the trials associated with the experiment.
# Arguments
- `experiment_name`: The name of the experiment to delete.
"""
function delete_experiment(
ExperimentName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteExperiment",
Dict{String,Any}("ExperimentName" => ExperimentName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_experiment(
ExperimentName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteExperiment",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ExperimentName" => ExperimentName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_feature_group(feature_group_name)
delete_feature_group(feature_group_name, params::Dict{String,<:Any})
Delete the FeatureGroup and any data that was written to the OnlineStore of the
FeatureGroup. Data cannot be accessed from the OnlineStore immediately after
DeleteFeatureGroup is called. Data written into the OfflineStore will not be deleted. The
Amazon Web Services Glue database and tables that are automatically created for your
OfflineStore are not deleted. Note that it can take approximately 10-15 minutes to delete
an OnlineStore FeatureGroup with the InMemory StorageType.
# Arguments
- `feature_group_name`: The name of the FeatureGroup you want to delete. The name must be
unique within an Amazon Web Services Region in an Amazon Web Services account.
"""
function delete_feature_group(
FeatureGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteFeatureGroup",
Dict{String,Any}("FeatureGroupName" => FeatureGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_feature_group(
FeatureGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteFeatureGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("FeatureGroupName" => FeatureGroupName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_flow_definition(flow_definition_name)
delete_flow_definition(flow_definition_name, params::Dict{String,<:Any})
Deletes the specified flow definition.
# Arguments
- `flow_definition_name`: The name of the flow definition you are deleting.
"""
function delete_flow_definition(
FlowDefinitionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteFlowDefinition",
Dict{String,Any}("FlowDefinitionName" => FlowDefinitionName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_flow_definition(
FlowDefinitionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteFlowDefinition",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("FlowDefinitionName" => FlowDefinitionName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_hub(hub_name)
delete_hub(hub_name, params::Dict{String,<:Any})
Delete a hub.
# Arguments
- `hub_name`: The name of the hub to delete.
"""
function delete_hub(HubName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"DeleteHub",
Dict{String,Any}("HubName" => HubName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_hub(
HubName, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteHub",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("HubName" => HubName), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_hub_content(hub_content_name, hub_content_type, hub_content_version, hub_name)
delete_hub_content(hub_content_name, hub_content_type, hub_content_version, hub_name, params::Dict{String,<:Any})
Delete the contents of a hub.
# Arguments
- `hub_content_name`: The name of the content that you want to delete from a hub.
- `hub_content_type`: The type of content that you want to delete from a hub.
- `hub_content_version`: The version of the content that you want to delete from a hub.
- `hub_name`: The name of the hub that you want to delete content in.
"""
function delete_hub_content(
HubContentName,
HubContentType,
HubContentVersion,
HubName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteHubContent",
Dict{String,Any}(
"HubContentName" => HubContentName,
"HubContentType" => HubContentType,
"HubContentVersion" => HubContentVersion,
"HubName" => HubName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_hub_content(
HubContentName,
HubContentType,
HubContentVersion,
HubName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteHubContent",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"HubContentName" => HubContentName,
"HubContentType" => HubContentType,
"HubContentVersion" => HubContentVersion,
"HubName" => HubName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_hub_content_reference(hub_content_name, hub_content_type, hub_name)
delete_hub_content_reference(hub_content_name, hub_content_type, hub_name, params::Dict{String,<:Any})
Delete a hub content reference in order to remove a model from a private hub.
# Arguments
- `hub_content_name`: The name of the hub content to delete.
- `hub_content_type`: The type of hub content to delete.
- `hub_name`: The name of the hub to delete the hub content reference from.
"""
function delete_hub_content_reference(
HubContentName,
HubContentType,
HubName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteHubContentReference",
Dict{String,Any}(
"HubContentName" => HubContentName,
"HubContentType" => HubContentType,
"HubName" => HubName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_hub_content_reference(
HubContentName,
HubContentType,
HubName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteHubContentReference",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"HubContentName" => HubContentName,
"HubContentType" => HubContentType,
"HubName" => HubName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_human_task_ui(human_task_ui_name)
delete_human_task_ui(human_task_ui_name, params::Dict{String,<:Any})
Use this operation to delete a human task user interface (worker task template). To see a
list of human task user interfaces (work task templates) in your account, use
ListHumanTaskUis. When you delete a worker task template, it no longer appears when you
call ListHumanTaskUis.
# Arguments
- `human_task_ui_name`: The name of the human task user interface (work task template) you
want to delete.
"""
function delete_human_task_ui(
HumanTaskUiName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteHumanTaskUi",
Dict{String,Any}("HumanTaskUiName" => HumanTaskUiName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_human_task_ui(
HumanTaskUiName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteHumanTaskUi",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("HumanTaskUiName" => HumanTaskUiName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_hyper_parameter_tuning_job(hyper_parameter_tuning_job_name)
delete_hyper_parameter_tuning_job(hyper_parameter_tuning_job_name, params::Dict{String,<:Any})
Deletes a hyperparameter tuning job. The DeleteHyperParameterTuningJob API deletes only the
tuning job entry that was created in SageMaker when you called the
CreateHyperParameterTuningJob API. It does not delete training jobs, artifacts, or the IAM
role that you specified when creating the model.
# Arguments
- `hyper_parameter_tuning_job_name`: The name of the hyperparameter tuning job that you
want to delete.
"""
function delete_hyper_parameter_tuning_job(
HyperParameterTuningJobName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteHyperParameterTuningJob",
Dict{String,Any}("HyperParameterTuningJobName" => HyperParameterTuningJobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_hyper_parameter_tuning_job(
HyperParameterTuningJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteHyperParameterTuningJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"HyperParameterTuningJobName" => HyperParameterTuningJobName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_image(image_name)
delete_image(image_name, params::Dict{String,<:Any})
Deletes a SageMaker image and all versions of the image. The container images aren't
deleted.
# Arguments
- `image_name`: The name of the image to delete.
"""
function delete_image(ImageName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"DeleteImage",
Dict{String,Any}("ImageName" => ImageName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_image(
ImageName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteImage",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ImageName" => ImageName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_image_version(image_name)
delete_image_version(image_name, params::Dict{String,<:Any})
Deletes a version of a SageMaker image. The container image the version represents isn't
deleted.
# Arguments
- `image_name`: The name of the image to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Alias"`: The alias of the image to delete.
- `"Version"`: The version to delete.
"""
function delete_image_version(ImageName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"DeleteImageVersion",
Dict{String,Any}("ImageName" => ImageName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_image_version(
ImageName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteImageVersion",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ImageName" => ImageName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_inference_component(inference_component_name)
delete_inference_component(inference_component_name, params::Dict{String,<:Any})
Deletes an inference component.
# Arguments
- `inference_component_name`: The name of the inference component to delete.
"""
function delete_inference_component(
InferenceComponentName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteInferenceComponent",
Dict{String,Any}("InferenceComponentName" => InferenceComponentName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_inference_component(
InferenceComponentName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteInferenceComponent",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InferenceComponentName" => InferenceComponentName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_inference_experiment(name)
delete_inference_experiment(name, params::Dict{String,<:Any})
Deletes an inference experiment. This operation does not delete your endpoint, variants,
or any underlying resources. This operation only deletes the metadata of your experiment.
# Arguments
- `name`: The name of the inference experiment you want to delete.
"""
function delete_inference_experiment(
Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteInferenceExperiment",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_inference_experiment(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteInferenceExperiment",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_mlflow_tracking_server(tracking_server_name)
delete_mlflow_tracking_server(tracking_server_name, params::Dict{String,<:Any})
Deletes an MLflow Tracking Server. For more information, see Clean up MLflow resources.
# Arguments
- `tracking_server_name`: The name of the the tracking server to delete.
"""
function delete_mlflow_tracking_server(
TrackingServerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteMlflowTrackingServer",
Dict{String,Any}("TrackingServerName" => TrackingServerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_mlflow_tracking_server(
TrackingServerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteMlflowTrackingServer",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("TrackingServerName" => TrackingServerName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_model(model_name)
delete_model(model_name, params::Dict{String,<:Any})
Deletes a model. The DeleteModel API deletes only the model entry that was created in
SageMaker when you called the CreateModel API. It does not delete model artifacts,
inference code, or the IAM role that you specified when creating the model.
# Arguments
- `model_name`: The name of the model to delete.
"""
function delete_model(ModelName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"DeleteModel",
Dict{String,Any}("ModelName" => ModelName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_model(
ModelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteModel",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ModelName" => ModelName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_model_bias_job_definition(job_definition_name)
delete_model_bias_job_definition(job_definition_name, params::Dict{String,<:Any})
Deletes an Amazon SageMaker model bias job definition.
# Arguments
- `job_definition_name`: The name of the model bias job definition to delete.
"""
function delete_model_bias_job_definition(
JobDefinitionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteModelBiasJobDefinition",
Dict{String,Any}("JobDefinitionName" => JobDefinitionName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_model_bias_job_definition(
JobDefinitionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteModelBiasJobDefinition",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("JobDefinitionName" => JobDefinitionName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_model_card(model_card_name)
delete_model_card(model_card_name, params::Dict{String,<:Any})
Deletes an Amazon SageMaker Model Card.
# Arguments
- `model_card_name`: The name of the model card to delete.
"""
function delete_model_card(ModelCardName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"DeleteModelCard",
Dict{String,Any}("ModelCardName" => ModelCardName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_model_card(
ModelCardName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteModelCard",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ModelCardName" => ModelCardName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_model_explainability_job_definition(job_definition_name)
delete_model_explainability_job_definition(job_definition_name, params::Dict{String,<:Any})
Deletes an Amazon SageMaker model explainability job definition.
# Arguments
- `job_definition_name`: The name of the model explainability job definition to delete.
"""
function delete_model_explainability_job_definition(
JobDefinitionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteModelExplainabilityJobDefinition",
Dict{String,Any}("JobDefinitionName" => JobDefinitionName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_model_explainability_job_definition(
JobDefinitionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteModelExplainabilityJobDefinition",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("JobDefinitionName" => JobDefinitionName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_model_package(model_package_name)
delete_model_package(model_package_name, params::Dict{String,<:Any})
Deletes a model package. A model package is used to create SageMaker models or list on
Amazon Web Services Marketplace. Buyers can subscribe to model packages listed on Amazon
Web Services Marketplace to create models in SageMaker.
# Arguments
- `model_package_name`: The name or Amazon Resource Name (ARN) of the model package to
delete. When you specify a name, the name must have 1 to 63 characters. Valid characters
are a-z, A-Z, 0-9, and - (hyphen).
"""
function delete_model_package(
ModelPackageName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteModelPackage",
Dict{String,Any}("ModelPackageName" => ModelPackageName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_model_package(
ModelPackageName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteModelPackage",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ModelPackageName" => ModelPackageName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_model_package_group(model_package_group_name)
delete_model_package_group(model_package_group_name, params::Dict{String,<:Any})
Deletes the specified model group.
# Arguments
- `model_package_group_name`: The name of the model group to delete.
"""
function delete_model_package_group(
ModelPackageGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteModelPackageGroup",
Dict{String,Any}("ModelPackageGroupName" => ModelPackageGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_model_package_group(
ModelPackageGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteModelPackageGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ModelPackageGroupName" => ModelPackageGroupName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_model_package_group_policy(model_package_group_name)
delete_model_package_group_policy(model_package_group_name, params::Dict{String,<:Any})
Deletes a model group resource policy.
# Arguments
- `model_package_group_name`: The name of the model group for which to delete the policy.
"""
function delete_model_package_group_policy(
ModelPackageGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteModelPackageGroupPolicy",
Dict{String,Any}("ModelPackageGroupName" => ModelPackageGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_model_package_group_policy(
ModelPackageGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteModelPackageGroupPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ModelPackageGroupName" => ModelPackageGroupName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_model_quality_job_definition(job_definition_name)
delete_model_quality_job_definition(job_definition_name, params::Dict{String,<:Any})
Deletes the secified model quality monitoring job definition.
# Arguments
- `job_definition_name`: The name of the model quality monitoring job definition to delete.
"""
function delete_model_quality_job_definition(
JobDefinitionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteModelQualityJobDefinition",
Dict{String,Any}("JobDefinitionName" => JobDefinitionName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_model_quality_job_definition(
JobDefinitionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteModelQualityJobDefinition",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("JobDefinitionName" => JobDefinitionName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_monitoring_schedule(monitoring_schedule_name)
delete_monitoring_schedule(monitoring_schedule_name, params::Dict{String,<:Any})
Deletes a monitoring schedule. Also stops the schedule had not already been stopped. This
does not delete the job execution history of the monitoring schedule.
# Arguments
- `monitoring_schedule_name`: The name of the monitoring schedule to delete.
"""
function delete_monitoring_schedule(
MonitoringScheduleName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteMonitoringSchedule",
Dict{String,Any}("MonitoringScheduleName" => MonitoringScheduleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_monitoring_schedule(
MonitoringScheduleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteMonitoringSchedule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("MonitoringScheduleName" => MonitoringScheduleName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_notebook_instance(notebook_instance_name)
delete_notebook_instance(notebook_instance_name, params::Dict{String,<:Any})
Deletes an SageMaker notebook instance. Before you can delete a notebook instance, you
must call the StopNotebookInstance API. When you delete a notebook instance, you lose all
of your data. SageMaker removes the ML compute instance, and deletes the ML storage volume
and the network interface associated with the notebook instance.
# Arguments
- `notebook_instance_name`: The name of the SageMaker notebook instance to delete.
"""
function delete_notebook_instance(
NotebookInstanceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteNotebookInstance",
Dict{String,Any}("NotebookInstanceName" => NotebookInstanceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_notebook_instance(
NotebookInstanceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteNotebookInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("NotebookInstanceName" => NotebookInstanceName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_notebook_instance_lifecycle_config(notebook_instance_lifecycle_config_name)
delete_notebook_instance_lifecycle_config(notebook_instance_lifecycle_config_name, params::Dict{String,<:Any})
Deletes a notebook instance lifecycle configuration.
# Arguments
- `notebook_instance_lifecycle_config_name`: The name of the lifecycle configuration to
delete.
"""
function delete_notebook_instance_lifecycle_config(
NotebookInstanceLifecycleConfigName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteNotebookInstanceLifecycleConfig",
Dict{String,Any}(
"NotebookInstanceLifecycleConfigName" => NotebookInstanceLifecycleConfigName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_notebook_instance_lifecycle_config(
NotebookInstanceLifecycleConfigName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteNotebookInstanceLifecycleConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"NotebookInstanceLifecycleConfigName" =>
NotebookInstanceLifecycleConfigName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_pipeline(client_request_token, pipeline_name)
delete_pipeline(client_request_token, pipeline_name, params::Dict{String,<:Any})
Deletes a pipeline if there are no running instances of the pipeline. To delete a pipeline,
you must stop all running instances of the pipeline using the StopPipelineExecution API.
When you delete a pipeline, all instances of the pipeline are deleted.
# Arguments
- `client_request_token`: A unique, case-sensitive identifier that you provide to ensure
the idempotency of the operation. An idempotent operation completes no more than one time.
- `pipeline_name`: The name of the pipeline to delete.
"""
function delete_pipeline(
ClientRequestToken, PipelineName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeletePipeline",
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken, "PipelineName" => PipelineName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_pipeline(
ClientRequestToken,
PipelineName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeletePipeline",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken,
"PipelineName" => PipelineName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_project(project_name)
delete_project(project_name, params::Dict{String,<:Any})
Delete the specified project.
# Arguments
- `project_name`: The name of the project to delete.
"""
function delete_project(ProjectName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"DeleteProject",
Dict{String,Any}("ProjectName" => 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 sagemaker(
"DeleteProject",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ProjectName" => ProjectName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_space(domain_id, space_name)
delete_space(domain_id, space_name, params::Dict{String,<:Any})
Used to delete a space.
# Arguments
- `domain_id`: The ID of the associated domain.
- `space_name`: The name of the space.
"""
function delete_space(
DomainId, SpaceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteSpace",
Dict{String,Any}("DomainId" => DomainId, "SpaceName" => SpaceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_space(
DomainId,
SpaceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteSpace",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DomainId" => DomainId, "SpaceName" => SpaceName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_studio_lifecycle_config(studio_lifecycle_config_name)
delete_studio_lifecycle_config(studio_lifecycle_config_name, params::Dict{String,<:Any})
Deletes the Amazon SageMaker Studio Lifecycle Configuration. In order to delete the
Lifecycle Configuration, there must be no running apps using the Lifecycle Configuration.
You must also remove the Lifecycle Configuration from UserSettings in all Domains and
UserProfiles.
# Arguments
- `studio_lifecycle_config_name`: The name of the Amazon SageMaker Studio Lifecycle
Configuration to delete.
"""
function delete_studio_lifecycle_config(
StudioLifecycleConfigName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteStudioLifecycleConfig",
Dict{String,Any}("StudioLifecycleConfigName" => StudioLifecycleConfigName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_studio_lifecycle_config(
StudioLifecycleConfigName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteStudioLifecycleConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("StudioLifecycleConfigName" => StudioLifecycleConfigName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_tags(resource_arn, tag_keys)
delete_tags(resource_arn, tag_keys, params::Dict{String,<:Any})
Deletes the specified tags from an SageMaker resource. To list a resource's tags, use the
ListTags API. When you call this API to delete tags from a hyperparameter tuning job, the
deleted tags are not removed from training jobs that the hyperparameter tuning job launched
before you called this API. When you call this API to delete tags from a SageMaker Domain
or User Profile, the deleted tags are not removed from Apps that the SageMaker Domain or
User Profile launched before you called this API.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource whose tags you want to
delete.
- `tag_keys`: An array or one or more tag keys to delete.
"""
function delete_tags(
ResourceArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteTags",
Dict{String,Any}("ResourceArn" => ResourceArn, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_tags(
ResourceArn,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteTags",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_trial(trial_name)
delete_trial(trial_name, params::Dict{String,<:Any})
Deletes the specified trial. All trial components that make up the trial must be deleted
first. Use the DescribeTrialComponent API to get the list of trial components.
# Arguments
- `trial_name`: The name of the trial to delete.
"""
function delete_trial(TrialName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"DeleteTrial",
Dict{String,Any}("TrialName" => TrialName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_trial(
TrialName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteTrial",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TrialName" => TrialName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_trial_component(trial_component_name)
delete_trial_component(trial_component_name, params::Dict{String,<:Any})
Deletes the specified trial component. A trial component must be disassociated from all
trials before the trial component can be deleted. To disassociate a trial component from a
trial, call the DisassociateTrialComponent API.
# Arguments
- `trial_component_name`: The name of the component to delete.
"""
function delete_trial_component(
TrialComponentName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteTrialComponent",
Dict{String,Any}("TrialComponentName" => TrialComponentName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_trial_component(
TrialComponentName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteTrialComponent",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("TrialComponentName" => TrialComponentName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_user_profile(domain_id, user_profile_name)
delete_user_profile(domain_id, user_profile_name, params::Dict{String,<:Any})
Deletes a user profile. When a user profile is deleted, the user loses access to their EFS
volume, including data, notebooks, and other artifacts.
# Arguments
- `domain_id`: The domain ID.
- `user_profile_name`: The user profile name.
"""
function delete_user_profile(
DomainId, UserProfileName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeleteUserProfile",
Dict{String,Any}("DomainId" => DomainId, "UserProfileName" => UserProfileName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_user_profile(
DomainId,
UserProfileName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteUserProfile",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DomainId" => DomainId, "UserProfileName" => UserProfileName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_workforce(workforce_name)
delete_workforce(workforce_name, params::Dict{String,<:Any})
Use this operation to delete a workforce. If you want to create a new workforce in an
Amazon Web Services Region where a workforce already exists, use this operation to delete
the existing workforce and then use CreateWorkforce to create a new workforce. If a
private workforce contains one or more work teams, you must use the DeleteWorkteam
operation to delete all work teams before you delete the workforce. If you try to delete a
workforce that contains one or more work teams, you will receive a ResourceInUse error.
# Arguments
- `workforce_name`: The name of the workforce.
"""
function delete_workforce(WorkforceName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"DeleteWorkforce",
Dict{String,Any}("WorkforceName" => WorkforceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_workforce(
WorkforceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteWorkforce",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("WorkforceName" => WorkforceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_workteam(workteam_name)
delete_workteam(workteam_name, params::Dict{String,<:Any})
Deletes an existing work team. This operation can't be undone.
# Arguments
- `workteam_name`: The name of the work team to delete.
"""
function delete_workteam(WorkteamName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"DeleteWorkteam",
Dict{String,Any}("WorkteamName" => WorkteamName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_workteam(
WorkteamName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeleteWorkteam",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("WorkteamName" => WorkteamName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_devices(device_fleet_name, device_names)
deregister_devices(device_fleet_name, device_names, params::Dict{String,<:Any})
Deregisters the specified devices. After you deregister a device, you will need to
re-register the devices.
# Arguments
- `device_fleet_name`: The name of the fleet the devices belong to.
- `device_names`: The unique IDs of the devices.
"""
function deregister_devices(
DeviceFleetName, DeviceNames; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DeregisterDevices",
Dict{String,Any}(
"DeviceFleetName" => DeviceFleetName, "DeviceNames" => DeviceNames
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_devices(
DeviceFleetName,
DeviceNames,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DeregisterDevices",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DeviceFleetName" => DeviceFleetName, "DeviceNames" => DeviceNames
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_action(action_name)
describe_action(action_name, params::Dict{String,<:Any})
Describes an action.
# Arguments
- `action_name`: The name of the action to describe.
"""
function describe_action(ActionName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"DescribeAction",
Dict{String,Any}("ActionName" => ActionName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_action(
ActionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeAction",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ActionName" => ActionName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_algorithm(algorithm_name)
describe_algorithm(algorithm_name, params::Dict{String,<:Any})
Returns a description of the specified algorithm that is in your account.
# Arguments
- `algorithm_name`: The name of the algorithm to describe.
"""
function describe_algorithm(
AlgorithmName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeAlgorithm",
Dict{String,Any}("AlgorithmName" => AlgorithmName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_algorithm(
AlgorithmName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeAlgorithm",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AlgorithmName" => AlgorithmName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_app(app_name, app_type, domain_id)
describe_app(app_name, app_type, domain_id, params::Dict{String,<:Any})
Describes the app.
# Arguments
- `app_name`: The name of the app.
- `app_type`: The type of app.
- `domain_id`: The domain ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SpaceName"`: The name of the space.
- `"UserProfileName"`: The user profile name. If this value is not set, then SpaceName must
be set.
"""
function describe_app(
AppName, AppType, DomainId; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeApp",
Dict{String,Any}(
"AppName" => AppName, "AppType" => AppType, "DomainId" => DomainId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_app(
AppName,
AppType,
DomainId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeApp",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AppName" => AppName, "AppType" => AppType, "DomainId" => DomainId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_app_image_config(app_image_config_name)
describe_app_image_config(app_image_config_name, params::Dict{String,<:Any})
Describes an AppImageConfig.
# Arguments
- `app_image_config_name`: The name of the AppImageConfig to describe.
"""
function describe_app_image_config(
AppImageConfigName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeAppImageConfig",
Dict{String,Any}("AppImageConfigName" => AppImageConfigName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_app_image_config(
AppImageConfigName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeAppImageConfig",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("AppImageConfigName" => AppImageConfigName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_artifact(artifact_arn)
describe_artifact(artifact_arn, params::Dict{String,<:Any})
Describes an artifact.
# Arguments
- `artifact_arn`: The Amazon Resource Name (ARN) of the artifact to describe.
"""
function describe_artifact(ArtifactArn; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"DescribeArtifact",
Dict{String,Any}("ArtifactArn" => ArtifactArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_artifact(
ArtifactArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeArtifact",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ArtifactArn" => ArtifactArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_auto_mljob(auto_mljob_name)
describe_auto_mljob(auto_mljob_name, params::Dict{String,<:Any})
Returns information about an AutoML job created by calling CreateAutoMLJob. AutoML jobs
created by calling CreateAutoMLJobV2 cannot be described by DescribeAutoMLJob.
# Arguments
- `auto_mljob_name`: Requests information about an AutoML job using its unique name.
"""
function describe_auto_mljob(
AutoMLJobName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeAutoMLJob",
Dict{String,Any}("AutoMLJobName" => AutoMLJobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_auto_mljob(
AutoMLJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeAutoMLJob",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AutoMLJobName" => AutoMLJobName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_auto_mljob_v2(auto_mljob_name)
describe_auto_mljob_v2(auto_mljob_name, params::Dict{String,<:Any})
Returns information about an AutoML job created by calling CreateAutoMLJobV2 or
CreateAutoMLJob.
# Arguments
- `auto_mljob_name`: Requests information about an AutoML job V2 using its unique name.
"""
function describe_auto_mljob_v2(
AutoMLJobName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeAutoMLJobV2",
Dict{String,Any}("AutoMLJobName" => AutoMLJobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_auto_mljob_v2(
AutoMLJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeAutoMLJobV2",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AutoMLJobName" => AutoMLJobName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_cluster(cluster_name)
describe_cluster(cluster_name, params::Dict{String,<:Any})
Retrieves information of a SageMaker HyperPod cluster.
# Arguments
- `cluster_name`: The string name or the Amazon Resource Name (ARN) of the SageMaker
HyperPod cluster.
"""
function describe_cluster(ClusterName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"DescribeCluster",
Dict{String,Any}("ClusterName" => ClusterName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_cluster(
ClusterName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeCluster",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClusterName" => ClusterName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_cluster_node(cluster_name, node_id)
describe_cluster_node(cluster_name, node_id, params::Dict{String,<:Any})
Retrieves information of a node (also called a instance interchangeably) of a SageMaker
HyperPod cluster.
# Arguments
- `cluster_name`: The string name or the Amazon Resource Name (ARN) of the SageMaker
HyperPod cluster in which the node is.
- `node_id`: The ID of the SageMaker HyperPod cluster node.
"""
function describe_cluster_node(
ClusterName, NodeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeClusterNode",
Dict{String,Any}("ClusterName" => ClusterName, "NodeId" => NodeId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_cluster_node(
ClusterName,
NodeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeClusterNode",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ClusterName" => ClusterName, "NodeId" => NodeId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_code_repository(code_repository_name)
describe_code_repository(code_repository_name, params::Dict{String,<:Any})
Gets details about the specified Git repository.
# Arguments
- `code_repository_name`: The name of the Git repository to describe.
"""
function describe_code_repository(
CodeRepositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeCodeRepository",
Dict{String,Any}("CodeRepositoryName" => CodeRepositoryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_code_repository(
CodeRepositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeCodeRepository",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("CodeRepositoryName" => CodeRepositoryName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_compilation_job(compilation_job_name)
describe_compilation_job(compilation_job_name, params::Dict{String,<:Any})
Returns information about a model compilation job. To create a model compilation job, use
CreateCompilationJob. To get information about multiple model compilation jobs, use
ListCompilationJobs.
# Arguments
- `compilation_job_name`: The name of the model compilation job that you want information
about.
"""
function describe_compilation_job(
CompilationJobName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeCompilationJob",
Dict{String,Any}("CompilationJobName" => CompilationJobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_compilation_job(
CompilationJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeCompilationJob",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("CompilationJobName" => CompilationJobName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_context(context_name)
describe_context(context_name, params::Dict{String,<:Any})
Describes a context.
# Arguments
- `context_name`: The name of the context to describe.
"""
function describe_context(ContextName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"DescribeContext",
Dict{String,Any}("ContextName" => ContextName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_context(
ContextName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeContext",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ContextName" => ContextName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_data_quality_job_definition(job_definition_name)
describe_data_quality_job_definition(job_definition_name, params::Dict{String,<:Any})
Gets the details of a data quality monitoring job definition.
# Arguments
- `job_definition_name`: The name of the data quality monitoring job definition to describe.
"""
function describe_data_quality_job_definition(
JobDefinitionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeDataQualityJobDefinition",
Dict{String,Any}("JobDefinitionName" => JobDefinitionName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_data_quality_job_definition(
JobDefinitionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeDataQualityJobDefinition",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("JobDefinitionName" => JobDefinitionName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_device(device_fleet_name, device_name)
describe_device(device_fleet_name, device_name, params::Dict{String,<:Any})
Describes the device.
# Arguments
- `device_fleet_name`: The name of the fleet the devices belong to.
- `device_name`: The unique ID of the device.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: Next token of device description.
"""
function describe_device(
DeviceFleetName, DeviceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeDevice",
Dict{String,Any}("DeviceFleetName" => DeviceFleetName, "DeviceName" => DeviceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_device(
DeviceFleetName,
DeviceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeDevice",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DeviceFleetName" => DeviceFleetName, "DeviceName" => DeviceName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_device_fleet(device_fleet_name)
describe_device_fleet(device_fleet_name, params::Dict{String,<:Any})
A description of the fleet the device belongs to.
# Arguments
- `device_fleet_name`: The name of the fleet.
"""
function describe_device_fleet(
DeviceFleetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeDeviceFleet",
Dict{String,Any}("DeviceFleetName" => DeviceFleetName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_device_fleet(
DeviceFleetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeDeviceFleet",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("DeviceFleetName" => DeviceFleetName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_domain(domain_id)
describe_domain(domain_id, params::Dict{String,<:Any})
The description of the domain.
# Arguments
- `domain_id`: The domain ID.
"""
function describe_domain(DomainId; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"DescribeDomain",
Dict{String,Any}("DomainId" => DomainId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_domain(
DomainId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeDomain",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainId" => DomainId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_edge_deployment_plan(edge_deployment_plan_name)
describe_edge_deployment_plan(edge_deployment_plan_name, params::Dict{String,<:Any})
Describes an edge deployment plan with deployment status per stage.
# Arguments
- `edge_deployment_plan_name`: The name of the deployment plan to describe.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to select (50 by default).
- `"NextToken"`: If the edge deployment plan has enough stages to require tokening, then
this is the response from the last list of stages returned.
"""
function describe_edge_deployment_plan(
EdgeDeploymentPlanName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeEdgeDeploymentPlan",
Dict{String,Any}("EdgeDeploymentPlanName" => EdgeDeploymentPlanName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_edge_deployment_plan(
EdgeDeploymentPlanName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeEdgeDeploymentPlan",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("EdgeDeploymentPlanName" => EdgeDeploymentPlanName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_edge_packaging_job(edge_packaging_job_name)
describe_edge_packaging_job(edge_packaging_job_name, params::Dict{String,<:Any})
A description of edge packaging jobs.
# Arguments
- `edge_packaging_job_name`: The name of the edge packaging job.
"""
function describe_edge_packaging_job(
EdgePackagingJobName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeEdgePackagingJob",
Dict{String,Any}("EdgePackagingJobName" => EdgePackagingJobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_edge_packaging_job(
EdgePackagingJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeEdgePackagingJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("EdgePackagingJobName" => EdgePackagingJobName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_endpoint(endpoint_name)
describe_endpoint(endpoint_name, params::Dict{String,<:Any})
Returns the description of an endpoint.
# Arguments
- `endpoint_name`: The name of the endpoint.
"""
function describe_endpoint(EndpointName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"DescribeEndpoint",
Dict{String,Any}("EndpointName" => EndpointName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_endpoint(
EndpointName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeEndpoint",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EndpointName" => EndpointName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_endpoint_config(endpoint_config_name)
describe_endpoint_config(endpoint_config_name, params::Dict{String,<:Any})
Returns the description of an endpoint configuration created using the CreateEndpointConfig
API.
# Arguments
- `endpoint_config_name`: The name of the endpoint configuration.
"""
function describe_endpoint_config(
EndpointConfigName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeEndpointConfig",
Dict{String,Any}("EndpointConfigName" => EndpointConfigName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_endpoint_config(
EndpointConfigName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeEndpointConfig",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("EndpointConfigName" => EndpointConfigName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_experiment(experiment_name)
describe_experiment(experiment_name, params::Dict{String,<:Any})
Provides a list of an experiment's properties.
# Arguments
- `experiment_name`: The name of the experiment to describe.
"""
function describe_experiment(
ExperimentName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeExperiment",
Dict{String,Any}("ExperimentName" => ExperimentName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_experiment(
ExperimentName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeExperiment",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ExperimentName" => ExperimentName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_feature_group(feature_group_name)
describe_feature_group(feature_group_name, params::Dict{String,<:Any})
Use this operation to describe a FeatureGroup. The response includes information on the
creation time, FeatureGroup name, the unique identifier for each FeatureGroup, and more.
# Arguments
- `feature_group_name`: The name or Amazon Resource Name (ARN) of the FeatureGroup you want
described.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: A token to resume pagination of the list of Features (FeatureDefinitions).
2,500 Features are returned by default.
"""
function describe_feature_group(
FeatureGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeFeatureGroup",
Dict{String,Any}("FeatureGroupName" => FeatureGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_feature_group(
FeatureGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeFeatureGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("FeatureGroupName" => FeatureGroupName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_feature_metadata(feature_group_name, feature_name)
describe_feature_metadata(feature_group_name, feature_name, params::Dict{String,<:Any})
Shows the metadata for a feature within a feature group.
# Arguments
- `feature_group_name`: The name or Amazon Resource Name (ARN) of the feature group
containing the feature.
- `feature_name`: The name of the feature.
"""
function describe_feature_metadata(
FeatureGroupName, FeatureName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeFeatureMetadata",
Dict{String,Any}(
"FeatureGroupName" => FeatureGroupName, "FeatureName" => FeatureName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_feature_metadata(
FeatureGroupName,
FeatureName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeFeatureMetadata",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FeatureGroupName" => FeatureGroupName, "FeatureName" => FeatureName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_flow_definition(flow_definition_name)
describe_flow_definition(flow_definition_name, params::Dict{String,<:Any})
Returns information about the specified flow definition.
# Arguments
- `flow_definition_name`: The name of the flow definition.
"""
function describe_flow_definition(
FlowDefinitionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeFlowDefinition",
Dict{String,Any}("FlowDefinitionName" => FlowDefinitionName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_flow_definition(
FlowDefinitionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeFlowDefinition",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("FlowDefinitionName" => FlowDefinitionName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_hub(hub_name)
describe_hub(hub_name, params::Dict{String,<:Any})
Describes a hub.
# Arguments
- `hub_name`: The name of the hub to describe.
"""
function describe_hub(HubName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"DescribeHub",
Dict{String,Any}("HubName" => HubName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_hub(
HubName, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeHub",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("HubName" => HubName), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_hub_content(hub_content_name, hub_content_type, hub_name)
describe_hub_content(hub_content_name, hub_content_type, hub_name, params::Dict{String,<:Any})
Describe the content of a hub.
# Arguments
- `hub_content_name`: The name of the content to describe.
- `hub_content_type`: The type of content in the hub.
- `hub_name`: The name of the hub that contains the content to describe.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"HubContentVersion"`: The version of the content to describe.
"""
function describe_hub_content(
HubContentName,
HubContentType,
HubName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeHubContent",
Dict{String,Any}(
"HubContentName" => HubContentName,
"HubContentType" => HubContentType,
"HubName" => HubName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_hub_content(
HubContentName,
HubContentType,
HubName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeHubContent",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"HubContentName" => HubContentName,
"HubContentType" => HubContentType,
"HubName" => HubName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_human_task_ui(human_task_ui_name)
describe_human_task_ui(human_task_ui_name, params::Dict{String,<:Any})
Returns information about the requested human task user interface (worker task template).
# Arguments
- `human_task_ui_name`: The name of the human task user interface (worker task template)
you want information about.
"""
function describe_human_task_ui(
HumanTaskUiName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeHumanTaskUi",
Dict{String,Any}("HumanTaskUiName" => HumanTaskUiName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_human_task_ui(
HumanTaskUiName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeHumanTaskUi",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("HumanTaskUiName" => HumanTaskUiName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_hyper_parameter_tuning_job(hyper_parameter_tuning_job_name)
describe_hyper_parameter_tuning_job(hyper_parameter_tuning_job_name, params::Dict{String,<:Any})
Returns a description of a hyperparameter tuning job, depending on the fields selected.
These fields can include the name, Amazon Resource Name (ARN), job status of your tuning
job and more.
# Arguments
- `hyper_parameter_tuning_job_name`: The name of the tuning job.
"""
function describe_hyper_parameter_tuning_job(
HyperParameterTuningJobName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeHyperParameterTuningJob",
Dict{String,Any}("HyperParameterTuningJobName" => HyperParameterTuningJobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_hyper_parameter_tuning_job(
HyperParameterTuningJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeHyperParameterTuningJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"HyperParameterTuningJobName" => HyperParameterTuningJobName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_image(image_name)
describe_image(image_name, params::Dict{String,<:Any})
Describes a SageMaker image.
# Arguments
- `image_name`: The name of the image to describe.
"""
function describe_image(ImageName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"DescribeImage",
Dict{String,Any}("ImageName" => ImageName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_image(
ImageName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeImage",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ImageName" => ImageName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_image_version(image_name)
describe_image_version(image_name, params::Dict{String,<:Any})
Describes a version of a SageMaker image.
# Arguments
- `image_name`: The name of the image.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Alias"`: The alias of the image version.
- `"Version"`: The version of the image. If not specified, the latest version is described.
"""
function describe_image_version(
ImageName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeImageVersion",
Dict{String,Any}("ImageName" => ImageName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_image_version(
ImageName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeImageVersion",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ImageName" => ImageName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_inference_component(inference_component_name)
describe_inference_component(inference_component_name, params::Dict{String,<:Any})
Returns information about an inference component.
# Arguments
- `inference_component_name`: The name of the inference component.
"""
function describe_inference_component(
InferenceComponentName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeInferenceComponent",
Dict{String,Any}("InferenceComponentName" => InferenceComponentName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_inference_component(
InferenceComponentName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeInferenceComponent",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InferenceComponentName" => InferenceComponentName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_inference_experiment(name)
describe_inference_experiment(name, params::Dict{String,<:Any})
Returns details about an inference experiment.
# Arguments
- `name`: The name of the inference experiment to describe.
"""
function describe_inference_experiment(
Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeInferenceExperiment",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_inference_experiment(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeInferenceExperiment",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_inference_recommendations_job(job_name)
describe_inference_recommendations_job(job_name, params::Dict{String,<:Any})
Provides the results of the Inference Recommender job. One or more recommendation jobs are
returned.
# Arguments
- `job_name`: The name of the job. The name must be unique within an Amazon Web Services
Region in the Amazon Web Services account.
"""
function describe_inference_recommendations_job(
JobName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeInferenceRecommendationsJob",
Dict{String,Any}("JobName" => JobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_inference_recommendations_job(
JobName, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeInferenceRecommendationsJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobName" => JobName), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_labeling_job(labeling_job_name)
describe_labeling_job(labeling_job_name, params::Dict{String,<:Any})
Gets information about a labeling job.
# Arguments
- `labeling_job_name`: The name of the labeling job to return information for.
"""
function describe_labeling_job(
LabelingJobName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeLabelingJob",
Dict{String,Any}("LabelingJobName" => LabelingJobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_labeling_job(
LabelingJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeLabelingJob",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("LabelingJobName" => LabelingJobName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_lineage_group(lineage_group_name)
describe_lineage_group(lineage_group_name, params::Dict{String,<:Any})
Provides a list of properties for the requested lineage group. For more information, see
Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.
# Arguments
- `lineage_group_name`: The name of the lineage group.
"""
function describe_lineage_group(
LineageGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeLineageGroup",
Dict{String,Any}("LineageGroupName" => LineageGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_lineage_group(
LineageGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeLineageGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("LineageGroupName" => LineageGroupName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_mlflow_tracking_server(tracking_server_name)
describe_mlflow_tracking_server(tracking_server_name, params::Dict{String,<:Any})
Returns information about an MLflow Tracking Server.
# Arguments
- `tracking_server_name`: The name of the MLflow Tracking Server to describe.
"""
function describe_mlflow_tracking_server(
TrackingServerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeMlflowTrackingServer",
Dict{String,Any}("TrackingServerName" => TrackingServerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_mlflow_tracking_server(
TrackingServerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeMlflowTrackingServer",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("TrackingServerName" => TrackingServerName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_model(model_name)
describe_model(model_name, params::Dict{String,<:Any})
Describes a model that you created using the CreateModel API.
# Arguments
- `model_name`: The name of the model.
"""
function describe_model(ModelName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"DescribeModel",
Dict{String,Any}("ModelName" => ModelName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_model(
ModelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeModel",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ModelName" => ModelName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_model_bias_job_definition(job_definition_name)
describe_model_bias_job_definition(job_definition_name, params::Dict{String,<:Any})
Returns a description of a model bias job definition.
# Arguments
- `job_definition_name`: The name of the model bias job definition. The name must be unique
within an Amazon Web Services Region in the Amazon Web Services account.
"""
function describe_model_bias_job_definition(
JobDefinitionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeModelBiasJobDefinition",
Dict{String,Any}("JobDefinitionName" => JobDefinitionName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_model_bias_job_definition(
JobDefinitionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeModelBiasJobDefinition",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("JobDefinitionName" => JobDefinitionName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_model_card(model_card_name)
describe_model_card(model_card_name, params::Dict{String,<:Any})
Describes the content, creation time, and security configuration of an Amazon SageMaker
Model Card.
# Arguments
- `model_card_name`: The name or Amazon Resource Name (ARN) of the model card to describe.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ModelCardVersion"`: The version of the model card to describe. If a version is not
provided, then the latest version of the model card is described.
"""
function describe_model_card(
ModelCardName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeModelCard",
Dict{String,Any}("ModelCardName" => ModelCardName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_model_card(
ModelCardName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeModelCard",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ModelCardName" => ModelCardName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_model_card_export_job(model_card_export_job_arn)
describe_model_card_export_job(model_card_export_job_arn, params::Dict{String,<:Any})
Describes an Amazon SageMaker Model Card export job.
# Arguments
- `model_card_export_job_arn`: The Amazon Resource Name (ARN) of the model card export job
to describe.
"""
function describe_model_card_export_job(
ModelCardExportJobArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeModelCardExportJob",
Dict{String,Any}("ModelCardExportJobArn" => ModelCardExportJobArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_model_card_export_job(
ModelCardExportJobArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeModelCardExportJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ModelCardExportJobArn" => ModelCardExportJobArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_model_explainability_job_definition(job_definition_name)
describe_model_explainability_job_definition(job_definition_name, params::Dict{String,<:Any})
Returns a description of a model explainability job definition.
# Arguments
- `job_definition_name`: The name of the model explainability job definition. The name must
be unique within an Amazon Web Services Region in the Amazon Web Services account.
"""
function describe_model_explainability_job_definition(
JobDefinitionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeModelExplainabilityJobDefinition",
Dict{String,Any}("JobDefinitionName" => JobDefinitionName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_model_explainability_job_definition(
JobDefinitionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeModelExplainabilityJobDefinition",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("JobDefinitionName" => JobDefinitionName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_model_package(model_package_name)
describe_model_package(model_package_name, params::Dict{String,<:Any})
Returns a description of the specified model package, which is used to create SageMaker
models or list them on Amazon Web Services Marketplace. If you provided a KMS Key ID when
you created your model package, you will see the KMS Decrypt API call in your CloudTrail
logs when you use this API. To create models in SageMaker, buyers can subscribe to model
packages listed on Amazon Web Services Marketplace.
# Arguments
- `model_package_name`: The name or Amazon Resource Name (ARN) of the model package to
describe. When you specify a name, the name must have 1 to 63 characters. Valid characters
are a-z, A-Z, 0-9, and - (hyphen).
"""
function describe_model_package(
ModelPackageName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeModelPackage",
Dict{String,Any}("ModelPackageName" => ModelPackageName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_model_package(
ModelPackageName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeModelPackage",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ModelPackageName" => ModelPackageName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_model_package_group(model_package_group_name)
describe_model_package_group(model_package_group_name, params::Dict{String,<:Any})
Gets a description for the specified model group.
# Arguments
- `model_package_group_name`: The name of the model group to describe.
"""
function describe_model_package_group(
ModelPackageGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeModelPackageGroup",
Dict{String,Any}("ModelPackageGroupName" => ModelPackageGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_model_package_group(
ModelPackageGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeModelPackageGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ModelPackageGroupName" => ModelPackageGroupName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_model_quality_job_definition(job_definition_name)
describe_model_quality_job_definition(job_definition_name, params::Dict{String,<:Any})
Returns a description of a model quality job definition.
# Arguments
- `job_definition_name`: The name of the model quality job. The name must be unique within
an Amazon Web Services Region in the Amazon Web Services account.
"""
function describe_model_quality_job_definition(
JobDefinitionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeModelQualityJobDefinition",
Dict{String,Any}("JobDefinitionName" => JobDefinitionName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_model_quality_job_definition(
JobDefinitionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeModelQualityJobDefinition",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("JobDefinitionName" => JobDefinitionName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_monitoring_schedule(monitoring_schedule_name)
describe_monitoring_schedule(monitoring_schedule_name, params::Dict{String,<:Any})
Describes the schedule for a monitoring job.
# Arguments
- `monitoring_schedule_name`: Name of a previously created monitoring schedule.
"""
function describe_monitoring_schedule(
MonitoringScheduleName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeMonitoringSchedule",
Dict{String,Any}("MonitoringScheduleName" => MonitoringScheduleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_monitoring_schedule(
MonitoringScheduleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeMonitoringSchedule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("MonitoringScheduleName" => MonitoringScheduleName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_notebook_instance(notebook_instance_name)
describe_notebook_instance(notebook_instance_name, params::Dict{String,<:Any})
Returns information about a notebook instance.
# Arguments
- `notebook_instance_name`: The name of the notebook instance that you want information
about.
"""
function describe_notebook_instance(
NotebookInstanceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeNotebookInstance",
Dict{String,Any}("NotebookInstanceName" => NotebookInstanceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_notebook_instance(
NotebookInstanceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeNotebookInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("NotebookInstanceName" => NotebookInstanceName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_notebook_instance_lifecycle_config(notebook_instance_lifecycle_config_name)
describe_notebook_instance_lifecycle_config(notebook_instance_lifecycle_config_name, params::Dict{String,<:Any})
Returns a description of a notebook instance lifecycle configuration. For information about
notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook
Instance.
# Arguments
- `notebook_instance_lifecycle_config_name`: The name of the lifecycle configuration to
describe.
"""
function describe_notebook_instance_lifecycle_config(
NotebookInstanceLifecycleConfigName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeNotebookInstanceLifecycleConfig",
Dict{String,Any}(
"NotebookInstanceLifecycleConfigName" => NotebookInstanceLifecycleConfigName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_notebook_instance_lifecycle_config(
NotebookInstanceLifecycleConfigName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeNotebookInstanceLifecycleConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"NotebookInstanceLifecycleConfigName" =>
NotebookInstanceLifecycleConfigName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_pipeline(pipeline_name)
describe_pipeline(pipeline_name, params::Dict{String,<:Any})
Describes the details of a pipeline.
# Arguments
- `pipeline_name`: The name or Amazon Resource Name (ARN) of the pipeline to describe.
"""
function describe_pipeline(PipelineName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"DescribePipeline",
Dict{String,Any}("PipelineName" => 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 sagemaker(
"DescribePipeline",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PipelineName" => PipelineName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_pipeline_definition_for_execution(pipeline_execution_arn)
describe_pipeline_definition_for_execution(pipeline_execution_arn, params::Dict{String,<:Any})
Describes the details of an execution's pipeline definition.
# Arguments
- `pipeline_execution_arn`: The Amazon Resource Name (ARN) of the pipeline execution.
"""
function describe_pipeline_definition_for_execution(
PipelineExecutionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribePipelineDefinitionForExecution",
Dict{String,Any}("PipelineExecutionArn" => PipelineExecutionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_pipeline_definition_for_execution(
PipelineExecutionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribePipelineDefinitionForExecution",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("PipelineExecutionArn" => PipelineExecutionArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_pipeline_execution(pipeline_execution_arn)
describe_pipeline_execution(pipeline_execution_arn, params::Dict{String,<:Any})
Describes the details of a pipeline execution.
# Arguments
- `pipeline_execution_arn`: The Amazon Resource Name (ARN) of the pipeline execution.
"""
function describe_pipeline_execution(
PipelineExecutionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribePipelineExecution",
Dict{String,Any}("PipelineExecutionArn" => PipelineExecutionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_pipeline_execution(
PipelineExecutionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribePipelineExecution",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("PipelineExecutionArn" => PipelineExecutionArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_processing_job(processing_job_name)
describe_processing_job(processing_job_name, params::Dict{String,<:Any})
Returns a description of a processing job.
# Arguments
- `processing_job_name`: The name of the processing job. The name must be unique within an
Amazon Web Services Region in the Amazon Web Services account.
"""
function describe_processing_job(
ProcessingJobName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeProcessingJob",
Dict{String,Any}("ProcessingJobName" => ProcessingJobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_processing_job(
ProcessingJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeProcessingJob",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ProcessingJobName" => ProcessingJobName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_project(project_name)
describe_project(project_name, params::Dict{String,<:Any})
Describes the details of a project.
# Arguments
- `project_name`: The name of the project to describe.
"""
function describe_project(ProjectName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"DescribeProject",
Dict{String,Any}("ProjectName" => 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 sagemaker(
"DescribeProject",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ProjectName" => ProjectName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_space(domain_id, space_name)
describe_space(domain_id, space_name, params::Dict{String,<:Any})
Describes the space.
# Arguments
- `domain_id`: The ID of the associated domain.
- `space_name`: The name of the space.
"""
function describe_space(
DomainId, SpaceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeSpace",
Dict{String,Any}("DomainId" => DomainId, "SpaceName" => SpaceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_space(
DomainId,
SpaceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeSpace",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DomainId" => DomainId, "SpaceName" => SpaceName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_studio_lifecycle_config(studio_lifecycle_config_name)
describe_studio_lifecycle_config(studio_lifecycle_config_name, params::Dict{String,<:Any})
Describes the Amazon SageMaker Studio Lifecycle Configuration.
# Arguments
- `studio_lifecycle_config_name`: The name of the Amazon SageMaker Studio Lifecycle
Configuration to describe.
"""
function describe_studio_lifecycle_config(
StudioLifecycleConfigName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeStudioLifecycleConfig",
Dict{String,Any}("StudioLifecycleConfigName" => StudioLifecycleConfigName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_studio_lifecycle_config(
StudioLifecycleConfigName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeStudioLifecycleConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("StudioLifecycleConfigName" => StudioLifecycleConfigName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_subscribed_workteam(workteam_arn)
describe_subscribed_workteam(workteam_arn, params::Dict{String,<:Any})
Gets information about a work team provided by a vendor. It returns details about the
subscription with a vendor in the Amazon Web Services Marketplace.
# Arguments
- `workteam_arn`: The Amazon Resource Name (ARN) of the subscribed work team to describe.
"""
function describe_subscribed_workteam(
WorkteamArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeSubscribedWorkteam",
Dict{String,Any}("WorkteamArn" => WorkteamArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_subscribed_workteam(
WorkteamArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeSubscribedWorkteam",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("WorkteamArn" => WorkteamArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_training_job(training_job_name)
describe_training_job(training_job_name, params::Dict{String,<:Any})
Returns information about a training job. Some of the attributes below only appear if the
training job successfully starts. If the training job fails, TrainingJobStatus is Failed
and, depending on the FailureReason, attributes like TrainingStartTime,
TrainingTimeInSeconds, TrainingEndTime, and BillableTimeInSeconds may not be present in the
response.
# Arguments
- `training_job_name`: The name of the training job.
"""
function describe_training_job(
TrainingJobName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeTrainingJob",
Dict{String,Any}("TrainingJobName" => TrainingJobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_training_job(
TrainingJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeTrainingJob",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("TrainingJobName" => TrainingJobName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_transform_job(transform_job_name)
describe_transform_job(transform_job_name, params::Dict{String,<:Any})
Returns information about a transform job.
# Arguments
- `transform_job_name`: The name of the transform job that you want to view details of.
"""
function describe_transform_job(
TransformJobName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeTransformJob",
Dict{String,Any}("TransformJobName" => TransformJobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_transform_job(
TransformJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeTransformJob",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("TransformJobName" => TransformJobName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_trial(trial_name)
describe_trial(trial_name, params::Dict{String,<:Any})
Provides a list of a trial's properties.
# Arguments
- `trial_name`: The name of the trial to describe.
"""
function describe_trial(TrialName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"DescribeTrial",
Dict{String,Any}("TrialName" => TrialName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_trial(
TrialName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeTrial",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TrialName" => TrialName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_trial_component(trial_component_name)
describe_trial_component(trial_component_name, params::Dict{String,<:Any})
Provides a list of a trials component's properties.
# Arguments
- `trial_component_name`: The name of the trial component to describe.
"""
function describe_trial_component(
TrialComponentName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeTrialComponent",
Dict{String,Any}("TrialComponentName" => TrialComponentName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_trial_component(
TrialComponentName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeTrialComponent",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("TrialComponentName" => TrialComponentName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_user_profile(domain_id, user_profile_name)
describe_user_profile(domain_id, user_profile_name, params::Dict{String,<:Any})
Describes a user profile. For more information, see CreateUserProfile.
# Arguments
- `domain_id`: The domain ID.
- `user_profile_name`: The user profile name. This value is not case sensitive.
"""
function describe_user_profile(
DomainId, UserProfileName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeUserProfile",
Dict{String,Any}("DomainId" => DomainId, "UserProfileName" => UserProfileName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_user_profile(
DomainId,
UserProfileName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeUserProfile",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DomainId" => DomainId, "UserProfileName" => UserProfileName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_workforce(workforce_name)
describe_workforce(workforce_name, params::Dict{String,<:Any})
Lists private workforce information, including workforce name, Amazon Resource Name (ARN),
and, if applicable, allowed IP address ranges (CIDRs). Allowable IP address ranges are the
IP addresses that workers can use to access tasks. This operation applies only to private
workforces.
# Arguments
- `workforce_name`: The name of the private workforce whose access you want to restrict.
WorkforceName is automatically set to default when a workforce is created and cannot be
modified.
"""
function describe_workforce(
WorkforceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DescribeWorkforce",
Dict{String,Any}("WorkforceName" => WorkforceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_workforce(
WorkforceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeWorkforce",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("WorkforceName" => WorkforceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_workteam(workteam_name)
describe_workteam(workteam_name, params::Dict{String,<:Any})
Gets information about a specific work team. You can see information such as the creation
date, the last updated date, membership information, and the work team's Amazon Resource
Name (ARN).
# Arguments
- `workteam_name`: The name of the work team to return a description of.
"""
function describe_workteam(WorkteamName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"DescribeWorkteam",
Dict{String,Any}("WorkteamName" => WorkteamName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_workteam(
WorkteamName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DescribeWorkteam",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("WorkteamName" => WorkteamName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_sagemaker_servicecatalog_portfolio()
disable_sagemaker_servicecatalog_portfolio(params::Dict{String,<:Any})
Disables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker
projects.
"""
function disable_sagemaker_servicecatalog_portfolio(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DisableSagemakerServicecatalogPortfolio";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_sagemaker_servicecatalog_portfolio(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DisableSagemakerServicecatalogPortfolio",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_trial_component(trial_component_name, trial_name)
disassociate_trial_component(trial_component_name, trial_name, params::Dict{String,<:Any})
Disassociates a trial component from a trial. This doesn't effect other trials the
component is associated with. Before you can delete a component, you must disassociate the
component from all trials it is associated with. To associate a trial component with a
trial, call the AssociateTrialComponent API. To get a list of the trials a component is
associated with, use the Search API. Specify ExperimentTrialComponent for the Resource
parameter. The list appears in the response under Results.TrialComponent.Parents.
# Arguments
- `trial_component_name`: The name of the component to disassociate from the trial.
- `trial_name`: The name of the trial to disassociate from.
"""
function disassociate_trial_component(
TrialComponentName, TrialName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"DisassociateTrialComponent",
Dict{String,Any}(
"TrialComponentName" => TrialComponentName, "TrialName" => TrialName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_trial_component(
TrialComponentName,
TrialName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"DisassociateTrialComponent",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TrialComponentName" => TrialComponentName, "TrialName" => TrialName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_sagemaker_servicecatalog_portfolio()
enable_sagemaker_servicecatalog_portfolio(params::Dict{String,<:Any})
Enables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker
projects.
"""
function enable_sagemaker_servicecatalog_portfolio(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"EnableSagemakerServicecatalogPortfolio";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_sagemaker_servicecatalog_portfolio(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"EnableSagemakerServicecatalogPortfolio",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_device_fleet_report(device_fleet_name)
get_device_fleet_report(device_fleet_name, params::Dict{String,<:Any})
Describes a fleet.
# Arguments
- `device_fleet_name`: The name of the fleet.
"""
function get_device_fleet_report(
DeviceFleetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"GetDeviceFleetReport",
Dict{String,Any}("DeviceFleetName" => DeviceFleetName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_device_fleet_report(
DeviceFleetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"GetDeviceFleetReport",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("DeviceFleetName" => DeviceFleetName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_lineage_group_policy(lineage_group_name)
get_lineage_group_policy(lineage_group_name, params::Dict{String,<:Any})
The resource policy for the lineage group.
# Arguments
- `lineage_group_name`: The name or Amazon Resource Name (ARN) of the lineage group.
"""
function get_lineage_group_policy(
LineageGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"GetLineageGroupPolicy",
Dict{String,Any}("LineageGroupName" => LineageGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_lineage_group_policy(
LineageGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"GetLineageGroupPolicy",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("LineageGroupName" => LineageGroupName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_model_package_group_policy(model_package_group_name)
get_model_package_group_policy(model_package_group_name, params::Dict{String,<:Any})
Gets a resource policy that manages access for a model group. For information about
resource policies, see Identity-based policies and resource-based policies in the Amazon
Web Services Identity and Access Management User Guide..
# Arguments
- `model_package_group_name`: The name of the model group for which to get the resource
policy.
"""
function get_model_package_group_policy(
ModelPackageGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"GetModelPackageGroupPolicy",
Dict{String,Any}("ModelPackageGroupName" => ModelPackageGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_model_package_group_policy(
ModelPackageGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"GetModelPackageGroupPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ModelPackageGroupName" => ModelPackageGroupName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_sagemaker_servicecatalog_portfolio_status()
get_sagemaker_servicecatalog_portfolio_status(params::Dict{String,<:Any})
Gets the status of Service Catalog in SageMaker. Service Catalog is used to create
SageMaker projects.
"""
function get_sagemaker_servicecatalog_portfolio_status(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"GetSagemakerServicecatalogPortfolioStatus";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_sagemaker_servicecatalog_portfolio_status(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"GetSagemakerServicecatalogPortfolioStatus",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_scaling_configuration_recommendation(inference_recommendations_job_name)
get_scaling_configuration_recommendation(inference_recommendations_job_name, params::Dict{String,<:Any})
Starts an Amazon SageMaker Inference Recommender autoscaling recommendation job. Returns
recommendations for autoscaling policies that you can apply to your SageMaker endpoint.
# Arguments
- `inference_recommendations_job_name`: The name of a previously completed Inference
Recommender job.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EndpointName"`: The name of an endpoint benchmarked during a previously completed
inference recommendation job. This name should come from one of the recommendations
returned by the job specified in the InferenceRecommendationsJobName field. Specify either
this field or the RecommendationId field.
- `"RecommendationId"`: The recommendation ID of a previously completed inference
recommendation. This ID should come from one of the recommendations returned by the job
specified in the InferenceRecommendationsJobName field. Specify either this field or the
EndpointName field.
- `"ScalingPolicyObjective"`: An object where you specify the anticipated traffic pattern
for an endpoint.
- `"TargetCpuUtilizationPerCore"`: The percentage of how much utilization you want an
instance to use before autoscaling. The default value is 50%.
"""
function get_scaling_configuration_recommendation(
InferenceRecommendationsJobName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"GetScalingConfigurationRecommendation",
Dict{String,Any}(
"InferenceRecommendationsJobName" => InferenceRecommendationsJobName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_scaling_configuration_recommendation(
InferenceRecommendationsJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"GetScalingConfigurationRecommendation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InferenceRecommendationsJobName" => InferenceRecommendationsJobName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_search_suggestions(resource)
get_search_suggestions(resource, params::Dict{String,<:Any})
An auto-complete API for the search functionality in the SageMaker console. It returns
suggestions of possible matches for the property name to use in Search queries. Provides
suggestions for HyperParameters, Tags, and Metrics.
# Arguments
- `resource`: The name of the SageMaker resource to search for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SuggestionQuery"`: Limits the property names that are included in the response.
"""
function get_search_suggestions(Resource; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"GetSearchSuggestions",
Dict{String,Any}("Resource" => Resource);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_search_suggestions(
Resource,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"GetSearchSuggestions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Resource" => Resource), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
import_hub_content(document_schema_version, hub_content_document, hub_content_name, hub_content_type, hub_name)
import_hub_content(document_schema_version, hub_content_document, hub_content_name, hub_content_type, hub_name, params::Dict{String,<:Any})
Import hub content.
# Arguments
- `document_schema_version`: The version of the hub content schema to import.
- `hub_content_document`: The hub content document that describes information about the hub
content such as type, associated containers, scripts, and more.
- `hub_content_name`: The name of the hub content to import.
- `hub_content_type`: The type of hub content to import.
- `hub_name`: The name of the hub to import content into.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"HubContentDescription"`: A description of the hub content to import.
- `"HubContentDisplayName"`: The display name of the hub content to import.
- `"HubContentMarkdown"`: A string that provides a description of the hub content. This
string can include links, tables, and standard markdown formating.
- `"HubContentSearchKeywords"`: The searchable keywords of the hub content.
- `"HubContentVersion"`: The version of the hub content to import.
- `"Tags"`: Any tags associated with the hub content.
"""
function import_hub_content(
DocumentSchemaVersion,
HubContentDocument,
HubContentName,
HubContentType,
HubName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"ImportHubContent",
Dict{String,Any}(
"DocumentSchemaVersion" => DocumentSchemaVersion,
"HubContentDocument" => HubContentDocument,
"HubContentName" => HubContentName,
"HubContentType" => HubContentType,
"HubName" => HubName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function import_hub_content(
DocumentSchemaVersion,
HubContentDocument,
HubContentName,
HubContentType,
HubName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"ImportHubContent",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DocumentSchemaVersion" => DocumentSchemaVersion,
"HubContentDocument" => HubContentDocument,
"HubContentName" => HubContentName,
"HubContentType" => HubContentType,
"HubName" => HubName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_actions()
list_actions(params::Dict{String,<:Any})
Lists the actions in your account and their properties.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ActionType"`: A filter that returns only actions of the specified type.
- `"CreatedAfter"`: A filter that returns only actions created on or after the specified
time.
- `"CreatedBefore"`: A filter that returns only actions created on or before the specified
time.
- `"MaxResults"`: The maximum number of actions to return in the response. The default
value is 10.
- `"NextToken"`: If the previous call to ListActions didn't return the full set of actions,
the call returns a token for getting the next set of actions.
- `"SortBy"`: The property used to sort results. The default value is CreationTime.
- `"SortOrder"`: The sort order. The default value is Descending.
- `"SourceUri"`: A filter that returns only actions with the specified source URI.
"""
function list_actions(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker("ListActions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_actions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListActions", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_algorithms()
list_algorithms(params::Dict{String,<:Any})
Lists the machine learning algorithms that have been created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: A filter that returns only algorithms created after the specified
time (timestamp).
- `"CreationTimeBefore"`: A filter that returns only algorithms created before the
specified time (timestamp).
- `"MaxResults"`: The maximum number of algorithms to return in the response.
- `"NameContains"`: A string in the algorithm name. This filter returns only algorithms
whose name contains the specified string.
- `"NextToken"`: If the response to a previous ListAlgorithms request was truncated, the
response includes a NextToken. To retrieve the next set of algorithms, use the token in the
next request.
- `"SortBy"`: The parameter by which to sort the results. The default is CreationTime.
- `"SortOrder"`: The sort order for the results. The default is Ascending.
"""
function list_algorithms(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListAlgorithms"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_algorithms(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListAlgorithms", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_aliases(image_name)
list_aliases(image_name, params::Dict{String,<:Any})
Lists the aliases of a specified image or image version.
# Arguments
- `image_name`: The name of the image.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Alias"`: The alias of the image version.
- `"MaxResults"`: The maximum number of aliases to return.
- `"NextToken"`: If the previous call to ListAliases didn't return the full set of aliases,
the call returns a token for retrieving the next set of aliases.
- `"Version"`: The version of the image. If image version is not specified, the aliases of
all versions of the image are listed.
"""
function list_aliases(ImageName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListAliases",
Dict{String,Any}("ImageName" => ImageName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_aliases(
ImageName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"ListAliases",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ImageName" => ImageName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_app_image_configs()
list_app_image_configs(params::Dict{String,<:Any})
Lists the AppImageConfigs in your account and their properties. The list can be filtered by
creation time or modified time, and whether the AppImageConfig name contains a specified
string.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: A filter that returns only AppImageConfigs created on or after the
specified time.
- `"CreationTimeBefore"`: A filter that returns only AppImageConfigs created on or before
the specified time.
- `"MaxResults"`: The total number of items to return in the response. If the total number
of items available is more than the value specified, a NextToken is provided in the
response. To resume pagination, provide the NextToken value in the as part of a subsequent
call. The default value is 10.
- `"ModifiedTimeAfter"`: A filter that returns only AppImageConfigs modified on or after
the specified time.
- `"ModifiedTimeBefore"`: A filter that returns only AppImageConfigs modified on or before
the specified time.
- `"NameContains"`: A filter that returns only AppImageConfigs whose name contains the
specified string.
- `"NextToken"`: If the previous call to ListImages didn't return the full set of
AppImageConfigs, the call returns a token for getting the next set of AppImageConfigs.
- `"SortBy"`: The property used to sort results. The default value is CreationTime.
- `"SortOrder"`: The sort order. The default value is Descending.
"""
function list_app_image_configs(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListAppImageConfigs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_app_image_configs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListAppImageConfigs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_apps()
list_apps(params::Dict{String,<:Any})
Lists apps.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DomainIdEquals"`: A parameter to search for the domain ID.
- `"MaxResults"`: This parameter defines the maximum number of results that can be return
in a single response. The MaxResults parameter is an upper bound, not a target. If there
are more results available than the value specified, a NextToken is provided in the
response. The NextToken indicates that the user should get the next set of results by
providing this token as a part of a subsequent call. The default value for MaxResults is 10.
- `"NextToken"`: If the previous response was truncated, you will receive this token. Use
it in your next request to receive the next set of results.
- `"SortBy"`: The parameter by which to sort the results. The default is CreationTime.
- `"SortOrder"`: The sort order for the results. The default is Ascending.
- `"SpaceNameEquals"`: A parameter to search by space name. If UserProfileNameEquals is
set, then this value cannot be set.
- `"UserProfileNameEquals"`: A parameter to search by user profile name. If SpaceNameEquals
is set, then this value cannot be set.
"""
function list_apps(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker("ListApps"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_apps(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListApps", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_artifacts()
list_artifacts(params::Dict{String,<:Any})
Lists the artifacts in your account and their properties.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ArtifactType"`: A filter that returns only artifacts of the specified type.
- `"CreatedAfter"`: A filter that returns only artifacts created on or after the specified
time.
- `"CreatedBefore"`: A filter that returns only artifacts created on or before the
specified time.
- `"MaxResults"`: The maximum number of artifacts to return in the response. The default
value is 10.
- `"NextToken"`: If the previous call to ListArtifacts didn't return the full set of
artifacts, the call returns a token for getting the next set of artifacts.
- `"SortBy"`: The property used to sort results. The default value is CreationTime.
- `"SortOrder"`: The sort order. The default value is Descending.
- `"SourceUri"`: A filter that returns only artifacts with the specified source URI.
"""
function list_artifacts(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListArtifacts"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_artifacts(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListArtifacts", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_associations()
list_associations(params::Dict{String,<:Any})
Lists the associations in your account and their properties.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AssociationType"`: A filter that returns only associations of the specified type.
- `"CreatedAfter"`: A filter that returns only associations created on or after the
specified time.
- `"CreatedBefore"`: A filter that returns only associations created on or before the
specified time.
- `"DestinationArn"`: A filter that returns only associations with the specified
destination Amazon Resource Name (ARN).
- `"DestinationType"`: A filter that returns only associations with the specified
destination type.
- `"MaxResults"`: The maximum number of associations to return in the response. The default
value is 10.
- `"NextToken"`: If the previous call to ListAssociations didn't return the full set of
associations, the call returns a token for getting the next set of associations.
- `"SortBy"`: The property used to sort results. The default value is CreationTime.
- `"SortOrder"`: The sort order. The default value is Descending.
- `"SourceArn"`: A filter that returns only associations with the specified source ARN.
- `"SourceType"`: A filter that returns only associations with the specified source type.
"""
function list_associations(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListAssociations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_associations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListAssociations", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_auto_mljobs()
list_auto_mljobs(params::Dict{String,<:Any})
Request a list of jobs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: Request a list of jobs, using a filter for time.
- `"CreationTimeBefore"`: Request a list of jobs, using a filter for time.
- `"LastModifiedTimeAfter"`: Request a list of jobs, using a filter for time.
- `"LastModifiedTimeBefore"`: Request a list of jobs, using a filter for time.
- `"MaxResults"`: Request a list of jobs up to a specified limit.
- `"NameContains"`: Request a list of jobs, using a search filter for name.
- `"NextToken"`: If the previous response was truncated, you receive this token. Use it in
your next request to receive the next set of results.
- `"SortBy"`: The parameter by which to sort the results. The default is Name.
- `"SortOrder"`: The sort order for the results. The default is Descending.
- `"StatusEquals"`: Request a list of jobs, using a filter for status.
"""
function list_auto_mljobs(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListAutoMLJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_auto_mljobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListAutoMLJobs", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_candidates_for_auto_mljob(auto_mljob_name)
list_candidates_for_auto_mljob(auto_mljob_name, params::Dict{String,<:Any})
List the candidates created for the job.
# Arguments
- `auto_mljob_name`: List the candidates created for the job by providing the job's name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CandidateNameEquals"`: List the candidates for the job and filter by candidate name.
- `"MaxResults"`: List the job's candidates up to a specified limit.
- `"NextToken"`: If the previous response was truncated, you receive this token. Use it in
your next request to receive the next set of results.
- `"SortBy"`: The parameter by which to sort the results. The default is Descending.
- `"SortOrder"`: The sort order for the results. The default is Ascending.
- `"StatusEquals"`: List the candidates for the job and filter by status.
"""
function list_candidates_for_auto_mljob(
AutoMLJobName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListCandidatesForAutoMLJob",
Dict{String,Any}("AutoMLJobName" => AutoMLJobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_candidates_for_auto_mljob(
AutoMLJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"ListCandidatesForAutoMLJob",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AutoMLJobName" => AutoMLJobName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_cluster_nodes(cluster_name)
list_cluster_nodes(cluster_name, params::Dict{String,<:Any})
Retrieves the list of instances (also called nodes interchangeably) in a SageMaker HyperPod
cluster.
# Arguments
- `cluster_name`: The string name or the Amazon Resource Name (ARN) of the SageMaker
HyperPod cluster in which you want to retrieve the list of nodes.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: A filter that returns nodes in a SageMaker HyperPod cluster
created after the specified time. Timestamps are formatted according to the ISO 8601
standard. Acceptable formats include: YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example,
2014-10-01T20:30:00.000Z YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example,
2014-10-01T12:30:00.000-08:00 YYYY-MM-DD, for example, 2014-10-01 Unix time in
seconds, for example, 1412195400. This is also referred to as Unix Epoch time and
represents the number of seconds since midnight, January 1, 1970 UTC. For more
information about the timestamp format, see Timestamp in the Amazon Web Services Command
Line Interface User Guide.
- `"CreationTimeBefore"`: A filter that returns nodes in a SageMaker HyperPod cluster
created before the specified time. The acceptable formats are the same as the timestamp
formats for CreationTimeAfter. For more information about the timestamp format, see
Timestamp in the Amazon Web Services Command Line Interface User Guide.
- `"InstanceGroupNameContains"`: A filter that returns the instance groups whose name
contain a specified string.
- `"MaxResults"`: The maximum number of nodes to return in the response.
- `"NextToken"`: If the result of the previous ListClusterNodes request was truncated, the
response includes a NextToken. To retrieve the next set of cluster nodes, use the token in
the next request.
- `"SortBy"`: The field by which to sort results. The default value is CREATION_TIME.
- `"SortOrder"`: The sort order for results. The default value is Ascending.
"""
function list_cluster_nodes(ClusterName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListClusterNodes",
Dict{String,Any}("ClusterName" => ClusterName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_cluster_nodes(
ClusterName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"ListClusterNodes",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClusterName" => ClusterName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_clusters()
list_clusters(params::Dict{String,<:Any})
Retrieves the list of SageMaker HyperPod clusters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: Set a start time for the time range during which you want to list
SageMaker HyperPod clusters. Timestamps are formatted according to the ISO 8601 standard.
Acceptable formats include: YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example,
2014-10-01T20:30:00.000Z YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example,
2014-10-01T12:30:00.000-08:00 YYYY-MM-DD, for example, 2014-10-01 Unix time in
seconds, for example, 1412195400. This is also referred to as Unix Epoch time and
represents the number of seconds since midnight, January 1, 1970 UTC. For more
information about the timestamp format, see Timestamp in the Amazon Web Services Command
Line Interface User Guide.
- `"CreationTimeBefore"`: Set an end time for the time range during which you want to list
SageMaker HyperPod clusters. A filter that returns nodes in a SageMaker HyperPod cluster
created before the specified time. The acceptable formats are the same as the timestamp
formats for CreationTimeAfter. For more information about the timestamp format, see
Timestamp in the Amazon Web Services Command Line Interface User Guide.
- `"MaxResults"`: Set the maximum number of SageMaker HyperPod clusters to list.
- `"NameContains"`: Set the maximum number of instances to print in the list.
- `"NextToken"`: Set the next token to retrieve the list of SageMaker HyperPod clusters.
- `"SortBy"`: The field by which to sort results. The default value is CREATION_TIME.
- `"SortOrder"`: The sort order for results. The default value is Ascending.
"""
function list_clusters(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker("ListClusters"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_clusters(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListClusters", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_code_repositories()
list_code_repositories(params::Dict{String,<:Any})
Gets a list of the Git repositories in your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: A filter that returns only Git repositories that were created
after the specified time.
- `"CreationTimeBefore"`: A filter that returns only Git repositories that were created
before the specified time.
- `"LastModifiedTimeAfter"`: A filter that returns only Git repositories that were last
modified after the specified time.
- `"LastModifiedTimeBefore"`: A filter that returns only Git repositories that were last
modified before the specified time.
- `"MaxResults"`: The maximum number of Git repositories to return in the response.
- `"NameContains"`: A string in the Git repositories name. This filter returns only
repositories whose name contains the specified string.
- `"NextToken"`: If the result of a ListCodeRepositoriesOutput request was truncated, the
response includes a NextToken. To get the next set of Git repositories, use the token in
the next request.
- `"SortBy"`: The field to sort results by. The default is Name.
- `"SortOrder"`: The sort order for results. The default is Ascending.
"""
function list_code_repositories(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListCodeRepositories"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_code_repositories(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListCodeRepositories",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_compilation_jobs()
list_compilation_jobs(params::Dict{String,<:Any})
Lists model compilation jobs that satisfy various filters. To create a model compilation
job, use CreateCompilationJob. To get information about a particular model compilation job
you have created, use DescribeCompilationJob.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: A filter that returns the model compilation jobs that were created
after a specified time.
- `"CreationTimeBefore"`: A filter that returns the model compilation jobs that were
created before a specified time.
- `"LastModifiedTimeAfter"`: A filter that returns the model compilation jobs that were
modified after a specified time.
- `"LastModifiedTimeBefore"`: A filter that returns the model compilation jobs that were
modified before a specified time.
- `"MaxResults"`: The maximum number of model compilation jobs to return in the response.
- `"NameContains"`: A filter that returns the model compilation jobs whose name contains a
specified string.
- `"NextToken"`: If the result of the previous ListCompilationJobs request was truncated,
the response includes a NextToken. To retrieve the next set of model compilation jobs, use
the token in the next request.
- `"SortBy"`: The field by which to sort results. The default is CreationTime.
- `"SortOrder"`: The sort order for results. The default is Ascending.
- `"StatusEquals"`: A filter that retrieves model compilation jobs with a specific
CompilationJobStatus status.
"""
function list_compilation_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListCompilationJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_compilation_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListCompilationJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_contexts()
list_contexts(params::Dict{String,<:Any})
Lists the contexts in your account and their properties.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ContextType"`: A filter that returns only contexts of the specified type.
- `"CreatedAfter"`: A filter that returns only contexts created on or after the specified
time.
- `"CreatedBefore"`: A filter that returns only contexts created on or before the specified
time.
- `"MaxResults"`: The maximum number of contexts to return in the response. The default
value is 10.
- `"NextToken"`: If the previous call to ListContexts didn't return the full set of
contexts, the call returns a token for getting the next set of contexts.
- `"SortBy"`: The property used to sort results. The default value is CreationTime.
- `"SortOrder"`: The sort order. The default value is Descending.
- `"SourceUri"`: A filter that returns only contexts with the specified source URI.
"""
function list_contexts(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker("ListContexts"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_contexts(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListContexts", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_data_quality_job_definitions()
list_data_quality_job_definitions(params::Dict{String,<:Any})
Lists the data quality job definitions in your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: A filter that returns only data quality monitoring job definitions
created after the specified time.
- `"CreationTimeBefore"`: A filter that returns only data quality monitoring job
definitions created before the specified time.
- `"EndpointName"`: A filter that lists the data quality job definitions associated with
the specified endpoint.
- `"MaxResults"`: The maximum number of data quality monitoring job definitions to return
in the response.
- `"NameContains"`: A string in the data quality monitoring job definition name. This
filter returns only data quality monitoring job definitions whose name contains the
specified string.
- `"NextToken"`: If the result of the previous ListDataQualityJobDefinitions request was
truncated, the response includes a NextToken. To retrieve the next set of transform jobs,
use the token in the next request.>
- `"SortBy"`: The field to sort results by. The default is CreationTime.
- `"SortOrder"`: Whether to sort the results in Ascending or Descending order. The default
is Descending.
"""
function list_data_quality_job_definitions(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListDataQualityJobDefinitions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_data_quality_job_definitions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListDataQualityJobDefinitions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_device_fleets()
list_device_fleets(params::Dict{String,<:Any})
Returns a list of devices in the fleet.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: Filter fleets where packaging job was created after specified time.
- `"CreationTimeBefore"`: Filter fleets where the edge packaging job was created before
specified time.
- `"LastModifiedTimeAfter"`: Select fleets where the job was updated after X
- `"LastModifiedTimeBefore"`: Select fleets where the job was updated before X
- `"MaxResults"`: The maximum number of results to select.
- `"NameContains"`: Filter for fleets containing this name in their fleet device name.
- `"NextToken"`: The response from the last list when returning a list large enough to need
tokening.
- `"SortBy"`: The column to sort by.
- `"SortOrder"`: What direction to sort in.
"""
function list_device_fleets(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListDeviceFleets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_device_fleets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListDeviceFleets", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_devices()
list_devices(params::Dict{String,<:Any})
A list of devices.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeviceFleetName"`: Filter for fleets containing this name in their device fleet name.
- `"LatestHeartbeatAfter"`: Select fleets where the job was updated after X
- `"MaxResults"`: Maximum number of results to select.
- `"ModelName"`: A filter that searches devices that contains this name in any of their
models.
- `"NextToken"`: The response from the last list when returning a list large enough to need
tokening.
"""
function list_devices(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker("ListDevices"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_devices(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListDevices", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_domains()
list_domains(params::Dict{String,<:Any})
Lists the domains.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: This parameter defines the maximum number of results that can be return
in a single response. The MaxResults parameter is an upper bound, not a target. If there
are more results available than the value specified, a NextToken is provided in the
response. The NextToken indicates that the user should get the next set of results by
providing this token as a part of a subsequent call. The default value for MaxResults is 10.
- `"NextToken"`: If the previous response was truncated, you will receive this token. Use
it in your next request to receive the next set of results.
"""
function list_domains(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker("ListDomains"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_domains(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListDomains", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_edge_deployment_plans()
list_edge_deployment_plans(params::Dict{String,<:Any})
Lists all edge deployment plans.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: Selects edge deployment plans created after this time.
- `"CreationTimeBefore"`: Selects edge deployment plans created before this time.
- `"DeviceFleetNameContains"`: Selects edge deployment plans with a device fleet name
containing this name.
- `"LastModifiedTimeAfter"`: Selects edge deployment plans that were last updated after
this time.
- `"LastModifiedTimeBefore"`: Selects edge deployment plans that were last updated before
this time.
- `"MaxResults"`: The maximum number of results to select (50 by default).
- `"NameContains"`: Selects edge deployment plans with names containing this name.
- `"NextToken"`: The response from the last list when returning a list large enough to need
tokening.
- `"SortBy"`: The column by which to sort the edge deployment plans. Can be one of NAME,
DEVICEFLEETNAME, CREATIONTIME, LASTMODIFIEDTIME.
- `"SortOrder"`: The direction of the sorting (ascending or descending).
"""
function list_edge_deployment_plans(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListEdgeDeploymentPlans"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_edge_deployment_plans(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListEdgeDeploymentPlans",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_edge_packaging_jobs()
list_edge_packaging_jobs(params::Dict{String,<:Any})
Returns a list of edge packaging jobs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: Select jobs where the job was created after specified time.
- `"CreationTimeBefore"`: Select jobs where the job was created before specified time.
- `"LastModifiedTimeAfter"`: Select jobs where the job was updated after specified time.
- `"LastModifiedTimeBefore"`: Select jobs where the job was updated before specified time.
- `"MaxResults"`: Maximum number of results to select.
- `"ModelNameContains"`: Filter for jobs where the model name contains this string.
- `"NameContains"`: Filter for jobs containing this name in their packaging job name.
- `"NextToken"`: The response from the last list when returning a list large enough to need
tokening.
- `"SortBy"`: Use to specify what column to sort by.
- `"SortOrder"`: What direction to sort by.
- `"StatusEquals"`: The job status to filter for.
"""
function list_edge_packaging_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListEdgePackagingJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_edge_packaging_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListEdgePackagingJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_endpoint_configs()
list_endpoint_configs(params::Dict{String,<:Any})
Lists endpoint configurations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: A filter that returns only endpoint configurations with a creation
time greater than or equal to the specified time (timestamp).
- `"CreationTimeBefore"`: A filter that returns only endpoint configurations created before
the specified time (timestamp).
- `"MaxResults"`: The maximum number of training jobs to return in the response.
- `"NameContains"`: A string in the endpoint configuration name. This filter returns only
endpoint configurations whose name contains the specified string.
- `"NextToken"`: If the result of the previous ListEndpointConfig request was truncated,
the response includes a NextToken. To retrieve the next set of endpoint configurations, use
the token in the next request.
- `"SortBy"`: The field to sort results by. The default is CreationTime.
- `"SortOrder"`: The sort order for results. The default is Descending.
"""
function list_endpoint_configs(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListEndpointConfigs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_endpoint_configs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListEndpointConfigs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_endpoints()
list_endpoints(params::Dict{String,<:Any})
Lists endpoints.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: A filter that returns only endpoints with a creation time greater
than or equal to the specified time (timestamp).
- `"CreationTimeBefore"`: A filter that returns only endpoints that were created before the
specified time (timestamp).
- `"LastModifiedTimeAfter"`: A filter that returns only endpoints that were modified after
the specified timestamp.
- `"LastModifiedTimeBefore"`: A filter that returns only endpoints that were modified
before the specified timestamp.
- `"MaxResults"`: The maximum number of endpoints to return in the response. This value
defaults to 10.
- `"NameContains"`: A string in endpoint names. This filter returns only endpoints whose
name contains the specified string.
- `"NextToken"`: If the result of a ListEndpoints request was truncated, the response
includes a NextToken. To retrieve the next set of endpoints, use the token in the next
request.
- `"SortBy"`: Sorts the list of results. The default is CreationTime.
- `"SortOrder"`: The sort order for results. The default is Descending.
- `"StatusEquals"`: A filter that returns only endpoints with the specified status.
"""
function list_endpoints(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListEndpoints"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_endpoints(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListEndpoints", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_experiments()
list_experiments(params::Dict{String,<:Any})
Lists all the experiments in your account. The list can be filtered to show only
experiments that were created in a specific time range. The list can be sorted by
experiment name or creation time.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreatedAfter"`: A filter that returns only experiments created after the specified time.
- `"CreatedBefore"`: A filter that returns only experiments created before the specified
time.
- `"MaxResults"`: The maximum number of experiments to return in the response. The default
value is 10.
- `"NextToken"`: If the previous call to ListExperiments didn't return the full set of
experiments, the call returns a token for getting the next set of experiments.
- `"SortBy"`: The property used to sort results. The default value is CreationTime.
- `"SortOrder"`: The sort order. The default value is Descending.
"""
function list_experiments(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListExperiments"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_experiments(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListExperiments", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_feature_groups()
list_feature_groups(params::Dict{String,<:Any})
List FeatureGroups based on given filter and order.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: Use this parameter to search for FeatureGroupss created after a
specific date and time.
- `"CreationTimeBefore"`: Use this parameter to search for FeatureGroupss created before a
specific date and time.
- `"FeatureGroupStatusEquals"`: A FeatureGroup status. Filters by FeatureGroup status.
- `"MaxResults"`: The maximum number of results returned by ListFeatureGroups.
- `"NameContains"`: A string that partially matches one or more FeatureGroups names.
Filters FeatureGroups by name.
- `"NextToken"`: A token to resume pagination of ListFeatureGroups results.
- `"OfflineStoreStatusEquals"`: An OfflineStore status. Filters by OfflineStore status.
- `"SortBy"`: The value on which the feature group list is sorted.
- `"SortOrder"`: The order in which feature groups are listed.
"""
function list_feature_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListFeatureGroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_feature_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListFeatureGroups", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_flow_definitions()
list_flow_definitions(params::Dict{String,<:Any})
Returns information about the flow definitions in your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: A filter that returns only flow definitions with a creation time
greater than or equal to the specified timestamp.
- `"CreationTimeBefore"`: A filter that returns only flow definitions that were created
before the specified timestamp.
- `"MaxResults"`: The total number of items to return. If the total number of available
items is more than the value specified in MaxResults, then a NextToken will be provided in
the output that you can use to resume pagination.
- `"NextToken"`: A token to resume pagination.
- `"SortOrder"`: An optional value that specifies whether you want the results sorted in
Ascending or Descending order.
"""
function list_flow_definitions(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListFlowDefinitions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_flow_definitions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListFlowDefinitions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_hub_content_versions(hub_content_name, hub_content_type, hub_name)
list_hub_content_versions(hub_content_name, hub_content_type, hub_name, params::Dict{String,<:Any})
List hub content versions.
# Arguments
- `hub_content_name`: The name of the hub content.
- `hub_content_type`: The type of hub content to list versions of.
- `hub_name`: The name of the hub to list the content versions of.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: Only list hub content versions that were created after the time
specified.
- `"CreationTimeBefore"`: Only list hub content versions that were created before the time
specified.
- `"MaxResults"`: The maximum number of hub content versions to list.
- `"MaxSchemaVersion"`: The upper bound of the hub content schema version.
- `"MinVersion"`: The lower bound of the hub content versions to list.
- `"NextToken"`: If the response to a previous ListHubContentVersions request was
truncated, the response includes a NextToken. To retrieve the next set of hub content
versions, use the token in the next request.
- `"SortBy"`: Sort hub content versions by either name or creation time.
- `"SortOrder"`: Sort hub content versions by ascending or descending order.
"""
function list_hub_content_versions(
HubContentName,
HubContentType,
HubName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"ListHubContentVersions",
Dict{String,Any}(
"HubContentName" => HubContentName,
"HubContentType" => HubContentType,
"HubName" => HubName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_hub_content_versions(
HubContentName,
HubContentType,
HubName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"ListHubContentVersions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"HubContentName" => HubContentName,
"HubContentType" => HubContentType,
"HubName" => HubName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_hub_contents(hub_content_type, hub_name)
list_hub_contents(hub_content_type, hub_name, params::Dict{String,<:Any})
List the contents of a hub.
# Arguments
- `hub_content_type`: The type of hub content to list.
- `hub_name`: The name of the hub to list the contents of.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: Only list hub content that was created after the time specified.
- `"CreationTimeBefore"`: Only list hub content that was created before the time specified.
- `"MaxResults"`: The maximum amount of hub content to list.
- `"MaxSchemaVersion"`: The upper bound of the hub content schema verion.
- `"NameContains"`: Only list hub content if the name contains the specified string.
- `"NextToken"`: If the response to a previous ListHubContents request was truncated, the
response includes a NextToken. To retrieve the next set of hub content, use the token in
the next request.
- `"SortBy"`: Sort hub content versions by either name or creation time.
- `"SortOrder"`: Sort hubs by ascending or descending order.
"""
function list_hub_contents(
HubContentType, HubName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListHubContents",
Dict{String,Any}("HubContentType" => HubContentType, "HubName" => HubName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_hub_contents(
HubContentType,
HubName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"ListHubContents",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("HubContentType" => HubContentType, "HubName" => HubName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_hubs()
list_hubs(params::Dict{String,<:Any})
List all existing hubs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: Only list hubs that were created after the time specified.
- `"CreationTimeBefore"`: Only list hubs that were created before the time specified.
- `"LastModifiedTimeAfter"`: Only list hubs that were last modified after the time
specified.
- `"LastModifiedTimeBefore"`: Only list hubs that were last modified before the time
specified.
- `"MaxResults"`: The maximum number of hubs to list.
- `"NameContains"`: Only list hubs with names that contain the specified string.
- `"NextToken"`: If the response to a previous ListHubs request was truncated, the response
includes a NextToken. To retrieve the next set of hubs, use the token in the next request.
- `"SortBy"`: Sort hubs by either name or creation time.
- `"SortOrder"`: Sort hubs by ascending or descending order.
"""
function list_hubs(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker("ListHubs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_hubs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListHubs", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_human_task_uis()
list_human_task_uis(params::Dict{String,<:Any})
Returns information about the human task user interfaces in your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: A filter that returns only human task user interfaces with a
creation time greater than or equal to the specified timestamp.
- `"CreationTimeBefore"`: A filter that returns only human task user interfaces that were
created before the specified timestamp.
- `"MaxResults"`: The total number of items to return. If the total number of available
items is more than the value specified in MaxResults, then a NextToken will be provided in
the output that you can use to resume pagination.
- `"NextToken"`: A token to resume pagination.
- `"SortOrder"`: An optional value that specifies whether you want the results sorted in
Ascending or Descending order.
"""
function list_human_task_uis(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListHumanTaskUis"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_human_task_uis(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListHumanTaskUis", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_hyper_parameter_tuning_jobs()
list_hyper_parameter_tuning_jobs(params::Dict{String,<:Any})
Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter
tuning jobs launched in your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: A filter that returns only tuning jobs that were created after the
specified time.
- `"CreationTimeBefore"`: A filter that returns only tuning jobs that were created before
the specified time.
- `"LastModifiedTimeAfter"`: A filter that returns only tuning jobs that were modified
after the specified time.
- `"LastModifiedTimeBefore"`: A filter that returns only tuning jobs that were modified
before the specified time.
- `"MaxResults"`: The maximum number of tuning jobs to return. The default value is 10.
- `"NameContains"`: A string in the tuning job name. This filter returns only tuning jobs
whose name contains the specified string.
- `"NextToken"`: If the result of the previous ListHyperParameterTuningJobs request was
truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use
the token in the next request.
- `"SortBy"`: The field to sort results by. The default is Name.
- `"SortOrder"`: The sort order for results. The default is Ascending.
- `"StatusEquals"`: A filter that returns only tuning jobs with the specified status.
"""
function list_hyper_parameter_tuning_jobs(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListHyperParameterTuningJobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_hyper_parameter_tuning_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListHyperParameterTuningJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_image_versions(image_name)
list_image_versions(image_name, params::Dict{String,<:Any})
Lists the versions of a specified image and their properties. The list can be filtered by
creation time or modified time.
# Arguments
- `image_name`: The name of the image to list the versions of.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: A filter that returns only versions created on or after the
specified time.
- `"CreationTimeBefore"`: A filter that returns only versions created on or before the
specified time.
- `"LastModifiedTimeAfter"`: A filter that returns only versions modified on or after the
specified time.
- `"LastModifiedTimeBefore"`: A filter that returns only versions modified on or before the
specified time.
- `"MaxResults"`: The maximum number of versions to return in the response. The default
value is 10.
- `"NextToken"`: If the previous call to ListImageVersions didn't return the full set of
versions, the call returns a token for getting the next set of versions.
- `"SortBy"`: The property used to sort results. The default value is CREATION_TIME.
- `"SortOrder"`: The sort order. The default value is DESCENDING.
"""
function list_image_versions(ImageName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListImageVersions",
Dict{String,Any}("ImageName" => ImageName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_image_versions(
ImageName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"ListImageVersions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ImageName" => ImageName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_images()
list_images(params::Dict{String,<:Any})
Lists the images in your account and their properties. The list can be filtered by creation
time or modified time, and whether the image name contains a specified string.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: A filter that returns only images created on or after the
specified time.
- `"CreationTimeBefore"`: A filter that returns only images created on or before the
specified time.
- `"LastModifiedTimeAfter"`: A filter that returns only images modified on or after the
specified time.
- `"LastModifiedTimeBefore"`: A filter that returns only images modified on or before the
specified time.
- `"MaxResults"`: The maximum number of images to return in the response. The default value
is 10.
- `"NameContains"`: A filter that returns only images whose name contains the specified
string.
- `"NextToken"`: If the previous call to ListImages didn't return the full set of images,
the call returns a token for getting the next set of images.
- `"SortBy"`: The property used to sort results. The default value is CREATION_TIME.
- `"SortOrder"`: The sort order. The default value is DESCENDING.
"""
function list_images(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker("ListImages"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_images(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListImages", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_inference_components()
list_inference_components(params::Dict{String,<:Any})
Lists the inference components in your account and their properties.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: Filters the results to only those inference components that were
created after the specified time.
- `"CreationTimeBefore"`: Filters the results to only those inference components that were
created before the specified time.
- `"EndpointNameEquals"`: An endpoint name to filter the listed inference components. The
response includes only those inference components that are hosted at the specified endpoint.
- `"LastModifiedTimeAfter"`: Filters the results to only those inference components that
were updated after the specified time.
- `"LastModifiedTimeBefore"`: Filters the results to only those inference components that
were updated before the specified time.
- `"MaxResults"`: The maximum number of inference components to return in the response.
This value defaults to 10.
- `"NameContains"`: Filters the results to only those inference components with a name that
contains the specified string.
- `"NextToken"`: A token that you use to get the next set of results following a truncated
response. If the response to the previous request was truncated, that response provides the
value for this token.
- `"SortBy"`: The field by which to sort the inference components in the response. The
default is CreationTime.
- `"SortOrder"`: The sort order for results. The default is Descending.
- `"StatusEquals"`: Filters the results to only those inference components with the
specified status.
- `"VariantNameEquals"`: A production variant name to filter the listed inference
components. The response includes only those inference components that are hosted at the
specified variant.
"""
function list_inference_components(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListInferenceComponents"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_inference_components(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListInferenceComponents",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_inference_experiments()
list_inference_experiments(params::Dict{String,<:Any})
Returns the list of all inference experiments.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: Selects inference experiments which were created after this
timestamp.
- `"CreationTimeBefore"`: Selects inference experiments which were created before this
timestamp.
- `"LastModifiedTimeAfter"`: Selects inference experiments which were last modified after
this timestamp.
- `"LastModifiedTimeBefore"`: Selects inference experiments which were last modified before
this timestamp.
- `"MaxResults"`: The maximum number of results to select.
- `"NameContains"`: Selects inference experiments whose names contain this name.
- `"NextToken"`: The response from the last list when returning a list large enough to
need tokening.
- `"SortBy"`: The column by which to sort the listed inference experiments.
- `"SortOrder"`: The direction of sorting (ascending or descending).
- `"StatusEquals"`: Selects inference experiments which are in this status. For the
possible statuses, see DescribeInferenceExperiment.
- `"Type"`: Selects inference experiments of this type. For the possible types of
inference experiments, see CreateInferenceExperiment.
"""
function list_inference_experiments(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListInferenceExperiments"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_inference_experiments(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListInferenceExperiments",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_inference_recommendations_job_steps(job_name)
list_inference_recommendations_job_steps(job_name, params::Dict{String,<:Any})
Returns a list of the subtasks for an Inference Recommender job. The supported subtasks are
benchmarks, which evaluate the performance of your model on different instance types.
# Arguments
- `job_name`: The name for the Inference Recommender 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.
- `"NextToken"`: A token that you can specify to return more results from the list. Specify
this field if you have a token that was returned from a previous request.
- `"Status"`: A filter to return benchmarks of a specified status. If this field is left
empty, then all benchmarks are returned.
- `"StepType"`: A filter to return details about the specified type of subtask. BENCHMARK:
Evaluate the performance of your model on different instance types.
"""
function list_inference_recommendations_job_steps(
JobName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListInferenceRecommendationsJobSteps",
Dict{String,Any}("JobName" => JobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_inference_recommendations_job_steps(
JobName, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListInferenceRecommendationsJobSteps",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobName" => JobName), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_inference_recommendations_jobs()
list_inference_recommendations_jobs(params::Dict{String,<:Any})
Lists recommendation jobs that satisfy various filters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: A filter that returns only jobs created after the specified time
(timestamp).
- `"CreationTimeBefore"`: A filter that returns only jobs created before the specified time
(timestamp).
- `"LastModifiedTimeAfter"`: A filter that returns only jobs that were last modified after
the specified time (timestamp).
- `"LastModifiedTimeBefore"`: A filter that returns only jobs that were last modified
before the specified time (timestamp).
- `"MaxResults"`: The maximum number of recommendations to return in the response.
- `"ModelNameEquals"`: A filter that returns only jobs that were created for this model.
- `"ModelPackageVersionArnEquals"`: A filter that returns only jobs that were created for
this versioned model package.
- `"NameContains"`: A string in the job name. This filter returns only recommendations
whose name contains the specified string.
- `"NextToken"`: If the response to a previous ListInferenceRecommendationsJobsRequest
request was truncated, the response includes a NextToken. To retrieve the next set of
recommendations, use the token in the next request.
- `"SortBy"`: The parameter by which to sort the results.
- `"SortOrder"`: The sort order for the results.
- `"StatusEquals"`: A filter that retrieves only inference recommendations jobs with a
specific status.
"""
function list_inference_recommendations_jobs(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListInferenceRecommendationsJobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_inference_recommendations_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListInferenceRecommendationsJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_labeling_jobs()
list_labeling_jobs(params::Dict{String,<:Any})
Gets a list of labeling jobs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: A filter that returns only labeling jobs created after the
specified time (timestamp).
- `"CreationTimeBefore"`: A filter that returns only labeling jobs created before the
specified time (timestamp).
- `"LastModifiedTimeAfter"`: A filter that returns only labeling jobs modified after the
specified time (timestamp).
- `"LastModifiedTimeBefore"`: A filter that returns only labeling jobs modified before the
specified time (timestamp).
- `"MaxResults"`: The maximum number of labeling jobs to return in each page of the
response.
- `"NameContains"`: A string in the labeling job name. This filter returns only labeling
jobs whose name contains the specified string.
- `"NextToken"`: If the result of the previous ListLabelingJobs request was truncated, the
response includes a NextToken. To retrieve the next set of labeling jobs, use the token in
the next request.
- `"SortBy"`: The field to sort results by. The default is CreationTime.
- `"SortOrder"`: The sort order for results. The default is Ascending.
- `"StatusEquals"`: A filter that retrieves only labeling jobs with a specific status.
"""
function list_labeling_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListLabelingJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_labeling_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListLabelingJobs", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_labeling_jobs_for_workteam(workteam_arn)
list_labeling_jobs_for_workteam(workteam_arn, params::Dict{String,<:Any})
Gets a list of labeling jobs assigned to a specified work team.
# Arguments
- `workteam_arn`: The Amazon Resource Name (ARN) of the work team for which you want to see
labeling jobs for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: A filter that returns only labeling jobs created after the
specified time (timestamp).
- `"CreationTimeBefore"`: A filter that returns only labeling jobs created before the
specified time (timestamp).
- `"JobReferenceCodeContains"`: A filter the limits jobs to only the ones whose job
reference code contains the specified string.
- `"MaxResults"`: The maximum number of labeling jobs to return in each page of the
response.
- `"NextToken"`: If the result of the previous ListLabelingJobsForWorkteam request was
truncated, the response includes a NextToken. To retrieve the next set of labeling jobs,
use the token in the next request.
- `"SortBy"`: The field to sort results by. The default is CreationTime.
- `"SortOrder"`: The sort order for results. The default is Ascending.
"""
function list_labeling_jobs_for_workteam(
WorkteamArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListLabelingJobsForWorkteam",
Dict{String,Any}("WorkteamArn" => WorkteamArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_labeling_jobs_for_workteam(
WorkteamArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"ListLabelingJobsForWorkteam",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("WorkteamArn" => WorkteamArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_lineage_groups()
list_lineage_groups(params::Dict{String,<:Any})
A list of lineage groups shared with your Amazon Web Services account. For more
information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreatedAfter"`: A timestamp to filter against lineage groups created after a certain
point in time.
- `"CreatedBefore"`: A timestamp to filter against lineage groups created before a certain
point in time.
- `"MaxResults"`: The maximum number of endpoints to return in the response. This value
defaults to 10.
- `"NextToken"`: If the response is truncated, SageMaker returns this token. To retrieve
the next set of algorithms, use it in the subsequent request.
- `"SortBy"`: The parameter by which to sort the results. The default is CreationTime.
- `"SortOrder"`: The sort order for the results. The default is Ascending.
"""
function list_lineage_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListLineageGroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_lineage_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListLineageGroups", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_mlflow_tracking_servers()
list_mlflow_tracking_servers(params::Dict{String,<:Any})
Lists all MLflow Tracking Servers.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreatedAfter"`: Use the CreatedAfter filter to only list tracking servers created after
a specific date and time. Listed tracking servers are shown with a date and time such as
\"2024-03-16T01:46:56+00:00\". The CreatedAfter parameter takes in a Unix timestamp. To
convert a date and time into a Unix timestamp, see EpochConverter.
- `"CreatedBefore"`: Use the CreatedBefore filter to only list tracking servers created
before a specific date and time. Listed tracking servers are shown with a date and time
such as \"2024-03-16T01:46:56+00:00\". The CreatedBefore parameter takes in a Unix
timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.
- `"MaxResults"`: The maximum number of tracking servers to list.
- `"MlflowVersion"`: Filter for tracking servers using the specified MLflow version.
- `"NextToken"`: If the previous response was truncated, you will receive this token. Use
it in your next request to receive the next set of results.
- `"SortBy"`: Filter for trackings servers sorting by name, creation time, or creation
status.
- `"SortOrder"`: Change the order of the listed tracking servers. By default, tracking
servers are listed in Descending order by creation time. To change the list order, you can
specify SortOrder to be Ascending.
- `"TrackingServerStatus"`: Filter for tracking servers with a specified creation status.
"""
function list_mlflow_tracking_servers(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListMlflowTrackingServers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_mlflow_tracking_servers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListMlflowTrackingServers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_model_bias_job_definitions()
list_model_bias_job_definitions(params::Dict{String,<:Any})
Lists model bias jobs definitions that satisfy various filters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: A filter that returns only model bias jobs created after a
specified time.
- `"CreationTimeBefore"`: A filter that returns only model bias jobs created before a
specified time.
- `"EndpointName"`: Name of the endpoint to monitor for model bias.
- `"MaxResults"`: The maximum number of model bias jobs to return in the response. The
default value is 10.
- `"NameContains"`: Filter for model bias jobs whose name contains a specified string.
- `"NextToken"`: The token returned if the response is truncated. To retrieve the next set
of job executions, use it in the next request.
- `"SortBy"`: Whether to sort results by the Name or CreationTime field. The default is
CreationTime.
- `"SortOrder"`: Whether to sort the results in Ascending or Descending order. The default
is Descending.
"""
function list_model_bias_job_definitions(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListModelBiasJobDefinitions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_model_bias_job_definitions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListModelBiasJobDefinitions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_model_card_export_jobs(model_card_name)
list_model_card_export_jobs(model_card_name, params::Dict{String,<:Any})
List the export jobs for the Amazon SageMaker Model Card.
# Arguments
- `model_card_name`: List export jobs for the model card with the specified name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: Only list model card export jobs that were created after the time
specified.
- `"CreationTimeBefore"`: Only list model card export jobs that were created before the
time specified.
- `"MaxResults"`: The maximum number of model card export jobs to list.
- `"ModelCardExportJobNameContains"`: Only list model card export jobs with names that
contain the specified string.
- `"ModelCardVersion"`: List export jobs for the model card with the specified version.
- `"NextToken"`: If the response to a previous ListModelCardExportJobs request was
truncated, the response includes a NextToken. To retrieve the next set of model card export
jobs, use the token in the next request.
- `"SortBy"`: Sort model card export jobs by either name or creation time. Sorts by
creation time by default.
- `"SortOrder"`: Sort model card export jobs by ascending or descending order.
- `"StatusEquals"`: Only list model card export jobs with the specified status.
"""
function list_model_card_export_jobs(
ModelCardName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListModelCardExportJobs",
Dict{String,Any}("ModelCardName" => ModelCardName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_model_card_export_jobs(
ModelCardName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"ListModelCardExportJobs",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ModelCardName" => ModelCardName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_model_card_versions(model_card_name)
list_model_card_versions(model_card_name, params::Dict{String,<:Any})
List existing versions of an Amazon SageMaker Model Card.
# Arguments
- `model_card_name`: List model card versions for the model card with the specified name or
Amazon Resource Name (ARN).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: Only list model card versions that were created after the time
specified.
- `"CreationTimeBefore"`: Only list model card versions that were created before the time
specified.
- `"MaxResults"`: The maximum number of model card versions to list.
- `"ModelCardStatus"`: Only list model card versions with the specified approval status.
- `"NextToken"`: If the response to a previous ListModelCardVersions request was truncated,
the response includes a NextToken. To retrieve the next set of model card versions, use the
token in the next request.
- `"SortBy"`: Sort listed model card versions by version. Sorts by version by default.
- `"SortOrder"`: Sort model card versions by ascending or descending order.
"""
function list_model_card_versions(
ModelCardName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListModelCardVersions",
Dict{String,Any}("ModelCardName" => ModelCardName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_model_card_versions(
ModelCardName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"ListModelCardVersions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ModelCardName" => ModelCardName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_model_cards()
list_model_cards(params::Dict{String,<:Any})
List existing model cards.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: Only list model cards that were created after the time specified.
- `"CreationTimeBefore"`: Only list model cards that were created before the time specified.
- `"MaxResults"`: The maximum number of model cards to list.
- `"ModelCardStatus"`: Only list model cards with the specified approval status.
- `"NameContains"`: Only list model cards with names that contain the specified string.
- `"NextToken"`: If the response to a previous ListModelCards request was truncated, the
response includes a NextToken. To retrieve the next set of model cards, use the token in
the next request.
- `"SortBy"`: Sort model cards by either name or creation time. Sorts by creation time by
default.
- `"SortOrder"`: Sort model cards by ascending or descending order.
"""
function list_model_cards(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListModelCards"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_model_cards(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListModelCards", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_model_explainability_job_definitions()
list_model_explainability_job_definitions(params::Dict{String,<:Any})
Lists model explainability job definitions that satisfy various filters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: A filter that returns only model explainability jobs created after
a specified time.
- `"CreationTimeBefore"`: A filter that returns only model explainability jobs created
before a specified time.
- `"EndpointName"`: Name of the endpoint to monitor for model explainability.
- `"MaxResults"`: The maximum number of jobs to return in the response. The default value
is 10.
- `"NameContains"`: Filter for model explainability jobs whose name contains a specified
string.
- `"NextToken"`: The token returned if the response is truncated. To retrieve the next set
of job executions, use it in the next request.
- `"SortBy"`: Whether to sort results by the Name or CreationTime field. The default is
CreationTime.
- `"SortOrder"`: Whether to sort the results in Ascending or Descending order. The default
is Descending.
"""
function list_model_explainability_job_definitions(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListModelExplainabilityJobDefinitions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_model_explainability_job_definitions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListModelExplainabilityJobDefinitions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_model_metadata()
list_model_metadata(params::Dict{String,<:Any})
Lists the domain, framework, task, and model name of standard machine learning models found
in common model zoos.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of models to return in the response.
- `"NextToken"`: If the response to a previous ListModelMetadataResponse request was
truncated, the response includes a NextToken. To retrieve the next set of model metadata,
use the token in the next request.
- `"SearchExpression"`: One or more filters that searches for the specified resource or
resources in a search. All resource objects that satisfy the expression's condition are
included in the search results. Specify the Framework, FrameworkVersion, Domain or Task to
filter supported. Filter names and values are case-sensitive.
"""
function list_model_metadata(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListModelMetadata"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_model_metadata(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListModelMetadata", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_model_package_groups()
list_model_package_groups(params::Dict{String,<:Any})
Gets a list of the model groups in your Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: A filter that returns only model groups created after the
specified time.
- `"CreationTimeBefore"`: A filter that returns only model groups created before the
specified time.
- `"CrossAccountFilterOption"`: A filter that returns either model groups shared with you
or model groups in your own account. When the value is CrossAccount, the results show the
resources made discoverable to you from other accounts. When the value is SameAccount or
null, the results show resources from your account. The default is SameAccount.
- `"MaxResults"`: The maximum number of results to return in the response.
- `"NameContains"`: A string in the model group name. This filter returns only model groups
whose name contains the specified string.
- `"NextToken"`: If the result of the previous ListModelPackageGroups request was
truncated, the response includes a NextToken. To retrieve the next set of model groups, use
the token in the next request.
- `"SortBy"`: The field to sort results by. The default is CreationTime.
- `"SortOrder"`: The sort order for results. The default is Ascending.
"""
function list_model_package_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListModelPackageGroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_model_package_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListModelPackageGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_model_packages()
list_model_packages(params::Dict{String,<:Any})
Lists the model packages that have been created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: A filter that returns only model packages created after the
specified time (timestamp).
- `"CreationTimeBefore"`: A filter that returns only model packages created before the
specified time (timestamp).
- `"MaxResults"`: The maximum number of model packages to return in the response.
- `"ModelApprovalStatus"`: A filter that returns only the model packages with the specified
approval status.
- `"ModelPackageGroupName"`: A filter that returns only model versions that belong to the
specified model group.
- `"ModelPackageType"`: A filter that returns only the model packages of the specified
type. This can be one of the following values. UNVERSIONED - List only unversioined
models. This is the default value if no ModelPackageType is specified. VERSIONED - List
only versioned models. BOTH - List both versioned and unversioned models.
- `"NameContains"`: A string in the model package name. This filter returns only model
packages whose name contains the specified string.
- `"NextToken"`: If the response to a previous ListModelPackages request was truncated, the
response includes a NextToken. To retrieve the next set of model packages, use the token in
the next request.
- `"SortBy"`: The parameter by which to sort the results. The default is CreationTime.
- `"SortOrder"`: The sort order for the results. The default is Ascending.
"""
function list_model_packages(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListModelPackages"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_model_packages(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListModelPackages", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_model_quality_job_definitions()
list_model_quality_job_definitions(params::Dict{String,<:Any})
Gets a list of model quality monitoring job definitions in your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: A filter that returns only model quality monitoring job
definitions created after the specified time.
- `"CreationTimeBefore"`: A filter that returns only model quality monitoring job
definitions created before the specified time.
- `"EndpointName"`: A filter that returns only model quality monitoring job definitions
that are associated with the specified endpoint.
- `"MaxResults"`: The maximum number of results to return in a call to
ListModelQualityJobDefinitions.
- `"NameContains"`: A string in the transform job name. This filter returns only model
quality monitoring job definitions whose name contains the specified string.
- `"NextToken"`: If the result of the previous ListModelQualityJobDefinitions request was
truncated, the response includes a NextToken. To retrieve the next set of model quality
monitoring job definitions, use the token in the next request.
- `"SortBy"`: The field to sort results by. The default is CreationTime.
- `"SortOrder"`: Whether to sort the results in Ascending or Descending order. The default
is Descending.
"""
function list_model_quality_job_definitions(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListModelQualityJobDefinitions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_model_quality_job_definitions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListModelQualityJobDefinitions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_models()
list_models(params::Dict{String,<:Any})
Lists models created with the CreateModel API.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: A filter that returns only models with a creation time greater
than or equal to the specified time (timestamp).
- `"CreationTimeBefore"`: A filter that returns only models created before the specified
time (timestamp).
- `"MaxResults"`: The maximum number of models to return in the response.
- `"NameContains"`: A string in the model name. This filter returns only models whose name
contains the specified string.
- `"NextToken"`: If the response to a previous ListModels request was truncated, the
response includes a NextToken. To retrieve the next set of models, use the token in the
next request.
- `"SortBy"`: Sorts the list of results. The default is CreationTime.
- `"SortOrder"`: The sort order for results. The default is Descending.
"""
function list_models(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker("ListModels"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_models(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListModels", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_monitoring_alert_history()
list_monitoring_alert_history(params::Dict{String,<:Any})
Gets a list of past alerts in a model monitoring schedule.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: A filter that returns only alerts created on or after the
specified time.
- `"CreationTimeBefore"`: A filter that returns only alerts created on or before the
specified time.
- `"MaxResults"`: The maximum number of results to display. The default is 100.
- `"MonitoringAlertName"`: The name of a monitoring alert.
- `"MonitoringScheduleName"`: The name of a monitoring schedule.
- `"NextToken"`: If the result of the previous ListMonitoringAlertHistory request was
truncated, the response includes a NextToken. To retrieve the next set of alerts in the
history, use the token in the next request.
- `"SortBy"`: The field used to sort results. The default is CreationTime.
- `"SortOrder"`: The sort order, whether Ascending or Descending, of the alert history. The
default is Descending.
- `"StatusEquals"`: A filter that retrieves only alerts with a specific status.
"""
function list_monitoring_alert_history(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListMonitoringAlertHistory"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_monitoring_alert_history(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListMonitoringAlertHistory",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_monitoring_alerts(monitoring_schedule_name)
list_monitoring_alerts(monitoring_schedule_name, params::Dict{String,<:Any})
Gets the alerts for a single monitoring schedule.
# Arguments
- `monitoring_schedule_name`: The name of a monitoring schedule.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to display. The default is 100.
- `"NextToken"`: If the result of the previous ListMonitoringAlerts request was truncated,
the response includes a NextToken. To retrieve the next set of alerts in the history, use
the token in the next request.
"""
function list_monitoring_alerts(
MonitoringScheduleName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListMonitoringAlerts",
Dict{String,Any}("MonitoringScheduleName" => MonitoringScheduleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_monitoring_alerts(
MonitoringScheduleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"ListMonitoringAlerts",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("MonitoringScheduleName" => MonitoringScheduleName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_monitoring_executions()
list_monitoring_executions(params::Dict{String,<:Any})
Returns list of all monitoring job executions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: A filter that returns only jobs created after a specified time.
- `"CreationTimeBefore"`: A filter that returns only jobs created before a specified time.
- `"EndpointName"`: Name of a specific endpoint to fetch jobs for.
- `"LastModifiedTimeAfter"`: A filter that returns only jobs modified before a specified
time.
- `"LastModifiedTimeBefore"`: A filter that returns only jobs modified after a specified
time.
- `"MaxResults"`: The maximum number of jobs to return in the response. The default value
is 10.
- `"MonitoringJobDefinitionName"`: Gets a list of the monitoring job runs of the specified
monitoring job definitions.
- `"MonitoringScheduleName"`: Name of a specific schedule to fetch jobs for.
- `"MonitoringTypeEquals"`: A filter that returns only the monitoring job runs of the
specified monitoring type.
- `"NextToken"`: The token returned if the response is truncated. To retrieve the next set
of job executions, use it in the next request.
- `"ScheduledTimeAfter"`: Filter for jobs scheduled after a specified time.
- `"ScheduledTimeBefore"`: Filter for jobs scheduled before a specified time.
- `"SortBy"`: Whether to sort the results by the Status, CreationTime, or ScheduledTime
field. The default is CreationTime.
- `"SortOrder"`: Whether to sort the results in Ascending or Descending order. The default
is Descending.
- `"StatusEquals"`: A filter that retrieves only jobs with a specific status.
"""
function list_monitoring_executions(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListMonitoringExecutions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_monitoring_executions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListMonitoringExecutions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_monitoring_schedules()
list_monitoring_schedules(params::Dict{String,<:Any})
Returns list of all monitoring schedules.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: A filter that returns only monitoring schedules created after a
specified time.
- `"CreationTimeBefore"`: A filter that returns only monitoring schedules created before a
specified time.
- `"EndpointName"`: Name of a specific endpoint to fetch schedules for.
- `"LastModifiedTimeAfter"`: A filter that returns only monitoring schedules modified after
a specified time.
- `"LastModifiedTimeBefore"`: A filter that returns only monitoring schedules modified
before a specified time.
- `"MaxResults"`: The maximum number of jobs to return in the response. The default value
is 10.
- `"MonitoringJobDefinitionName"`: Gets a list of the monitoring schedules for the
specified monitoring job definition.
- `"MonitoringTypeEquals"`: A filter that returns only the monitoring schedules for the
specified monitoring type.
- `"NameContains"`: Filter for monitoring schedules whose name contains a specified string.
- `"NextToken"`: The token returned if the response is truncated. To retrieve the next set
of job executions, use it in the next request.
- `"SortBy"`: Whether to sort the results by the Status, CreationTime, or ScheduledTime
field. The default is CreationTime.
- `"SortOrder"`: Whether to sort the results in Ascending or Descending order. The default
is Descending.
- `"StatusEquals"`: A filter that returns only monitoring schedules modified before a
specified time.
"""
function list_monitoring_schedules(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListMonitoringSchedules"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_monitoring_schedules(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListMonitoringSchedules",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_notebook_instance_lifecycle_configs()
list_notebook_instance_lifecycle_configs(params::Dict{String,<:Any})
Lists notebook instance lifestyle configurations created with the
CreateNotebookInstanceLifecycleConfig API.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: A filter that returns only lifecycle configurations that were
created after the specified time (timestamp).
- `"CreationTimeBefore"`: A filter that returns only lifecycle configurations that were
created before the specified time (timestamp).
- `"LastModifiedTimeAfter"`: A filter that returns only lifecycle configurations that were
modified after the specified time (timestamp).
- `"LastModifiedTimeBefore"`: A filter that returns only lifecycle configurations that were
modified before the specified time (timestamp).
- `"MaxResults"`: The maximum number of lifecycle configurations to return in the response.
- `"NameContains"`: A string in the lifecycle configuration name. This filter returns only
lifecycle configurations whose name contains the specified string.
- `"NextToken"`: If the result of a ListNotebookInstanceLifecycleConfigs request was
truncated, the response includes a NextToken. To get the next set of lifecycle
configurations, use the token in the next request.
- `"SortBy"`: Sorts the list of results. The default is CreationTime.
- `"SortOrder"`: The sort order for results.
"""
function list_notebook_instance_lifecycle_configs(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListNotebookInstanceLifecycleConfigs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_notebook_instance_lifecycle_configs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListNotebookInstanceLifecycleConfigs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_notebook_instances()
list_notebook_instances(params::Dict{String,<:Any})
Returns a list of the SageMaker notebook instances in the requester's account in an Amazon
Web Services Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AdditionalCodeRepositoryEquals"`: A filter that returns only notebook instances with
associated with the specified git repository.
- `"CreationTimeAfter"`: A filter that returns only notebook instances that were created
after the specified time (timestamp).
- `"CreationTimeBefore"`: A filter that returns only notebook instances that were created
before the specified time (timestamp).
- `"DefaultCodeRepositoryContains"`: A string in the name or URL of a Git repository
associated with this notebook instance. This filter returns only notebook instances
associated with a git repository with a name that contains the specified string.
- `"LastModifiedTimeAfter"`: A filter that returns only notebook instances that were
modified after the specified time (timestamp).
- `"LastModifiedTimeBefore"`: A filter that returns only notebook instances that were
modified before the specified time (timestamp).
- `"MaxResults"`: The maximum number of notebook instances to return.
- `"NameContains"`: A string in the notebook instances' name. This filter returns only
notebook instances whose name contains the specified string.
- `"NextToken"`: If the previous call to the ListNotebookInstances is truncated, the
response includes a NextToken. You can use this token in your subsequent
ListNotebookInstances request to fetch the next set of notebook instances. You might
specify a filter or a sort order in your request. When response is truncated, you must use
the same values for the filer and sort order in the next request.
- `"NotebookInstanceLifecycleConfigNameContains"`: A string in the name of a notebook
instances lifecycle configuration associated with this notebook instance. This filter
returns only notebook instances associated with a lifecycle configuration with a name that
contains the specified string.
- `"SortBy"`: The field to sort results by. The default is Name.
- `"SortOrder"`: The sort order for results.
- `"StatusEquals"`: A filter that returns only notebook instances with the specified status.
"""
function list_notebook_instances(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListNotebookInstances"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_notebook_instances(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListNotebookInstances",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_pipeline_execution_steps()
list_pipeline_execution_steps(params::Dict{String,<:Any})
Gets a list of PipeLineExecutionStep objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of pipeline execution steps to return in the response.
- `"NextToken"`: If the result of the previous ListPipelineExecutionSteps request was
truncated, the response includes a NextToken. To retrieve the next set of pipeline
execution steps, use the token in the next request.
- `"PipelineExecutionArn"`: The Amazon Resource Name (ARN) of the pipeline execution.
- `"SortOrder"`: The field by which to sort results. The default is CreatedTime.
"""
function list_pipeline_execution_steps(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListPipelineExecutionSteps"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_pipeline_execution_steps(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListPipelineExecutionSteps",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_pipeline_executions(pipeline_name)
list_pipeline_executions(pipeline_name, params::Dict{String,<:Any})
Gets a list of the pipeline executions.
# Arguments
- `pipeline_name`: The name or Amazon Resource Name (ARN) of the pipeline.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreatedAfter"`: A filter that returns the pipeline executions that were created after a
specified time.
- `"CreatedBefore"`: A filter that returns the pipeline executions that were created before
a specified time.
- `"MaxResults"`: The maximum number of pipeline executions to return in the response.
- `"NextToken"`: If the result of the previous ListPipelineExecutions request was
truncated, the response includes a NextToken. To retrieve the next set of pipeline
executions, use the token in the next request.
- `"SortBy"`: The field by which to sort results. The default is CreatedTime.
- `"SortOrder"`: The sort order for results.
"""
function list_pipeline_executions(
PipelineName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListPipelineExecutions",
Dict{String,Any}("PipelineName" => PipelineName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_pipeline_executions(
PipelineName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"ListPipelineExecutions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PipelineName" => PipelineName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_pipeline_parameters_for_execution(pipeline_execution_arn)
list_pipeline_parameters_for_execution(pipeline_execution_arn, params::Dict{String,<:Any})
Gets a list of parameters for a pipeline execution.
# Arguments
- `pipeline_execution_arn`: The Amazon Resource Name (ARN) of the pipeline execution.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of parameters to return in the response.
- `"NextToken"`: If the result of the previous ListPipelineParametersForExecution request
was truncated, the response includes a NextToken. To retrieve the next set of parameters,
use the token in the next request.
"""
function list_pipeline_parameters_for_execution(
PipelineExecutionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListPipelineParametersForExecution",
Dict{String,Any}("PipelineExecutionArn" => PipelineExecutionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_pipeline_parameters_for_execution(
PipelineExecutionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"ListPipelineParametersForExecution",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("PipelineExecutionArn" => PipelineExecutionArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_pipelines()
list_pipelines(params::Dict{String,<:Any})
Gets a list of pipelines.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreatedAfter"`: A filter that returns the pipelines that were created after a specified
time.
- `"CreatedBefore"`: A filter that returns the pipelines that were created before a
specified time.
- `"MaxResults"`: The maximum number of pipelines to return in the response.
- `"NextToken"`: If the result of the previous ListPipelines request was truncated, the
response includes a NextToken. To retrieve the next set of pipelines, use the token in the
next request.
- `"PipelineNamePrefix"`: The prefix of the pipeline name.
- `"SortBy"`: The field by which to sort results. The default is CreatedTime.
- `"SortOrder"`: The sort order for results.
"""
function list_pipelines(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListPipelines"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_pipelines(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListPipelines", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_processing_jobs()
list_processing_jobs(params::Dict{String,<:Any})
Lists processing jobs that satisfy various filters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: A filter that returns only processing jobs created after the
specified time.
- `"CreationTimeBefore"`: A filter that returns only processing jobs created after the
specified time.
- `"LastModifiedTimeAfter"`: A filter that returns only processing jobs modified after the
specified time.
- `"LastModifiedTimeBefore"`: A filter that returns only processing jobs modified before
the specified time.
- `"MaxResults"`: The maximum number of processing jobs to return in the response.
- `"NameContains"`: A string in the processing job name. This filter returns only
processing jobs whose name contains the specified string.
- `"NextToken"`: If the result of the previous ListProcessingJobs request was truncated,
the response includes a NextToken. To retrieve the next set of processing jobs, use the
token in the next request.
- `"SortBy"`: The field to sort results by. The default is CreationTime.
- `"SortOrder"`: The sort order for results. The default is Ascending.
- `"StatusEquals"`: A filter that retrieves only processing jobs with a specific status.
"""
function list_processing_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListProcessingJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_processing_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListProcessingJobs", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_projects()
list_projects(params::Dict{String,<:Any})
Gets a list of the projects in an Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: A filter that returns the projects that were created after a
specified time.
- `"CreationTimeBefore"`: A filter that returns the projects that were created before a
specified time.
- `"MaxResults"`: The maximum number of projects to return in the response.
- `"NameContains"`: A filter that returns the projects whose name contains a specified
string.
- `"NextToken"`: If the result of the previous ListProjects request was truncated, the
response includes a NextToken. To retrieve the next set of projects, use the token in the
next request.
- `"SortBy"`: The field by which to sort results. The default is CreationTime.
- `"SortOrder"`: The sort order for results. The default is Ascending.
"""
function list_projects(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker("ListProjects"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_projects(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListProjects", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_resource_catalogs()
list_resource_catalogs(params::Dict{String,<:Any})
Lists Amazon SageMaker Catalogs based on given filters and orders. The maximum number of
ResourceCatalogs viewable is 1000.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: Use this parameter to search for ResourceCatalogs created after a
specific date and time.
- `"CreationTimeBefore"`: Use this parameter to search for ResourceCatalogs created before
a specific date and time.
- `"MaxResults"`: The maximum number of results returned by ListResourceCatalogs.
- `"NameContains"`: A string that partially matches one or more ResourceCatalogs names.
Filters ResourceCatalog by name.
- `"NextToken"`: A token to resume pagination of ListResourceCatalogs results.
- `"SortBy"`: The value on which the resource catalog list is sorted.
- `"SortOrder"`: The order in which the resource catalogs are listed.
"""
function list_resource_catalogs(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListResourceCatalogs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_resource_catalogs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListResourceCatalogs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_spaces()
list_spaces(params::Dict{String,<:Any})
Lists spaces.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DomainIdEquals"`: A parameter to search for the domain ID.
- `"MaxResults"`: This parameter defines the maximum number of results that can be return
in a single response. The MaxResults parameter is an upper bound, not a target. If there
are more results available than the value specified, a NextToken is provided in the
response. The NextToken indicates that the user should get the next set of results by
providing this token as a part of a subsequent call. The default value for MaxResults is 10.
- `"NextToken"`: If the previous response was truncated, you will receive this token. Use
it in your next request to receive the next set of results.
- `"SortBy"`: The parameter by which to sort the results. The default is CreationTime.
- `"SortOrder"`: The sort order for the results. The default is Ascending.
- `"SpaceNameContains"`: A parameter by which to filter the results.
"""
function list_spaces(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker("ListSpaces"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_spaces(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListSpaces", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_stage_devices(edge_deployment_plan_name, stage_name)
list_stage_devices(edge_deployment_plan_name, stage_name, params::Dict{String,<:Any})
Lists devices allocated to the stage, containing detailed device information and deployment
status.
# Arguments
- `edge_deployment_plan_name`: The name of the edge deployment plan.
- `stage_name`: The name of the stage in the deployment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExcludeDevicesDeployedInOtherStage"`: Toggle for excluding devices deployed in other
stages.
- `"MaxResults"`: The maximum number of requests to select.
- `"NextToken"`: The response from the last list when returning a list large enough to
neeed tokening.
"""
function list_stage_devices(
EdgeDeploymentPlanName, StageName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListStageDevices",
Dict{String,Any}(
"EdgeDeploymentPlanName" => EdgeDeploymentPlanName, "StageName" => StageName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_stage_devices(
EdgeDeploymentPlanName,
StageName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"ListStageDevices",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EdgeDeploymentPlanName" => EdgeDeploymentPlanName,
"StageName" => StageName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_studio_lifecycle_configs()
list_studio_lifecycle_configs(params::Dict{String,<:Any})
Lists the Amazon SageMaker Studio Lifecycle Configurations in your Amazon Web Services
Account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AppTypeEquals"`: A parameter to search for the App Type to which the Lifecycle
Configuration is attached.
- `"CreationTimeAfter"`: A filter that returns only Lifecycle Configurations created on or
after the specified time.
- `"CreationTimeBefore"`: A filter that returns only Lifecycle Configurations created on or
before the specified time.
- `"MaxResults"`: The total number of items to return in the response. If the total number
of items available is more than the value specified, a NextToken is provided in the
response. To resume pagination, provide the NextToken value in the as part of a subsequent
call. The default value is 10.
- `"ModifiedTimeAfter"`: A filter that returns only Lifecycle Configurations modified after
the specified time.
- `"ModifiedTimeBefore"`: A filter that returns only Lifecycle Configurations modified
before the specified time.
- `"NameContains"`: A string in the Lifecycle Configuration name. This filter returns only
Lifecycle Configurations whose name contains the specified string.
- `"NextToken"`: If the previous call to ListStudioLifecycleConfigs didn't return the full
set of Lifecycle Configurations, the call returns a token for getting the next set of
Lifecycle Configurations.
- `"SortBy"`: The property used to sort results. The default value is CreationTime.
- `"SortOrder"`: The sort order. The default value is Descending.
"""
function list_studio_lifecycle_configs(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListStudioLifecycleConfigs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_studio_lifecycle_configs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListStudioLifecycleConfigs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_subscribed_workteams()
list_subscribed_workteams(params::Dict{String,<:Any})
Gets a list of the work teams that you are subscribed to in the Amazon Web Services
Marketplace. The list may be empty if no work team satisfies the filter specified in the
NameContains parameter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of work teams to return in each page of the response.
- `"NameContains"`: A string in the work team name. This filter returns only work teams
whose name contains the specified string.
- `"NextToken"`: If the result of the previous ListSubscribedWorkteams request was
truncated, the response includes a NextToken. To retrieve the next set of labeling jobs,
use the token in the next request.
"""
function list_subscribed_workteams(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListSubscribedWorkteams"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_subscribed_workteams(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListSubscribedWorkteams",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags(resource_arn)
list_tags(resource_arn, params::Dict{String,<:Any})
Returns the tags for the specified SageMaker resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource whose tags you want to
retrieve.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Maximum number of tags to return.
- `"NextToken"`: If the response to the previous ListTags request is truncated, SageMaker
returns this token. To retrieve the next set of tags, use it in the subsequent request.
"""
function list_tags(ResourceArn; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListTags",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"ListTags",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_training_jobs()
list_training_jobs(params::Dict{String,<:Any})
Lists training jobs. When StatusEquals and MaxResults are set at the same time, the
MaxResults number of training jobs are first retrieved ignoring the StatusEquals parameter
and then they are filtered by the StatusEquals parameter, which is returned as a response.
For example, if ListTrainingJobs is invoked with the following parameters: { ...
MaxResults: 100, StatusEquals: InProgress ... } First, 100 trainings jobs with any status,
including those other than InProgress, are selected (sorted according to the creation time,
from the most current to the oldest). Next, those with a status of InProgress are returned.
You can quickly test the API using the following Amazon Web Services CLI code. aws
sagemaker list-training-jobs --max-results 100 --status-equals InProgress
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: A filter that returns only training jobs created after the
specified time (timestamp).
- `"CreationTimeBefore"`: A filter that returns only training jobs created before the
specified time (timestamp).
- `"LastModifiedTimeAfter"`: A filter that returns only training jobs modified after the
specified time (timestamp).
- `"LastModifiedTimeBefore"`: A filter that returns only training jobs modified before the
specified time (timestamp).
- `"MaxResults"`: The maximum number of training jobs to return in the response.
- `"NameContains"`: A string in the training job name. This filter returns only training
jobs whose name contains the specified string.
- `"NextToken"`: If the result of the previous ListTrainingJobs request was truncated, the
response includes a NextToken. To retrieve the next set of training jobs, use the token in
the next request.
- `"SortBy"`: The field to sort results by. The default is CreationTime.
- `"SortOrder"`: The sort order for results. The default is Ascending.
- `"StatusEquals"`: A filter that retrieves only training jobs with a specific status.
- `"WarmPoolStatusEquals"`: A filter that retrieves only training jobs with a specific warm
pool status.
"""
function list_training_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListTrainingJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_training_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListTrainingJobs", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_training_jobs_for_hyper_parameter_tuning_job(hyper_parameter_tuning_job_name)
list_training_jobs_for_hyper_parameter_tuning_job(hyper_parameter_tuning_job_name, params::Dict{String,<:Any})
Gets a list of TrainingJobSummary objects that describe the training jobs that a
hyperparameter tuning job launched.
# Arguments
- `hyper_parameter_tuning_job_name`: The name of the tuning job whose training jobs 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 training jobs to return. The default value is 10.
- `"NextToken"`: If the result of the previous ListTrainingJobsForHyperParameterTuningJob
request was truncated, the response includes a NextToken. To retrieve the next set of
training jobs, use the token in the next request.
- `"SortBy"`: The field to sort results by. The default is Name. If the value of this field
is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are
not listed.
- `"SortOrder"`: The sort order for results. The default is Ascending.
- `"StatusEquals"`: A filter that returns only training jobs with the specified status.
"""
function list_training_jobs_for_hyper_parameter_tuning_job(
HyperParameterTuningJobName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListTrainingJobsForHyperParameterTuningJob",
Dict{String,Any}("HyperParameterTuningJobName" => HyperParameterTuningJobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_training_jobs_for_hyper_parameter_tuning_job(
HyperParameterTuningJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"ListTrainingJobsForHyperParameterTuningJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"HyperParameterTuningJobName" => HyperParameterTuningJobName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_transform_jobs()
list_transform_jobs(params::Dict{String,<:Any})
Lists transform jobs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: A filter that returns only transform jobs created after the
specified time.
- `"CreationTimeBefore"`: A filter that returns only transform jobs created before the
specified time.
- `"LastModifiedTimeAfter"`: A filter that returns only transform jobs modified after the
specified time.
- `"LastModifiedTimeBefore"`: A filter that returns only transform jobs modified before the
specified time.
- `"MaxResults"`: The maximum number of transform jobs to return in the response. The
default value is 10.
- `"NameContains"`: A string in the transform job name. This filter returns only transform
jobs whose name contains the specified string.
- `"NextToken"`: If the result of the previous ListTransformJobs request was truncated, the
response includes a NextToken. To retrieve the next set of transform jobs, use the token in
the next request.
- `"SortBy"`: The field to sort results by. The default is CreationTime.
- `"SortOrder"`: The sort order for results. The default is Descending.
- `"StatusEquals"`: A filter that retrieves only transform jobs with a specific status.
"""
function list_transform_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListTransformJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_transform_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListTransformJobs", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_trial_components()
list_trial_components(params::Dict{String,<:Any})
Lists the trial components in your account. You can sort the list by trial component name
or creation time. You can filter the list to show only components that were created in a
specific time range. You can also filter on one of the following: ExperimentName
SourceArn TrialName
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreatedAfter"`: A filter that returns only components created after the specified time.
- `"CreatedBefore"`: A filter that returns only components created before the specified
time.
- `"ExperimentName"`: A filter that returns only components that are part of the specified
experiment. If you specify ExperimentName, you can't filter by SourceArn or TrialName.
- `"MaxResults"`: The maximum number of components to return in the response. The default
value is 10.
- `"NextToken"`: If the previous call to ListTrialComponents didn't return the full set of
components, the call returns a token for getting the next set of components.
- `"SortBy"`: The property used to sort results. The default value is CreationTime.
- `"SortOrder"`: The sort order. The default value is Descending.
- `"SourceArn"`: A filter that returns only components that have the specified source
Amazon Resource Name (ARN). If you specify SourceArn, you can't filter by ExperimentName or
TrialName.
- `"TrialName"`: A filter that returns only components that are part of the specified
trial. If you specify TrialName, you can't filter by ExperimentName or SourceArn.
"""
function list_trial_components(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListTrialComponents"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_trial_components(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListTrialComponents",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_trials()
list_trials(params::Dict{String,<:Any})
Lists the trials in your account. Specify an experiment name to limit the list to the
trials that are part of that experiment. Specify a trial component name to limit the list
to the trials that associated with that trial component. The list can be filtered to show
only trials that were created in a specific time range. The list can be sorted by trial
name or creation time.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreatedAfter"`: A filter that returns only trials created after the specified time.
- `"CreatedBefore"`: A filter that returns only trials created before the specified time.
- `"ExperimentName"`: A filter that returns only trials that are part of the specified
experiment.
- `"MaxResults"`: The maximum number of trials to return in the response. The default value
is 10.
- `"NextToken"`: If the previous call to ListTrials didn't return the full set of trials,
the call returns a token for getting the next set of trials.
- `"SortBy"`: The property used to sort results. The default value is CreationTime.
- `"SortOrder"`: The sort order. The default value is Descending.
- `"TrialComponentName"`: A filter that returns only trials that are associated with the
specified trial component.
"""
function list_trials(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker("ListTrials"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_trials(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListTrials", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_user_profiles()
list_user_profiles(params::Dict{String,<:Any})
Lists user profiles.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DomainIdEquals"`: A parameter by which to filter the results.
- `"MaxResults"`: This parameter defines the maximum number of results that can be return
in a single response. The MaxResults parameter is an upper bound, not a target. If there
are more results available than the value specified, a NextToken is provided in the
response. The NextToken indicates that the user should get the next set of results by
providing this token as a part of a subsequent call. The default value for MaxResults is 10.
- `"NextToken"`: If the previous response was truncated, you will receive this token. Use
it in your next request to receive the next set of results.
- `"SortBy"`: The parameter by which to sort the results. The default is CreationTime.
- `"SortOrder"`: The sort order for the results. The default is Ascending.
- `"UserProfileNameContains"`: A parameter by which to filter the results.
"""
function list_user_profiles(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"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 sagemaker(
"ListUserProfiles", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_workforces()
list_workforces(params::Dict{String,<:Any})
Use this operation to list all private and vendor workforces in an Amazon Web Services
Region. Note that you can only have one private workforce per 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 workforces returned in the response.
- `"NameContains"`: A filter you can use to search for workforces using part of the
workforce name.
- `"NextToken"`: A token to resume pagination.
- `"SortBy"`: Sort workforces using the workforce name or creation date.
- `"SortOrder"`: Sort workforces in ascending or descending order.
"""
function list_workforces(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListWorkforces"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_workforces(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListWorkforces", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_workteams()
list_workteams(params::Dict{String,<:Any})
Gets a list of private work teams that you have defined in a region. The list may be empty
if no work team satisfies the filter specified in the NameContains parameter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of work teams to return in each page of the response.
- `"NameContains"`: A string in the work team's name. This filter returns only work teams
whose name contains the specified string.
- `"NextToken"`: If the result of the previous ListWorkteams request was truncated, the
response includes a NextToken. To retrieve the next set of labeling jobs, use the token in
the next request.
- `"SortBy"`: The field to sort results by. The default is CreationTime.
- `"SortOrder"`: The sort order for results. The default is Ascending.
"""
function list_workteams(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"ListWorkteams"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_workteams(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"ListWorkteams", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
put_model_package_group_policy(model_package_group_name, resource_policy)
put_model_package_group_policy(model_package_group_name, resource_policy, params::Dict{String,<:Any})
Adds a resouce policy to control access to a model group. For information about resoure
policies, see Identity-based policies and resource-based policies in the Amazon Web
Services Identity and Access Management User Guide..
# Arguments
- `model_package_group_name`: The name of the model group to add a resource policy to.
- `resource_policy`: The resource policy for the model group.
"""
function put_model_package_group_policy(
ModelPackageGroupName, ResourcePolicy; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"PutModelPackageGroupPolicy",
Dict{String,Any}(
"ModelPackageGroupName" => ModelPackageGroupName,
"ResourcePolicy" => ResourcePolicy,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_model_package_group_policy(
ModelPackageGroupName,
ResourcePolicy,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"PutModelPackageGroupPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ModelPackageGroupName" => ModelPackageGroupName,
"ResourcePolicy" => ResourcePolicy,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
query_lineage()
query_lineage(params::Dict{String,<:Any})
Use this action to inspect your lineage and discover relationships between entities. For
more information, see Querying Lineage Entities in the Amazon SageMaker Developer Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Direction"`: Associations between lineage entities have a direction. This parameter
determines the direction from the StartArn(s) that the query traverses.
- `"Filters"`: A set of filtering parameters that allow you to specify which entities
should be returned. Properties - Key-value pairs to match on the lineage entities'
properties. LineageTypes - A set of lineage entity types to match on. For example:
TrialComponent, Artifact, or Context. CreatedBefore - Filter entities created before this
date. ModifiedBefore - Filter entities modified before this date. ModifiedAfter -
Filter entities modified after this date.
- `"IncludeEdges"`: Setting this value to True retrieves not only the entities of interest
but also the Associations and lineage entities on the path. Set to False to only return
lineage entities that match your query.
- `"MaxDepth"`: The maximum depth in lineage relationships from the StartArns that are
traversed. Depth is a measure of the number of Associations from the StartArn entity to the
matched results.
- `"MaxResults"`: Limits the number of vertices in the results. Use the NextToken in a
response to to retrieve the next page of results.
- `"NextToken"`: Limits the number of vertices in the request. Use the NextToken in a
response to to retrieve the next page of results.
- `"StartArns"`: A list of resource Amazon Resource Name (ARN) that represent the starting
point for your lineage query.
"""
function query_lineage(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker("QueryLineage"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function query_lineage(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"QueryLineage", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
register_devices(device_fleet_name, devices)
register_devices(device_fleet_name, devices, params::Dict{String,<:Any})
Register devices.
# Arguments
- `device_fleet_name`: The name of the fleet.
- `devices`: A list of devices to register with SageMaker Edge Manager.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: The tags associated with devices.
"""
function register_devices(
DeviceFleetName, Devices; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"RegisterDevices",
Dict{String,Any}("DeviceFleetName" => DeviceFleetName, "Devices" => Devices);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_devices(
DeviceFleetName,
Devices,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"RegisterDevices",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DeviceFleetName" => DeviceFleetName, "Devices" => Devices
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
render_ui_template(role_arn, task)
render_ui_template(role_arn, task, params::Dict{String,<:Any})
Renders the UI template so that you can preview the worker's experience.
# Arguments
- `role_arn`: The Amazon Resource Name (ARN) that has access to the S3 objects that are
used by the template.
- `task`: A RenderableTask object containing a representative task to render.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"HumanTaskUiArn"`: The HumanTaskUiArn of the worker UI that you want to render. Do not
provide a HumanTaskUiArn if you use the UiTemplate parameter. See a list of available Human
Ui Amazon Resource Names (ARNs) in UiConfig.
- `"UiTemplate"`: A Template object containing the worker UI template to render.
"""
function render_ui_template(
RoleArn, Task; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"RenderUiTemplate",
Dict{String,Any}("RoleArn" => RoleArn, "Task" => Task);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function render_ui_template(
RoleArn,
Task,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"RenderUiTemplate",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("RoleArn" => RoleArn, "Task" => Task), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
retry_pipeline_execution(client_request_token, pipeline_execution_arn)
retry_pipeline_execution(client_request_token, pipeline_execution_arn, params::Dict{String,<:Any})
Retry the execution of the pipeline.
# Arguments
- `client_request_token`: A unique, case-sensitive identifier that you provide to ensure
the idempotency of the operation. An idempotent operation completes no more than once.
- `pipeline_execution_arn`: The Amazon Resource Name (ARN) of the pipeline execution.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ParallelismConfiguration"`: This configuration, if specified, overrides the parallelism
configuration of the parent pipeline.
"""
function retry_pipeline_execution(
ClientRequestToken,
PipelineExecutionArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"RetryPipelineExecution",
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken,
"PipelineExecutionArn" => PipelineExecutionArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function retry_pipeline_execution(
ClientRequestToken,
PipelineExecutionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"RetryPipelineExecution",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken,
"PipelineExecutionArn" => PipelineExecutionArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search(resource)
search(resource, params::Dict{String,<:Any})
Finds SageMaker resources that match a search query. Matching resources are returned as a
list of SearchRecord objects in the response. You can sort the search results by any
resource property in a ascending or descending order. You can query against the following
value types: numeric, text, Boolean, and timestamp. The Search API may provide access to
otherwise restricted data. See Amazon SageMaker API Permissions: Actions, Permissions, and
Resources Reference for more information.
# Arguments
- `resource`: The name of the SageMaker resource to search for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CrossAccountFilterOption"`: A cross account filter option. When the value is
\"CrossAccount\" the search results will only include resources made discoverable to you
from other accounts. When the value is \"SameAccount\" or null the search results will only
include resources from your account. Default is null. For more information on searching for
resources made discoverable to your account, see Search discoverable resources in the
SageMaker Developer Guide. The maximum number of ResourceCatalogs viewable is 1000.
- `"MaxResults"`: The maximum number of results to return.
- `"NextToken"`: If more than MaxResults resources match the specified SearchExpression,
the response includes a NextToken. The NextToken can be passed to the next SearchRequest to
continue retrieving results.
- `"SearchExpression"`: A Boolean conditional statement. Resources must satisfy this
condition to be included in search results. You must provide at least one subexpression,
filter, or nested filter. The maximum number of recursive SubExpressions, NestedFilters,
and Filters that can be included in a SearchExpression object is 50.
- `"SortBy"`: The name of the resource property used to sort the SearchResults. The default
is LastModifiedTime.
- `"SortOrder"`: How SearchResults are ordered. Valid values are Ascending or Descending.
The default is Descending.
- `"VisibilityConditions"`: Limits the results of your search request to the resources
that you can access.
"""
function search(Resource; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"Search",
Dict{String,Any}("Resource" => Resource);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search(
Resource,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"Search",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Resource" => Resource), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_pipeline_execution_step_failure(callback_token)
send_pipeline_execution_step_failure(callback_token, params::Dict{String,<:Any})
Notifies the pipeline that the execution of a callback step failed, along with a message
describing why. When a callback step is run, the pipeline generates a callback token and
includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).
# Arguments
- `callback_token`: The pipeline generated token from the Amazon SQS queue.
# 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 operation. An idempotent operation completes no more than one time.
- `"FailureReason"`: A message describing why the step failed.
"""
function send_pipeline_execution_step_failure(
CallbackToken; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"SendPipelineExecutionStepFailure",
Dict{String,Any}(
"CallbackToken" => CallbackToken, "ClientRequestToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_pipeline_execution_step_failure(
CallbackToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"SendPipelineExecutionStepFailure",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CallbackToken" => CallbackToken,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_pipeline_execution_step_success(callback_token)
send_pipeline_execution_step_success(callback_token, params::Dict{String,<:Any})
Notifies the pipeline that the execution of a callback step succeeded and provides a list
of the step's output parameters. When a callback step is run, the pipeline generates a
callback token and includes the token in a message sent to Amazon Simple Queue Service
(Amazon SQS).
# Arguments
- `callback_token`: The pipeline generated token from the Amazon SQS queue.
# 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 operation. An idempotent operation completes no more than one time.
- `"OutputParameters"`: A list of the output parameters of the callback step.
"""
function send_pipeline_execution_step_success(
CallbackToken; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"SendPipelineExecutionStepSuccess",
Dict{String,Any}(
"CallbackToken" => CallbackToken, "ClientRequestToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_pipeline_execution_step_success(
CallbackToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"SendPipelineExecutionStepSuccess",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CallbackToken" => CallbackToken,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_edge_deployment_stage(edge_deployment_plan_name, stage_name)
start_edge_deployment_stage(edge_deployment_plan_name, stage_name, params::Dict{String,<:Any})
Starts a stage in an edge deployment plan.
# Arguments
- `edge_deployment_plan_name`: The name of the edge deployment plan to start.
- `stage_name`: The name of the stage to start.
"""
function start_edge_deployment_stage(
EdgeDeploymentPlanName, StageName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"StartEdgeDeploymentStage",
Dict{String,Any}(
"EdgeDeploymentPlanName" => EdgeDeploymentPlanName, "StageName" => StageName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_edge_deployment_stage(
EdgeDeploymentPlanName,
StageName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"StartEdgeDeploymentStage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EdgeDeploymentPlanName" => EdgeDeploymentPlanName,
"StageName" => StageName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_inference_experiment(name)
start_inference_experiment(name, params::Dict{String,<:Any})
Starts an inference experiment.
# Arguments
- `name`: The name of the inference experiment to start.
"""
function start_inference_experiment(Name; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"StartInferenceExperiment",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_inference_experiment(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"StartInferenceExperiment",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_mlflow_tracking_server(tracking_server_name)
start_mlflow_tracking_server(tracking_server_name, params::Dict{String,<:Any})
Programmatically start an MLflow Tracking Server.
# Arguments
- `tracking_server_name`: The name of the tracking server to start.
"""
function start_mlflow_tracking_server(
TrackingServerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"StartMlflowTrackingServer",
Dict{String,Any}("TrackingServerName" => TrackingServerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_mlflow_tracking_server(
TrackingServerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"StartMlflowTrackingServer",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("TrackingServerName" => TrackingServerName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_monitoring_schedule(monitoring_schedule_name)
start_monitoring_schedule(monitoring_schedule_name, params::Dict{String,<:Any})
Starts a previously stopped monitoring schedule. By default, when you successfully create
a new schedule, the status of a monitoring schedule is scheduled.
# Arguments
- `monitoring_schedule_name`: The name of the schedule to start.
"""
function start_monitoring_schedule(
MonitoringScheduleName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"StartMonitoringSchedule",
Dict{String,Any}("MonitoringScheduleName" => MonitoringScheduleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_monitoring_schedule(
MonitoringScheduleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"StartMonitoringSchedule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("MonitoringScheduleName" => MonitoringScheduleName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_notebook_instance(notebook_instance_name)
start_notebook_instance(notebook_instance_name, params::Dict{String,<:Any})
Launches an ML compute instance with the latest version of the libraries and attaches your
ML storage volume. After configuring the notebook instance, SageMaker sets the notebook
instance status to InService. A notebook instance's status must be InService before you can
connect to your Jupyter notebook.
# Arguments
- `notebook_instance_name`: The name of the notebook instance to start.
"""
function start_notebook_instance(
NotebookInstanceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"StartNotebookInstance",
Dict{String,Any}("NotebookInstanceName" => NotebookInstanceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_notebook_instance(
NotebookInstanceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"StartNotebookInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("NotebookInstanceName" => NotebookInstanceName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_pipeline_execution(client_request_token, pipeline_name)
start_pipeline_execution(client_request_token, pipeline_name, params::Dict{String,<:Any})
Starts a pipeline execution.
# Arguments
- `client_request_token`: A unique, case-sensitive identifier that you provide to ensure
the idempotency of the operation. An idempotent operation completes no more than once.
- `pipeline_name`: The name or Amazon Resource Name (ARN) of the pipeline.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ParallelismConfiguration"`: This configuration, if specified, overrides the parallelism
configuration of the parent pipeline for this specific run.
- `"PipelineExecutionDescription"`: The description of the pipeline execution.
- `"PipelineExecutionDisplayName"`: The display name of the pipeline execution.
- `"PipelineParameters"`: Contains a list of pipeline parameters. This list can be empty.
- `"SelectiveExecutionConfig"`: The selective execution configuration applied to the
pipeline run.
"""
function start_pipeline_execution(
ClientRequestToken, PipelineName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"StartPipelineExecution",
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken, "PipelineName" => PipelineName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_pipeline_execution(
ClientRequestToken,
PipelineName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"StartPipelineExecution",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken,
"PipelineName" => PipelineName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_auto_mljob(auto_mljob_name)
stop_auto_mljob(auto_mljob_name, params::Dict{String,<:Any})
A method for forcing a running job to shut down.
# Arguments
- `auto_mljob_name`: The name of the object you are requesting.
"""
function stop_auto_mljob(AutoMLJobName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"StopAutoMLJob",
Dict{String,Any}("AutoMLJobName" => AutoMLJobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_auto_mljob(
AutoMLJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"StopAutoMLJob",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AutoMLJobName" => AutoMLJobName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_compilation_job(compilation_job_name)
stop_compilation_job(compilation_job_name, params::Dict{String,<:Any})
Stops a model compilation job. To stop a job, Amazon SageMaker sends the algorithm the
SIGTERM signal. This gracefully shuts the job down. If the job hasn't stopped, it sends the
SIGKILL signal. When it receives a StopCompilationJob request, Amazon SageMaker changes the
CompilationJobStatus of the job to Stopping. After Amazon SageMaker stops the job, it sets
the CompilationJobStatus to Stopped.
# Arguments
- `compilation_job_name`: The name of the model compilation job to stop.
"""
function stop_compilation_job(
CompilationJobName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"StopCompilationJob",
Dict{String,Any}("CompilationJobName" => CompilationJobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_compilation_job(
CompilationJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"StopCompilationJob",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("CompilationJobName" => CompilationJobName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_edge_deployment_stage(edge_deployment_plan_name, stage_name)
stop_edge_deployment_stage(edge_deployment_plan_name, stage_name, params::Dict{String,<:Any})
Stops a stage in an edge deployment plan.
# Arguments
- `edge_deployment_plan_name`: The name of the edge deployment plan to stop.
- `stage_name`: The name of the stage to stop.
"""
function stop_edge_deployment_stage(
EdgeDeploymentPlanName, StageName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"StopEdgeDeploymentStage",
Dict{String,Any}(
"EdgeDeploymentPlanName" => EdgeDeploymentPlanName, "StageName" => StageName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_edge_deployment_stage(
EdgeDeploymentPlanName,
StageName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"StopEdgeDeploymentStage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EdgeDeploymentPlanName" => EdgeDeploymentPlanName,
"StageName" => StageName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_edge_packaging_job(edge_packaging_job_name)
stop_edge_packaging_job(edge_packaging_job_name, params::Dict{String,<:Any})
Request to stop an edge packaging job.
# Arguments
- `edge_packaging_job_name`: The name of the edge packaging job.
"""
function stop_edge_packaging_job(
EdgePackagingJobName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"StopEdgePackagingJob",
Dict{String,Any}("EdgePackagingJobName" => EdgePackagingJobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_edge_packaging_job(
EdgePackagingJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"StopEdgePackagingJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("EdgePackagingJobName" => EdgePackagingJobName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_hyper_parameter_tuning_job(hyper_parameter_tuning_job_name)
stop_hyper_parameter_tuning_job(hyper_parameter_tuning_job_name, params::Dict{String,<:Any})
Stops a running hyperparameter tuning job and all running training jobs that the tuning job
launched. All model artifacts output from the training jobs are stored in Amazon Simple
Storage Service (Amazon S3). All data that the training jobs write to Amazon CloudWatch
Logs are still available in CloudWatch. After the tuning job moves to the Stopped state, it
releases all reserved resources for the tuning job.
# Arguments
- `hyper_parameter_tuning_job_name`: The name of the tuning job to stop.
"""
function stop_hyper_parameter_tuning_job(
HyperParameterTuningJobName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"StopHyperParameterTuningJob",
Dict{String,Any}("HyperParameterTuningJobName" => HyperParameterTuningJobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_hyper_parameter_tuning_job(
HyperParameterTuningJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"StopHyperParameterTuningJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"HyperParameterTuningJobName" => HyperParameterTuningJobName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_inference_experiment(model_variant_actions, name)
stop_inference_experiment(model_variant_actions, name, params::Dict{String,<:Any})
Stops an inference experiment.
# Arguments
- `model_variant_actions`: Array of key-value pairs, with names of variants mapped to
actions. The possible actions are the following: Promote - Promote the shadow variant
to a production variant Remove - Delete the variant Retain - Keep the variant as it
is
- `name`: The name of the inference experiment to stop.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DesiredModelVariants"`: An array of ModelVariantConfig objects. There is one for each
variant that you want to deploy after the inference experiment stops. Each
ModelVariantConfig describes the infrastructure configuration for deploying the
corresponding variant.
- `"DesiredState"`: The desired state of the experiment after stopping. The possible
states are the following: Completed: The experiment completed successfully
Cancelled: The experiment was canceled
- `"Reason"`: The reason for stopping the experiment.
"""
function stop_inference_experiment(
ModelVariantActions, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"StopInferenceExperiment",
Dict{String,Any}("ModelVariantActions" => ModelVariantActions, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_inference_experiment(
ModelVariantActions,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"StopInferenceExperiment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ModelVariantActions" => ModelVariantActions, "Name" => Name
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_inference_recommendations_job(job_name)
stop_inference_recommendations_job(job_name, params::Dict{String,<:Any})
Stops an Inference Recommender job.
# Arguments
- `job_name`: The name of the job you want to stop.
"""
function stop_inference_recommendations_job(
JobName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"StopInferenceRecommendationsJob",
Dict{String,Any}("JobName" => JobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_inference_recommendations_job(
JobName, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"StopInferenceRecommendationsJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobName" => JobName), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_labeling_job(labeling_job_name)
stop_labeling_job(labeling_job_name, params::Dict{String,<:Any})
Stops a running labeling job. A job that is stopped cannot be restarted. Any results
obtained before the job is stopped are placed in the Amazon S3 output bucket.
# Arguments
- `labeling_job_name`: The name of the labeling job to stop.
"""
function stop_labeling_job(
LabelingJobName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"StopLabelingJob",
Dict{String,Any}("LabelingJobName" => LabelingJobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_labeling_job(
LabelingJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"StopLabelingJob",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("LabelingJobName" => LabelingJobName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_mlflow_tracking_server(tracking_server_name)
stop_mlflow_tracking_server(tracking_server_name, params::Dict{String,<:Any})
Programmatically stop an MLflow Tracking Server.
# Arguments
- `tracking_server_name`: The name of the tracking server to stop.
"""
function stop_mlflow_tracking_server(
TrackingServerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"StopMlflowTrackingServer",
Dict{String,Any}("TrackingServerName" => TrackingServerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_mlflow_tracking_server(
TrackingServerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"StopMlflowTrackingServer",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("TrackingServerName" => TrackingServerName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_monitoring_schedule(monitoring_schedule_name)
stop_monitoring_schedule(monitoring_schedule_name, params::Dict{String,<:Any})
Stops a previously started monitoring schedule.
# Arguments
- `monitoring_schedule_name`: The name of the schedule to stop.
"""
function stop_monitoring_schedule(
MonitoringScheduleName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"StopMonitoringSchedule",
Dict{String,Any}("MonitoringScheduleName" => MonitoringScheduleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_monitoring_schedule(
MonitoringScheduleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"StopMonitoringSchedule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("MonitoringScheduleName" => MonitoringScheduleName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_notebook_instance(notebook_instance_name)
stop_notebook_instance(notebook_instance_name, params::Dict{String,<:Any})
Terminates the ML compute instance. Before terminating the instance, SageMaker disconnects
the ML storage volume from it. SageMaker preserves the ML storage volume. SageMaker stops
charging you for the ML compute instance when you call StopNotebookInstance. To access data
on the ML storage volume for a notebook instance that has been terminated, call the
StartNotebookInstance API. StartNotebookInstance launches another ML compute instance,
configures it, and attaches the preserved ML storage volume so you can continue your work.
# Arguments
- `notebook_instance_name`: The name of the notebook instance to terminate.
"""
function stop_notebook_instance(
NotebookInstanceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"StopNotebookInstance",
Dict{String,Any}("NotebookInstanceName" => NotebookInstanceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_notebook_instance(
NotebookInstanceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"StopNotebookInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("NotebookInstanceName" => NotebookInstanceName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_pipeline_execution(client_request_token, pipeline_execution_arn)
stop_pipeline_execution(client_request_token, pipeline_execution_arn, params::Dict{String,<:Any})
Stops a pipeline execution. Callback Step A pipeline execution won't stop while a
callback step is running. When you call StopPipelineExecution on a pipeline execution with
a running callback step, SageMaker Pipelines sends an additional Amazon SQS message to the
specified SQS queue. The body of the SQS message contains a \"Status\" field which is set
to \"Stopping\". You should add logic to your Amazon SQS message consumer to take any
needed action (for example, resource cleanup) upon receipt of the message followed by a
call to SendPipelineExecutionStepSuccess or SendPipelineExecutionStepFailure. Only when
SageMaker Pipelines receives one of these calls will it stop the pipeline execution.
Lambda Step A pipeline execution can't be stopped while a lambda step is running because
the Lambda function invoked by the lambda step can't be stopped. If you attempt to stop the
execution while the Lambda function is running, the pipeline waits for the Lambda function
to finish or until the timeout is hit, whichever occurs first, and then stops. If the
Lambda function finishes, the pipeline execution status is Stopped. If the timeout is hit
the pipeline execution status is Failed.
# Arguments
- `client_request_token`: A unique, case-sensitive identifier that you provide to ensure
the idempotency of the operation. An idempotent operation completes no more than once.
- `pipeline_execution_arn`: The Amazon Resource Name (ARN) of the pipeline execution.
"""
function stop_pipeline_execution(
ClientRequestToken,
PipelineExecutionArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"StopPipelineExecution",
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken,
"PipelineExecutionArn" => PipelineExecutionArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_pipeline_execution(
ClientRequestToken,
PipelineExecutionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"StopPipelineExecution",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken,
"PipelineExecutionArn" => PipelineExecutionArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_processing_job(processing_job_name)
stop_processing_job(processing_job_name, params::Dict{String,<:Any})
Stops a processing job.
# Arguments
- `processing_job_name`: The name of the processing job to stop.
"""
function stop_processing_job(
ProcessingJobName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"StopProcessingJob",
Dict{String,Any}("ProcessingJobName" => ProcessingJobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_processing_job(
ProcessingJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"StopProcessingJob",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ProcessingJobName" => ProcessingJobName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_training_job(training_job_name)
stop_training_job(training_job_name, params::Dict{String,<:Any})
Stops a training job. To stop a job, SageMaker sends the algorithm the SIGTERM signal,
which delays job termination for 120 seconds. Algorithms might use this 120-second window
to save the model artifacts, so the results of the training is not lost. When it receives
a StopTrainingJob request, SageMaker changes the status of the job to Stopping. After
SageMaker stops the job, it sets the status to Stopped.
# Arguments
- `training_job_name`: The name of the training job to stop.
"""
function stop_training_job(
TrainingJobName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"StopTrainingJob",
Dict{String,Any}("TrainingJobName" => TrainingJobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_training_job(
TrainingJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"StopTrainingJob",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("TrainingJobName" => TrainingJobName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_transform_job(transform_job_name)
stop_transform_job(transform_job_name, params::Dict{String,<:Any})
Stops a batch transform job. When Amazon SageMaker receives a StopTransformJob request, the
status of the job changes to Stopping. After Amazon SageMaker stops the job, the status is
set to Stopped. When you stop a batch transform job before it is completed, Amazon
SageMaker doesn't store the job's output in Amazon S3.
# Arguments
- `transform_job_name`: The name of the batch transform job to stop.
"""
function stop_transform_job(
TransformJobName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"StopTransformJob",
Dict{String,Any}("TransformJobName" => TransformJobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_transform_job(
TransformJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"StopTransformJob",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("TransformJobName" => TransformJobName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_action(action_name)
update_action(action_name, params::Dict{String,<:Any})
Updates an action.
# Arguments
- `action_name`: The name of the action to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The new description for the action.
- `"Properties"`: The new list of properties. Overwrites the current property list.
- `"PropertiesToRemove"`: A list of properties to remove.
- `"Status"`: The new status for the action.
"""
function update_action(ActionName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"UpdateAction",
Dict{String,Any}("ActionName" => ActionName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_action(
ActionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateAction",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ActionName" => ActionName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_app_image_config(app_image_config_name)
update_app_image_config(app_image_config_name, params::Dict{String,<:Any})
Updates the properties of an AppImageConfig.
# Arguments
- `app_image_config_name`: The name of the AppImageConfig to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CodeEditorAppImageConfig"`: The Code Editor app running on the image.
- `"JupyterLabAppImageConfig"`: The JupyterLab app running on the image.
- `"KernelGatewayImageConfig"`: The new KernelGateway app to run on the image.
"""
function update_app_image_config(
AppImageConfigName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"UpdateAppImageConfig",
Dict{String,Any}("AppImageConfigName" => AppImageConfigName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_app_image_config(
AppImageConfigName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateAppImageConfig",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("AppImageConfigName" => AppImageConfigName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_artifact(artifact_arn)
update_artifact(artifact_arn, params::Dict{String,<:Any})
Updates an artifact.
# Arguments
- `artifact_arn`: The Amazon Resource Name (ARN) of the artifact to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ArtifactName"`: The new name for the artifact.
- `"Properties"`: The new list of properties. Overwrites the current property list.
- `"PropertiesToRemove"`: A list of properties to remove.
"""
function update_artifact(ArtifactArn; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"UpdateArtifact",
Dict{String,Any}("ArtifactArn" => ArtifactArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_artifact(
ArtifactArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateArtifact",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ArtifactArn" => ArtifactArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_cluster(cluster_name, instance_groups)
update_cluster(cluster_name, instance_groups, params::Dict{String,<:Any})
Updates a SageMaker HyperPod cluster.
# Arguments
- `cluster_name`: Specify the name of the SageMaker HyperPod cluster you want to update.
- `instance_groups`: Specify the instance groups to update.
"""
function update_cluster(
ClusterName, InstanceGroups; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"UpdateCluster",
Dict{String,Any}("ClusterName" => ClusterName, "InstanceGroups" => InstanceGroups);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_cluster(
ClusterName,
InstanceGroups,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClusterName" => ClusterName, "InstanceGroups" => InstanceGroups
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_cluster_software(cluster_name)
update_cluster_software(cluster_name, params::Dict{String,<:Any})
Updates the platform software of a SageMaker HyperPod cluster for security patching. To
learn how to use this API, see Update the SageMaker HyperPod platform software of a cluster.
# Arguments
- `cluster_name`: Specify the name or the Amazon Resource Name (ARN) of the SageMaker
HyperPod cluster you want to update for security patching.
"""
function update_cluster_software(
ClusterName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"UpdateClusterSoftware",
Dict{String,Any}("ClusterName" => ClusterName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_cluster_software(
ClusterName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateClusterSoftware",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClusterName" => ClusterName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_code_repository(code_repository_name)
update_code_repository(code_repository_name, params::Dict{String,<:Any})
Updates the specified Git repository with the specified values.
# Arguments
- `code_repository_name`: The name of the Git repository to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GitConfig"`: The configuration of the git repository, including the URL and the Amazon
Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the
credentials used to access the repository. The secret must have a staging label of
AWSCURRENT and must be in the following format: {\"username\": UserName, \"password\":
Password}
"""
function update_code_repository(
CodeRepositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"UpdateCodeRepository",
Dict{String,Any}("CodeRepositoryName" => CodeRepositoryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_code_repository(
CodeRepositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateCodeRepository",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("CodeRepositoryName" => CodeRepositoryName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_context(context_name)
update_context(context_name, params::Dict{String,<:Any})
Updates a context.
# Arguments
- `context_name`: The name of the context to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The new description for the context.
- `"Properties"`: The new list of properties. Overwrites the current property list.
- `"PropertiesToRemove"`: A list of properties to remove.
"""
function update_context(ContextName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"UpdateContext",
Dict{String,Any}("ContextName" => ContextName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_context(
ContextName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateContext",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ContextName" => ContextName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_device_fleet(device_fleet_name, output_config)
update_device_fleet(device_fleet_name, output_config, params::Dict{String,<:Any})
Updates a fleet of devices.
# Arguments
- `device_fleet_name`: The name of the fleet.
- `output_config`: Output configuration for storing sample data collected by the fleet.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: Description of the fleet.
- `"EnableIotRoleAlias"`: Whether to create an Amazon Web Services IoT Role Alias during
device fleet creation. The name of the role alias generated will match this pattern:
\"SageMakerEdge-{DeviceFleetName}\". For example, if your device fleet is called
\"demo-fleet\", the name of the role alias will be \"SageMakerEdge-demo-fleet\".
- `"RoleArn"`: The Amazon Resource Name (ARN) of the device.
"""
function update_device_fleet(
DeviceFleetName, OutputConfig; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"UpdateDeviceFleet",
Dict{String,Any}(
"DeviceFleetName" => DeviceFleetName, "OutputConfig" => OutputConfig
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_device_fleet(
DeviceFleetName,
OutputConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateDeviceFleet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DeviceFleetName" => DeviceFleetName, "OutputConfig" => OutputConfig
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_devices(device_fleet_name, devices)
update_devices(device_fleet_name, devices, params::Dict{String,<:Any})
Updates one or more devices in a fleet.
# Arguments
- `device_fleet_name`: The name of the fleet the devices belong to.
- `devices`: List of devices to register with Edge Manager agent.
"""
function update_devices(
DeviceFleetName, Devices; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"UpdateDevices",
Dict{String,Any}("DeviceFleetName" => DeviceFleetName, "Devices" => Devices);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_devices(
DeviceFleetName,
Devices,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateDevices",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DeviceFleetName" => DeviceFleetName, "Devices" => Devices
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_domain(domain_id)
update_domain(domain_id, params::Dict{String,<:Any})
Updates the default settings for new user profiles in the domain.
# Arguments
- `domain_id`: The ID of the domain to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AppNetworkAccessType"`: Specifies the VPC used for non-EFS traffic.
PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which
allows direct internet access. VpcOnly - All Studio traffic is through the specified VPC
and subnets. This configuration can only be modified if there are no apps in the
InService, Pending, or Deleting state. The configuration cannot be updated if
DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is already set or
DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided as part of
the same request.
- `"AppSecurityGroupManagement"`: The entity that creates and manages the required security
groups for inter-app communication in VPCOnly mode. Required when
CreateDomain.AppNetworkAccessType is VPCOnly and
DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. If
setting up the domain for use with RStudio, this value must be set to Service.
- `"DefaultSpaceSettings"`: The default settings used to create a space within the domain.
- `"DefaultUserSettings"`: A collection of settings.
- `"DomainSettingsForUpdate"`: A collection of DomainSettings configuration values to
update.
- `"SubnetIds"`: The VPC subnets that Studio uses for communication. If removing subnets,
ensure there are no apps in the InService, Pending, or Deleting state.
"""
function update_domain(DomainId; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"UpdateDomain",
Dict{String,Any}("DomainId" => DomainId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_domain(
DomainId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateDomain",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainId" => DomainId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_endpoint(endpoint_config_name, endpoint_name)
update_endpoint(endpoint_config_name, endpoint_name, params::Dict{String,<:Any})
Deploys the EndpointConfig specified in the request to a new fleet of instances. SageMaker
shifts endpoint traffic to the new instances with the updated endpoint configuration and
then deletes the old instances using the previous EndpointConfig (there is no availability
loss). For more information about how to control the update and traffic shifting process,
see Update models in production. When SageMaker receives the request, it sets the endpoint
status to Updating. After updating the endpoint, it sets the status to InService. To check
the status of an endpoint, use the DescribeEndpoint API. You must not delete an
EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or
CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you
must create a new EndpointConfig. If you delete the EndpointConfig of an endpoint that is
active or being created or updated you may lose visibility into the instance type the
endpoint is using. The endpoint must be deleted in order to stop incurring charges.
# Arguments
- `endpoint_config_name`: The name of the new endpoint configuration.
- `endpoint_name`: The name of the endpoint whose configuration you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeploymentConfig"`: The deployment configuration for an endpoint, which contains the
desired deployment strategy and rollback configurations.
- `"ExcludeRetainedVariantProperties"`: When you are updating endpoint resources with
RetainAllVariantProperties, whose value is set to true, ExcludeRetainedVariantProperties
specifies the list of type VariantProperty to override with the values provided by
EndpointConfig. If you don't specify a value for ExcludeRetainedVariantProperties, no
variant properties are overridden.
- `"RetainAllVariantProperties"`: When updating endpoint resources, enables or disables the
retention of variant properties, such as the instance count or the variant weight. To
retain the variant properties of an endpoint when updating it, set
RetainAllVariantProperties to true. To use the variant properties specified in a new
EndpointConfig call when updating an endpoint, set RetainAllVariantProperties to false. The
default is false.
- `"RetainDeploymentConfig"`: Specifies whether to reuse the last deployment configuration.
The default value is false (the configuration is not reused).
"""
function update_endpoint(
EndpointConfigName, EndpointName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"UpdateEndpoint",
Dict{String,Any}(
"EndpointConfigName" => EndpointConfigName, "EndpointName" => EndpointName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_endpoint(
EndpointConfigName,
EndpointName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateEndpoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EndpointConfigName" => EndpointConfigName,
"EndpointName" => EndpointName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_endpoint_weights_and_capacities(desired_weights_and_capacities, endpoint_name)
update_endpoint_weights_and_capacities(desired_weights_and_capacities, endpoint_name, params::Dict{String,<:Any})
Updates variant weight of one or more variants associated with an existing endpoint, or
capacity of one variant associated with an existing endpoint. When it receives the request,
SageMaker sets the endpoint status to Updating. After updating the endpoint, it sets the
status to InService. To check the status of an endpoint, use the DescribeEndpoint API.
# Arguments
- `desired_weights_and_capacities`: An object that provides new capacity and weight values
for a variant.
- `endpoint_name`: The name of an existing SageMaker endpoint.
"""
function update_endpoint_weights_and_capacities(
DesiredWeightsAndCapacities,
EndpointName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateEndpointWeightsAndCapacities",
Dict{String,Any}(
"DesiredWeightsAndCapacities" => DesiredWeightsAndCapacities,
"EndpointName" => EndpointName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_endpoint_weights_and_capacities(
DesiredWeightsAndCapacities,
EndpointName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateEndpointWeightsAndCapacities",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DesiredWeightsAndCapacities" => DesiredWeightsAndCapacities,
"EndpointName" => EndpointName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_experiment(experiment_name)
update_experiment(experiment_name, params::Dict{String,<:Any})
Adds, updates, or removes the description of an experiment. Updates the display name of an
experiment.
# Arguments
- `experiment_name`: The name of the experiment to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description of the experiment.
- `"DisplayName"`: The name of the experiment as displayed. The name doesn't need to be
unique. If DisplayName isn't specified, ExperimentName is displayed.
"""
function update_experiment(
ExperimentName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"UpdateExperiment",
Dict{String,Any}("ExperimentName" => ExperimentName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_experiment(
ExperimentName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateExperiment",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ExperimentName" => ExperimentName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_feature_group(feature_group_name)
update_feature_group(feature_group_name, params::Dict{String,<:Any})
Updates the feature group by either adding features or updating the online store
configuration. Use one of the following request parameters at a time while using the
UpdateFeatureGroup API. You can add features for your feature group using the
FeatureAdditions request parameter. Features cannot be removed from a feature group. You
can update the online store configuration by using the OnlineStoreConfig request parameter.
If a TtlDuration is specified, the default TtlDuration applies for all records added to the
feature group after the feature group is updated. If a record level TtlDuration exists from
using the PutRecord API, the record level TtlDuration applies to that record instead of the
default TtlDuration. To remove the default TtlDuration from an existing feature group, use
the UpdateFeatureGroup API and set the TtlDuration Unit and Value to null.
# Arguments
- `feature_group_name`: The name or Amazon Resource Name (ARN) of the feature group that
you're updating.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FeatureAdditions"`: Updates the feature group. Updating a feature group is an
asynchronous operation. When you get an HTTP 200 response, you've made a valid request. It
takes some time after you've made a valid request for Feature Store to update the feature
group.
- `"OnlineStoreConfig"`: Updates the feature group online store configuration.
- `"ThroughputConfig"`:
"""
function update_feature_group(
FeatureGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"UpdateFeatureGroup",
Dict{String,Any}("FeatureGroupName" => FeatureGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_feature_group(
FeatureGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateFeatureGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("FeatureGroupName" => FeatureGroupName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_feature_metadata(feature_group_name, feature_name)
update_feature_metadata(feature_group_name, feature_name, params::Dict{String,<:Any})
Updates the description and parameters of the feature group.
# Arguments
- `feature_group_name`: The name or Amazon Resource Name (ARN) of the feature group
containing the feature that you're updating.
- `feature_name`: The name of the feature that you're updating.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description that you can write to better describe the feature.
- `"ParameterAdditions"`: A list of key-value pairs that you can add to better describe the
feature.
- `"ParameterRemovals"`: A list of parameter keys that you can specify to remove parameters
that describe your feature.
"""
function update_feature_metadata(
FeatureGroupName, FeatureName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"UpdateFeatureMetadata",
Dict{String,Any}(
"FeatureGroupName" => FeatureGroupName, "FeatureName" => FeatureName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_feature_metadata(
FeatureGroupName,
FeatureName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateFeatureMetadata",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FeatureGroupName" => FeatureGroupName, "FeatureName" => FeatureName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_hub(hub_name)
update_hub(hub_name, params::Dict{String,<:Any})
Update a hub.
# Arguments
- `hub_name`: The name of the hub to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"HubDescription"`: A description of the updated hub.
- `"HubDisplayName"`: The display name of the hub.
- `"HubSearchKeywords"`: The searchable keywords for the hub.
"""
function update_hub(HubName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"UpdateHub",
Dict{String,Any}("HubName" => HubName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_hub(
HubName, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"UpdateHub",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("HubName" => HubName), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_image(image_name)
update_image(image_name, params::Dict{String,<:Any})
Updates the properties of a SageMaker image. To change the image's tags, use the AddTags
and DeleteTags APIs.
# Arguments
- `image_name`: The name of the image to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeleteProperties"`: A list of properties to delete. Only the Description and
DisplayName properties can be deleted.
- `"Description"`: The new description for the image.
- `"DisplayName"`: The new display name for the image.
- `"RoleArn"`: The new ARN for the IAM role that enables Amazon SageMaker to perform tasks
on your behalf.
"""
function update_image(ImageName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"UpdateImage",
Dict{String,Any}("ImageName" => ImageName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_image(
ImageName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateImage",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ImageName" => ImageName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_image_version(image_name)
update_image_version(image_name, params::Dict{String,<:Any})
Updates the properties of a SageMaker image version.
# Arguments
- `image_name`: The name of the image.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Alias"`: The alias of the image version.
- `"AliasesToAdd"`: A list of aliases to add.
- `"AliasesToDelete"`: A list of aliases to delete.
- `"Horovod"`: Indicates Horovod compatibility.
- `"JobType"`: Indicates SageMaker job type compatibility. TRAINING: The image version
is compatible with SageMaker training jobs. INFERENCE: The image version is compatible
with SageMaker inference jobs. NOTEBOOK_KERNEL: The image version is compatible with
SageMaker notebook kernels.
- `"MLFramework"`: The machine learning framework vended in the image version.
- `"Processor"`: Indicates CPU or GPU compatibility. CPU: The image version is
compatible with CPU. GPU: The image version is compatible with GPU.
- `"ProgrammingLang"`: The supported programming language and its version.
- `"ReleaseNotes"`: The maintainer description of the image version.
- `"VendorGuidance"`: The availability of the image version specified by the maintainer.
NOT_PROVIDED: The maintainers did not provide a status for image version stability.
STABLE: The image version is stable. TO_BE_ARCHIVED: The image version is set to be
archived. Custom image versions that are set to be archived are automatically archived
after three months. ARCHIVED: The image version is archived. Archived image versions are
not searchable and are no longer actively supported.
- `"Version"`: The version of the image.
"""
function update_image_version(ImageName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"UpdateImageVersion",
Dict{String,Any}("ImageName" => ImageName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_image_version(
ImageName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateImageVersion",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ImageName" => ImageName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_inference_component(inference_component_name)
update_inference_component(inference_component_name, params::Dict{String,<:Any})
Updates an inference component.
# Arguments
- `inference_component_name`: The name of the inference component.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"RuntimeConfig"`: Runtime settings for a model that is deployed with an inference
component.
- `"Specification"`: Details about the resources to deploy with this inference component,
including the model, container, and compute resources.
"""
function update_inference_component(
InferenceComponentName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"UpdateInferenceComponent",
Dict{String,Any}("InferenceComponentName" => InferenceComponentName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_inference_component(
InferenceComponentName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateInferenceComponent",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InferenceComponentName" => InferenceComponentName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_inference_component_runtime_config(desired_runtime_config, inference_component_name)
update_inference_component_runtime_config(desired_runtime_config, inference_component_name, params::Dict{String,<:Any})
Runtime settings for a model that is deployed with an inference component.
# Arguments
- `desired_runtime_config`: Runtime settings for a model that is deployed with an inference
component.
- `inference_component_name`: The name of the inference component to update.
"""
function update_inference_component_runtime_config(
DesiredRuntimeConfig,
InferenceComponentName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateInferenceComponentRuntimeConfig",
Dict{String,Any}(
"DesiredRuntimeConfig" => DesiredRuntimeConfig,
"InferenceComponentName" => InferenceComponentName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_inference_component_runtime_config(
DesiredRuntimeConfig,
InferenceComponentName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateInferenceComponentRuntimeConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DesiredRuntimeConfig" => DesiredRuntimeConfig,
"InferenceComponentName" => InferenceComponentName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_inference_experiment(name)
update_inference_experiment(name, params::Dict{String,<:Any})
Updates an inference experiment that you created. The status of the inference experiment
has to be either Created, Running. For more information on the status of an inference
experiment, see DescribeInferenceExperiment.
# Arguments
- `name`: The name of the inference experiment to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataStorageConfig"`: The Amazon S3 location and configuration for storing inference
request and response data.
- `"Description"`: The description of the inference experiment.
- `"ModelVariants"`: An array of ModelVariantConfig objects. There is one for each
variant, whose infrastructure configuration you want to update.
- `"Schedule"`: The duration for which the inference experiment will run. If the status of
the inference experiment is Created, then you can update both the start and end dates. If
the status of the inference experiment is Running, then you can update only the end date.
- `"ShadowModeConfig"`: The configuration of ShadowMode inference experiment type. Use
this field to specify a production variant which takes all the inference requests, and a
shadow variant to which Amazon SageMaker replicates a percentage of the inference requests.
For the shadow variant also specify the percentage of requests that Amazon SageMaker
replicates.
"""
function update_inference_experiment(
Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"UpdateInferenceExperiment",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_inference_experiment(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"UpdateInferenceExperiment",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_mlflow_tracking_server(tracking_server_name)
update_mlflow_tracking_server(tracking_server_name, params::Dict{String,<:Any})
Updates properties of an existing MLflow Tracking Server.
# Arguments
- `tracking_server_name`: The name of the MLflow Tracking Server to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ArtifactStoreUri"`: The new S3 URI for the general purpose bucket to use as the
artifact store for the MLflow Tracking Server.
- `"AutomaticModelRegistration"`: Whether to enable or disable automatic registration of
new MLflow models to the SageMaker Model Registry. To enable automatic model registration,
set this value to True. To disable automatic model registration, set this value to False.
If not specified, AutomaticModelRegistration defaults to False
- `"TrackingServerSize"`: The new size for the MLflow Tracking Server.
- `"WeeklyMaintenanceWindowStart"`: The new weekly maintenance window start day and time to
update. The maintenance window day and time should be in Coordinated Universal Time (UTC)
24-hour standard time. For example: TUE:03:30.
"""
function update_mlflow_tracking_server(
TrackingServerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"UpdateMlflowTrackingServer",
Dict{String,Any}("TrackingServerName" => TrackingServerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_mlflow_tracking_server(
TrackingServerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateMlflowTrackingServer",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("TrackingServerName" => TrackingServerName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_model_card(model_card_name)
update_model_card(model_card_name, params::Dict{String,<:Any})
Update an Amazon SageMaker Model Card. You cannot update both model card content and model
card status in a single call.
# Arguments
- `model_card_name`: The name or Amazon Resource Name (ARN) of the model card to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Content"`: The updated model card content. Content must be in model card JSON schema
and provided as a string. When updating model card content, be sure to include the full
content and not just updated content.
- `"ModelCardStatus"`: The approval status of the model card within your organization.
Different organizations might have different criteria for model card review and approval.
Draft: The model card is a work in progress. PendingReview: The model card is pending
review. Approved: The model card is approved. Archived: The model card is archived.
No more updates should be made to the model card, but it can still be exported.
"""
function update_model_card(ModelCardName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"UpdateModelCard",
Dict{String,Any}("ModelCardName" => ModelCardName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_model_card(
ModelCardName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateModelCard",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ModelCardName" => ModelCardName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_model_package(model_package_arn)
update_model_package(model_package_arn, params::Dict{String,<:Any})
Updates a versioned model.
# Arguments
- `model_package_arn`: The Amazon Resource Name (ARN) of the model package.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AdditionalInferenceSpecificationsToAdd"`: An array of additional Inference
Specification objects to be added to the existing array additional Inference Specification.
Total number of additional Inference Specifications can not exceed 15. Each additional
Inference Specification specifies artifacts based on this model package that can be used on
inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.
- `"ApprovalDescription"`: A description for the approval status of the model.
- `"CustomerMetadataProperties"`: The metadata properties associated with the model package
versions.
- `"CustomerMetadataPropertiesToRemove"`: The metadata properties associated with the model
package versions to remove.
- `"InferenceSpecification"`: Specifies details about inference jobs that you can run with
models based on this model package, including the following information: The Amazon ECR
paths of containers that contain the inference code and model artifacts. The instance
types that the model package supports for transform jobs and real-time endpoints used for
inference. The input and output content formats that the model package supports for
inference.
- `"ModelApprovalStatus"`: The approval status of the model.
- `"ModelCard"`: The model card associated with the model package. Since
ModelPackageModelCard is tied to a model package, it is a specific usage of a model card
and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard
schema does not include model_package_details, and model_overview is composed of the
model_creator and model_artifact properties. For more information about the model package
model card schema, see Model package model card schema. For more information about the
model card associated with the model package, see View the Details of a Model Version.
- `"SourceUri"`: The URI of the source for the model package.
"""
function update_model_package(
ModelPackageArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"UpdateModelPackage",
Dict{String,Any}("ModelPackageArn" => ModelPackageArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_model_package(
ModelPackageArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateModelPackage",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ModelPackageArn" => ModelPackageArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_monitoring_alert(datapoints_to_alert, evaluation_period, monitoring_alert_name, monitoring_schedule_name)
update_monitoring_alert(datapoints_to_alert, evaluation_period, monitoring_alert_name, monitoring_schedule_name, params::Dict{String,<:Any})
Update the parameters of a model monitor alert.
# Arguments
- `datapoints_to_alert`: Within EvaluationPeriod, how many execution failures will raise an
alert.
- `evaluation_period`: The number of most recent monitoring executions to consider when
evaluating alert status.
- `monitoring_alert_name`: The name of a monitoring alert.
- `monitoring_schedule_name`: The name of a monitoring schedule.
"""
function update_monitoring_alert(
DatapointsToAlert,
EvaluationPeriod,
MonitoringAlertName,
MonitoringScheduleName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateMonitoringAlert",
Dict{String,Any}(
"DatapointsToAlert" => DatapointsToAlert,
"EvaluationPeriod" => EvaluationPeriod,
"MonitoringAlertName" => MonitoringAlertName,
"MonitoringScheduleName" => MonitoringScheduleName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_monitoring_alert(
DatapointsToAlert,
EvaluationPeriod,
MonitoringAlertName,
MonitoringScheduleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateMonitoringAlert",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatapointsToAlert" => DatapointsToAlert,
"EvaluationPeriod" => EvaluationPeriod,
"MonitoringAlertName" => MonitoringAlertName,
"MonitoringScheduleName" => MonitoringScheduleName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_monitoring_schedule(monitoring_schedule_config, monitoring_schedule_name)
update_monitoring_schedule(monitoring_schedule_config, monitoring_schedule_name, params::Dict{String,<:Any})
Updates a previously created schedule.
# Arguments
- `monitoring_schedule_config`: The configuration object that specifies the monitoring
schedule and defines the monitoring job.
- `monitoring_schedule_name`: The name of the monitoring schedule. The name must be unique
within an Amazon Web Services Region within an Amazon Web Services account.
"""
function update_monitoring_schedule(
MonitoringScheduleConfig,
MonitoringScheduleName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateMonitoringSchedule",
Dict{String,Any}(
"MonitoringScheduleConfig" => MonitoringScheduleConfig,
"MonitoringScheduleName" => MonitoringScheduleName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_monitoring_schedule(
MonitoringScheduleConfig,
MonitoringScheduleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateMonitoringSchedule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MonitoringScheduleConfig" => MonitoringScheduleConfig,
"MonitoringScheduleName" => MonitoringScheduleName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_notebook_instance(notebook_instance_name)
update_notebook_instance(notebook_instance_name, params::Dict{String,<:Any})
Updates a notebook instance. NotebookInstance updates include upgrading or downgrading the
ML compute instance used for your notebook instance to accommodate changes in your workload
requirements.
# Arguments
- `notebook_instance_name`: The name of the notebook instance to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceleratorTypes"`: A list of the Elastic Inference (EI) instance types to associate
with this notebook instance. Currently only one EI instance type can be associated with a
notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.
- `"AdditionalCodeRepositories"`: An array of up to three Git repositories to associate
with the notebook instance. These can be either the names of Git repositories stored as
resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit
or in any other Git repository. These repositories are cloned at the same level as the
default repository of your notebook instance. For more information, see Associating Git
Repositories with SageMaker Notebook Instances.
- `"DefaultCodeRepository"`: The Git repository to associate with the notebook instance as
its default code repository. This can be either the name of a Git repository stored as a
resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit
or in any other Git repository. When you open a notebook instance, it opens in the
directory that contains this repository. For more information, see Associating Git
Repositories with SageMaker Notebook Instances.
- `"DisassociateAcceleratorTypes"`: A list of the Elastic Inference (EI) instance types to
remove from this notebook instance. This operation is idempotent. If you specify an
accelerator type that is not associated with the notebook instance when you call this
method, it does not throw an error.
- `"DisassociateAdditionalCodeRepositories"`: A list of names or URLs of the default Git
repositories to remove from this notebook instance. This operation is idempotent. If you
specify a Git repository that is not associated with the notebook instance when you call
this method, it does not throw an error.
- `"DisassociateDefaultCodeRepository"`: The name or URL of the default Git repository to
remove from this notebook instance. This operation is idempotent. If you specify a Git
repository that is not associated with the notebook instance when you call this method, it
does not throw an error.
- `"DisassociateLifecycleConfig"`: Set to true to remove the notebook instance lifecycle
configuration currently associated with the notebook instance. This operation is
idempotent. If you specify a lifecycle configuration that is not associated with the
notebook instance when you call this method, it does not throw an error.
- `"InstanceMetadataServiceConfiguration"`: Information on the IMDS configuration of the
notebook instance
- `"InstanceType"`: The Amazon ML compute instance type.
- `"LifecycleConfigName"`: The name of a lifecycle configuration to associate with the
notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional)
Customize a Notebook Instance.
- `"RoleArn"`: The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to
access the notebook instance. For more information, see SageMaker Roles. To be able to
pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.
- `"RootAccess"`: Whether root access is enabled or disabled for users of the notebook
instance. The default value is Enabled. If you set this to Disabled, users don't have root
access on the notebook instance, but lifecycle configuration scripts still run with root
permissions.
- `"VolumeSizeInGB"`: The size, in GB, of the ML storage volume to attach to the notebook
instance. The default value is 5 GB. ML storage volumes are encrypted, so SageMaker can't
determine the amount of available free space on the volume. Because of this, you can
increase the volume size when you update a notebook instance, but you can't decrease the
volume size. If you want to decrease the size of the ML storage volume in use, create a new
notebook instance with the desired size.
"""
function update_notebook_instance(
NotebookInstanceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"UpdateNotebookInstance",
Dict{String,Any}("NotebookInstanceName" => NotebookInstanceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_notebook_instance(
NotebookInstanceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateNotebookInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("NotebookInstanceName" => NotebookInstanceName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_notebook_instance_lifecycle_config(notebook_instance_lifecycle_config_name)
update_notebook_instance_lifecycle_config(notebook_instance_lifecycle_config_name, params::Dict{String,<:Any})
Updates a notebook instance lifecycle configuration created with the
CreateNotebookInstanceLifecycleConfig API.
# Arguments
- `notebook_instance_lifecycle_config_name`: The name of the lifecycle configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"OnCreate"`: The shell script that runs only once, when you create a notebook instance.
The shell script must be a base64-encoded string.
- `"OnStart"`: The shell script that runs every time you start a notebook instance,
including when you create the notebook instance. The shell script must be a base64-encoded
string.
"""
function update_notebook_instance_lifecycle_config(
NotebookInstanceLifecycleConfigName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"UpdateNotebookInstanceLifecycleConfig",
Dict{String,Any}(
"NotebookInstanceLifecycleConfigName" => NotebookInstanceLifecycleConfigName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_notebook_instance_lifecycle_config(
NotebookInstanceLifecycleConfigName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateNotebookInstanceLifecycleConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"NotebookInstanceLifecycleConfigName" =>
NotebookInstanceLifecycleConfigName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_pipeline(pipeline_name)
update_pipeline(pipeline_name, params::Dict{String,<:Any})
Updates a pipeline.
# Arguments
- `pipeline_name`: The name of the pipeline to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ParallelismConfiguration"`: If specified, it applies to all executions of this pipeline
by default.
- `"PipelineDefinition"`: The JSON pipeline definition.
- `"PipelineDefinitionS3Location"`: The location of the pipeline definition stored in
Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.
- `"PipelineDescription"`: The description of the pipeline.
- `"PipelineDisplayName"`: The display name of the pipeline.
- `"RoleArn"`: The Amazon Resource Name (ARN) that the pipeline uses to execute.
"""
function update_pipeline(PipelineName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"UpdatePipeline",
Dict{String,Any}("PipelineName" => PipelineName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_pipeline(
PipelineName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdatePipeline",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PipelineName" => PipelineName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_pipeline_execution(pipeline_execution_arn)
update_pipeline_execution(pipeline_execution_arn, params::Dict{String,<:Any})
Updates a pipeline execution.
# Arguments
- `pipeline_execution_arn`: The Amazon Resource Name (ARN) of the pipeline execution.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ParallelismConfiguration"`: This configuration, if specified, overrides the parallelism
configuration of the parent pipeline for this specific run.
- `"PipelineExecutionDescription"`: The description of the pipeline execution.
- `"PipelineExecutionDisplayName"`: The display name of the pipeline execution.
"""
function update_pipeline_execution(
PipelineExecutionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"UpdatePipelineExecution",
Dict{String,Any}("PipelineExecutionArn" => PipelineExecutionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_pipeline_execution(
PipelineExecutionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdatePipelineExecution",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("PipelineExecutionArn" => PipelineExecutionArn),
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 machine learning (ML) project that is created from a template that sets up an ML
pipeline from training to deploying an approved model. You must not update a project that
is in use. If you update the ServiceCatalogProvisioningUpdateDetails of a project that is
active or being created, or updated, you may lose resources already created by the project.
# Arguments
- `project_name`: The name of the project.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ProjectDescription"`: The description for the project.
- `"ServiceCatalogProvisioningUpdateDetails"`: The product ID and provisioning artifact ID
to provision a service catalog. The provisioning artifact ID will default to the latest
provisioning artifact ID of the product, if you don't provide the provisioning artifact ID.
For more information, see What is Amazon Web Services Service Catalog.
- `"Tags"`: An array of key-value pairs. You can use tags to categorize your Amazon Web
Services resources in different ways, for example, by purpose, owner, or environment. For
more information, see Tagging Amazon Web Services Resources. In addition, the project must
have tag update constraints set in order to include this parameter in the request. For more
information, see Amazon Web Services Service Catalog Tag Update Constraints.
"""
function update_project(ProjectName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"UpdateProject",
Dict{String,Any}("ProjectName" => 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 sagemaker(
"UpdateProject",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ProjectName" => ProjectName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_space(domain_id, space_name)
update_space(domain_id, space_name, params::Dict{String,<:Any})
Updates the settings of a space.
# Arguments
- `domain_id`: The ID of the associated domain.
- `space_name`: The name of the space.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SpaceDisplayName"`: The name of the space that appears in the Amazon SageMaker Studio
UI.
- `"SpaceSettings"`: A collection of space settings.
"""
function update_space(
DomainId, SpaceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"UpdateSpace",
Dict{String,Any}("DomainId" => DomainId, "SpaceName" => SpaceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_space(
DomainId,
SpaceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateSpace",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DomainId" => DomainId, "SpaceName" => SpaceName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_training_job(training_job_name)
update_training_job(training_job_name, params::Dict{String,<:Any})
Update a model training job to request a new Debugger profiling configuration or to change
warm pool retention length.
# Arguments
- `training_job_name`: The name of a training job to update the Debugger profiling
configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ProfilerConfig"`: Configuration information for Amazon SageMaker Debugger system
monitoring, framework profiling, and storage paths.
- `"ProfilerRuleConfigurations"`: Configuration information for Amazon SageMaker Debugger
rules for profiling system and framework metrics.
- `"RemoteDebugConfig"`: Configuration for remote debugging while the training job is
running. You can update the remote debugging configuration when the SecondaryStatus of the
job is Downloading or Training.To learn more about the remote debugging functionality of
SageMaker, see Access a training container through Amazon Web Services Systems Manager
(SSM) for remote debugging.
- `"ResourceConfig"`: The training job ResourceConfig to update warm pool retention length.
"""
function update_training_job(
TrainingJobName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"UpdateTrainingJob",
Dict{String,Any}("TrainingJobName" => TrainingJobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_training_job(
TrainingJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateTrainingJob",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("TrainingJobName" => TrainingJobName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_trial(trial_name)
update_trial(trial_name, params::Dict{String,<:Any})
Updates the display name of a trial.
# Arguments
- `trial_name`: The name of the trial to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DisplayName"`: The name of the trial as displayed. The name doesn't need to be unique.
If DisplayName isn't specified, TrialName is displayed.
"""
function update_trial(TrialName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"UpdateTrial",
Dict{String,Any}("TrialName" => TrialName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_trial(
TrialName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateTrial",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TrialName" => TrialName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_trial_component(trial_component_name)
update_trial_component(trial_component_name, params::Dict{String,<:Any})
Updates one or more properties of a trial component.
# Arguments
- `trial_component_name`: The name of the component to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DisplayName"`: The name of the component as displayed. The name doesn't need to be
unique. If DisplayName isn't specified, TrialComponentName is displayed.
- `"EndTime"`: When the component ended.
- `"InputArtifacts"`: Replaces all of the component's input artifacts with the specified
artifacts or adds new input artifacts. Existing input artifacts are replaced if the trial
component is updated with an identical input artifact key.
- `"InputArtifactsToRemove"`: The input artifacts to remove from the component.
- `"OutputArtifacts"`: Replaces all of the component's output artifacts with the specified
artifacts or adds new output artifacts. Existing output artifacts are replaced if the trial
component is updated with an identical output artifact key.
- `"OutputArtifactsToRemove"`: The output artifacts to remove from the component.
- `"Parameters"`: Replaces all of the component's hyperparameters with the specified
hyperparameters or add new hyperparameters. Existing hyperparameters are replaced if the
trial component is updated with an identical hyperparameter key.
- `"ParametersToRemove"`: The hyperparameters to remove from the component.
- `"StartTime"`: When the component started.
- `"Status"`: The new status of the component.
"""
function update_trial_component(
TrialComponentName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"UpdateTrialComponent",
Dict{String,Any}("TrialComponentName" => TrialComponentName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_trial_component(
TrialComponentName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateTrialComponent",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("TrialComponentName" => TrialComponentName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_user_profile(domain_id, user_profile_name)
update_user_profile(domain_id, user_profile_name, params::Dict{String,<:Any})
Updates a user profile.
# Arguments
- `domain_id`: The domain ID.
- `user_profile_name`: The user profile name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"UserSettings"`: A collection of settings.
"""
function update_user_profile(
DomainId, UserProfileName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker(
"UpdateUserProfile",
Dict{String,Any}("DomainId" => DomainId, "UserProfileName" => UserProfileName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_user_profile(
DomainId,
UserProfileName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateUserProfile",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DomainId" => DomainId, "UserProfileName" => UserProfileName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_workforce(workforce_name)
update_workforce(workforce_name, params::Dict{String,<:Any})
Use this operation to update your workforce. You can use this operation to require that
workers use specific IP addresses to work on tasks and to update your OpenID Connect (OIDC)
Identity Provider (IdP) workforce configuration. The worker portal is now supported in VPC
and public internet. Use SourceIpConfig to restrict worker access to tasks to a specific
range of IP addresses. You specify allowed IP addresses by creating a list of up to ten
CIDRs. By default, a workforce isn't restricted to specific IP addresses. If you specify a
range of IP addresses, workers who attempt to access tasks using any IP address outside the
specified range are denied and get a Not Found error message on the worker portal. To
restrict access to all the workers in public internet, add the SourceIpConfig CIDR value as
\"10.0.0.0/16\". Amazon SageMaker does not support Source Ip restriction for worker
portals in VPC. Use OidcConfig to update the configuration of a workforce created using
your own OIDC IdP. You can only update your OIDC IdP configuration when there are no work
teams associated with your workforce. You can delete work teams using the DeleteWorkteam
operation. After restricting access to a range of IP addresses or updating your OIDC IdP
configuration with this operation, you can view details about your update workforce using
the DescribeWorkforce operation. This operation only applies to private workforces.
# Arguments
- `workforce_name`: The name of the private workforce that you want to update. You can find
your workforce name by using the ListWorkforces operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"OidcConfig"`: Use this parameter to update your OIDC Identity Provider (IdP)
configuration for a workforce made using your own IdP.
- `"SourceIpConfig"`: A list of one to ten worker IP address ranges (CIDRs) that can be
used to access tasks assigned to this workforce. Maximum: Ten CIDR values
- `"WorkforceVpcConfig"`: Use this parameter to update your VPC configuration for a
workforce.
"""
function update_workforce(WorkforceName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"UpdateWorkforce",
Dict{String,Any}("WorkforceName" => WorkforceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_workforce(
WorkforceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateWorkforce",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("WorkforceName" => WorkforceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_workteam(workteam_name)
update_workteam(workteam_name, params::Dict{String,<:Any})
Updates an existing work team with new member definitions or description.
# Arguments
- `workteam_name`: The name of the work team to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: An updated description for the work team.
- `"MemberDefinitions"`: A list of MemberDefinition objects that contains objects that
identify the workers that make up the work team. Workforces can be created using Amazon
Cognito or your own OIDC Identity Provider (IdP). For private workforces created using
Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC
identity provider (IdP) use OidcMemberDefinition. You should not provide input for both of
these parameters in a single request. For workforces created using Amazon Cognito, private
work teams correspond to Amazon Cognito user groups within the user pool used to create a
workforce. All of the CognitoMemberDefinition objects that make up the member definition
must have the same ClientId and UserPool values. To add a Amazon Cognito user group to an
existing worker pool, see Adding groups to a User Pool. For more information about user
pools, see Amazon Cognito User Pools. For workforces created using your own OIDC IdP,
specify the user groups that you want to include in your private work team in
OidcMemberDefinition by listing those groups in Groups. Be aware that user groups that are
already in the work team must also be listed in Groups when you make this request to remain
on the work team. If you do not include these user groups, they will no longer be
associated with the work team you update.
- `"NotificationConfiguration"`: Configures SNS topic notifications for available or
expiring work items
- `"WorkerAccessConfiguration"`: Use this optional parameter to constrain access to an
Amazon S3 resource based on the IP address using supported IAM global condition keys. The
Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL.
"""
function update_workteam(WorkteamName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker(
"UpdateWorkteam",
Dict{String,Any}("WorkteamName" => WorkteamName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_workteam(
WorkteamName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker(
"UpdateWorkteam",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("WorkteamName" => WorkteamName), 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 | 6940 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: sagemaker_a2i_runtime
using AWS.Compat
using AWS.UUIDs
"""
delete_human_loop(human_loop_name)
delete_human_loop(human_loop_name, params::Dict{String,<:Any})
Deletes the specified human loop for a flow definition. If the human loop was deleted, this
operation will return a ResourceNotFoundException.
# Arguments
- `human_loop_name`: The name of the human loop that you want to delete.
"""
function delete_human_loop(HumanLoopName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker_a2i_runtime(
"DELETE",
"/human-loops/$(HumanLoopName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_human_loop(
HumanLoopName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker_a2i_runtime(
"DELETE",
"/human-loops/$(HumanLoopName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_human_loop(human_loop_name)
describe_human_loop(human_loop_name, params::Dict{String,<:Any})
Returns information about the specified human loop. If the human loop was deleted, this
operation will return a ResourceNotFoundException error.
# Arguments
- `human_loop_name`: The name of the human loop that you want information about.
"""
function describe_human_loop(
HumanLoopName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker_a2i_runtime(
"GET",
"/human-loops/$(HumanLoopName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_human_loop(
HumanLoopName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker_a2i_runtime(
"GET",
"/human-loops/$(HumanLoopName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_human_loops(flow_definition_arn)
list_human_loops(flow_definition_arn, params::Dict{String,<:Any})
Returns information about human loops, given the specified parameters. If a human loop was
deleted, it will not be included.
# Arguments
- `flow_definition_arn`: The Amazon Resource Name (ARN) of a flow definition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationTimeAfter"`: (Optional) The timestamp of the date when you want the human loops
to begin in ISO 8601 format. For example, 2020-02-24.
- `"CreationTimeBefore"`: (Optional) The timestamp of the date before which you want the
human loops to begin in ISO 8601 format. For example, 2020-02-24.
- `"MaxResults"`: The total number of items to return. If the total number of available
items is more than the value specified in MaxResults, then a NextToken is returned in the
output. You can use this token to display the next page of results.
- `"NextToken"`: A token to display the next page of results.
- `"SortOrder"`: Optional. The order for displaying results. Valid values: Ascending and
Descending.
"""
function list_human_loops(
FlowDefinitionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker_a2i_runtime(
"GET",
"/human-loops",
Dict{String,Any}("FlowDefinitionArn" => FlowDefinitionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_human_loops(
FlowDefinitionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker_a2i_runtime(
"GET",
"/human-loops",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("FlowDefinitionArn" => FlowDefinitionArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_human_loop(flow_definition_arn, human_loop_input, human_loop_name)
start_human_loop(flow_definition_arn, human_loop_input, human_loop_name, params::Dict{String,<:Any})
Starts a human loop, provided that at least one activation condition is met.
# Arguments
- `flow_definition_arn`: The Amazon Resource Name (ARN) of the flow definition associated
with this human loop.
- `human_loop_input`: An object that contains information about the human loop.
- `human_loop_name`: The name of the human loop.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataAttributes"`: Attributes of the specified data. Use DataAttributes to specify if
your data is free of personally identifiable information and/or free of adult content.
"""
function start_human_loop(
FlowDefinitionArn,
HumanLoopInput,
HumanLoopName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker_a2i_runtime(
"POST",
"/human-loops",
Dict{String,Any}(
"FlowDefinitionArn" => FlowDefinitionArn,
"HumanLoopInput" => HumanLoopInput,
"HumanLoopName" => HumanLoopName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_human_loop(
FlowDefinitionArn,
HumanLoopInput,
HumanLoopName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker_a2i_runtime(
"POST",
"/human-loops",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FlowDefinitionArn" => FlowDefinitionArn,
"HumanLoopInput" => HumanLoopInput,
"HumanLoopName" => HumanLoopName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_human_loop(human_loop_name)
stop_human_loop(human_loop_name, params::Dict{String,<:Any})
Stops the specified human loop.
# Arguments
- `human_loop_name`: The name of the human loop that you want to stop.
"""
function stop_human_loop(HumanLoopName; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker_a2i_runtime(
"POST",
"/human-loops/stop",
Dict{String,Any}("HumanLoopName" => HumanLoopName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_human_loop(
HumanLoopName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker_a2i_runtime(
"POST",
"/human-loops/stop",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("HumanLoopName" => HumanLoopName), 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 | 4704 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: sagemaker_edge
using AWS.Compat
using AWS.UUIDs
"""
get_deployments(device_fleet_name, device_name)
get_deployments(device_fleet_name, device_name, params::Dict{String,<:Any})
Use to get the active deployments from a device.
# Arguments
- `device_fleet_name`: The name of the fleet that the device belongs to.
- `device_name`: The unique name of the device you want to get the configuration of active
deployments from.
"""
function get_deployments(
DeviceFleetName, DeviceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker_edge(
"POST",
"/GetDeployments",
Dict{String,Any}("DeviceFleetName" => DeviceFleetName, "DeviceName" => DeviceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_deployments(
DeviceFleetName,
DeviceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker_edge(
"POST",
"/GetDeployments",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DeviceFleetName" => DeviceFleetName, "DeviceName" => DeviceName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_device_registration(device_fleet_name, device_name)
get_device_registration(device_fleet_name, device_name, params::Dict{String,<:Any})
Use to check if a device is registered with SageMaker Edge Manager.
# Arguments
- `device_fleet_name`: The name of the fleet that the device belongs to.
- `device_name`: The unique name of the device you want to get the registration status from.
"""
function get_device_registration(
DeviceFleetName, DeviceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker_edge(
"POST",
"/GetDeviceRegistration",
Dict{String,Any}("DeviceFleetName" => DeviceFleetName, "DeviceName" => DeviceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_device_registration(
DeviceFleetName,
DeviceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker_edge(
"POST",
"/GetDeviceRegistration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DeviceFleetName" => DeviceFleetName, "DeviceName" => DeviceName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_heartbeat(agent_version, device_fleet_name, device_name)
send_heartbeat(agent_version, device_fleet_name, device_name, params::Dict{String,<:Any})
Use to get the current status of devices registered on SageMaker Edge Manager.
# Arguments
- `agent_version`: Returns the version of the agent.
- `device_fleet_name`: The name of the fleet that the device belongs to.
- `device_name`: The unique name of the device.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AgentMetrics"`: For internal use. Returns a list of SageMaker Edge Manager agent
operating metrics.
- `"DeploymentResult"`: Returns the result of a deployment on the device.
- `"Models"`: Returns a list of models deployed on the the device.
"""
function send_heartbeat(
AgentVersion,
DeviceFleetName,
DeviceName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker_edge(
"POST",
"/SendHeartbeat",
Dict{String,Any}(
"AgentVersion" => AgentVersion,
"DeviceFleetName" => DeviceFleetName,
"DeviceName" => DeviceName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_heartbeat(
AgentVersion,
DeviceFleetName,
DeviceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker_edge(
"POST",
"/SendHeartbeat",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AgentVersion" => AgentVersion,
"DeviceFleetName" => DeviceFleetName,
"DeviceName" => DeviceName,
),
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 | 10206 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: sagemaker_featurestore_runtime
using AWS.Compat
using AWS.UUIDs
"""
batch_get_record(identifiers)
batch_get_record(identifiers, params::Dict{String,<:Any})
Retrieves a batch of Records from a FeatureGroup.
# Arguments
- `identifiers`: A list containing the name or Amazon Resource Name (ARN) of the
FeatureGroup, the list of names of Features to be retrieved, and the corresponding
RecordIdentifier values as strings.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExpirationTimeResponse"`: Parameter to request ExpiresAt in response. If Enabled,
BatchGetRecord will return the value of ExpiresAt, if it is not null. If Disabled and null,
BatchGetRecord will return null.
"""
function batch_get_record(Identifiers; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker_featurestore_runtime(
"POST",
"/BatchGetRecord",
Dict{String,Any}("Identifiers" => Identifiers);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_record(
Identifiers,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker_featurestore_runtime(
"POST",
"/BatchGetRecord",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Identifiers" => Identifiers), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_record(event_time, feature_group_name, record_identifier_value_as_string)
delete_record(event_time, feature_group_name, record_identifier_value_as_string, params::Dict{String,<:Any})
Deletes a Record from a FeatureGroup in the OnlineStore. Feature Store supports both
SoftDelete and HardDelete. For SoftDelete (default), feature columns are set to null and
the record is no longer retrievable by GetRecord or BatchGetRecord. For HardDelete, the
complete Record is removed from the OnlineStore. In both cases, Feature Store appends the
deleted record marker to the OfflineStore. The deleted record marker is a record with the
same RecordIdentifer as the original, but with is_deleted value set to True, EventTime set
to the delete input EventTime, and other feature values set to null. Note that the
EventTime specified in DeleteRecord should be set later than the EventTime of the existing
record in the OnlineStore for that RecordIdentifer. If it is not, the deletion does not
occur: For SoftDelete, the existing (not deleted) record remains in the OnlineStore,
though the delete record marker is still written to the OfflineStore. HardDelete returns
EventTime: 400 ValidationException to indicate that the delete operation failed. No delete
record marker is written to the OfflineStore. When a record is deleted from the
OnlineStore, the deleted record marker is appended to the OfflineStore. If you have the
Iceberg table format enabled for your OfflineStore, you can remove all history of a record
from the OfflineStore using Amazon Athena or Apache Spark. For information on how to hard
delete a record from the OfflineStore with the Iceberg table format enabled, see Delete
records from the offline store.
# Arguments
- `event_time`: Timestamp indicating when the deletion event occurred. EventTime can be
used to query data at a certain point in time.
- `feature_group_name`: The name or Amazon Resource Name (ARN) of the feature group to
delete the record from.
- `record_identifier_value_as_string`: The value for the RecordIdentifier that uniquely
identifies the record, in string format.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeletionMode"`: The name of the deletion mode for deleting the record. By default, the
deletion mode is set to SoftDelete.
- `"TargetStores"`: A list of stores from which you're deleting the record. By default,
Feature Store deletes the record from all of the stores that you're using for the
FeatureGroup.
"""
function delete_record(
EventTime,
FeatureGroupName,
RecordIdentifierValueAsString;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker_featurestore_runtime(
"DELETE",
"/FeatureGroup/$(FeatureGroupName)",
Dict{String,Any}(
"EventTime" => EventTime,
"RecordIdentifierValueAsString" => RecordIdentifierValueAsString,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_record(
EventTime,
FeatureGroupName,
RecordIdentifierValueAsString,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker_featurestore_runtime(
"DELETE",
"/FeatureGroup/$(FeatureGroupName)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EventTime" => EventTime,
"RecordIdentifierValueAsString" => RecordIdentifierValueAsString,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_record(feature_group_name, record_identifier_value_as_string)
get_record(feature_group_name, record_identifier_value_as_string, params::Dict{String,<:Any})
Use for OnlineStore serving from a FeatureStore. Only the latest records stored in the
OnlineStore can be retrieved. If no Record with RecordIdentifierValue is found, then an
empty result is returned.
# Arguments
- `feature_group_name`: The name or Amazon Resource Name (ARN) of the feature group from
which you want to retrieve a record.
- `record_identifier_value_as_string`: The value that corresponds to RecordIdentifier type
and uniquely identifies the record in the FeatureGroup.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExpirationTimeResponse"`: Parameter to request ExpiresAt in response. If Enabled,
GetRecord will return the value of ExpiresAt, if it is not null. If Disabled and null,
GetRecord will return null.
- `"FeatureName"`: List of names of Features to be retrieved. If not specified, the latest
value for all the Features are returned.
"""
function get_record(
FeatureGroupName,
RecordIdentifierValueAsString;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker_featurestore_runtime(
"GET",
"/FeatureGroup/$(FeatureGroupName)",
Dict{String,Any}("RecordIdentifierValueAsString" => RecordIdentifierValueAsString);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_record(
FeatureGroupName,
RecordIdentifierValueAsString,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker_featurestore_runtime(
"GET",
"/FeatureGroup/$(FeatureGroupName)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"RecordIdentifierValueAsString" => RecordIdentifierValueAsString
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_record(feature_group_name, record)
put_record(feature_group_name, record, params::Dict{String,<:Any})
The PutRecord API is used to ingest a list of Records into your feature group. If a new
record’s EventTime is greater, the new record is written to both the OnlineStore and
OfflineStore. Otherwise, the record is a historic record and it is written only to the
OfflineStore. You can specify the ingestion to be applied to the OnlineStore,
OfflineStore, or both by using the TargetStores request parameter. You can set the
ingested record to expire at a given time to live (TTL) duration after the record’s event
time, ExpiresAt = EventTime + TtlDuration, by specifying the TtlDuration parameter. A
record level TtlDuration is set when specifying the TtlDuration parameter using the
PutRecord API call. If the input TtlDuration is null or unspecified, TtlDuration is set to
the default feature group level TtlDuration. A record level TtlDuration supersedes the
group level TtlDuration.
# Arguments
- `feature_group_name`: The name or Amazon Resource Name (ARN) of the feature group that
you want to insert the record into.
- `record`: List of FeatureValues to be inserted. This will be a full over-write. If you
only want to update few of the feature values, do the following: Use GetRecord to
retrieve the latest record. Update the record returned from GetRecord. Use PutRecord
to update feature values.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"TargetStores"`: A list of stores to which you're adding the record. By default, Feature
Store adds the record to all of the stores that you're using for the FeatureGroup.
- `"TtlDuration"`: Time to live duration, where the record is hard deleted after the
expiration time is reached; ExpiresAt = EventTime + TtlDuration. For information on
HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
"""
function put_record(
FeatureGroupName, Record; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker_featurestore_runtime(
"PUT",
"/FeatureGroup/$(FeatureGroupName)",
Dict{String,Any}("Record" => Record);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_record(
FeatureGroupName,
Record,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker_featurestore_runtime(
"PUT",
"/FeatureGroup/$(FeatureGroupName)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Record" => Record), 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 | 25569 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: sagemaker_geospatial
using AWS.Compat
using AWS.UUIDs
"""
delete_earth_observation_job(arn)
delete_earth_observation_job(arn, params::Dict{String,<:Any})
Use this operation to delete an Earth Observation job.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the Earth Observation job being deleted.
"""
function delete_earth_observation_job(
Arn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker_geospatial(
"DELETE",
"/earth-observation-jobs/$(Arn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_earth_observation_job(
Arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker_geospatial(
"DELETE",
"/earth-observation-jobs/$(Arn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_vector_enrichment_job(arn)
delete_vector_enrichment_job(arn, params::Dict{String,<:Any})
Use this operation to delete a Vector Enrichment job.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the Vector Enrichment job being deleted.
"""
function delete_vector_enrichment_job(
Arn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker_geospatial(
"DELETE",
"/vector-enrichment-jobs/$(Arn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_vector_enrichment_job(
Arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker_geospatial(
"DELETE",
"/vector-enrichment-jobs/$(Arn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
export_earth_observation_job(arn, execution_role_arn, output_config)
export_earth_observation_job(arn, execution_role_arn, output_config, params::Dict{String,<:Any})
Use this operation to export results of an Earth Observation job and optionally source
images used as input to the EOJ to an Amazon S3 location.
# Arguments
- `arn`: The input Amazon Resource Name (ARN) of the Earth Observation job being exported.
- `execution_role_arn`: The Amazon Resource Name (ARN) of the IAM role that you specified
for the job.
- `output_config`: An object containing information about the output file.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: A unique token that guarantees that the call to this API is idempotent.
- `"ExportSourceImages"`: The source images provided to the Earth Observation job being
exported.
"""
function export_earth_observation_job(
Arn, ExecutionRoleArn, OutputConfig; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker_geospatial(
"POST",
"/export-earth-observation-job",
Dict{String,Any}(
"Arn" => Arn,
"ExecutionRoleArn" => ExecutionRoleArn,
"OutputConfig" => OutputConfig,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function export_earth_observation_job(
Arn,
ExecutionRoleArn,
OutputConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker_geospatial(
"POST",
"/export-earth-observation-job",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Arn" => Arn,
"ExecutionRoleArn" => ExecutionRoleArn,
"OutputConfig" => OutputConfig,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
export_vector_enrichment_job(arn, execution_role_arn, output_config)
export_vector_enrichment_job(arn, execution_role_arn, output_config, params::Dict{String,<:Any})
Use this operation to copy results of a Vector Enrichment job to an Amazon S3 location.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the Vector Enrichment job.
- `execution_role_arn`: The Amazon Resource Name (ARN) of the IAM rolewith permission to
upload to the location in OutputConfig.
- `output_config`: Output location information for exporting Vector Enrichment Job results.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: A unique token that guarantees that the call to this API is idempotent.
"""
function export_vector_enrichment_job(
Arn, ExecutionRoleArn, OutputConfig; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker_geospatial(
"POST",
"/export-vector-enrichment-jobs",
Dict{String,Any}(
"Arn" => Arn,
"ExecutionRoleArn" => ExecutionRoleArn,
"OutputConfig" => OutputConfig,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function export_vector_enrichment_job(
Arn,
ExecutionRoleArn,
OutputConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker_geospatial(
"POST",
"/export-vector-enrichment-jobs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Arn" => Arn,
"ExecutionRoleArn" => ExecutionRoleArn,
"OutputConfig" => OutputConfig,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_earth_observation_job(arn)
get_earth_observation_job(arn, params::Dict{String,<:Any})
Get the details for a previously initiated Earth Observation job.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the Earth Observation job.
"""
function get_earth_observation_job(Arn; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker_geospatial(
"GET",
"/earth-observation-jobs/$(Arn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_earth_observation_job(
Arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker_geospatial(
"GET",
"/earth-observation-jobs/$(Arn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_raster_data_collection(arn)
get_raster_data_collection(arn, params::Dict{String,<:Any})
Use this operation to get details of a specific raster data collection.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the raster data collection.
"""
function get_raster_data_collection(Arn; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker_geospatial(
"GET",
"/raster-data-collection/$(Arn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_raster_data_collection(
Arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker_geospatial(
"GET",
"/raster-data-collection/$(Arn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_tile(arn, image_assets, target, x, y, z)
get_tile(arn, image_assets, target, x, y, z, params::Dict{String,<:Any})
Gets a web mercator tile for the given Earth Observation job.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the tile operation.
- `image_assets`: The particular assets or bands to tile.
- `target`: Determines what part of the Earth Observation job to tile. 'INPUT' or 'OUTPUT'
are the valid options.
- `x`: The x coordinate of the tile input.
- `y`: The y coordinate of the tile input.
- `z`: The z coordinate of the tile input.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExecutionRoleArn"`: The Amazon Resource Name (ARN) of the IAM role that you specify.
- `"ImageMask"`: Determines whether or not to return a valid data mask.
- `"OutputDataType"`: The output data type of the tile operation.
- `"OutputFormat"`: The data format of the output tile. The formats include .npy, .png and
.jpg.
- `"PropertyFilters"`: Property filters for the imagery to tile.
- `"TimeRangeFilter"`: Time range filter applied to imagery to find the images to tile.
"""
function get_tile(
Arn, ImageAssets, Target, x, y, z; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker_geospatial(
"GET",
"/tile/$(z)/$(x)/$(y)",
Dict{String,Any}("Arn" => Arn, "ImageAssets" => ImageAssets, "Target" => Target);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_tile(
Arn,
ImageAssets,
Target,
x,
y,
z,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker_geospatial(
"GET",
"/tile/$(z)/$(x)/$(y)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Arn" => Arn, "ImageAssets" => ImageAssets, "Target" => Target
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_vector_enrichment_job(arn)
get_vector_enrichment_job(arn, params::Dict{String,<:Any})
Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the Vector Enrichment job.
"""
function get_vector_enrichment_job(Arn; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker_geospatial(
"GET",
"/vector-enrichment-jobs/$(Arn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_vector_enrichment_job(
Arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker_geospatial(
"GET",
"/vector-enrichment-jobs/$(Arn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_earth_observation_jobs()
list_earth_observation_jobs(params::Dict{String,<:Any})
Use this operation to get a list of the Earth Observation jobs associated with the calling
Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The total number of items to return.
- `"NextToken"`: If the previous response was truncated, you receive this token. Use it in
your next request to receive the next set of results.
- `"SortBy"`: The parameter by which to sort the results.
- `"SortOrder"`: An optional value that specifies whether you want the results sorted in
Ascending or Descending order.
- `"StatusEquals"`: A filter that retrieves only jobs with a specific status.
"""
function list_earth_observation_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker_geospatial(
"POST",
"/list-earth-observation-jobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_earth_observation_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker_geospatial(
"POST",
"/list-earth-observation-jobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_raster_data_collections()
list_raster_data_collections(params::Dict{String,<:Any})
Use this operation to get raster data collections.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The total number of items to return.
- `"NextToken"`: If the previous response was truncated, you receive this token. Use it in
your next request to receive the next set of results.
"""
function list_raster_data_collections(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker_geospatial(
"GET",
"/raster-data-collections";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_raster_data_collections(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker_geospatial(
"GET",
"/raster-data-collections",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Lists the tags attached to the resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource you want to tag.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker_geospatial(
"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 sagemaker_geospatial(
"GET",
"/tags/$(ResourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_vector_enrichment_jobs()
list_vector_enrichment_jobs(params::Dict{String,<:Any})
Retrieves a list of vector enrichment jobs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of items to return.
- `"NextToken"`: If the previous response was truncated, you receive this token. Use it in
your next request to receive the next set of results.
- `"SortBy"`: The parameter by which to sort the results.
- `"SortOrder"`: An optional value that specifies whether you want the results sorted in
Ascending or Descending order.
- `"StatusEquals"`: A filter that retrieves only jobs with a specific status.
"""
function list_vector_enrichment_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker_geospatial(
"POST",
"/list-vector-enrichment-jobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_vector_enrichment_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker_geospatial(
"POST",
"/list-vector-enrichment-jobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_raster_data_collection(arn, raster_data_collection_query)
search_raster_data_collection(arn, raster_data_collection_query, params::Dict{String,<:Any})
Allows you run image query on a specific raster data collection to get a list of the
satellite imagery matching the selected filters.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the raster data collection.
- `raster_data_collection_query`: RasterDataCollectionQuery consisting of
AreaOfInterest(AOI), PropertyFilters and TimeRangeFilterInput used in
SearchRasterDataCollection.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: If the previous response was truncated, you receive this token. Use it in
your next request to receive the next set of results.
"""
function search_raster_data_collection(
Arn, RasterDataCollectionQuery; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker_geospatial(
"POST",
"/search-raster-data-collection",
Dict{String,Any}(
"Arn" => Arn, "RasterDataCollectionQuery" => RasterDataCollectionQuery
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_raster_data_collection(
Arn,
RasterDataCollectionQuery,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker_geospatial(
"POST",
"/search-raster-data-collection",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Arn" => Arn, "RasterDataCollectionQuery" => RasterDataCollectionQuery
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_earth_observation_job(execution_role_arn, input_config, job_config, name)
start_earth_observation_job(execution_role_arn, input_config, job_config, name, params::Dict{String,<:Any})
Use this operation to create an Earth observation job.
# Arguments
- `execution_role_arn`: The Amazon Resource Name (ARN) of the IAM role that you specified
for the job.
- `input_config`: Input configuration information for the Earth Observation job.
- `job_config`: An object containing information about the job configuration.
- `name`: The name of the Earth Observation job.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: A unique token that guarantees that the call to this API is idempotent.
- `"KmsKeyId"`: The Key Management Service key ID for server-side encryption.
- `"Tags"`: Each tag consists of a key and a value.
"""
function start_earth_observation_job(
ExecutionRoleArn,
InputConfig,
JobConfig,
Name;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker_geospatial(
"POST",
"/earth-observation-jobs",
Dict{String,Any}(
"ExecutionRoleArn" => ExecutionRoleArn,
"InputConfig" => InputConfig,
"JobConfig" => JobConfig,
"Name" => Name,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_earth_observation_job(
ExecutionRoleArn,
InputConfig,
JobConfig,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker_geospatial(
"POST",
"/earth-observation-jobs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ExecutionRoleArn" => ExecutionRoleArn,
"InputConfig" => InputConfig,
"JobConfig" => JobConfig,
"Name" => Name,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_vector_enrichment_job(execution_role_arn, input_config, job_config, name)
start_vector_enrichment_job(execution_role_arn, input_config, job_config, name, params::Dict{String,<:Any})
Creates a Vector Enrichment job for the supplied job type. Currently, there are two
supported job types: reverse geocoding and map matching.
# Arguments
- `execution_role_arn`: The Amazon Resource Name (ARN) of the IAM role that you specified
for the job.
- `input_config`: Input configuration information for the Vector Enrichment job.
- `job_config`: An object containing information about the job configuration.
- `name`: The name of the Vector Enrichment job.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: A unique token that guarantees that the call to this API is idempotent.
- `"KmsKeyId"`: The Key Management Service key ID for server-side encryption.
- `"Tags"`: Each tag consists of a key and a value.
"""
function start_vector_enrichment_job(
ExecutionRoleArn,
InputConfig,
JobConfig,
Name;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker_geospatial(
"POST",
"/vector-enrichment-jobs",
Dict{String,Any}(
"ExecutionRoleArn" => ExecutionRoleArn,
"InputConfig" => InputConfig,
"JobConfig" => JobConfig,
"Name" => Name,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_vector_enrichment_job(
ExecutionRoleArn,
InputConfig,
JobConfig,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker_geospatial(
"POST",
"/vector-enrichment-jobs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ExecutionRoleArn" => ExecutionRoleArn,
"InputConfig" => InputConfig,
"JobConfig" => JobConfig,
"Name" => Name,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_earth_observation_job(arn)
stop_earth_observation_job(arn, params::Dict{String,<:Any})
Use this operation to stop an existing earth observation job.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the Earth Observation job being stopped.
"""
function stop_earth_observation_job(Arn; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker_geospatial(
"POST",
"/earth-observation-jobs/stop",
Dict{String,Any}("Arn" => Arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_earth_observation_job(
Arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker_geospatial(
"POST",
"/earth-observation-jobs/stop",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Arn" => Arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_vector_enrichment_job(arn)
stop_vector_enrichment_job(arn, params::Dict{String,<:Any})
Stops the Vector Enrichment job for a given job ARN.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the Vector Enrichment job.
"""
function stop_vector_enrichment_job(Arn; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker_geospatial(
"POST",
"/vector-enrichment-jobs/stop",
Dict{String,Any}("Arn" => Arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_vector_enrichment_job(
Arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker_geospatial(
"POST",
"/vector-enrichment-jobs/stop",
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})
The resource you want to tag.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource you want to tag.
- `tags`: Each tag consists of a key and a value.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return sagemaker_geospatial(
"PUT",
"/tags/$(ResourceArn)",
Dict{String,Any}("Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ResourceArn,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker_geospatial(
"PUT",
"/tags/$(ResourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Tags" => Tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
The resource you want to untag.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource you want to untag.
- `tag_keys`: Keys of the tags you want to remove.
"""
function untag_resource(
ResourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker_geospatial(
"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 sagemaker_geospatial(
"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 | 1551 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: sagemaker_metrics
using AWS.Compat
using AWS.UUIDs
"""
batch_put_metrics(metric_data, trial_component_name)
batch_put_metrics(metric_data, trial_component_name, params::Dict{String,<:Any})
Used to ingest training metrics into SageMaker. These metrics can be visualized in
SageMaker Studio and retrieved with the GetMetrics API.
# Arguments
- `metric_data`: A list of raw metric values to put.
- `trial_component_name`: The name of the Trial Component to associate with the metrics.
"""
function batch_put_metrics(
MetricData, TrialComponentName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker_metrics(
"PUT",
"/BatchPutMetrics",
Dict{String,Any}(
"MetricData" => MetricData, "TrialComponentName" => TrialComponentName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_put_metrics(
MetricData,
TrialComponentName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker_metrics(
"PUT",
"/BatchPutMetrics",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MetricData" => MetricData, "TrialComponentName" => TrialComponentName
),
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 | 14781 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: sagemaker_runtime
using AWS.Compat
using AWS.UUIDs
"""
invoke_endpoint(body, endpoint_name)
invoke_endpoint(body, endpoint_name, params::Dict{String,<:Any})
After you deploy a model into production using Amazon SageMaker hosting services, your
client applications use this API to get inferences from the model hosted at the specified
endpoint. For an overview of Amazon SageMaker, see How It Works. Amazon SageMaker strips
all POST headers except those supported by the API. Amazon SageMaker might add additional
headers. You should not rely on the behavior of headers outside those enumerated in the
request syntax. Calls to InvokeEndpoint are authenticated by using Amazon Web Services
Signature Version 4. For information, see Authenticating Requests (Amazon Web Services
Signature Version 4) in the Amazon S3 API Reference. A customer's model containers must
respond to requests within 60 seconds. The model itself can have a maximum processing time
of 60 seconds before responding to invocations. If your model is going to take 50-60
seconds of processing time, the SDK socket timeout should be set to be 70 seconds.
Endpoints are scoped to an individual account, and are not public. The URL does not contain
the account ID, but Amazon SageMaker determines the account ID from the authentication
token that is supplied by the caller.
# Arguments
- `body`: Provides input data, in the format specified in the ContentType request header.
Amazon SageMaker passes all of the data in the body to the model. For information about
the format of the request body, see Common Data Formats-Inference.
- `endpoint_name`: The name of the endpoint that you specified when you created the
endpoint using the CreateEndpoint API.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Accept"`: The desired MIME type of the inference response from the model container.
- `"Content-Type"`: The MIME type of the input data in the request body.
- `"X-Amzn-SageMaker-Custom-Attributes"`: Provides additional information about a request
for an inference submitted to a model hosted at an Amazon SageMaker endpoint. The
information is an opaque value that is forwarded verbatim. You could use this value, for
example, to provide an ID that you can use to track a request or to provide other metadata
that a service endpoint was programmed to process. The value must consist of no more than
1024 visible US-ASCII characters as specified in Section 3.3.6. Field Value Components of
the Hypertext Transfer Protocol (HTTP/1.1). The code in your model is responsible for
setting or updating any custom attributes in the response. If your code does not set this
value in the response, an empty value is returned. For example, if a custom attribute
represents the trace ID, your model can prepend the custom attribute with Trace ID: in your
post-processing function. This feature is currently supported in the Amazon Web Services
SDKs but not in the Amazon SageMaker Python SDK.
- `"X-Amzn-SageMaker-Enable-Explanations"`: An optional JMESPath expression used to
override the EnableExplanations parameter of the ClarifyExplainerConfig API. See the
EnableExplanations section in the developer guide for more information.
- `"X-Amzn-SageMaker-Inference-Component"`: If the endpoint hosts one or more inference
components, this parameter specifies the name of inference component to invoke.
- `"X-Amzn-SageMaker-Inference-Id"`: If you provide a value, it is added to the captured
data when you enable data capture on the endpoint. For information about data capture, see
Capture Data.
- `"X-Amzn-SageMaker-Target-Container-Hostname"`: If the endpoint hosts multiple containers
and is configured to use direct invocation, this parameter specifies the host name of the
container to invoke.
- `"X-Amzn-SageMaker-Target-Model"`: The model to request for inference when invoking a
multi-model endpoint.
- `"X-Amzn-SageMaker-Target-Variant"`: Specify the production variant to send the inference
request to when invoking an endpoint that is running two or more variants. Note that this
parameter overrides the default behavior for the endpoint, which is to distribute the
invocation traffic based on the variant weights. For information about how to use variant
targeting to perform a/b testing, see Test models in production
"""
function invoke_endpoint(
Body, EndpointName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker_runtime(
"POST",
"/endpoints/$(EndpointName)/invocations",
Dict{String,Any}("Body" => Body);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function invoke_endpoint(
Body,
EndpointName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker_runtime(
"POST",
"/endpoints/$(EndpointName)/invocations",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Body" => Body), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
invoke_endpoint_async(endpoint_name, x-_amzn-_sage_maker-_input_location)
invoke_endpoint_async(endpoint_name, x-_amzn-_sage_maker-_input_location, params::Dict{String,<:Any})
After you deploy a model into production using Amazon SageMaker hosting services, your
client applications use this API to get inferences from the model hosted at the specified
endpoint in an asynchronous manner. Inference requests sent to this API are enqueued for
asynchronous processing. The processing of the inference request may or may not complete
before you receive a response from this API. The response from this API will not contain
the result of the inference request but contain information about where you can locate it.
Amazon SageMaker strips all POST headers except those supported by the API. Amazon
SageMaker might add additional headers. You should not rely on the behavior of headers
outside those enumerated in the request syntax. Calls to InvokeEndpointAsync are
authenticated by using Amazon Web Services Signature Version 4. For information, see
Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon S3 API
Reference.
# Arguments
- `endpoint_name`: The name of the endpoint that you specified when you created the
endpoint using the CreateEndpoint API.
- `x-_amzn-_sage_maker-_input_location`: The Amazon S3 URI where the inference request
payload is stored.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amzn-SageMaker-Accept"`: The desired MIME type of the inference response from the
model container.
- `"X-Amzn-SageMaker-Content-Type"`: The MIME type of the input data in the request body.
- `"X-Amzn-SageMaker-Custom-Attributes"`: Provides additional information about a request
for an inference submitted to a model hosted at an Amazon SageMaker endpoint. The
information is an opaque value that is forwarded verbatim. You could use this value, for
example, to provide an ID that you can use to track a request or to provide other metadata
that a service endpoint was programmed to process. The value must consist of no more than
1024 visible US-ASCII characters as specified in Section 3.3.6. Field Value Components of
the Hypertext Transfer Protocol (HTTP/1.1). The code in your model is responsible for
setting or updating any custom attributes in the response. If your code does not set this
value in the response, an empty value is returned. For example, if a custom attribute
represents the trace ID, your model can prepend the custom attribute with Trace ID: in your
post-processing function. This feature is currently supported in the Amazon Web Services
SDKs but not in the Amazon SageMaker Python SDK.
- `"X-Amzn-SageMaker-Inference-Id"`: The identifier for the inference request. Amazon
SageMaker will generate an identifier for you if none is specified.
- `"X-Amzn-SageMaker-InvocationTimeoutSeconds"`: Maximum amount of time in seconds a
request can be processed before it is marked as expired. The default is 15 minutes, or 900
seconds.
- `"X-Amzn-SageMaker-RequestTTLSeconds"`: Maximum age in seconds a request can be in the
queue before it is marked as expired. The default is 6 hours, or 21,600 seconds.
"""
function invoke_endpoint_async(
EndpointName,
X_Amzn_SageMaker_InputLocation;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker_runtime(
"POST",
"/endpoints/$(EndpointName)/async-invocations",
Dict{String,Any}(
"headers" => Dict{String,Any}(
"X-Amzn-SageMaker-InputLocation" => X_Amzn_SageMaker_InputLocation
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function invoke_endpoint_async(
EndpointName,
X_Amzn_SageMaker_InputLocation,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker_runtime(
"POST",
"/endpoints/$(EndpointName)/async-invocations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}(
"X-Amzn-SageMaker-InputLocation" =>
X_Amzn_SageMaker_InputLocation,
),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
invoke_endpoint_with_response_stream(body, endpoint_name)
invoke_endpoint_with_response_stream(body, endpoint_name, params::Dict{String,<:Any})
Invokes a model at the specified endpoint to return the inference response as a stream. The
inference stream provides the response payload incrementally as a series of parts. Before
you can get an inference stream, you must have access to a model that's deployed using
Amazon SageMaker hosting services, and the container for that model must support inference
streaming. For more information that can help you use this API, see the following sections
in the Amazon SageMaker Developer Guide: For information about how to add streaming
support to a model, see How Containers Serve Requests. For information about how to
process the streaming response, see Invoke real-time endpoints. Before you can use this
operation, your IAM permissions must allow the sagemaker:InvokeEndpoint action. For more
information about Amazon SageMaker actions for IAM policies, see Actions, resources, and
condition keys for Amazon SageMaker in the IAM Service Authorization Reference. Amazon
SageMaker strips all POST headers except those supported by the API. Amazon SageMaker might
add additional headers. You should not rely on the behavior of headers outside those
enumerated in the request syntax. Calls to InvokeEndpointWithResponseStream are
authenticated by using Amazon Web Services Signature Version 4. For information, see
Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon S3 API
Reference.
# Arguments
- `body`: Provides input data, in the format specified in the ContentType request header.
Amazon SageMaker passes all of the data in the body to the model. For information about
the format of the request body, see Common Data Formats-Inference.
- `endpoint_name`: The name of the endpoint that you specified when you created the
endpoint using the CreateEndpoint API.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Content-Type"`: The MIME type of the input data in the request body.
- `"X-Amzn-SageMaker-Accept"`: The desired MIME type of the inference response from the
model container.
- `"X-Amzn-SageMaker-Custom-Attributes"`: Provides additional information about a request
for an inference submitted to a model hosted at an Amazon SageMaker endpoint. The
information is an opaque value that is forwarded verbatim. You could use this value, for
example, to provide an ID that you can use to track a request or to provide other metadata
that a service endpoint was programmed to process. The value must consist of no more than
1024 visible US-ASCII characters as specified in Section 3.3.6. Field Value Components of
the Hypertext Transfer Protocol (HTTP/1.1). The code in your model is responsible for
setting or updating any custom attributes in the response. If your code does not set this
value in the response, an empty value is returned. For example, if a custom attribute
represents the trace ID, your model can prepend the custom attribute with Trace ID: in your
post-processing function. This feature is currently supported in the Amazon Web Services
SDKs but not in the Amazon SageMaker Python SDK.
- `"X-Amzn-SageMaker-Inference-Component"`: If the endpoint hosts one or more inference
components, this parameter specifies the name of inference component to invoke for a
streaming response.
- `"X-Amzn-SageMaker-Inference-Id"`: An identifier that you assign to your request.
- `"X-Amzn-SageMaker-Target-Container-Hostname"`: If the endpoint hosts multiple containers
and is configured to use direct invocation, this parameter specifies the host name of the
container to invoke.
- `"X-Amzn-SageMaker-Target-Variant"`: Specify the production variant to send the inference
request to when invoking an endpoint that is running two or more variants. Note that this
parameter overrides the default behavior for the endpoint, which is to distribute the
invocation traffic based on the variant weights. For information about how to use variant
targeting to perform a/b testing, see Test models in production
"""
function invoke_endpoint_with_response_stream(
Body, EndpointName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sagemaker_runtime(
"POST",
"/endpoints/$(EndpointName)/invocations-response-stream",
Dict{String,Any}("Body" => Body);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function invoke_endpoint_with_response_stream(
Body,
EndpointName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sagemaker_runtime(
"POST",
"/endpoints/$(EndpointName)/invocations-response-stream",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Body" => Body), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 13619 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: savingsplans
using AWS.Compat
using AWS.UUIDs
"""
create_savings_plan(commitment, savings_plan_offering_id)
create_savings_plan(commitment, savings_plan_offering_id, params::Dict{String,<:Any})
Creates a Savings Plan.
# Arguments
- `commitment`: The hourly commitment, in the same currency of the savingsPlanOfferingId.
This is a value between 0.001 and 1 million. You cannot specify more than five digits after
the decimal point.
- `savings_plan_offering_id`: The ID of the offering.
# 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.
- `"purchaseTime"`: The purchase time of the Savings Plan in UTC format
(YYYY-MM-DDTHH:MM:SSZ).
- `"tags"`: One or more tags.
- `"upfrontPaymentAmount"`: The up-front payment amount. This is a whole number between 50
and 99 percent of the total value of the Savings Plan. This parameter is only supported if
the payment option is Partial Upfront.
"""
function create_savings_plan(
commitment, savingsPlanOfferingId; aws_config::AbstractAWSConfig=global_aws_config()
)
return savingsplans(
"POST",
"/CreateSavingsPlan",
Dict{String,Any}(
"commitment" => commitment,
"savingsPlanOfferingId" => savingsPlanOfferingId,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_savings_plan(
commitment,
savingsPlanOfferingId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return savingsplans(
"POST",
"/CreateSavingsPlan",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"commitment" => commitment,
"savingsPlanOfferingId" => savingsPlanOfferingId,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_queued_savings_plan(savings_plan_id)
delete_queued_savings_plan(savings_plan_id, params::Dict{String,<:Any})
Deletes the queued purchase for the specified Savings Plan.
# Arguments
- `savings_plan_id`: The ID of the Savings Plan.
"""
function delete_queued_savings_plan(
savingsPlanId; aws_config::AbstractAWSConfig=global_aws_config()
)
return savingsplans(
"POST",
"/DeleteQueuedSavingsPlan",
Dict{String,Any}("savingsPlanId" => savingsPlanId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_queued_savings_plan(
savingsPlanId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return savingsplans(
"POST",
"/DeleteQueuedSavingsPlan",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("savingsPlanId" => savingsPlanId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_savings_plan_rates(savings_plan_id)
describe_savings_plan_rates(savings_plan_id, params::Dict{String,<:Any})
Describes the rates for the specified Savings Plan.
# Arguments
- `savings_plan_id`: The ID of the Savings Plan.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: The filters.
- `"maxResults"`: The maximum number of results to return with a single call. To retrieve
additional results, make another call with the returned token value.
- `"nextToken"`: The token for the next page of results.
"""
function describe_savings_plan_rates(
savingsPlanId; aws_config::AbstractAWSConfig=global_aws_config()
)
return savingsplans(
"POST",
"/DescribeSavingsPlanRates",
Dict{String,Any}("savingsPlanId" => savingsPlanId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_savings_plan_rates(
savingsPlanId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return savingsplans(
"POST",
"/DescribeSavingsPlanRates",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("savingsPlanId" => savingsPlanId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_savings_plans()
describe_savings_plans(params::Dict{String,<:Any})
Describes the specified Savings Plans.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: The filters.
- `"maxResults"`: The maximum number of results to return with a single call. To retrieve
additional results, make another call with the returned token value.
- `"nextToken"`: The token for the next page of results.
- `"savingsPlanArns"`: The Amazon Resource Names (ARN) of the Savings Plans.
- `"savingsPlanIds"`: The IDs of the Savings Plans.
- `"states"`: The current states of the Savings Plans.
"""
function describe_savings_plans(; aws_config::AbstractAWSConfig=global_aws_config())
return savingsplans(
"POST",
"/DescribeSavingsPlans";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_savings_plans(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return savingsplans(
"POST",
"/DescribeSavingsPlans",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_savings_plans_offering_rates()
describe_savings_plans_offering_rates(params::Dict{String,<:Any})
Describes the offering rates for the specified Savings Plans.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: The filters.
- `"maxResults"`: The maximum number of results to return with a single call. To retrieve
additional results, make another call with the returned token value.
- `"nextToken"`: The token for the next page of results.
- `"operations"`: The specific Amazon Web Services operation for the line item in the
billing report.
- `"products"`: The Amazon Web Services products.
- `"savingsPlanOfferingIds"`: The IDs of the offerings.
- `"savingsPlanPaymentOptions"`: The payment options.
- `"savingsPlanTypes"`: The plan types.
- `"serviceCodes"`: The services.
- `"usageTypes"`: The usage details of the line item in the billing report.
"""
function describe_savings_plans_offering_rates(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return savingsplans(
"POST",
"/DescribeSavingsPlansOfferingRates";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_savings_plans_offering_rates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return savingsplans(
"POST",
"/DescribeSavingsPlansOfferingRates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_savings_plans_offerings()
describe_savings_plans_offerings(params::Dict{String,<:Any})
Describes the offerings for the specified Savings Plans.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"currencies"`: The currencies.
- `"descriptions"`: The descriptions.
- `"durations"`: The duration, in seconds.
- `"filters"`: The filters.
- `"maxResults"`: The maximum number of results to return with a single call. To retrieve
additional results, make another call with the returned token value.
- `"nextToken"`: The token for the next page of results.
- `"offeringIds"`: The IDs of the offerings.
- `"operations"`: The specific Amazon Web Services operation for the line item in the
billing report.
- `"paymentOptions"`: The payment options.
- `"planTypes"`: The plan types.
- `"productType"`: The product type.
- `"serviceCodes"`: The services.
- `"usageTypes"`: The usage details of the line item in the billing report.
"""
function describe_savings_plans_offerings(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return savingsplans(
"POST",
"/DescribeSavingsPlansOfferings";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_savings_plans_offerings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return savingsplans(
"POST",
"/DescribeSavingsPlansOfferings",
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 savingsplans(
"POST",
"/ListTagsForResource",
Dict{String,Any}("resourceArn" => resourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return savingsplans(
"POST",
"/ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
return_savings_plan(savings_plan_id)
return_savings_plan(savings_plan_id, params::Dict{String,<:Any})
Returns the specified Savings Plan.
# Arguments
- `savings_plan_id`: The ID of the Savings Plan.
# 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.
"""
function return_savings_plan(
savingsPlanId; aws_config::AbstractAWSConfig=global_aws_config()
)
return savingsplans(
"POST",
"/ReturnSavingsPlan",
Dict{String,Any}(
"savingsPlanId" => savingsPlanId, "clientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function return_savings_plan(
savingsPlanId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return savingsplans(
"POST",
"/ReturnSavingsPlan",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"savingsPlanId" => savingsPlanId, "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})
Adds the specified tags to the specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
- `tags`: One or more tags. For example, { \"tags\": {\"key1\":\"value1\",
\"key2\":\"value2\"} }.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return savingsplans(
"POST",
"/TagResource",
Dict{String,Any}("resourceArn" => resourceArn, "tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resourceArn,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return savingsplans(
"POST",
"/TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("resourceArn" => resourceArn, "tags" => tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes 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 savingsplans(
"POST",
"/UntagResource",
Dict{String,Any}("resourceArn" => resourceArn, "tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return savingsplans(
"POST",
"/UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("resourceArn" => resourceArn, "tagKeys" => tagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 21276 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: scheduler
using AWS.Compat
using AWS.UUIDs
"""
create_schedule(flexible_time_window, name, schedule_expression, target)
create_schedule(flexible_time_window, name, schedule_expression, target, params::Dict{String,<:Any})
Creates the specified schedule.
# Arguments
- `flexible_time_window`: Allows you to configure a time window during which EventBridge
Scheduler invokes the schedule.
- `name`: The name of the schedule that you are creating.
- `schedule_expression`: The expression that defines when the schedule runs. The following
formats are supported. at expression - at(yyyy-mm-ddThh:mm:ss) rate expression -
rate(value unit) cron expression - cron(fields) You can use at expressions to
create one-time schedules that invoke a target once, at the time and in the time zone, that
you specify. You can use rate and cron expressions to create recurring schedules.
Rate-based schedules are useful when you want to invoke a target at regular intervals, such
as every 15 minutes or every five days. Cron-based schedules are useful when you want to
invoke a target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day
of the month. A cron expression consists of six fields separated by white spaces:
(minutes hours day_of_month month day_of_week year). A rate expression consists of a
value as a positive integer, and a unit with the following options: minute | minutes | hour
| hours | day | days For more information and examples, see Schedule types on EventBridge
Scheduler in the EventBridge Scheduler User Guide.
- `target`: The schedule's target.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ActionAfterCompletion"`: Specifies the action that EventBridge Scheduler applies to the
schedule after the schedule completes invoking the target.
- `"ClientToken"`: Unique, case-sensitive identifier you provide to ensure the idempotency
of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly
generated token for the request to ensure idempotency.
- `"Description"`: The description you specify for the schedule.
- `"EndDate"`: The date, in UTC, before which the schedule can invoke its target. Depending
on the schedule's recurrence expression, invocations might stop on, or before, the EndDate
you specify. EventBridge Scheduler ignores EndDate for one-time schedules.
- `"GroupName"`: The name of the schedule group to associate with this schedule. If you
omit this, the default schedule group is used.
- `"KmsKeyArn"`: The Amazon Resource Name (ARN) for the customer managed KMS key that
EventBridge Scheduler will use to encrypt and decrypt your data.
- `"ScheduleExpressionTimezone"`: The timezone in which the scheduling expression is
evaluated.
- `"StartDate"`: The date, in UTC, after which the schedule can begin invoking its target.
Depending on the schedule's recurrence expression, invocations might occur on, or after,
the StartDate you specify. EventBridge Scheduler ignores StartDate for one-time schedules.
- `"State"`: Specifies whether the schedule is enabled or disabled.
"""
function create_schedule(
FlexibleTimeWindow,
Name,
ScheduleExpression,
Target;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return scheduler(
"POST",
"/schedules/$(Name)",
Dict{String,Any}(
"FlexibleTimeWindow" => FlexibleTimeWindow,
"ScheduleExpression" => ScheduleExpression,
"Target" => Target,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_schedule(
FlexibleTimeWindow,
Name,
ScheduleExpression,
Target,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return scheduler(
"POST",
"/schedules/$(Name)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FlexibleTimeWindow" => FlexibleTimeWindow,
"ScheduleExpression" => ScheduleExpression,
"Target" => Target,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_schedule_group(name)
create_schedule_group(name, params::Dict{String,<:Any})
Creates the specified schedule group.
# Arguments
- `name`: The name of the schedule group that you are creating.
# 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, EventBridge Scheduler uses a randomly
generated token for the request to ensure idempotency.
- `"Tags"`: The list of tags to associate with the schedule group.
"""
function create_schedule_group(Name; aws_config::AbstractAWSConfig=global_aws_config())
return scheduler(
"POST",
"/schedule-groups/$(Name)",
Dict{String,Any}("ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_schedule_group(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return scheduler(
"POST",
"/schedule-groups/$(Name)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_schedule(name)
delete_schedule(name, params::Dict{String,<:Any})
Deletes the specified schedule.
# Arguments
- `name`: The name of the schedule to delete.
# 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, EventBridge Scheduler uses a randomly
generated token for the request to ensure idempotency.
- `"groupName"`: The name of the schedule group associated with this schedule. If you omit
this, the default schedule group is used.
"""
function delete_schedule(Name; aws_config::AbstractAWSConfig=global_aws_config())
return scheduler(
"DELETE",
"/schedules/$(Name)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_schedule(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return scheduler(
"DELETE",
"/schedules/$(Name)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_schedule_group(name)
delete_schedule_group(name, params::Dict{String,<:Any})
Deletes the specified schedule group. Deleting a schedule group results in EventBridge
Scheduler deleting all schedules associated with the group. When you delete a group, it
remains in a DELETING state until all of its associated schedules are deleted. Schedules
associated with the group that are set to run while the schedule group is in the process of
being deleted might continue to invoke their targets until the schedule group and its
associated schedules are deleted. This operation is eventually consistent.
# Arguments
- `name`: The name of the schedule group to delete.
# 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, EventBridge Scheduler uses a randomly
generated token for the request to ensure idempotency.
"""
function delete_schedule_group(Name; aws_config::AbstractAWSConfig=global_aws_config())
return scheduler(
"DELETE",
"/schedule-groups/$(Name)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_schedule_group(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return scheduler(
"DELETE",
"/schedule-groups/$(Name)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_schedule(name)
get_schedule(name, params::Dict{String,<:Any})
Retrieves the specified schedule.
# Arguments
- `name`: The name of the schedule to retrieve.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"groupName"`: The name of the schedule group associated with this schedule. If you omit
this, EventBridge Scheduler assumes that the schedule is associated with the default group.
"""
function get_schedule(Name; aws_config::AbstractAWSConfig=global_aws_config())
return scheduler(
"GET", "/schedules/$(Name)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_schedule(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return scheduler(
"GET",
"/schedules/$(Name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_schedule_group(name)
get_schedule_group(name, params::Dict{String,<:Any})
Retrieves the specified schedule group.
# Arguments
- `name`: The name of the schedule group to retrieve.
"""
function get_schedule_group(Name; aws_config::AbstractAWSConfig=global_aws_config())
return scheduler(
"GET",
"/schedule-groups/$(Name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_schedule_group(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return scheduler(
"GET",
"/schedule-groups/$(Name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_schedule_groups()
list_schedule_groups(params::Dict{String,<:Any})
Returns a paginated list of your schedule groups.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: If specified, 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"`: The name prefix that you can use to return a filtered list of your
schedule groups.
- `"NextToken"`: The token returned by a previous call to retrieve the next set of results.
"""
function list_schedule_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return scheduler(
"GET", "/schedule-groups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_schedule_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return scheduler(
"GET",
"/schedule-groups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_schedules()
list_schedules(params::Dict{String,<:Any})
Returns a paginated list of your EventBridge Scheduler schedules.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: If specified, 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"`: Schedule name prefix to return the filtered list of resources.
- `"NextToken"`: The token returned by a previous call to retrieve the next set of results.
- `"ScheduleGroup"`: If specified, only lists the schedules whose associated schedule group
matches the given filter.
- `"State"`: If specified, only lists the schedules whose current state matches the given
filter.
"""
function list_schedules(; aws_config::AbstractAWSConfig=global_aws_config())
return scheduler(
"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 scheduler(
"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 the tags associated with the Scheduler resource.
# Arguments
- `resource_arn`: The ARN of the EventBridge Scheduler resource for which you want to view
tags.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return scheduler(
"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 scheduler(
"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})
Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource.
You can only assign tags to schedule groups.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the schedule group that you are adding
tags to.
- `tags`: The list of tags to associate with the schedule group.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return scheduler(
"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 scheduler(
"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 EventBridge Scheduler schedule group.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the schedule group 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 scheduler(
"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 scheduler(
"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_schedule(flexible_time_window, name, schedule_expression, target)
update_schedule(flexible_time_window, name, schedule_expression, target, params::Dict{String,<:Any})
Updates the specified schedule. When you call UpdateSchedule, EventBridge Scheduler uses
all values, including empty values, specified in the request and overrides the existing
schedule. This is by design. This means that if you do not set an optional field in your
request, that field will be set to its system-default value after the update. Before
calling this operation, we recommend that you call the GetSchedule API operation and make a
note of all optional parameters for your UpdateSchedule call.
# Arguments
- `flexible_time_window`: Allows you to configure a time window during which EventBridge
Scheduler invokes the schedule.
- `name`: The name of the schedule that you are updating.
- `schedule_expression`: The expression that defines when the schedule runs. The following
formats are supported. at expression - at(yyyy-mm-ddThh:mm:ss) rate expression -
rate(value unit) cron expression - cron(fields) You can use at expressions to
create one-time schedules that invoke a target once, at the time and in the time zone, that
you specify. You can use rate and cron expressions to create recurring schedules.
Rate-based schedules are useful when you want to invoke a target at regular intervals, such
as every 15 minutes or every five days. Cron-based schedules are useful when you want to
invoke a target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day
of the month. A cron expression consists of six fields separated by white spaces:
(minutes hours day_of_month month day_of_week year). A rate expression consists of a
value as a positive integer, and a unit with the following options: minute | minutes | hour
| hours | day | days For more information and examples, see Schedule types on EventBridge
Scheduler in the EventBridge Scheduler User Guide.
- `target`: The schedule target. You can use this operation to change the target that your
schedule invokes.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ActionAfterCompletion"`: Specifies the action that EventBridge Scheduler applies to the
schedule after the schedule completes invoking the target.
- `"ClientToken"`: Unique, case-sensitive identifier you provide to ensure the idempotency
of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly
generated token for the request to ensure idempotency.
- `"Description"`: The description you specify for the schedule.
- `"EndDate"`: The date, in UTC, before which the schedule can invoke its target. Depending
on the schedule's recurrence expression, invocations might stop on, or before, the EndDate
you specify. EventBridge Scheduler ignores EndDate for one-time schedules.
- `"GroupName"`: The name of the schedule group with which the schedule is associated. You
must provide this value in order for EventBridge Scheduler to find the schedule you want to
update. If you omit this value, EventBridge Scheduler assumes the group is associated to
the default group.
- `"KmsKeyArn"`: The ARN for the customer managed KMS key that that you want EventBridge
Scheduler to use to encrypt and decrypt your data.
- `"ScheduleExpressionTimezone"`: The timezone in which the scheduling expression is
evaluated.
- `"StartDate"`: The date, in UTC, after which the schedule can begin invoking its target.
Depending on the schedule's recurrence expression, invocations might occur on, or after,
the StartDate you specify. EventBridge Scheduler ignores StartDate for one-time schedules.
- `"State"`: Specifies whether the schedule is enabled or disabled.
"""
function update_schedule(
FlexibleTimeWindow,
Name,
ScheduleExpression,
Target;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return scheduler(
"PUT",
"/schedules/$(Name)",
Dict{String,Any}(
"FlexibleTimeWindow" => FlexibleTimeWindow,
"ScheduleExpression" => ScheduleExpression,
"Target" => Target,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_schedule(
FlexibleTimeWindow,
Name,
ScheduleExpression,
Target,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return scheduler(
"PUT",
"/schedules/$(Name)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FlexibleTimeWindow" => FlexibleTimeWindow,
"ScheduleExpression" => ScheduleExpression,
"Target" => Target,
"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 | 32669 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: schemas
using AWS.Compat
using AWS.UUIDs
"""
create_discoverer(source_arn)
create_discoverer(source_arn, params::Dict{String,<:Any})
Creates a discoverer.
# Arguments
- `source_arn`: The ARN of the event bus.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CrossAccount"`: Support discovery of schemas in events sent to the bus from another
account. (default: true).
- `"Description"`: A description for the discoverer.
- `"tags"`: Tags associated with the resource.
"""
function create_discoverer(SourceArn; aws_config::AbstractAWSConfig=global_aws_config())
return schemas(
"POST",
"/v1/discoverers",
Dict{String,Any}("SourceArn" => SourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_discoverer(
SourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return schemas(
"POST",
"/v1/discoverers",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SourceArn" => SourceArn), 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 registry.
# Arguments
- `registry_name`: The name of the registry.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the registry to be created.
- `"tags"`: Tags to associate with the registry.
"""
function create_registry(registryName; aws_config::AbstractAWSConfig=global_aws_config())
return schemas(
"POST",
"/v1/registries/name/$(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 schemas(
"POST",
"/v1/registries/name/$(registryName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_schema(content, type, registry_name, schema_name)
create_schema(content, type, registry_name, schema_name, params::Dict{String,<:Any})
Creates a schema definition. Inactive schemas will be deleted after two years.
# Arguments
- `content`: The source of the schema definition.
- `type`: The type of schema.
- `registry_name`: The name of the registry.
- `schema_name`: The name of the schema.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the schema.
- `"tags"`: Tags associated with the schema.
"""
function create_schema(
Content,
Type,
registryName,
schemaName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return schemas(
"POST",
"/v1/registries/name/$(registryName)/schemas/name/$(schemaName)",
Dict{String,Any}("Content" => Content, "Type" => Type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_schema(
Content,
Type,
registryName,
schemaName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return schemas(
"POST",
"/v1/registries/name/$(registryName)/schemas/name/$(schemaName)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Content" => Content, "Type" => Type), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_discoverer(discoverer_id)
delete_discoverer(discoverer_id, params::Dict{String,<:Any})
Deletes a discoverer.
# Arguments
- `discoverer_id`: The ID of the discoverer.
"""
function delete_discoverer(discovererId; aws_config::AbstractAWSConfig=global_aws_config())
return schemas(
"DELETE",
"/v1/discoverers/id/$(discovererId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_discoverer(
discovererId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return schemas(
"DELETE",
"/v1/discoverers/id/$(discovererId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_registry(registry_name)
delete_registry(registry_name, params::Dict{String,<:Any})
Deletes a Registry.
# Arguments
- `registry_name`: The name of the registry.
"""
function delete_registry(registryName; aws_config::AbstractAWSConfig=global_aws_config())
return schemas(
"DELETE",
"/v1/registries/name/$(registryName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_registry(
registryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return schemas(
"DELETE",
"/v1/registries/name/$(registryName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_resource_policy()
delete_resource_policy(params::Dict{String,<:Any})
Delete the resource-based policy attached to the specified registry.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"registryName"`: The name of the registry.
"""
function delete_resource_policy(; aws_config::AbstractAWSConfig=global_aws_config())
return schemas(
"DELETE", "/v1/policy"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_resource_policy(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return schemas(
"DELETE",
"/v1/policy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_schema(registry_name, schema_name)
delete_schema(registry_name, schema_name, params::Dict{String,<:Any})
Delete a schema definition.
# Arguments
- `registry_name`: The name of the registry.
- `schema_name`: The name of the schema.
"""
function delete_schema(
registryName, schemaName; aws_config::AbstractAWSConfig=global_aws_config()
)
return schemas(
"DELETE",
"/v1/registries/name/$(registryName)/schemas/name/$(schemaName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_schema(
registryName,
schemaName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return schemas(
"DELETE",
"/v1/registries/name/$(registryName)/schemas/name/$(schemaName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_schema_version(registry_name, schema_name, schema_version)
delete_schema_version(registry_name, schema_name, schema_version, params::Dict{String,<:Any})
Delete the schema version definition
# Arguments
- `registry_name`: The name of the registry.
- `schema_name`: The name of the schema.
- `schema_version`: The version number of the schema
"""
function delete_schema_version(
registryName,
schemaName,
schemaVersion;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return schemas(
"DELETE",
"/v1/registries/name/$(registryName)/schemas/name/$(schemaName)/version/$(schemaVersion)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_schema_version(
registryName,
schemaName,
schemaVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return schemas(
"DELETE",
"/v1/registries/name/$(registryName)/schemas/name/$(schemaName)/version/$(schemaVersion)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_code_binding(language, registry_name, schema_name)
describe_code_binding(language, registry_name, schema_name, params::Dict{String,<:Any})
Describe the code binding URI.
# Arguments
- `language`: The language of the code binding.
- `registry_name`: The name of the registry.
- `schema_name`: The name of the schema.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"schemaVersion"`: Specifying this limits the results to only this schema version.
"""
function describe_code_binding(
language, registryName, schemaName; aws_config::AbstractAWSConfig=global_aws_config()
)
return schemas(
"GET",
"/v1/registries/name/$(registryName)/schemas/name/$(schemaName)/language/$(language)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_code_binding(
language,
registryName,
schemaName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return schemas(
"GET",
"/v1/registries/name/$(registryName)/schemas/name/$(schemaName)/language/$(language)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_discoverer(discoverer_id)
describe_discoverer(discoverer_id, params::Dict{String,<:Any})
Describes the discoverer.
# Arguments
- `discoverer_id`: The ID of the discoverer.
"""
function describe_discoverer(
discovererId; aws_config::AbstractAWSConfig=global_aws_config()
)
return schemas(
"GET",
"/v1/discoverers/id/$(discovererId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_discoverer(
discovererId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return schemas(
"GET",
"/v1/discoverers/id/$(discovererId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_registry(registry_name)
describe_registry(registry_name, params::Dict{String,<:Any})
Describes the registry.
# Arguments
- `registry_name`: The name of the registry.
"""
function describe_registry(registryName; aws_config::AbstractAWSConfig=global_aws_config())
return schemas(
"GET",
"/v1/registries/name/$(registryName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_registry(
registryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return schemas(
"GET",
"/v1/registries/name/$(registryName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_schema(registry_name, schema_name)
describe_schema(registry_name, schema_name, params::Dict{String,<:Any})
Retrieve the schema definition.
# Arguments
- `registry_name`: The name of the registry.
- `schema_name`: The name of the schema.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"schemaVersion"`: Specifying this limits the results to only this schema version.
"""
function describe_schema(
registryName, schemaName; aws_config::AbstractAWSConfig=global_aws_config()
)
return schemas(
"GET",
"/v1/registries/name/$(registryName)/schemas/name/$(schemaName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_schema(
registryName,
schemaName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return schemas(
"GET",
"/v1/registries/name/$(registryName)/schemas/name/$(schemaName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
export_schema(registry_name, schema_name, type)
export_schema(registry_name, schema_name, type, params::Dict{String,<:Any})
# Arguments
- `registry_name`: The name of the registry.
- `schema_name`: The name of the schema.
- `type`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"schemaVersion"`: Specifying this limits the results to only this schema version.
"""
function export_schema(
registryName, schemaName, type; aws_config::AbstractAWSConfig=global_aws_config()
)
return schemas(
"GET",
"/v1/registries/name/$(registryName)/schemas/name/$(schemaName)/export",
Dict{String,Any}("type" => type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function export_schema(
registryName,
schemaName,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return schemas(
"GET",
"/v1/registries/name/$(registryName)/schemas/name/$(schemaName)/export",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("type" => type), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_code_binding_source(language, registry_name, schema_name)
get_code_binding_source(language, registry_name, schema_name, params::Dict{String,<:Any})
Get the code binding source URI.
# Arguments
- `language`: The language of the code binding.
- `registry_name`: The name of the registry.
- `schema_name`: The name of the schema.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"schemaVersion"`: Specifying this limits the results to only this schema version.
"""
function get_code_binding_source(
language, registryName, schemaName; aws_config::AbstractAWSConfig=global_aws_config()
)
return schemas(
"GET",
"/v1/registries/name/$(registryName)/schemas/name/$(schemaName)/language/$(language)/source";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_code_binding_source(
language,
registryName,
schemaName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return schemas(
"GET",
"/v1/registries/name/$(registryName)/schemas/name/$(schemaName)/language/$(language)/source",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_discovered_schema(events, type)
get_discovered_schema(events, type, params::Dict{String,<:Any})
Get the discovered schema that was generated based on sampled events.
# Arguments
- `events`: An array of strings where each string is a JSON event. These are the events
that were used to generate the schema. The array includes a single type of event and has a
maximum size of 10 events.
- `type`: The type of event.
"""
function get_discovered_schema(
Events, Type; aws_config::AbstractAWSConfig=global_aws_config()
)
return schemas(
"POST",
"/v1/discover",
Dict{String,Any}("Events" => Events, "Type" => Type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_discovered_schema(
Events,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return schemas(
"POST",
"/v1/discover",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Events" => Events, "Type" => Type), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resource_policy()
get_resource_policy(params::Dict{String,<:Any})
Retrieves the resource-based policy attached to a given registry.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"registryName"`: The name of the registry.
"""
function get_resource_policy(; aws_config::AbstractAWSConfig=global_aws_config())
return schemas(
"GET", "/v1/policy"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_resource_policy(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return schemas(
"GET", "/v1/policy", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_discoverers()
list_discoverers(params::Dict{String,<:Any})
List the discoverers.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"discovererIdPrefix"`: Specifying this limits the results to only those discoverer IDs
that start with the specified prefix.
- `"limit"`:
- `"nextToken"`: The token that specifies the next page of results to return. To request
the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be
shared with other accounts.
- `"sourceArnPrefix"`: Specifying this limits the results to only those ARNs that start
with the specified prefix.
"""
function list_discoverers(; aws_config::AbstractAWSConfig=global_aws_config())
return schemas(
"GET", "/v1/discoverers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_discoverers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return schemas(
"GET",
"/v1/discoverers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_registries()
list_registries(params::Dict{String,<:Any})
List the registries.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"limit"`:
- `"nextToken"`: The token that specifies the next page of results to return. To request
the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be
shared with other accounts.
- `"registryNamePrefix"`: Specifying this limits the results to only those registry names
that start with the specified prefix.
- `"scope"`: Can be set to Local or AWS to limit responses to your custom registries, or
the ones provided by AWS.
"""
function list_registries(; aws_config::AbstractAWSConfig=global_aws_config())
return schemas(
"GET", "/v1/registries"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_registries(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return schemas(
"GET",
"/v1/registries",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_schema_versions(registry_name, schema_name)
list_schema_versions(registry_name, schema_name, params::Dict{String,<:Any})
Provides a list of the schema versions and related information.
# Arguments
- `registry_name`: The name of the registry.
- `schema_name`: The name of the schema.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"limit"`:
- `"nextToken"`: The token that specifies the next page of results to return. To request
the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be
shared with other accounts.
"""
function list_schema_versions(
registryName, schemaName; aws_config::AbstractAWSConfig=global_aws_config()
)
return schemas(
"GET",
"/v1/registries/name/$(registryName)/schemas/name/$(schemaName)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_schema_versions(
registryName,
schemaName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return schemas(
"GET",
"/v1/registries/name/$(registryName)/schemas/name/$(schemaName)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_schemas(registry_name)
list_schemas(registry_name, params::Dict{String,<:Any})
List the schemas.
# Arguments
- `registry_name`: The name of the registry.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"limit"`:
- `"nextToken"`: The token that specifies the next page of results to return. To request
the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be
shared with other accounts.
- `"schemaNamePrefix"`: Specifying this limits the results to only those schema names that
start with the specified prefix.
"""
function list_schemas(registryName; aws_config::AbstractAWSConfig=global_aws_config())
return schemas(
"GET",
"/v1/registries/name/$(registryName)/schemas";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_schemas(
registryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return schemas(
"GET",
"/v1/registries/name/$(registryName)/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})
Get tags for resource.
# Arguments
- `resource-arn`: The ARN of the resource.
"""
function list_tags_for_resource(
resource_arn; aws_config::AbstractAWSConfig=global_aws_config()
)
return schemas(
"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 schemas(
"GET",
"/tags/$(resource-arn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_code_binding(language, registry_name, schema_name)
put_code_binding(language, registry_name, schema_name, params::Dict{String,<:Any})
Put code binding URI
# Arguments
- `language`: The language of the code binding.
- `registry_name`: The name of the registry.
- `schema_name`: The name of the schema.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"schemaVersion"`: Specifying this limits the results to only this schema version.
"""
function put_code_binding(
language, registryName, schemaName; aws_config::AbstractAWSConfig=global_aws_config()
)
return schemas(
"POST",
"/v1/registries/name/$(registryName)/schemas/name/$(schemaName)/language/$(language)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_code_binding(
language,
registryName,
schemaName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return schemas(
"POST",
"/v1/registries/name/$(registryName)/schemas/name/$(schemaName)/language/$(language)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_resource_policy(policy)
put_resource_policy(policy, params::Dict{String,<:Any})
The name of the policy.
# Arguments
- `policy`: The resource-based policy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"RevisionId"`: The revision ID of the policy.
- `"registryName"`: The name of the registry.
"""
function put_resource_policy(Policy; aws_config::AbstractAWSConfig=global_aws_config())
return schemas(
"PUT",
"/v1/policy",
Dict{String,Any}("Policy" => Policy);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_resource_policy(
Policy, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return schemas(
"PUT",
"/v1/policy",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Policy" => Policy), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_schemas(keywords, registry_name)
search_schemas(keywords, registry_name, params::Dict{String,<:Any})
Search the schemas
# Arguments
- `keywords`: Specifying this limits the results to only schemas that include the provided
keywords.
- `registry_name`: The name of the registry.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"limit"`:
- `"nextToken"`: The token that specifies the next page of results to return. To request
the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be
shared with other accounts.
"""
function search_schemas(
keywords, registryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return schemas(
"GET",
"/v1/registries/name/$(registryName)/schemas/search",
Dict{String,Any}("keywords" => keywords);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_schemas(
keywords,
registryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return schemas(
"GET",
"/v1/registries/name/$(registryName)/schemas/search",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("keywords" => keywords), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_discoverer(discoverer_id)
start_discoverer(discoverer_id, params::Dict{String,<:Any})
Starts the discoverer
# Arguments
- `discoverer_id`: The ID of the discoverer.
"""
function start_discoverer(discovererId; aws_config::AbstractAWSConfig=global_aws_config())
return schemas(
"POST",
"/v1/discoverers/id/$(discovererId)/start";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_discoverer(
discovererId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return schemas(
"POST",
"/v1/discoverers/id/$(discovererId)/start",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_discoverer(discoverer_id)
stop_discoverer(discoverer_id, params::Dict{String,<:Any})
Stops the discoverer
# Arguments
- `discoverer_id`: The ID of the discoverer.
"""
function stop_discoverer(discovererId; aws_config::AbstractAWSConfig=global_aws_config())
return schemas(
"POST",
"/v1/discoverers/id/$(discovererId)/stop";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_discoverer(
discovererId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return schemas(
"POST",
"/v1/discoverers/id/$(discovererId)/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})
Add tags to a resource.
# Arguments
- `resource-arn`: The ARN of the resource.
- `tags`: Tags associated with the resource.
"""
function tag_resource(resource_arn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return schemas(
"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 schemas(
"POST",
"/tags/$(resource-arn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tags" => tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource-arn, tag_keys)
untag_resource(resource-arn, tag_keys, params::Dict{String,<:Any})
Removes tags from a resource.
# Arguments
- `resource-arn`: The ARN of the resource.
- `tag_keys`: Keys of key-value pairs.
"""
function untag_resource(
resource_arn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return schemas(
"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 schemas(
"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_discoverer(discoverer_id)
update_discoverer(discoverer_id, params::Dict{String,<:Any})
Updates the discoverer
# Arguments
- `discoverer_id`: The ID of the discoverer.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CrossAccount"`: Support discovery of schemas in events sent to the bus from another
account. (default: true)
- `"Description"`: The description of the discoverer to update.
"""
function update_discoverer(discovererId; aws_config::AbstractAWSConfig=global_aws_config())
return schemas(
"PUT",
"/v1/discoverers/id/$(discovererId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_discoverer(
discovererId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return schemas(
"PUT",
"/v1/discoverers/id/$(discovererId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_registry(registry_name)
update_registry(registry_name, params::Dict{String,<:Any})
Updates a registry.
# Arguments
- `registry_name`: The name of the registry.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description of the registry to update.
"""
function update_registry(registryName; aws_config::AbstractAWSConfig=global_aws_config())
return schemas(
"PUT",
"/v1/registries/name/$(registryName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_registry(
registryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return schemas(
"PUT",
"/v1/registries/name/$(registryName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_schema(registry_name, schema_name)
update_schema(registry_name, schema_name, params::Dict{String,<:Any})
Updates the schema definition Inactive schemas will be deleted after two years.
# Arguments
- `registry_name`: The name of the registry.
- `schema_name`: The name of the schema.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientTokenId"`: The ID of the client token.
- `"Content"`: The source of the schema definition.
- `"Description"`: The description of the schema.
- `"Type"`: The schema type for the events schema.
"""
function update_schema(
registryName, schemaName; aws_config::AbstractAWSConfig=global_aws_config()
)
return schemas(
"PUT",
"/v1/registries/name/$(registryName)/schemas/name/$(schemaName)",
Dict{String,Any}("ClientTokenId" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_schema(
registryName,
schemaName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return schemas(
"PUT",
"/v1/registries/name/$(registryName)/schemas/name/$(schemaName)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClientTokenId" => 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 | 73743 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: secrets_manager
using AWS.Compat
using AWS.UUIDs
"""
batch_get_secret_value()
batch_get_secret_value(params::Dict{String,<:Any})
Retrieves the contents of the encrypted fields SecretString or SecretBinary for up to 20
secrets. To retrieve a single secret, call GetSecretValue. To choose which secrets to
retrieve, you can specify a list of secrets by name or ARN, or you can use filters. If
Secrets Manager encounters errors such as AccessDeniedException while attempting to
retrieve any of the secrets, you can see the errors in Errors in the response. Secrets
Manager generates CloudTrail GetSecretValue log entries for each secret you request when
you call this action. Do not include sensitive information in request parameters because it
might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:BatchGetSecretValue, and you must have
secretsmanager:GetSecretValue for each secret. If you use filters, you must also have
secretsmanager:ListSecrets. If the secrets are encrypted using customer-managed keys
instead of the Amazon Web Services managed key aws/secretsmanager, then you also need
kms:Decrypt permissions for the keys. For more information, see IAM policy actions for
Secrets Manager and Authentication and access control in Secrets Manager.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: The filters to choose which secrets to retrieve. You must include Filters or
SecretIdList, but not both.
- `"MaxResults"`: The number of results to include in the response. If there are more
results available, in the response, Secrets Manager includes NextToken. To get the next
results, call BatchGetSecretValue again with the value from NextToken. To use this
parameter, you must also use the Filters parameter.
- `"NextToken"`: A token that indicates where the output should continue from, if a
previous call did not show all results. To get the next results, call BatchGetSecretValue
again with this value.
- `"SecretIdList"`: The ARN or names of the secrets to retrieve. You must include Filters
or SecretIdList, but not both.
"""
function batch_get_secret_value(; aws_config::AbstractAWSConfig=global_aws_config())
return secrets_manager(
"BatchGetSecretValue"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function batch_get_secret_value(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return secrets_manager(
"BatchGetSecretValue",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_rotate_secret(secret_id)
cancel_rotate_secret(secret_id, params::Dict{String,<:Any})
Turns off automatic rotation, and if a rotation is currently in progress, cancels the
rotation. If you cancel a rotation in progress, it can leave the VersionStage labels in an
unexpected state. You might need to remove the staging label AWSPENDING from the partially
created version. You also need to determine whether to roll back to the previous version of
the secret by moving the staging label AWSCURRENT to the version that has AWSPENDING. To
determine which version has a specific staging label, call ListSecretVersionIds. Then use
UpdateSecretVersionStage to change staging labels. For more information, see How rotation
works. To turn on automatic rotation again, call RotateSecret. Secrets Manager generates a
CloudTrail log entry when you call this action. Do not include sensitive information in
request parameters because it might be logged. For more information, see Logging Secrets
Manager events with CloudTrail. Required permissions: secretsmanager:CancelRotateSecret.
For more information, see IAM policy actions for Secrets Manager and Authentication and
access control in Secrets Manager.
# Arguments
- `secret_id`: The ARN or name of the secret. For an ARN, we recommend that you specify a
complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
"""
function cancel_rotate_secret(SecretId; aws_config::AbstractAWSConfig=global_aws_config())
return secrets_manager(
"CancelRotateSecret",
Dict{String,Any}("SecretId" => SecretId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_rotate_secret(
SecretId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return secrets_manager(
"CancelRotateSecret",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SecretId" => SecretId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_secret(name)
create_secret(name, params::Dict{String,<:Any})
Creates a new secret. A secret can be a password, a set of credentials such as a user name
and password, an OAuth token, or other secret information that you store in an encrypted
form in Secrets Manager. The secret also includes the connection information to access a
database or other service, which Secrets Manager doesn't encrypt. A secret in Secrets
Manager consists of both the protected secret data and the important information needed to
manage the secret. For secrets that use managed rotation, you need to create the secret
through the managing service. For more information, see Secrets Manager secrets managed by
other Amazon Web Services services. For information about creating a secret in the
console, see Create a secret. To create a secret, you can provide the secret value to be
encrypted in either the SecretString parameter or the SecretBinary parameter, but not both.
If you include SecretString or SecretBinary then Secrets Manager creates an initial secret
version and automatically attaches the staging label AWSCURRENT to it. For database
credentials you want to rotate, for Secrets Manager to be able to rotate the secret, you
must make sure the JSON you store in the SecretString matches the JSON structure of a
database secret. If you don't specify an KMS encryption key, Secrets Manager uses the
Amazon Web Services managed key aws/secretsmanager. If this key doesn't already exist in
your account, then Secrets Manager creates it for you automatically. All users and roles in
the Amazon Web Services account automatically have access to use aws/secretsmanager.
Creating aws/secretsmanager can result in a one-time significant delay in returning the
result. If the secret is in a different Amazon Web Services account from the credentials
calling the API, then you can't use aws/secretsmanager to encrypt the secret, and you must
create and use a customer managed KMS key. Secrets Manager generates a CloudTrail log
entry when you call this action. Do not include sensitive information in request parameters
except SecretBinary or SecretString because it might be logged. For more information, see
Logging Secrets Manager events with CloudTrail. Required permissions:
secretsmanager:CreateSecret. If you include tags in the secret, you also need
secretsmanager:TagResource. To add replica Regions, you must also have
secretsmanager:ReplicateSecretToRegions. For more information, see IAM policy actions for
Secrets Manager and Authentication and access control in Secrets Manager. To encrypt the
secret with a KMS key other than aws/secretsmanager, you need kms:GenerateDataKey and
kms:Decrypt permission to the key.
# Arguments
- `name`: The name of the new secret. The secret name can contain ASCII letters, numbers,
and the following characters: /_+=.@- Do not end your secret name with a hyphen followed by
six characters. If you do so, you risk confusion and unexpected results when searching for
a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random
characters after the secret name at the end of the ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AddReplicaRegions"`: A list of Regions and KMS keys to replicate secrets.
- `"ClientRequestToken"`: If you include SecretString or SecretBinary, then Secrets Manager
creates an initial version for the secret, and this parameter specifies the unique
identifier for the new version. If you use the Amazon Web Services CLI or one of the
Amazon Web Services SDKs to call this operation, then you can leave this parameter empty.
The CLI or SDK generates a random UUID for you and includes it as the value for this
parameter in the request. If you generate a raw HTTP request to the Secrets Manager
service endpoint, then you must generate a ClientRequestToken and include it in the
request. This value helps ensure idempotency. Secrets Manager uses this value to prevent
the accidental creation of duplicate versions if there are failures and retries during a
rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your
versions within the specified secret. If the ClientRequestToken value isn't already
associated with a version of the secret then a new version of the secret is created. If
a version with this value already exists and the version SecretString and SecretBinary
values are the same as those in the request, then the request is ignored. If a version
with this value already exists and that version's SecretString and SecretBinary values are
different from those in the request, then the request fails because you cannot modify an
existing version. Instead, use PutSecretValue to create a new version. This value becomes
the VersionId of the new version.
- `"Description"`: The description of the secret.
- `"ForceOverwriteReplicaSecret"`: Specifies whether to overwrite a secret with the same
name in the destination Region. By default, secrets aren't overwritten.
- `"KmsKeyId"`: The ARN, key ID, or alias of the KMS key that Secrets Manager uses to
encrypt the secret value in the secret. An alias is always prefixed by alias/, for example
alias/aws/secretsmanager. For more information, see About aliases. To use a KMS key in a
different account, use the key ARN or the alias ARN. If you don't specify this value, then
Secrets Manager uses the key aws/secretsmanager. If that key doesn't yet exist, then
Secrets Manager creates it for you automatically the first time it encrypts the secret
value. If the secret is in a different Amazon Web Services account from the credentials
calling the API, then you can't use aws/secretsmanager to encrypt the secret, and you must
create and use a customer managed KMS key.
- `"SecretBinary"`: The binary data to encrypt and store in the new version of the secret.
We recommend that you store your binary data in a file and then pass the contents of the
file as a parameter. Either SecretString or SecretBinary must have a value, but not both.
This parameter is not available in the Secrets Manager console. Sensitive: This field
contains sensitive information, so the service does not include it in CloudTrail log
entries. If you create your own log entries, you must also avoid logging the information in
this field.
- `"SecretString"`: The text data to encrypt and store in this new version of the secret.
We recommend you use a JSON structure of key/value pairs for your secret value. Either
SecretString or SecretBinary must have a value, but not both. If you create a secret by
using the Secrets Manager console then Secrets Manager puts the protected secret text in
only the SecretString parameter. The Secrets Manager console stores the information as a
JSON structure of key/value pairs that a Lambda rotation function can parse. Sensitive:
This field contains sensitive information, so the service does not include it in CloudTrail
log entries. If you create your own log entries, you must also avoid logging the
information in this field.
- `"Tags"`: A list of tags to attach to the secret. Each tag is a key and value pair of
strings in a JSON text string, for example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"productio
n\"}] Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a
different tag from one with key \"abc\". If you check tags in permissions policies as part
of your security strategy, then adding or removing a tag can change permissions. If the
completion of this operation would result in you losing your permissions for this secret,
then Secrets Manager blocks the operation and returns an Access Denied error. For more
information, see Control access to secrets using tags and Limit access to identities with
tags that match secrets' tags. For information about how to format a JSON parameter for the
various command line tool environments, see Using JSON for Parameters. If your command-line
tool or SDK requires quotation marks around the parameter, you should use single quotes to
avoid confusion with the double quotes required in the JSON text. For tag quotas and naming
restrictions, see Service quotas for Tagging in the Amazon Web Services General Reference
guide.
"""
function create_secret(Name; aws_config::AbstractAWSConfig=global_aws_config())
return secrets_manager(
"CreateSecret",
Dict{String,Any}("Name" => Name, "ClientRequestToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_secret(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return secrets_manager(
"CreateSecret",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Name" => Name, "ClientRequestToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_resource_policy(secret_id)
delete_resource_policy(secret_id, params::Dict{String,<:Any})
Deletes the resource-based permission policy attached to the secret. To attach a policy to
a secret, use PutResourcePolicy. Secrets Manager generates a CloudTrail log entry when you
call this action. Do not include sensitive information in request parameters because it
might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:DeleteResourcePolicy. For more information, see IAM
policy actions for Secrets Manager and Authentication and access control in Secrets
Manager.
# Arguments
- `secret_id`: The ARN or name of the secret to delete the attached resource-based policy
for. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
See Finding a secret from a partial ARN.
"""
function delete_resource_policy(SecretId; aws_config::AbstractAWSConfig=global_aws_config())
return secrets_manager(
"DeleteResourcePolicy",
Dict{String,Any}("SecretId" => SecretId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_resource_policy(
SecretId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return secrets_manager(
"DeleteResourcePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SecretId" => SecretId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_secret(secret_id)
delete_secret(secret_id, params::Dict{String,<:Any})
Deletes a secret and all of its versions. You can specify a recovery window during which
you can restore the secret. The minimum recovery window is 7 days. The default recovery
window is 30 days. Secrets Manager attaches a DeletionDate stamp to the secret that
specifies the end of the recovery window. At the end of the recovery window, Secrets
Manager deletes the secret permanently. You can't delete a primary secret that is
replicated to other Regions. You must first delete the replicas using
RemoveRegionsFromReplication, and then delete the primary secret. When you delete a
replica, it is deleted immediately. You can't directly delete a version of a secret.
Instead, you remove all staging labels from the version using UpdateSecretVersionStage.
This marks the version as deprecated, and then Secrets Manager can automatically delete the
version in the background. To determine whether an application still uses a secret, you can
create an Amazon CloudWatch alarm to alert you to any attempts to access a secret during
the recovery window. For more information, see Monitor secrets scheduled for deletion.
Secrets Manager performs the permanent secret deletion at the end of the waiting period as
a background task with low priority. There is no guarantee of a specific time after the
recovery window for the permanent delete to occur. At any time before recovery window ends,
you can use RestoreSecret to remove the DeletionDate and cancel the deletion of the secret.
When a secret is scheduled for deletion, you cannot retrieve the secret value. You must
first cancel the deletion with RestoreSecret and then you can retrieve the secret. Secrets
Manager generates a CloudTrail log entry when you call this action. Do not include
sensitive information in request parameters because it might be logged. For more
information, see Logging Secrets Manager events with CloudTrail. Required permissions:
secretsmanager:DeleteSecret. For more information, see IAM policy actions for Secrets
Manager and Authentication and access control in Secrets Manager.
# Arguments
- `secret_id`: The ARN or name of the secret to delete. For an ARN, we recommend that you
specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ForceDeleteWithoutRecovery"`: Specifies whether to delete the secret without any
recovery window. You can't use both this parameter and RecoveryWindowInDays in the same
call. If you don't use either, then by default Secrets Manager uses a 30 day recovery
window. Secrets Manager performs the actual deletion with an asynchronous background
process, so there might be a short delay before the secret is permanently deleted. If you
delete a secret and then immediately create a secret with the same name, use appropriate
back off and retry logic. If you forcibly delete an already deleted or nonexistent secret,
the operation does not return ResourceNotFoundException. Use this parameter with caution.
This parameter causes the operation to skip the normal recovery window before the permanent
deletion that Secrets Manager would normally impose with the RecoveryWindowInDays
parameter. If you delete a secret with the ForceDeleteWithoutRecovery parameter, then you
have no opportunity to recover the secret. You lose the secret permanently.
- `"RecoveryWindowInDays"`: The number of days from 7 to 30 that Secrets Manager waits
before permanently deleting the secret. You can't use both this parameter and
ForceDeleteWithoutRecovery in the same call. If you don't use either, then by default
Secrets Manager uses a 30 day recovery window.
"""
function delete_secret(SecretId; aws_config::AbstractAWSConfig=global_aws_config())
return secrets_manager(
"DeleteSecret",
Dict{String,Any}("SecretId" => SecretId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_secret(
SecretId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return secrets_manager(
"DeleteSecret",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SecretId" => SecretId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_secret(secret_id)
describe_secret(secret_id, params::Dict{String,<:Any})
Retrieves the details of a secret. It does not include the encrypted secret value. Secrets
Manager only returns fields that have a value in the response. Secrets Manager generates a
CloudTrail log entry when you call this action. Do not include sensitive information in
request parameters because it might be logged. For more information, see Logging Secrets
Manager events with CloudTrail. Required permissions: secretsmanager:DescribeSecret. For
more information, see IAM policy actions for Secrets Manager and Authentication and access
control in Secrets Manager.
# Arguments
- `secret_id`: The ARN or name of the secret. For an ARN, we recommend that you specify a
complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
"""
function describe_secret(SecretId; aws_config::AbstractAWSConfig=global_aws_config())
return secrets_manager(
"DescribeSecret",
Dict{String,Any}("SecretId" => SecretId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_secret(
SecretId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return secrets_manager(
"DescribeSecret",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SecretId" => SecretId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_random_password()
get_random_password(params::Dict{String,<:Any})
Generates a random password. We recommend that you specify the maximum length and include
every character type that the system you are generating a password for can support. By
default, Secrets Manager uses uppercase and lowercase letters, numbers, and the following
characters in passwords: !\"#%&'()*+,-./:;<=>?@[]^_`{|}~ Secrets Manager
generates a CloudTrail log entry when you call this action. Required permissions:
secretsmanager:GetRandomPassword. For more information, see IAM policy actions for Secrets
Manager and Authentication and access control in Secrets Manager.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExcludeCharacters"`: A string of the characters that you don't want in the password.
- `"ExcludeLowercase"`: Specifies whether to exclude lowercase letters from the password.
If you don't include this switch, the password can contain lowercase letters.
- `"ExcludeNumbers"`: Specifies whether to exclude numbers from the password. If you don't
include this switch, the password can contain numbers.
- `"ExcludePunctuation"`: Specifies whether to exclude the following punctuation characters
from the password: ! \" # % & ' ( ) * + , - . / : ; < = > ? @ [ ] ^ _ ` { | }
~. If you don't include this switch, the password can contain punctuation.
- `"ExcludeUppercase"`: Specifies whether to exclude uppercase letters from the password.
If you don't include this switch, the password can contain uppercase letters.
- `"IncludeSpace"`: Specifies whether to include the space character. If you include this
switch, the password can contain space characters.
- `"PasswordLength"`: The length of the password. If you don't include this parameter, the
default length is 32 characters.
- `"RequireEachIncludedType"`: Specifies whether to include at least one upper and
lowercase letter, one number, and one punctuation. If you don't include this switch, the
password contains at least one of every character type.
"""
function get_random_password(; aws_config::AbstractAWSConfig=global_aws_config())
return secrets_manager(
"GetRandomPassword"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_random_password(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return secrets_manager(
"GetRandomPassword", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_resource_policy(secret_id)
get_resource_policy(secret_id, params::Dict{String,<:Any})
Retrieves the JSON text of the resource-based policy document attached to the secret. For
more information about permissions policies attached to a secret, see Permissions policies
attached to a secret. Secrets Manager generates a CloudTrail log entry when you call this
action. Do not include sensitive information in request parameters because it might be
logged. For more information, see Logging Secrets Manager events with CloudTrail. Required
permissions: secretsmanager:GetResourcePolicy. For more information, see IAM policy
actions for Secrets Manager and Authentication and access control in Secrets Manager.
# Arguments
- `secret_id`: The ARN or name of the secret to retrieve the attached resource-based policy
for. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
See Finding a secret from a partial ARN.
"""
function get_resource_policy(SecretId; aws_config::AbstractAWSConfig=global_aws_config())
return secrets_manager(
"GetResourcePolicy",
Dict{String,Any}("SecretId" => SecretId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resource_policy(
SecretId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return secrets_manager(
"GetResourcePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SecretId" => SecretId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_secret_value(secret_id)
get_secret_value(secret_id, params::Dict{String,<:Any})
Retrieves the contents of the encrypted fields SecretString or SecretBinary from the
specified version of a secret, whichever contains content. To retrieve the values for a
group of secrets, call BatchGetSecretValue. We recommend that you cache your secret values
by using client-side caching. Caching secrets improves speed and reduces your costs. For
more information, see Cache secrets for your applications. To retrieve the previous version
of a secret, use VersionStage and specify AWSPREVIOUS. To revert to the previous version of
a secret, call UpdateSecretVersionStage. Secrets Manager generates a CloudTrail log entry
when you call this action. Do not include sensitive information in request parameters
because it might be logged. For more information, see Logging Secrets Manager events with
CloudTrail. Required permissions: secretsmanager:GetSecretValue. If the secret is
encrypted using a customer-managed key instead of the Amazon Web Services managed key
aws/secretsmanager, then you also need kms:Decrypt permissions for that key. For more
information, see IAM policy actions for Secrets Manager and Authentication and access
control in Secrets Manager.
# Arguments
- `secret_id`: The ARN or name of the secret to retrieve. To retrieve a secret from another
account, you must use an ARN. For an ARN, we recommend that you specify a complete ARN
rather than a partial ARN. See Finding a secret from a partial ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"VersionId"`: The unique identifier of the version of the secret to retrieve. If you
include both this parameter and VersionStage, the two parameters must refer to the same
secret version. If you don't specify either a VersionStage or VersionId, then Secrets
Manager returns the AWSCURRENT version. This value is typically a UUID-type value with 32
hexadecimal digits.
- `"VersionStage"`: The staging label of the version of the secret to retrieve. Secrets
Manager uses staging labels to keep track of different versions during the rotation
process. If you include both this parameter and VersionId, the two parameters must refer to
the same secret version. If you don't specify either a VersionStage or VersionId, Secrets
Manager returns the AWSCURRENT version.
"""
function get_secret_value(SecretId; aws_config::AbstractAWSConfig=global_aws_config())
return secrets_manager(
"GetSecretValue",
Dict{String,Any}("SecretId" => SecretId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_secret_value(
SecretId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return secrets_manager(
"GetSecretValue",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SecretId" => SecretId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_secret_version_ids(secret_id)
list_secret_version_ids(secret_id, params::Dict{String,<:Any})
Lists the versions of a secret. Secrets Manager uses staging labels to indicate the
different versions of a secret. For more information, see Secrets Manager concepts:
Versions. To list the secrets in the account, use ListSecrets. Secrets Manager generates a
CloudTrail log entry when you call this action. Do not include sensitive information in
request parameters because it might be logged. For more information, see Logging Secrets
Manager events with CloudTrail. Required permissions:
secretsmanager:ListSecretVersionIds. For more information, see IAM policy actions for
Secrets Manager and Authentication and access control in Secrets Manager.
# Arguments
- `secret_id`: The ARN or name of the secret whose versions you want to list. For an ARN,
we recommend that you specify a complete ARN rather than a partial ARN. See Finding a
secret from a partial ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IncludeDeprecated"`: Specifies whether to include versions of secrets that don't have
any staging labels attached to them. Versions without staging labels are considered
deprecated and are subject to deletion by Secrets Manager. By default, versions without
staging labels aren't included.
- `"MaxResults"`: The number of results to include in the response. If there are more
results available, in the response, Secrets Manager includes NextToken. To get the next
results, call ListSecretVersionIds again with the value from NextToken.
- `"NextToken"`: A token that indicates where the output should continue from, if a
previous call did not show all results. To get the next results, call ListSecretVersionIds
again with this value.
"""
function list_secret_version_ids(
SecretId; aws_config::AbstractAWSConfig=global_aws_config()
)
return secrets_manager(
"ListSecretVersionIds",
Dict{String,Any}("SecretId" => SecretId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_secret_version_ids(
SecretId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return secrets_manager(
"ListSecretVersionIds",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SecretId" => SecretId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_secrets()
list_secrets(params::Dict{String,<:Any})
Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account,
not including secrets that are marked for deletion. To see secrets marked for deletion, use
the Secrets Manager console. All Secrets Manager operations are eventually consistent.
ListSecrets might not reflect changes from the last five minutes. You can get more recent
information for a specific secret by calling DescribeSecret. To list the versions of a
secret, use ListSecretVersionIds. To retrieve the values for the secrets, call
BatchGetSecretValue or GetSecretValue. For information about finding secrets in the
console, see Find secrets in Secrets Manager. Secrets Manager generates a CloudTrail log
entry when you call this action. Do not include sensitive information in request parameters
because it might be logged. For more information, see Logging Secrets Manager events with
CloudTrail. Required permissions: secretsmanager:ListSecrets. For more information, see
IAM policy actions for Secrets Manager and Authentication and access control in Secrets
Manager.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: The filters to apply to the list of secrets.
- `"IncludePlannedDeletion"`: Specifies whether to include secrets scheduled for deletion.
By default, secrets scheduled for deletion aren't included.
- `"MaxResults"`: The number of results to include in the response. If there are more
results available, in the response, Secrets Manager includes NextToken. To get the next
results, call ListSecrets again with the value from NextToken.
- `"NextToken"`: A token that indicates where the output should continue from, if a
previous call did not show all results. To get the next results, call ListSecrets again
with this value.
- `"SortOrder"`: Secrets are listed by CreatedDate.
"""
function list_secrets(; aws_config::AbstractAWSConfig=global_aws_config())
return secrets_manager(
"ListSecrets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_secrets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return secrets_manager(
"ListSecrets", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
put_resource_policy(resource_policy, secret_id)
put_resource_policy(resource_policy, secret_id, params::Dict{String,<:Any})
Attaches a resource-based permission policy to a secret. A resource-based policy is
optional. For more information, see Authentication and access control for Secrets Manager
For information about attaching a policy in the console, see Attach a permissions policy to
a secret. Secrets Manager generates a CloudTrail log entry when you call this action. Do
not include sensitive information in request parameters because it might be logged. For
more information, see Logging Secrets Manager events with CloudTrail. Required
permissions: secretsmanager:PutResourcePolicy. For more information, see IAM policy
actions for Secrets Manager and Authentication and access control in Secrets Manager.
# Arguments
- `resource_policy`: A JSON-formatted string for an Amazon Web Services resource-based
policy. For example policies, see Permissions policy examples.
- `secret_id`: The ARN or name of the secret to attach the resource-based policy. For an
ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a
secret from a partial ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BlockPublicPolicy"`: Specifies whether to block resource-based policies that allow
broad access to the secret, for example those that use a wildcard for the principal. By
default, public policies aren't blocked. Resource policy validation and the
BlockPublicPolicy parameter help protect your resources by preventing public access from
being granted through the resource policies that are directly attached to your secrets. In
addition to using these features, carefully inspect the following policies to confirm that
they do not grant public access: Identity-based policies attached to associated Amazon
Web Services principals (for example, IAM roles) Resource-based policies attached to
associated Amazon Web Services resources (for example, Key Management Service (KMS) keys)
To review permissions to your secrets, see Determine who has permissions to your secrets.
"""
function put_resource_policy(
ResourcePolicy, SecretId; aws_config::AbstractAWSConfig=global_aws_config()
)
return secrets_manager(
"PutResourcePolicy",
Dict{String,Any}("ResourcePolicy" => ResourcePolicy, "SecretId" => SecretId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_resource_policy(
ResourcePolicy,
SecretId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return secrets_manager(
"PutResourcePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ResourcePolicy" => ResourcePolicy, "SecretId" => SecretId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_secret_value(secret_id)
put_secret_value(secret_id, params::Dict{String,<:Any})
Creates a new version with a new encrypted secret value and attaches it to the secret. The
version can contain a new SecretString value or a new SecretBinary value. We recommend you
avoid calling PutSecretValue at a sustained rate of more than once every 10 minutes. When
you update the secret value, Secrets Manager creates a new version of the secret. Secrets
Manager removes outdated versions when there are more than 100, but it does not remove
versions created less than 24 hours ago. If you call PutSecretValue more than once every 10
minutes, you create more versions than Secrets Manager removes, and you will reach the
quota for secret versions. You can specify the staging labels to attach to the new version
in VersionStages. If you don't include VersionStages, then Secrets Manager automatically
moves the staging label AWSCURRENT to this version. If this operation creates the first
version for the secret, then Secrets Manager automatically attaches the staging label
AWSCURRENT to it. If this operation moves the staging label AWSCURRENT from another version
to this version, then Secrets Manager also automatically moves the staging label
AWSPREVIOUS to the version that AWSCURRENT was removed from. This operation is idempotent.
If you call this operation with a ClientRequestToken that matches an existing version's
VersionId, and you specify the same secret data, the operation succeeds but does nothing.
However, if the secret data is different, then the operation fails because you can't modify
an existing version; you can only create new ones. Secrets Manager generates a CloudTrail
log entry when you call this action. Do not include sensitive information in request
parameters except SecretBinary, SecretString, or RotationToken because it might be logged.
For more information, see Logging Secrets Manager events with CloudTrail. Required
permissions: secretsmanager:PutSecretValue. For more information, see IAM policy actions
for Secrets Manager and Authentication and access control in Secrets Manager.
# Arguments
- `secret_id`: The ARN or name of the secret to add a new version to. For an ARN, we
recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret
from a partial ARN. If the secret doesn't already exist, use CreateSecret instead.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: A unique identifier for the new version of the secret. If you
use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this
operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID
for you and includes it as the value for this parameter in the request. If you generate a
raw HTTP request to the Secrets Manager service endpoint, then you must generate a
ClientRequestToken and include it in the request. This value helps ensure idempotency.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if
there are failures and retries during a rotation. We recommend that you generate a
UUID-type value to ensure uniqueness of your versions within the specified secret. If
the ClientRequestToken value isn't already associated with a version of the secret then a
new version of the secret is created. If a version with this value already exists and
that version's SecretString or SecretBinary values are the same as those in the request
then the request is ignored. The operation is idempotent. If a version with this value
already exists and the version of the SecretString and SecretBinary values are different
from those in the request, then the request fails because you can't modify a secret
version. You can only create new versions to store new secret values. This value becomes
the VersionId of the new version.
- `"RotationToken"`: A unique identifier that indicates the source of the request. For
cross-account rotation (when you rotate a secret in one account by using a Lambda rotation
function in another account) and the Lambda rotation function assumes an IAM role to call
Secrets Manager, Secrets Manager validates the identity with the rotation token. For more
information, see How rotation works. Sensitive: This field contains sensitive information,
so the service does not include it in CloudTrail log entries. If you create your own log
entries, you must also avoid logging the information in this field.
- `"SecretBinary"`: The binary data to encrypt and store in the new version of the secret.
To use this parameter in the command-line tools, we recommend that you store your binary
data in a file and then pass the contents of the file as a parameter. You must include
SecretBinary or SecretString, but not both. You can't access this value from the Secrets
Manager console. Sensitive: This field contains sensitive information, so the service does
not include it in CloudTrail log entries. If you create your own log entries, you must also
avoid logging the information in this field.
- `"SecretString"`: The text to encrypt and store in the new version of the secret. You
must include SecretBinary or SecretString, but not both. We recommend you create the secret
string as JSON key/value pairs, as shown in the example. Sensitive: This field contains
sensitive information, so the service does not include it in CloudTrail log entries. If you
create your own log entries, you must also avoid logging the information in this field.
- `"VersionStages"`: A list of staging labels to attach to this version of the secret.
Secrets Manager uses staging labels to track versions of a secret through the rotation
process. If you specify a staging label that's already associated with a different version
of the same secret, then Secrets Manager removes the label from the other version and
attaches it to this version. If you specify AWSCURRENT, and it is already attached to
another version, then Secrets Manager also moves the staging label AWSPREVIOUS to the
version that AWSCURRENT was removed from. If you don't include VersionStages, then Secrets
Manager automatically moves the staging label AWSCURRENT to this version.
"""
function put_secret_value(SecretId; aws_config::AbstractAWSConfig=global_aws_config())
return secrets_manager(
"PutSecretValue",
Dict{String,Any}("SecretId" => SecretId, "ClientRequestToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_secret_value(
SecretId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return secrets_manager(
"PutSecretValue",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SecretId" => SecretId, "ClientRequestToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_regions_from_replication(remove_replica_regions, secret_id)
remove_regions_from_replication(remove_replica_regions, secret_id, params::Dict{String,<:Any})
For a secret that is replicated to other Regions, deletes the secret replicas from the
Regions you specify. Secrets Manager generates a CloudTrail log entry when you call this
action. Do not include sensitive information in request parameters because it might be
logged. For more information, see Logging Secrets Manager events with CloudTrail. Required
permissions: secretsmanager:RemoveRegionsFromReplication. For more information, see IAM
policy actions for Secrets Manager and Authentication and access control in Secrets
Manager.
# Arguments
- `remove_replica_regions`: The Regions of the replicas to remove.
- `secret_id`: The ARN or name of the secret.
"""
function remove_regions_from_replication(
RemoveReplicaRegions, SecretId; aws_config::AbstractAWSConfig=global_aws_config()
)
return secrets_manager(
"RemoveRegionsFromReplication",
Dict{String,Any}(
"RemoveReplicaRegions" => RemoveReplicaRegions, "SecretId" => SecretId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_regions_from_replication(
RemoveReplicaRegions,
SecretId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return secrets_manager(
"RemoveRegionsFromReplication",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"RemoveReplicaRegions" => RemoveReplicaRegions, "SecretId" => SecretId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
replicate_secret_to_regions(add_replica_regions, secret_id)
replicate_secret_to_regions(add_replica_regions, secret_id, params::Dict{String,<:Any})
Replicates the secret to a new Regions. See Multi-Region secrets. Secrets Manager generates
a CloudTrail log entry when you call this action. Do not include sensitive information in
request parameters because it might be logged. For more information, see Logging Secrets
Manager events with CloudTrail. Required permissions:
secretsmanager:ReplicateSecretToRegions. If the primary secret is encrypted with a KMS key
other than aws/secretsmanager, you also need kms:Decrypt permission to the key. To encrypt
the replicated secret with a KMS key other than aws/secretsmanager, you need
kms:GenerateDataKey and kms:Encrypt to the key. For more information, see IAM policy
actions for Secrets Manager and Authentication and access control in Secrets Manager.
# Arguments
- `add_replica_regions`: A list of Regions in which to replicate the secret.
- `secret_id`: The ARN or name of the secret to replicate.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ForceOverwriteReplicaSecret"`: Specifies whether to overwrite a secret with the same
name in the destination Region. By default, secrets aren't overwritten.
"""
function replicate_secret_to_regions(
AddReplicaRegions, SecretId; aws_config::AbstractAWSConfig=global_aws_config()
)
return secrets_manager(
"ReplicateSecretToRegions",
Dict{String,Any}("AddReplicaRegions" => AddReplicaRegions, "SecretId" => SecretId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function replicate_secret_to_regions(
AddReplicaRegions,
SecretId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return secrets_manager(
"ReplicateSecretToRegions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AddReplicaRegions" => AddReplicaRegions, "SecretId" => SecretId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restore_secret(secret_id)
restore_secret(secret_id, params::Dict{String,<:Any})
Cancels the scheduled deletion of a secret by removing the DeletedDate time stamp. You can
access a secret again after it has been restored. Secrets Manager generates a CloudTrail
log entry when you call this action. Do not include sensitive information in request
parameters because it might be logged. For more information, see Logging Secrets Manager
events with CloudTrail. Required permissions: secretsmanager:RestoreSecret. For more
information, see IAM policy actions for Secrets Manager and Authentication and access
control in Secrets Manager.
# Arguments
- `secret_id`: The ARN or name of the secret to restore. For an ARN, we recommend that you
specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
"""
function restore_secret(SecretId; aws_config::AbstractAWSConfig=global_aws_config())
return secrets_manager(
"RestoreSecret",
Dict{String,Any}("SecretId" => SecretId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function restore_secret(
SecretId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return secrets_manager(
"RestoreSecret",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SecretId" => SecretId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
rotate_secret(secret_id)
rotate_secret(secret_id, params::Dict{String,<:Any})
Configures and starts the asynchronous process of rotating the secret. For information
about rotation, see Rotate secrets in the Secrets Manager User Guide. If you include the
configuration parameters, the operation sets the values for the secret and then immediately
starts a rotation. If you don't include the configuration parameters, the operation starts
a rotation with the values already stored in the secret. When rotation is successful, the
AWSPENDING staging label might be attached to the same version as the AWSCURRENT version,
or it might not be attached to any version. If the AWSPENDING staging label is present but
not attached to the same version as AWSCURRENT, then any later invocation of RotateSecret
assumes that a previous rotation request is still in progress and returns an error. When
rotation is unsuccessful, the AWSPENDING staging label might be attached to an empty secret
version. For more information, see Troubleshoot rotation in the Secrets Manager User Guide.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include
sensitive information in request parameters because it might be logged. For more
information, see Logging Secrets Manager events with CloudTrail. Required permissions:
secretsmanager:RotateSecret. For more information, see IAM policy actions for Secrets
Manager and Authentication and access control in Secrets Manager. You also need
lambda:InvokeFunction permissions on the rotation function. For more information, see
Permissions for rotation.
# Arguments
- `secret_id`: The ARN or name of the secret to rotate. For an ARN, we recommend that you
specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: A unique identifier for the new version of the secret. You only
need to specify this value if you implement your own retry logic and you want to ensure
that Secrets Manager doesn't attempt to create a secret version twice. If you use the
Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then
you can leave this parameter empty. The CLI or SDK generates a random UUID for you and
includes it as the value for this parameter in the request. If you generate a raw HTTP
request to the Secrets Manager service endpoint, then you must generate a
ClientRequestToken and include it in the request. This value helps ensure idempotency.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if
there are failures and retries during a rotation. We recommend that you generate a
UUID-type value to ensure uniqueness of your versions within the specified secret.
- `"RotateImmediately"`: Specifies whether to rotate the secret immediately or wait until
the next scheduled rotation window. The rotation schedule is defined in
RotateSecretRequestRotationRules. For secrets that use a Lambda rotation function to
rotate, if you don't immediately rotate the secret, Secrets Manager tests the rotation
configuration by running the testSecret step of the Lambda rotation function. The test
creates an AWSPENDING version of the secret and then removes it. By default, Secrets
Manager rotates the secret immediately.
- `"RotationLambdaARN"`: For secrets that use a Lambda rotation function to rotate, the ARN
of the Lambda rotation function. For secrets that use managed rotation, omit this field.
For more information, see Managed rotation in the Secrets Manager User Guide.
- `"RotationRules"`: A structure that defines the rotation configuration for this secret.
"""
function rotate_secret(SecretId; aws_config::AbstractAWSConfig=global_aws_config())
return secrets_manager(
"RotateSecret",
Dict{String,Any}("SecretId" => SecretId, "ClientRequestToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function rotate_secret(
SecretId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return secrets_manager(
"RotateSecret",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SecretId" => SecretId, "ClientRequestToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_replication_to_replica(secret_id)
stop_replication_to_replica(secret_id, params::Dict{String,<:Any})
Removes the link between the replica secret and the primary secret and promotes the replica
to a primary secret in the replica Region. You must call this operation from the Region in
which you want to promote the replica to a primary secret. Secrets Manager generates a
CloudTrail log entry when you call this action. Do not include sensitive information in
request parameters because it might be logged. For more information, see Logging Secrets
Manager events with CloudTrail. Required permissions:
secretsmanager:StopReplicationToReplica. For more information, see IAM policy actions for
Secrets Manager and Authentication and access control in Secrets Manager.
# Arguments
- `secret_id`: The ARN of the primary secret.
"""
function stop_replication_to_replica(
SecretId; aws_config::AbstractAWSConfig=global_aws_config()
)
return secrets_manager(
"StopReplicationToReplica",
Dict{String,Any}("SecretId" => SecretId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_replication_to_replica(
SecretId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return secrets_manager(
"StopReplicationToReplica",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SecretId" => SecretId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(secret_id, tags)
tag_resource(secret_id, tags, params::Dict{String,<:Any})
Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of the
secret's metadata. They are not associated with specific versions of the secret. This
operation appends tags to the existing list of tags. For tag quotas and naming
restrictions, see Service quotas for Tagging in the Amazon Web Services General Reference
guide. If you use tags as part of your security strategy, then adding or removing a tag
can change permissions. If successfully completing this operation would result in you
losing your permissions for this secret, then the operation is blocked and returns an
Access Denied error. Secrets Manager generates a CloudTrail log entry when you call this
action. Do not include sensitive information in request parameters because it might be
logged. For more information, see Logging Secrets Manager events with CloudTrail. Required
permissions: secretsmanager:TagResource. For more information, see IAM policy actions for
Secrets Manager and Authentication and access control in Secrets Manager.
# Arguments
- `secret_id`: The identifier for the secret to attach tags to. You can specify either the
Amazon Resource Name (ARN) or the friendly name of the secret. For an ARN, we recommend
that you specify a complete ARN rather than a partial ARN. See Finding a secret from a
partial ARN.
- `tags`: The tags to attach to the secret as a JSON text string argument. Each element in
the list consists of a Key and a Value. For storing multiple values, we recommend that you
use a JSON text string argument and specify key/value pairs. For more information, see
Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI
User Guide.
"""
function tag_resource(SecretId, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return secrets_manager(
"TagResource",
Dict{String,Any}("SecretId" => SecretId, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
SecretId,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return secrets_manager(
"TagResource",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("SecretId" => SecretId, "Tags" => Tags), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(secret_id, tag_keys)
untag_resource(secret_id, tag_keys, params::Dict{String,<:Any})
Removes specific tags from a secret. This operation is idempotent. If a requested tag is
not attached to the secret, no error is returned and the secret metadata is unchanged. If
you use tags as part of your security strategy, then removing a tag can change permissions.
If successfully completing this operation would result in you losing your permissions for
this secret, then the operation is blocked and returns an Access Denied error. Secrets
Manager generates a CloudTrail log entry when you call this action. Do not include
sensitive information in request parameters because it might be logged. For more
information, see Logging Secrets Manager events with CloudTrail. Required permissions:
secretsmanager:UntagResource. For more information, see IAM policy actions for Secrets
Manager and Authentication and access control in Secrets Manager.
# Arguments
- `secret_id`: The ARN or name of the secret. For an ARN, we recommend that you specify a
complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
- `tag_keys`: A list of tag key names to remove from the secret. You don't specify the
value. Both the key and its associated value are removed. This parameter requires a JSON
text string argument. For storing multiple values, we recommend that you use a JSON text
string argument and specify key/value pairs. For more information, see Specifying parameter
values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
"""
function untag_resource(
SecretId, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return secrets_manager(
"UntagResource",
Dict{String,Any}("SecretId" => SecretId, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
SecretId,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return secrets_manager(
"UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("SecretId" => SecretId, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_secret(secret_id)
update_secret(secret_id, params::Dict{String,<:Any})
Modifies the details of a secret, including metadata and the secret value. To change the
secret value, you can also use PutSecretValue. To change the rotation configuration of a
secret, use RotateSecret instead. To change a secret so that it is managed by another
service, you need to recreate the secret in that service. See Secrets Manager secrets
managed by other Amazon Web Services services. We recommend you avoid calling UpdateSecret
at a sustained rate of more than once every 10 minutes. When you call UpdateSecret to
update the secret value, Secrets Manager creates a new version of the secret. Secrets
Manager removes outdated versions when there are more than 100, but it does not remove
versions created less than 24 hours ago. If you update the secret value more than once
every 10 minutes, you create more versions than Secrets Manager removes, and you will reach
the quota for secret versions. If you include SecretString or SecretBinary to create a new
secret version, Secrets Manager automatically moves the staging label AWSCURRENT to the new
version. Then it attaches the label AWSPREVIOUS to the version that AWSCURRENT was removed
from. If you call this operation with a ClientRequestToken that matches an existing
version's VersionId, the operation results in an error. You can't modify an existing
version, you can only create a new version. To remove a version, remove all staging labels
from it. See UpdateSecretVersionStage. Secrets Manager generates a CloudTrail log entry
when you call this action. Do not include sensitive information in request parameters
except SecretBinary or SecretString because it might be logged. For more information, see
Logging Secrets Manager events with CloudTrail. Required permissions:
secretsmanager:UpdateSecret. For more information, see IAM policy actions for Secrets
Manager and Authentication and access control in Secrets Manager. If you use a customer
managed key, you must also have kms:GenerateDataKey, kms:Encrypt, and kms:Decrypt
permissions on the key. If you change the KMS key and you don't have kms:Encrypt permission
to the new key, Secrets Manager does not re-ecrypt existing secret versions with the new
key. For more information, see Secret encryption and decryption.
# Arguments
- `secret_id`: The ARN or name of the secret. For an ARN, we recommend that you specify a
complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: If you include SecretString or SecretBinary, then Secrets Manager
creates a new version for the secret, and this parameter specifies the unique identifier
for the new version. If you use the Amazon Web Services CLI or one of the Amazon Web
Services SDKs to call this operation, then you can leave this parameter empty. The CLI or
SDK generates a random UUID for you and includes it as the value for this parameter in the
request. If you generate a raw HTTP request to the Secrets Manager service endpoint, then
you must generate a ClientRequestToken and include it in the request. This value helps
ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of
duplicate versions if there are failures and retries during a rotation. We recommend that
you generate a UUID-type value to ensure uniqueness of your versions within the specified
secret.
- `"Description"`: The description of the secret.
- `"KmsKeyId"`: The ARN, key ID, or alias of the KMS key that Secrets Manager uses to
encrypt new secret versions as well as any existing versions with the staging labels
AWSCURRENT, AWSPENDING, or AWSPREVIOUS. If you don't have kms:Encrypt permission to the new
key, Secrets Manager does not re-ecrypt existing secret versions with the new key. For more
information about versions and staging labels, see Concepts: Version. A key alias is always
prefixed by alias/, for example alias/aws/secretsmanager. For more information, see About
aliases. If you set this to an empty string, Secrets Manager uses the Amazon Web Services
managed key aws/secretsmanager. If this key doesn't already exist in your account, then
Secrets Manager creates it for you automatically. All users and roles in the Amazon Web
Services account automatically have access to use aws/secretsmanager. Creating
aws/secretsmanager can result in a one-time significant delay in returning the result.
You can only use the Amazon Web Services managed key aws/secretsmanager if you call this
operation using credentials from the same Amazon Web Services account that owns the secret.
If the secret is in a different account, then you must use a customer managed key and
provide the ARN of that KMS key in this field. The user making the call must have
permissions to both the secret and the KMS key in their respective accounts.
- `"SecretBinary"`: The binary data to encrypt and store in the new version of the secret.
We recommend that you store your binary data in a file and then pass the contents of the
file as a parameter. Either SecretBinary or SecretString must have a value, but not both.
You can't access this parameter in the Secrets Manager console. Sensitive: This field
contains sensitive information, so the service does not include it in CloudTrail log
entries. If you create your own log entries, you must also avoid logging the information in
this field.
- `"SecretString"`: The text data to encrypt and store in the new version of the secret. We
recommend you use a JSON structure of key/value pairs for your secret value. Either
SecretBinary or SecretString must have a value, but not both. Sensitive: This field
contains sensitive information, so the service does not include it in CloudTrail log
entries. If you create your own log entries, you must also avoid logging the information in
this field.
"""
function update_secret(SecretId; aws_config::AbstractAWSConfig=global_aws_config())
return secrets_manager(
"UpdateSecret",
Dict{String,Any}("SecretId" => SecretId, "ClientRequestToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_secret(
SecretId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return secrets_manager(
"UpdateSecret",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SecretId" => SecretId, "ClientRequestToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_secret_version_stage(secret_id, version_stage)
update_secret_version_stage(secret_id, version_stage, params::Dict{String,<:Any})
Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging
labels to track a version as it progresses through the secret rotation process. Each
staging label can be attached to only one version at a time. To add a staging label to a
version when it is already attached to another version, Secrets Manager first removes it
from the other version first and then attaches it to this one. For more information about
versions and staging labels, see Concepts: Version. The staging labels that you specify in
the VersionStage parameter are added to the existing list of staging labels for the
version. You can move the AWSCURRENT staging label to this version by including it in this
call. Whenever you move AWSCURRENT, Secrets Manager automatically moves the label
AWSPREVIOUS to the version that AWSCURRENT was removed from. If this action results in the
last label being removed from a version, then the version is considered to be 'deprecated'
and can be deleted by Secrets Manager. Secrets Manager generates a CloudTrail log entry
when you call this action. Do not include sensitive information in request parameters
because it might be logged. For more information, see Logging Secrets Manager events with
CloudTrail. Required permissions: secretsmanager:UpdateSecretVersionStage. For more
information, see IAM policy actions for Secrets Manager and Authentication and access
control in Secrets Manager.
# Arguments
- `secret_id`: The ARN or the name of the secret with the version and staging labelsto
modify. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
See Finding a secret from a partial ARN.
- `version_stage`: The staging label to add to this version.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MoveToVersionId"`: The ID of the version to add the staging label to. To remove a label
from a version, then do not specify this parameter. If the staging label is already
attached to a different version of the secret, then you must also specify the
RemoveFromVersionId parameter.
- `"RemoveFromVersionId"`: The ID of the version that the staging label is to be removed
from. If the staging label you are trying to attach to one version is already attached to a
different version, then you must include this parameter and specify the version that the
label is to be removed from. If the label is attached and you either do not specify this
parameter, or the version ID does not match, then the operation fails.
"""
function update_secret_version_stage(
SecretId, VersionStage; aws_config::AbstractAWSConfig=global_aws_config()
)
return secrets_manager(
"UpdateSecretVersionStage",
Dict{String,Any}("SecretId" => SecretId, "VersionStage" => VersionStage);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_secret_version_stage(
SecretId,
VersionStage,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return secrets_manager(
"UpdateSecretVersionStage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("SecretId" => SecretId, "VersionStage" => VersionStage),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
validate_resource_policy(resource_policy)
validate_resource_policy(resource_policy, params::Dict{String,<:Any})
Validates that a resource policy does not grant a wide range of principals access to your
secret. A resource-based policy is optional for secrets. The API performs three checks when
validating the policy: Sends a call to Zelkova, an automated reasoning engine, to ensure
your resource policy does not allow broad access to your secret, for example policies that
use a wildcard for the principal. Checks for correct syntax in a policy. Verifies the
policy does not lock out a caller. Secrets Manager generates a CloudTrail log entry when
you call this action. Do not include sensitive information in request parameters because it
might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:ValidateResourcePolicy and
secretsmanager:PutResourcePolicy. For more information, see IAM policy actions for Secrets
Manager and Authentication and access control in Secrets Manager.
# Arguments
- `resource_policy`: A JSON-formatted string that contains an Amazon Web Services
resource-based policy. The policy in the string identifies who can access or manage this
secret and its versions. For example policies, see Permissions policy examples.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SecretId"`: The ARN or name of the secret with the resource-based policy you want to
validate.
"""
function validate_resource_policy(
ResourcePolicy; aws_config::AbstractAWSConfig=global_aws_config()
)
return secrets_manager(
"ValidateResourcePolicy",
Dict{String,Any}("ResourcePolicy" => ResourcePolicy);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function validate_resource_policy(
ResourcePolicy,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return secrets_manager(
"ValidateResourcePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourcePolicy" => ResourcePolicy), 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 | 123985 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: securityhub
using AWS.Compat
using AWS.UUIDs
"""
accept_administrator_invitation(administrator_id, invitation_id)
accept_administrator_invitation(administrator_id, invitation_id, params::Dict{String,<:Any})
Accepts the invitation to be a member account and be monitored by the Security Hub
administrator account that the invitation was sent from. This operation is only used by
member accounts that are not added through Organizations. When the member account accepts
the invitation, permission is granted to the administrator account to view findings
generated in the member account.
# Arguments
- `administrator_id`: The account ID of the Security Hub administrator account that sent
the invitation.
- `invitation_id`: The identifier of the invitation sent from the Security Hub
administrator account.
"""
function accept_administrator_invitation(
AdministratorId, InvitationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"POST",
"/administrator",
Dict{String,Any}(
"AdministratorId" => AdministratorId, "InvitationId" => InvitationId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function accept_administrator_invitation(
AdministratorId,
InvitationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"POST",
"/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(invitation_id, master_id)
accept_invitation(invitation_id, master_id, params::Dict{String,<:Any})
This method is deprecated. Instead, use AcceptAdministratorInvitation. The Security Hub
console continues to use AcceptInvitation. It will eventually change to use
AcceptAdministratorInvitation. Any IAM policies that specifically control access to this
function must continue to use AcceptInvitation. You should also add
AcceptAdministratorInvitation to your policies to ensure that the correct permissions are
in place after the console begins to use AcceptAdministratorInvitation. Accepts the
invitation to be a member account and be monitored by the Security Hub administrator
account that the invitation was sent from. This operation is only used by member accounts
that are not added through Organizations. When the member account accepts the invitation,
permission is granted to the administrator account to view findings generated in the member
account.
# Arguments
- `invitation_id`: The identifier of the invitation sent from the Security Hub
administrator account.
- `master_id`: The account ID of the Security Hub administrator account that sent the
invitation.
"""
function accept_invitation(
InvitationId, MasterId; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"POST",
"/master",
Dict{String,Any}("InvitationId" => InvitationId, "MasterId" => MasterId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function accept_invitation(
InvitationId,
MasterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"POST",
"/master",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InvitationId" => InvitationId, "MasterId" => MasterId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_delete_automation_rules(automation_rules_arns)
batch_delete_automation_rules(automation_rules_arns, params::Dict{String,<:Any})
Deletes one or more automation rules.
# Arguments
- `automation_rules_arns`: A list of Amazon Resource Names (ARNs) for the rules that are
to be deleted.
"""
function batch_delete_automation_rules(
AutomationRulesArns; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"POST",
"/automationrules/delete",
Dict{String,Any}("AutomationRulesArns" => AutomationRulesArns);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_delete_automation_rules(
AutomationRulesArns,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"POST",
"/automationrules/delete",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AutomationRulesArns" => AutomationRulesArns),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_disable_standards(standards_subscription_arns)
batch_disable_standards(standards_subscription_arns, params::Dict{String,<:Any})
Disables the standards specified by the provided StandardsSubscriptionArns. For more
information, see Security Standards section of the Security Hub User Guide.
# Arguments
- `standards_subscription_arns`: The ARNs of the standards subscriptions to disable.
"""
function batch_disable_standards(
StandardsSubscriptionArns; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"POST",
"/standards/deregister",
Dict{String,Any}("StandardsSubscriptionArns" => StandardsSubscriptionArns);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_disable_standards(
StandardsSubscriptionArns,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"POST",
"/standards/deregister",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("StandardsSubscriptionArns" => StandardsSubscriptionArns),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_enable_standards(standards_subscription_requests)
batch_enable_standards(standards_subscription_requests, params::Dict{String,<:Any})
Enables the standards specified by the provided StandardsArn. To obtain the ARN for a
standard, use the DescribeStandards operation. For more information, see the Security
Standards section of the Security Hub User Guide.
# Arguments
- `standards_subscription_requests`: The list of standards checks to enable.
"""
function batch_enable_standards(
StandardsSubscriptionRequests; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"POST",
"/standards/register",
Dict{String,Any}("StandardsSubscriptionRequests" => StandardsSubscriptionRequests);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_enable_standards(
StandardsSubscriptionRequests,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"POST",
"/standards/register",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"StandardsSubscriptionRequests" => StandardsSubscriptionRequests
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_automation_rules(automation_rules_arns)
batch_get_automation_rules(automation_rules_arns, params::Dict{String,<:Any})
Retrieves a list of details for automation rules based on rule Amazon Resource Names
(ARNs).
# Arguments
- `automation_rules_arns`: A list of rule ARNs to get details for.
"""
function batch_get_automation_rules(
AutomationRulesArns; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"POST",
"/automationrules/get",
Dict{String,Any}("AutomationRulesArns" => AutomationRulesArns);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_automation_rules(
AutomationRulesArns,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"POST",
"/automationrules/get",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AutomationRulesArns" => AutomationRulesArns),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_configuration_policy_associations(configuration_policy_association_identifiers)
batch_get_configuration_policy_associations(configuration_policy_association_identifiers, params::Dict{String,<:Any})
Returns associations between an Security Hub configuration and a batch of target accounts,
organizational units, or the root. Only the Security Hub delegated administrator can invoke
this operation from the home Region. A configuration can refer to a configuration policy or
to a self-managed configuration.
# Arguments
- `configuration_policy_association_identifiers`: Specifies one or more target account
IDs, organizational unit (OU) IDs, or the root ID to retrieve associations for.
"""
function batch_get_configuration_policy_associations(
ConfigurationPolicyAssociationIdentifiers;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"POST",
"/configurationPolicyAssociation/batchget",
Dict{String,Any}(
"ConfigurationPolicyAssociationIdentifiers" =>
ConfigurationPolicyAssociationIdentifiers,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_configuration_policy_associations(
ConfigurationPolicyAssociationIdentifiers,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"POST",
"/configurationPolicyAssociation/batchget",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigurationPolicyAssociationIdentifiers" =>
ConfigurationPolicyAssociationIdentifiers,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_security_controls(security_control_ids)
batch_get_security_controls(security_control_ids, params::Dict{String,<:Any})
Provides details about a batch of security controls for the current Amazon Web Services
account and Amazon Web Services Region.
# Arguments
- `security_control_ids`: A list of security controls (identified with SecurityControlId,
SecurityControlArn, or a mix of both parameters). The security control ID or Amazon
Resource Name (ARN) is the same across standards.
"""
function batch_get_security_controls(
SecurityControlIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"POST",
"/securityControls/batchGet",
Dict{String,Any}("SecurityControlIds" => SecurityControlIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_security_controls(
SecurityControlIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"POST",
"/securityControls/batchGet",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("SecurityControlIds" => SecurityControlIds), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_standards_control_associations(standards_control_association_ids)
batch_get_standards_control_associations(standards_control_association_ids, params::Dict{String,<:Any})
For a batch of security controls and standards, identifies whether each control is
currently enabled or disabled in a standard.
# Arguments
- `standards_control_association_ids`: An array with one or more objects that includes a
security control (identified with SecurityControlId, SecurityControlArn, or a mix of both
parameters) and the Amazon Resource Name (ARN) of a standard. This field is used to query
the enablement status of a control in a specified standard. The security control ID or ARN
is the same across standards.
"""
function batch_get_standards_control_associations(
StandardsControlAssociationIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"POST",
"/associations/batchGet",
Dict{String,Any}(
"StandardsControlAssociationIds" => StandardsControlAssociationIds
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_standards_control_associations(
StandardsControlAssociationIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"POST",
"/associations/batchGet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"StandardsControlAssociationIds" => StandardsControlAssociationIds
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_import_findings(findings)
batch_import_findings(findings, params::Dict{String,<:Any})
Imports security findings generated by a finding provider into Security Hub. This action is
requested by the finding provider to import its findings into Security Hub.
BatchImportFindings must be called by one of the following: The Amazon Web Services
account that is associated with a finding if you are using the default product ARN or are a
partner sending findings from within a customer's Amazon Web Services account. In these
cases, the identifier of the account that you are calling BatchImportFindings from needs to
be the same as the AwsAccountId attribute for the finding. An Amazon Web Services account
that Security Hub has allow-listed for an official partner integration. In this case, you
can call BatchImportFindings from the allow-listed account and send findings from different
customer accounts in the same batch. The maximum allowed size for a finding is 240 Kb. An
error is returned for any finding larger than 240 Kb. After a finding is created,
BatchImportFindings cannot be used to update the following finding fields and objects,
which Security Hub customers use to manage their investigation workflow. Note
UserDefinedFields VerificationState Workflow Finding providers also should not
use BatchImportFindings to update the following attributes. Confidence Criticality
RelatedFindings Severity Types Instead, finding providers use
FindingProviderFields to provide values for these attributes.
# Arguments
- `findings`: A list of findings to import. To successfully import a finding, it must
follow the Amazon Web Services Security Finding Format. Maximum of 100 findings per request.
"""
function batch_import_findings(Findings; aws_config::AbstractAWSConfig=global_aws_config())
return securityhub(
"POST",
"/findings/import",
Dict{String,Any}("Findings" => Findings);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_import_findings(
Findings,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"POST",
"/findings/import",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Findings" => Findings), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_update_automation_rules(update_automation_rules_request_items)
batch_update_automation_rules(update_automation_rules_request_items, params::Dict{String,<:Any})
Updates one or more automation rules based on rule Amazon Resource Names (ARNs) and input
parameters.
# Arguments
- `update_automation_rules_request_items`: An array of ARNs for the rules that are to be
updated. Optionally, you can also include RuleStatus and RuleOrder.
"""
function batch_update_automation_rules(
UpdateAutomationRulesRequestItems; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"PATCH",
"/automationrules/update",
Dict{String,Any}(
"UpdateAutomationRulesRequestItems" => UpdateAutomationRulesRequestItems
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_update_automation_rules(
UpdateAutomationRulesRequestItems,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"PATCH",
"/automationrules/update",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"UpdateAutomationRulesRequestItems" => UpdateAutomationRulesRequestItems
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_update_findings(finding_identifiers)
batch_update_findings(finding_identifiers, params::Dict{String,<:Any})
Used by Security Hub customers to update information about their investigation into a
finding. Requested by administrator accounts or member accounts. Administrator accounts can
update findings for their account and their member accounts. Member accounts can update
findings for their account. Updates from BatchUpdateFindings do not affect the value of
UpdatedAt for a finding. Administrator and member accounts can use BatchUpdateFindings to
update the following finding fields and objects. Confidence Criticality Note
RelatedFindings Severity Types UserDefinedFields VerificationState
Workflow You can configure IAM policies to restrict access to fields and field values.
For example, you might not want member accounts to be able to suppress findings or change
the finding severity. See Configuring access to BatchUpdateFindings in the Security Hub
User Guide.
# Arguments
- `finding_identifiers`: The list of findings to update. BatchUpdateFindings can be used to
update up to 100 findings at a time. For each finding, the list provides the finding
identifier and the ARN of the finding provider.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Confidence"`: The updated value for the finding confidence. Confidence is defined as
the likelihood that a finding accurately identifies the behavior or issue that it was
intended to identify. Confidence is scored on a 0-100 basis using a ratio scale, where 0
means zero percent confidence and 100 means 100 percent confidence.
- `"Criticality"`: The updated value for the level of importance assigned to the resources
associated with the findings. A score of 0 means that the underlying resources have no
criticality, and a score of 100 is reserved for the most critical resources.
- `"Note"`:
- `"RelatedFindings"`: A list of findings that are related to the updated findings.
- `"Severity"`: Used to update the finding severity.
- `"Types"`: One or more finding types in the format of namespace/category/classifier that
classify a finding. Valid namespace values are as follows. Software and Configuration
Checks TTPs Effects Unusual Behaviors Sensitive Data Identifications
- `"UserDefinedFields"`: A list of name/value string pairs associated with the finding.
These are custom, user-defined fields added to a finding.
- `"VerificationState"`: Indicates the veracity of a finding. The available values for
VerificationState are as follows. UNKNOWN – The default disposition of a security
finding TRUE_POSITIVE – The security finding is confirmed FALSE_POSITIVE – The
security finding was determined to be a false alarm BENIGN_POSITIVE – A special case
of TRUE_POSITIVE where the finding doesn't pose any threat, is expected, or both
- `"Workflow"`: Used to update the workflow status of a finding. The workflow status
indicates the progress of the investigation into the finding.
"""
function batch_update_findings(
FindingIdentifiers; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"PATCH",
"/findings/batchupdate",
Dict{String,Any}("FindingIdentifiers" => FindingIdentifiers);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_update_findings(
FindingIdentifiers,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"PATCH",
"/findings/batchupdate",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("FindingIdentifiers" => FindingIdentifiers), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_update_standards_control_associations(standards_control_association_updates)
batch_update_standards_control_associations(standards_control_association_updates, params::Dict{String,<:Any})
For a batch of security controls and standards, this operation updates the enablement
status of a control in a standard.
# Arguments
- `standards_control_association_updates`: Updates the enablement status of a security
control in a specified standard.
"""
function batch_update_standards_control_associations(
StandardsControlAssociationUpdates; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"PATCH",
"/associations",
Dict{String,Any}(
"StandardsControlAssociationUpdates" => StandardsControlAssociationUpdates
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_update_standards_control_associations(
StandardsControlAssociationUpdates,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"PATCH",
"/associations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"StandardsControlAssociationUpdates" =>
StandardsControlAssociationUpdates,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_action_target(description, id, name)
create_action_target(description, id, name, params::Dict{String,<:Any})
Creates a custom action target in Security Hub. You can use custom actions on findings and
insights in Security Hub to trigger target actions in Amazon CloudWatch Events.
# Arguments
- `description`: The description for the custom action target.
- `id`: The ID for the custom action target. Can contain up to 20 alphanumeric characters.
- `name`: The name of the custom action target. Can contain up to 20 characters.
"""
function create_action_target(
Description, Id, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"POST",
"/actionTargets",
Dict{String,Any}("Description" => Description, "Id" => Id, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_action_target(
Description,
Id,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"POST",
"/actionTargets",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Description" => Description, "Id" => Id, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_automation_rule(actions, criteria, description, rule_name, rule_order)
create_automation_rule(actions, criteria, description, rule_name, rule_order, params::Dict{String,<:Any})
Creates an automation rule based on input parameters.
# Arguments
- `actions`: One or more actions to update finding fields if a finding matches the
conditions specified in Criteria.
- `criteria`: A set of ASFF finding field attributes and corresponding expected values
that Security Hub uses to filter findings. If a rule is enabled and a finding matches the
conditions specified in this parameter, Security Hub applies the rule action to the
finding.
- `description`: A description of the rule.
- `rule_name`: The name of the rule.
- `rule_order`: An integer ranging from 1 to 1000 that represents the order in which the
rule action is applied to findings. Security Hub applies rules with lower values for this
parameter first.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IsTerminal"`: Specifies whether a rule is the last to be applied with respect to a
finding that matches the rule criteria. This is useful when a finding matches the criteria
for multiple rules, and each rule has different actions. If a rule is terminal, Security
Hub applies the rule action to a finding that matches the rule criteria and doesn't
evaluate other rules for the finding. By default, a rule isn't terminal.
- `"RuleStatus"`: Whether the rule is active after it is created. If this parameter is
equal to ENABLED, Security Hub starts applying the rule to findings and finding updates
after the rule is created. To change the value of this parameter after creating a rule, use
BatchUpdateAutomationRules .
- `"Tags"`: User-defined tags associated with an automation rule.
"""
function create_automation_rule(
Actions,
Criteria,
Description,
RuleName,
RuleOrder;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"POST",
"/automationrules/create",
Dict{String,Any}(
"Actions" => Actions,
"Criteria" => Criteria,
"Description" => Description,
"RuleName" => RuleName,
"RuleOrder" => RuleOrder,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_automation_rule(
Actions,
Criteria,
Description,
RuleName,
RuleOrder,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"POST",
"/automationrules/create",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Actions" => Actions,
"Criteria" => Criteria,
"Description" => Description,
"RuleName" => RuleName,
"RuleOrder" => RuleOrder,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_configuration_policy(configuration_policy, name)
create_configuration_policy(configuration_policy, name, params::Dict{String,<:Any})
Creates a configuration policy with the defined configuration. Only the Security Hub
delegated administrator can invoke this operation from the home Region.
# Arguments
- `configuration_policy`: An object that defines how Security Hub is configured. It
includes whether Security Hub is enabled or disabled, a list of enabled security standards,
a list of enabled or disabled security controls, and a list of custom parameter values for
specified controls. If you provide a list of security controls that are enabled in the
configuration policy, Security Hub disables all other controls (including newly released
controls). If you provide a list of security controls that are disabled in the
configuration policy, Security Hub enables all other controls (including newly released
controls).
- `name`: The name of the configuration policy. Alphanumeric characters and the following
ASCII characters are permitted: -, ., !, *, /.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description of the configuration policy.
- `"Tags"`: User-defined tags associated with a configuration policy. For more
information, see Tagging Security Hub resources in the Security Hub user guide.
"""
function create_configuration_policy(
ConfigurationPolicy, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"POST",
"/configurationPolicy/create",
Dict{String,Any}("ConfigurationPolicy" => ConfigurationPolicy, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_configuration_policy(
ConfigurationPolicy,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"POST",
"/configurationPolicy/create",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigurationPolicy" => ConfigurationPolicy, "Name" => Name
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_finding_aggregator(region_linking_mode)
create_finding_aggregator(region_linking_mode, params::Dict{String,<:Any})
Used to enable finding aggregation. Must be called from the aggregation Region. For more
details about cross-Region replication, see Configuring finding aggregation in the Security
Hub User Guide.
# Arguments
- `region_linking_mode`: Indicates whether to aggregate findings from all of the available
Regions in the current partition. Also determines whether to automatically aggregate
findings from new Regions as Security Hub supports them and you opt into them. The selected
option also determines how to use the Regions provided in the Regions list. The options are
as follows: ALL_REGIONS - Indicates to aggregate findings from all of the Regions where
Security Hub is enabled. When you choose this option, Security Hub also automatically
aggregates findings from new Regions as Security Hub supports them and you opt into them.
ALL_REGIONS_EXCEPT_SPECIFIED - Indicates to aggregate findings from all of the Regions
where Security Hub is enabled, except for the Regions listed in the Regions parameter. When
you choose this option, Security Hub also automatically aggregates findings from new
Regions as Security Hub supports them and you opt into them. SPECIFIED_REGIONS -
Indicates to aggregate findings only from the Regions listed in the Regions parameter.
Security Hub does not automatically aggregate findings from new Regions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Regions"`: If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a
space-separated list of Regions that do not aggregate findings to the aggregation Region.
If RegionLinkingMode is SPECIFIED_REGIONS, then this is a space-separated list of Regions
that do aggregate findings to the aggregation Region.
"""
function create_finding_aggregator(
RegionLinkingMode; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"POST",
"/findingAggregator/create",
Dict{String,Any}("RegionLinkingMode" => RegionLinkingMode);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_finding_aggregator(
RegionLinkingMode,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"POST",
"/findingAggregator/create",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("RegionLinkingMode" => RegionLinkingMode), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_insight(filters, group_by_attribute, name)
create_insight(filters, group_by_attribute, name, params::Dict{String,<:Any})
Creates a custom insight in Security Hub. An insight is a consolidation of findings that
relate to a security issue that requires attention or remediation. To group the related
findings in the insight, use the GroupByAttribute.
# Arguments
- `filters`: One or more attributes used to filter the findings included in the insight.
The insight only includes findings that match the criteria defined in the filters.
- `group_by_attribute`: The attribute used to group the findings for the insight. The
grouping attribute identifies the type of item that the insight applies to. For example, if
an insight is grouped by resource identifier, then the insight produces a list of resource
identifiers.
- `name`: The name of the custom insight to create.
"""
function create_insight(
Filters, GroupByAttribute, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"POST",
"/insights",
Dict{String,Any}(
"Filters" => Filters, "GroupByAttribute" => GroupByAttribute, "Name" => Name
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_insight(
Filters,
GroupByAttribute,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"POST",
"/insights",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Filters" => Filters,
"GroupByAttribute" => GroupByAttribute,
"Name" => Name,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_members(account_details)
create_members(account_details, params::Dict{String,<:Any})
Creates a member association in Security Hub between the specified accounts and the account
used to make the request, which is the administrator account. If you are integrated with
Organizations, then the administrator account is designated by the organization management
account. CreateMembers is always used to add accounts that are not organization members.
For accounts that are managed using Organizations, CreateMembers is only used in the
following cases: Security Hub is not configured to automatically add new organization
accounts. The account was disassociated or deleted in Security Hub. This action can
only be used by an account that has Security Hub enabled. To enable Security Hub, you can
use the EnableSecurityHub operation. For accounts that are not organization members, you
create the account association and then send an invitation to the member account. To send
the invitation, you use the InviteMembers operation. If the account owner accepts the
invitation, the account becomes a member account in Security Hub. Accounts that are managed
using Organizations do not receive an invitation. They automatically become a member
account in Security Hub. If the organization account does not have Security Hub enabled,
then Security Hub and the default standards are automatically enabled. Note that Security
Hub cannot be enabled automatically for the organization management account. The
organization management account must enable Security Hub before the administrator account
enables it as a member account. For organization accounts that already have Security Hub
enabled, Security Hub does not make any other changes to those accounts. It does not change
their enabled standards or controls. A permissions policy is added that permits the
administrator account to view the findings generated in the member account. To remove the
association between the administrator and member accounts, use the
DisassociateFromMasterAccount or DisassociateMembers operation.
# Arguments
- `account_details`: The list of accounts to associate with the Security Hub administrator
account. For each account, the list includes the account ID and optionally the email
address.
"""
function create_members(AccountDetails; aws_config::AbstractAWSConfig=global_aws_config())
return securityhub(
"POST",
"/members",
Dict{String,Any}("AccountDetails" => AccountDetails);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_members(
AccountDetails,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"POST",
"/members",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AccountDetails" => AccountDetails), 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 to become a member account. A prospective member account uses this
operation to decline an invitation to become a member. This operation is only called by
member accounts that aren't part of an organization. Organization accounts don't receive
invitations.
# Arguments
- `account_ids`: The list of prospective member account IDs for which to decline an
invitation.
"""
function decline_invitations(AccountIds; aws_config::AbstractAWSConfig=global_aws_config())
return securityhub(
"POST",
"/invitations/decline",
Dict{String,Any}("AccountIds" => AccountIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function decline_invitations(
AccountIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"POST",
"/invitations/decline",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AccountIds" => AccountIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_action_target(action_target_arn)
delete_action_target(action_target_arn, params::Dict{String,<:Any})
Deletes a custom action target from Security Hub. Deleting a custom action target does not
affect any findings or insights that were already sent to Amazon CloudWatch Events using
the custom action.
# Arguments
- `action_target_arn`: The Amazon Resource Name (ARN) of the custom action target to delete.
"""
function delete_action_target(
ActionTargetArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"DELETE",
"/actionTargets/$(ActionTargetArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_action_target(
ActionTargetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"DELETE",
"/actionTargets/$(ActionTargetArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_configuration_policy(identifier)
delete_configuration_policy(identifier, params::Dict{String,<:Any})
Deletes a configuration policy. Only the Security Hub delegated administrator can invoke
this operation from the home Region. For the deletion to succeed, you must first
disassociate a configuration policy from target accounts, organizational units, or the root
by invoking the StartConfigurationPolicyDisassociation operation.
# Arguments
- `identifier`: The Amazon Resource Name (ARN) or universally unique identifier (UUID) of
the configuration policy.
"""
function delete_configuration_policy(
Identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"DELETE",
"/configurationPolicy/$(Identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_configuration_policy(
Identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"DELETE",
"/configurationPolicy/$(Identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_finding_aggregator(finding_aggregator_arn)
delete_finding_aggregator(finding_aggregator_arn, params::Dict{String,<:Any})
Deletes a finding aggregator. When you delete the finding aggregator, you stop finding
aggregation. When you stop finding aggregation, findings that were already aggregated to
the aggregation Region are still visible from the aggregation Region. New findings and
finding updates are not aggregated.
# Arguments
- `finding_aggregator_arn`: The ARN of the finding aggregator to delete. To obtain the ARN,
use ListFindingAggregators.
"""
function delete_finding_aggregator(
FindingAggregatorArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"DELETE",
"/findingAggregator/delete/$(FindingAggregatorArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_finding_aggregator(
FindingAggregatorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"DELETE",
"/findingAggregator/delete/$(FindingAggregatorArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_insight(insight_arn)
delete_insight(insight_arn, params::Dict{String,<:Any})
Deletes the insight specified by the InsightArn.
# Arguments
- `insight_arn`: The ARN of the insight to delete.
"""
function delete_insight(InsightArn; aws_config::AbstractAWSConfig=global_aws_config())
return securityhub(
"DELETE",
"/insights/$(InsightArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_insight(
InsightArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"DELETE",
"/insights/$(InsightArn)",
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 received by the Amazon Web Services account to become a member account.
A Security Hub administrator account can use this operation to delete invitations sent to
one or more member accounts. This operation is only used to delete invitations that are
sent to member accounts that aren't part of an organization. Organization accounts don't
receive invitations.
# Arguments
- `account_ids`: The list of member account IDs that received the invitations you want to
delete.
"""
function delete_invitations(AccountIds; aws_config::AbstractAWSConfig=global_aws_config())
return securityhub(
"POST",
"/invitations/delete",
Dict{String,Any}("AccountIds" => AccountIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_invitations(
AccountIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"POST",
"/invitations/delete",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AccountIds" => AccountIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_members(account_ids)
delete_members(account_ids, params::Dict{String,<:Any})
Deletes the specified member accounts from Security Hub. You can invoke this API only to
delete accounts that became members through invitation. You can't invoke this API to delete
accounts that belong to an Organizations organization.
# Arguments
- `account_ids`: The list of account IDs for the member accounts to delete.
"""
function delete_members(AccountIds; aws_config::AbstractAWSConfig=global_aws_config())
return securityhub(
"POST",
"/members/delete",
Dict{String,Any}("AccountIds" => AccountIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_members(
AccountIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"POST",
"/members/delete",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AccountIds" => AccountIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_action_targets()
describe_action_targets(params::Dict{String,<:Any})
Returns a list of the custom action targets in Security Hub in your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ActionTargetArns"`: A list of custom action target ARNs for the custom action targets
to retrieve.
- `"MaxResults"`: The maximum number of results to return.
- `"NextToken"`: The token that is required for pagination. On your first call to the
DescribeActionTargets operation, set the value of this parameter to NULL. For subsequent
calls to the operation, to continue listing data, set the value of this parameter to the
value returned from the previous response.
"""
function describe_action_targets(; aws_config::AbstractAWSConfig=global_aws_config())
return securityhub(
"POST", "/actionTargets/get"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_action_targets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"POST",
"/actionTargets/get",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_hub()
describe_hub(params::Dict{String,<:Any})
Returns details about the Hub resource in your account, including the HubArn and the time
when you enabled Security Hub.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"HubArn"`: The ARN of the Hub resource to retrieve.
"""
function describe_hub(; aws_config::AbstractAWSConfig=global_aws_config())
return securityhub(
"GET", "/accounts"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_hub(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"GET", "/accounts", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_organization_configuration()
describe_organization_configuration(params::Dict{String,<:Any})
Returns information about the way your organization is configured in Security Hub. Only the
Security Hub administrator account can invoke this operation.
"""
function describe_organization_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"GET",
"/organization/configuration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_organization_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"GET",
"/organization/configuration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_products()
describe_products(params::Dict{String,<:Any})
Returns information about product integrations in Security Hub. You can optionally provide
an integration ARN. If you provide an integration ARN, then the results only include that
integration. If you do not provide an integration ARN, then the results include all of the
available product integrations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to return.
- `"NextToken"`: The token that is required for pagination. On your first call to the
DescribeProducts operation, set the value of this parameter to NULL. For subsequent calls
to the operation, to continue listing data, set the value of this parameter to the value
returned from the previous response.
- `"ProductArn"`: The ARN of the integration to return.
"""
function describe_products(; aws_config::AbstractAWSConfig=global_aws_config())
return securityhub(
"GET", "/products"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_products(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"GET", "/products", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_standards()
describe_standards(params::Dict{String,<:Any})
Returns a list of the available standards in Security Hub. For each standard, the results
include the standard ARN, the name, and a description.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of standards to return.
- `"NextToken"`: The token that is required for pagination. On your first call to the
DescribeStandards operation, set the value of this parameter to NULL. For subsequent calls
to the operation, to continue listing data, set the value of this parameter to the value
returned from the previous response.
"""
function describe_standards(; aws_config::AbstractAWSConfig=global_aws_config())
return securityhub(
"GET", "/standards"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_standards(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"GET", "/standards", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_standards_controls(standards_subscription_arn)
describe_standards_controls(standards_subscription_arn, params::Dict{String,<:Any})
Returns a list of security standards controls. For each control, the results include
information about whether it is currently enabled, the severity, and a link to remediation
information.
# Arguments
- `standards_subscription_arn`: The ARN of a resource that represents your subscription to
a supported standard. To get the subscription ARNs of the standards you have enabled, use
the GetEnabledStandards operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of security standard controls to return.
- `"NextToken"`: The token that is required for pagination. On your first call to the
DescribeStandardsControls operation, set the value of this parameter to NULL. For
subsequent calls to the operation, to continue listing data, set the value of this
parameter to the value returned from the previous response.
"""
function describe_standards_controls(
StandardsSubscriptionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"GET",
"/standards/controls/$(StandardsSubscriptionArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_standards_controls(
StandardsSubscriptionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"GET",
"/standards/controls/$(StandardsSubscriptionArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_import_findings_for_product(product_subscription_arn)
disable_import_findings_for_product(product_subscription_arn, params::Dict{String,<:Any})
Disables the integration of the specified product with Security Hub. After the integration
is disabled, findings from that product are no longer sent to Security Hub.
# Arguments
- `product_subscription_arn`: The ARN of the integrated product to disable the integration
for.
"""
function disable_import_findings_for_product(
ProductSubscriptionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"DELETE",
"/productSubscriptions/$(ProductSubscriptionArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_import_findings_for_product(
ProductSubscriptionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"DELETE",
"/productSubscriptions/$(ProductSubscriptionArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_organization_admin_account(admin_account_id)
disable_organization_admin_account(admin_account_id, params::Dict{String,<:Any})
Disables a Security Hub administrator account. Can only be called by the organization
management account.
# Arguments
- `admin_account_id`: The Amazon Web Services account identifier of the Security Hub
administrator account.
"""
function disable_organization_admin_account(
AdminAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"POST",
"/organization/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 securityhub(
"POST",
"/organization/admin/disable",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AdminAccountId" => AdminAccountId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_security_hub()
disable_security_hub(params::Dict{String,<:Any})
Disables Security Hub in your account only in the current Amazon Web Services Region. To
disable Security Hub in all Regions, you must submit one request per Region where you have
enabled Security Hub. You can't disable Security Hub in an account that is currently the
Security Hub administrator. When you disable Security Hub, your existing findings and
insights and any Security Hub configuration settings are deleted after 90 days and cannot
be recovered. Any standards that were enabled are disabled, and your administrator and
member account associations are removed. If you want to save your existing findings, you
must export them before you disable Security Hub.
"""
function disable_security_hub(; aws_config::AbstractAWSConfig=global_aws_config())
return securityhub(
"DELETE", "/accounts"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function disable_security_hub(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"DELETE",
"/accounts",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_from_administrator_account()
disassociate_from_administrator_account(params::Dict{String,<:Any})
Disassociates the current Security Hub member account from the associated administrator
account. This operation is only used by accounts that are not part of an organization. For
organization accounts, only the administrator account can disassociate a member account.
"""
function disassociate_from_administrator_account(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"POST",
"/administrator/disassociate";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_from_administrator_account(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"POST",
"/administrator/disassociate",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_from_master_account()
disassociate_from_master_account(params::Dict{String,<:Any})
This method is deprecated. Instead, use DisassociateFromAdministratorAccount. The Security
Hub console continues to use DisassociateFromMasterAccount. It will eventually change to
use DisassociateFromAdministratorAccount. Any IAM policies that specifically control access
to this function must continue to use DisassociateFromMasterAccount. You should also add
DisassociateFromAdministratorAccount to your policies to ensure that the correct
permissions are in place after the console begins to use
DisassociateFromAdministratorAccount. Disassociates the current Security Hub member account
from the associated administrator account. This operation is only used by accounts that are
not part of an organization. For organization accounts, only the administrator account can
disassociate a member account.
"""
function disassociate_from_master_account(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"POST",
"/master/disassociate";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_from_master_account(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"POST",
"/master/disassociate",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_members(account_ids)
disassociate_members(account_ids, params::Dict{String,<:Any})
Disassociates the specified member accounts from the associated administrator account. Can
be used to disassociate both accounts that are managed using Organizations and accounts
that were invited manually.
# Arguments
- `account_ids`: The account IDs of the member accounts to disassociate from the
administrator account.
"""
function disassociate_members(AccountIds; aws_config::AbstractAWSConfig=global_aws_config())
return securityhub(
"POST",
"/members/disassociate",
Dict{String,Any}("AccountIds" => AccountIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_members(
AccountIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"POST",
"/members/disassociate",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AccountIds" => AccountIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_import_findings_for_product(product_arn)
enable_import_findings_for_product(product_arn, params::Dict{String,<:Any})
Enables the integration of a partner product with Security Hub. Integrated products send
findings to Security Hub. When you enable a product integration, a permissions policy that
grants permission for the product to send findings to Security Hub is applied.
# Arguments
- `product_arn`: The ARN of the product to enable the integration for.
"""
function enable_import_findings_for_product(
ProductArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"POST",
"/productSubscriptions",
Dict{String,Any}("ProductArn" => ProductArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_import_findings_for_product(
ProductArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"POST",
"/productSubscriptions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ProductArn" => ProductArn), 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 the Security Hub administrator account for an organization. Can only be called
by the organization management account.
# Arguments
- `admin_account_id`: The Amazon Web Services account identifier of the account to
designate as the Security Hub administrator account.
"""
function enable_organization_admin_account(
AdminAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"POST",
"/organization/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 securityhub(
"POST",
"/organization/admin/enable",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AdminAccountId" => AdminAccountId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_security_hub()
enable_security_hub(params::Dict{String,<:Any})
Enables Security Hub for your account in the current Region or the Region you specify in
the request. When you enable Security Hub, you grant to Security Hub the permissions
necessary to gather findings from other services that are integrated with Security Hub.
When you use the EnableSecurityHub operation to enable Security Hub, you also automatically
enable the following standards: Center for Internet Security (CIS) Amazon Web Services
Foundations Benchmark v1.2.0 Amazon Web Services Foundational Security Best Practices
Other standards are not automatically enabled. To opt out of automatically enabled
standards, set EnableDefaultStandards to false. After you enable Security Hub, to enable a
standard, use the BatchEnableStandards operation. To disable a standard, use the
BatchDisableStandards operation. To learn more, see the setup information in the Security
Hub User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ControlFindingGenerator"`: This field, used when enabling Security Hub, specifies
whether the calling account has consolidated control findings turned on. If the value for
this field is set to SECURITY_CONTROL, Security Hub generates a single finding for a
control check even when the check applies to multiple enabled standards. If the value for
this field is set to STANDARD_CONTROL, Security Hub generates separate findings for a
control check when the check applies to multiple enabled standards. The value for this
field in a member account matches the value in the administrator account. For accounts that
aren't part of an organization, the default value of this field is SECURITY_CONTROL if you
enabled Security Hub on or after February 23, 2023.
- `"EnableDefaultStandards"`: Whether to enable the security standards that Security Hub
has designated as automatically enabled. If you do not provide a value for
EnableDefaultStandards, it is set to true. To not enable the automatically enabled
standards, set EnableDefaultStandards to false.
- `"Tags"`: The tags to add to the hub resource when you enable Security Hub.
"""
function enable_security_hub(; aws_config::AbstractAWSConfig=global_aws_config())
return securityhub(
"POST", "/accounts"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function enable_security_hub(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"POST", "/accounts", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_administrator_account()
get_administrator_account(params::Dict{String,<:Any})
Provides the details for the Security Hub administrator account for the current member
account. Can be used by both member accounts that are managed using Organizations and
accounts that were invited manually.
"""
function get_administrator_account(; aws_config::AbstractAWSConfig=global_aws_config())
return securityhub(
"GET", "/administrator"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_administrator_account(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"GET",
"/administrator",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_configuration_policy(identifier)
get_configuration_policy(identifier, params::Dict{String,<:Any})
Provides information about a configuration policy. Only the Security Hub delegated
administrator can invoke this operation from the home Region.
# Arguments
- `identifier`: The Amazon Resource Name (ARN) or universally unique identifier (UUID) of
the configuration policy.
"""
function get_configuration_policy(
Identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"GET",
"/configurationPolicy/get/$(Identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_configuration_policy(
Identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"GET",
"/configurationPolicy/get/$(Identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_configuration_policy_association(target)
get_configuration_policy_association(target, params::Dict{String,<:Any})
Returns the association between a configuration and a target account, organizational unit,
or the root. The configuration can be a configuration policy or self-managed behavior. Only
the Security Hub delegated administrator can invoke this operation from the home Region.
# Arguments
- `target`: The target account ID, organizational unit ID, or the root ID to retrieve the
association for.
"""
function get_configuration_policy_association(
Target; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"POST",
"/configurationPolicyAssociation/get",
Dict{String,Any}("Target" => Target);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_configuration_policy_association(
Target, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"POST",
"/configurationPolicyAssociation/get",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Target" => Target), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_enabled_standards()
get_enabled_standards(params::Dict{String,<:Any})
Returns a list of the standards that are currently enabled.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to return in the response.
- `"NextToken"`: The token that is required for pagination. On your first call to the
GetEnabledStandards operation, set the value of this parameter to NULL. For subsequent
calls to the operation, to continue listing data, set the value of this parameter to the
value returned from the previous response.
- `"StandardsSubscriptionArns"`: The list of the standards subscription ARNs for the
standards to retrieve.
"""
function get_enabled_standards(; aws_config::AbstractAWSConfig=global_aws_config())
return securityhub(
"POST", "/standards/get"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_enabled_standards(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"POST",
"/standards/get",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_finding_aggregator(finding_aggregator_arn)
get_finding_aggregator(finding_aggregator_arn, params::Dict{String,<:Any})
Returns the current finding aggregation configuration.
# Arguments
- `finding_aggregator_arn`: The ARN of the finding aggregator to return details for. To
obtain the ARN, use ListFindingAggregators.
"""
function get_finding_aggregator(
FindingAggregatorArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"GET",
"/findingAggregator/get/$(FindingAggregatorArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_finding_aggregator(
FindingAggregatorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"GET",
"/findingAggregator/get/$(FindingAggregatorArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_finding_history(finding_identifier)
get_finding_history(finding_identifier, params::Dict{String,<:Any})
Returns history for a Security Hub finding in the last 90 days. The history includes
changes made to any fields in the Amazon Web Services Security Finding Format (ASFF).
# Arguments
- `finding_identifier`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EndTime"`: An ISO 8601-formatted timestamp that indicates the end time of the
requested finding history. If you provide values for both StartTime and EndTime, Security
Hub returns finding history for the specified time period. If you provide a value for
StartTime but not for EndTime, Security Hub returns finding history from the StartTime to
the time at which the API is called. If you provide a value for EndTime but not for
StartTime, Security Hub returns finding history from the CreatedAt timestamp of the finding
to the EndTime. If you provide neither StartTime nor EndTime, Security Hub returns finding
history from the CreatedAt timestamp of the finding to the time at which the API is called.
In all of these scenarios, the response is limited to 100 results, and the maximum time
period is limited to 90 days. This field accepts only the specified formats. Timestamps can
end with Z or (\"+\" / \"-\") time-hour [\":\" time-minute]. The time-secfrac after seconds
is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid
timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example,
2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example,
2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example,
2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example,
2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example,
2024-01-04T15:25:10.123456789+17:59)
- `"MaxResults"`: The maximum number of results to be returned. If you don’t provide it,
Security Hub returns up to 100 results of finding history.
- `"NextToken"`: A token for pagination purposes. Provide NULL as the initial value. In
subsequent requests, provide the token included in the response to get up to an additional
100 results of finding history. If you don’t provide NextToken, Security Hub returns up
to 100 results of finding history for each request.
- `"StartTime"`: A timestamp that indicates the start time of the requested finding
history. If you provide values for both StartTime and EndTime, Security Hub returns finding
history for the specified time period. If you provide a value for StartTime but not for
EndTime, Security Hub returns finding history from the StartTime to the time at which the
API is called. If you provide a value for EndTime but not for StartTime, Security Hub
returns finding history from the CreatedAt timestamp of the finding to the EndTime. If you
provide neither StartTime nor EndTime, Security Hub returns finding history from the
CreatedAt timestamp of the finding to the time at which the API is called. In all of these
scenarios, the response is limited to 100 results, and the maximum time period is limited
to 90 days. This field accepts only the specified formats. Timestamps can end with Z or
(\"+\" / \"-\") time-hour [\":\" time-minute]. The time-secfrac after seconds is limited to
a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats
with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
"""
function get_finding_history(
FindingIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"POST",
"/findingHistory/get",
Dict{String,Any}("FindingIdentifier" => FindingIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_finding_history(
FindingIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"POST",
"/findingHistory/get",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("FindingIdentifier" => FindingIdentifier), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_findings()
get_findings(params::Dict{String,<:Any})
Returns a list of findings that match the specified criteria. If finding aggregation is
enabled, then when you call GetFindings from the aggregation Region, the results include
all of the matching findings from both the aggregation Region and the linked Regions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: The finding attributes used to define a condition to filter the returned
findings. You can filter by up to 10 finding attributes. For each attribute, you can
provide up to 20 filter values. Note that in the available filter fields, WorkflowState is
deprecated. To search for a finding based on its workflow status, use WorkflowStatus.
- `"MaxResults"`: The maximum number of findings to return.
- `"NextToken"`: The token that is required for pagination. On your first call to the
GetFindings operation, set the value of this parameter to NULL. For subsequent calls to the
operation, to continue listing data, set the value of this parameter to the value returned
from the previous response.
- `"SortCriteria"`: The finding attributes used to sort the list of returned findings.
"""
function get_findings(; aws_config::AbstractAWSConfig=global_aws_config())
return securityhub(
"POST", "/findings"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_findings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"POST", "/findings", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_insight_results(insight_arn)
get_insight_results(insight_arn, params::Dict{String,<:Any})
Lists the results of the Security Hub insight specified by the insight ARN.
# Arguments
- `insight_arn`: The ARN of the insight for which to return results.
"""
function get_insight_results(InsightArn; aws_config::AbstractAWSConfig=global_aws_config())
return securityhub(
"GET",
"/insights/results/$(InsightArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_insight_results(
InsightArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"GET",
"/insights/results/$(InsightArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_insights()
get_insights(params::Dict{String,<:Any})
Lists and describes insights for the specified insight ARNs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InsightArns"`: The ARNs of the insights to describe. If you do not provide any insight
ARNs, then GetInsights returns all of your custom insights. It does not return any managed
insights.
- `"MaxResults"`: The maximum number of items to return in the response.
- `"NextToken"`: The token that is required for pagination. On your first call to the
GetInsights operation, set the value of this parameter to NULL. For subsequent calls to the
operation, to continue listing data, set the value of this parameter to the value returned
from the previous response.
"""
function get_insights(; aws_config::AbstractAWSConfig=global_aws_config())
return securityhub(
"POST", "/insights/get"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_insights(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"POST",
"/insights/get",
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 Security Hub membership invitations that were sent to the current
member account, not including the currently accepted invitation.
"""
function get_invitations_count(; aws_config::AbstractAWSConfig=global_aws_config())
return securityhub(
"GET", "/invitations/count"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_invitations_count(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"GET",
"/invitations/count",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_master_account()
get_master_account(params::Dict{String,<:Any})
This method is deprecated. Instead, use GetAdministratorAccount. The Security Hub console
continues to use GetMasterAccount. It will eventually change to use
GetAdministratorAccount. Any IAM policies that specifically control access to this function
must continue to use GetMasterAccount. You should also add GetAdministratorAccount to your
policies to ensure that the correct permissions are in place after the console begins to
use GetAdministratorAccount. Provides the details for the Security Hub administrator
account for the current member account. Can be used by both member accounts that are
managed using Organizations and accounts that were invited manually.
"""
function get_master_account(; aws_config::AbstractAWSConfig=global_aws_config())
return securityhub(
"GET", "/master"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_master_account(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"GET", "/master", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_members(account_ids)
get_members(account_ids, params::Dict{String,<:Any})
Returns the details for the Security Hub member accounts for the specified account IDs. An
administrator account can be either the delegated Security Hub administrator account for an
organization or an administrator account that enabled Security Hub manually. The results
include both member accounts that are managed using Organizations and accounts that were
invited manually.
# Arguments
- `account_ids`: The list of account IDs for the Security Hub member accounts to return the
details for.
"""
function get_members(AccountIds; aws_config::AbstractAWSConfig=global_aws_config())
return securityhub(
"POST",
"/members/get",
Dict{String,Any}("AccountIds" => AccountIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_members(
AccountIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"POST",
"/members/get",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AccountIds" => AccountIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_security_control_definition(security_control_id)
get_security_control_definition(security_control_id, params::Dict{String,<:Any})
Retrieves the definition of a security control. The definition includes the control title,
description, Region availability, parameter definitions, and other details.
# Arguments
- `security_control_id`: The ID of the security control to retrieve the definition for.
This field doesn’t accept an Amazon Resource Name (ARN).
"""
function get_security_control_definition(
SecurityControlId; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"GET",
"/securityControl/definition",
Dict{String,Any}("SecurityControlId" => SecurityControlId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_security_control_definition(
SecurityControlId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"GET",
"/securityControl/definition",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("SecurityControlId" => SecurityControlId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
invite_members(account_ids)
invite_members(account_ids, params::Dict{String,<:Any})
Invites other Amazon Web Services accounts to become member accounts for the Security Hub
administrator account that the invitation is sent from. This operation is only used to
invite accounts that do not belong to an organization. Organization accounts do not receive
invitations. Before you can use this action to invite a member, you must first use the
CreateMembers action to create the member account in Security Hub. When the account owner
enables Security Hub and accepts the invitation to become a member account, the
administrator account can view the findings generated from the member account.
# Arguments
- `account_ids`: The list of account IDs of the Amazon Web Services accounts to invite to
Security Hub as members.
"""
function invite_members(AccountIds; aws_config::AbstractAWSConfig=global_aws_config())
return securityhub(
"POST",
"/members/invite",
Dict{String,Any}("AccountIds" => AccountIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function invite_members(
AccountIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"POST",
"/members/invite",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AccountIds" => AccountIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_automation_rules()
list_automation_rules(params::Dict{String,<:Any})
A list of automation rules and their metadata for the calling account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of rules to return in the response. This currently
ranges from 1 to 100.
- `"NextToken"`: A token to specify where to start paginating the response. This is the
NextToken from a previously truncated response. On your first call to the
ListAutomationRules API, set the value of this parameter to NULL.
"""
function list_automation_rules(; aws_config::AbstractAWSConfig=global_aws_config())
return securityhub(
"GET",
"/automationrules/list";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_automation_rules(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"GET",
"/automationrules/list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_configuration_policies()
list_configuration_policies(params::Dict{String,<:Any})
Lists the configuration policies that the Security Hub delegated administrator has created
for your organization. Only the delegated administrator can invoke this operation from the
home Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results that's returned by
ListConfigurationPolicies in each page of the response. When this parameter is used,
ListConfigurationPolicies returns the specified number of results in a single page and a
NextToken response element. You can see the remaining results of the initial request by
sending another ListConfigurationPolicies request with the returned NextToken value. A
valid range for MaxResults is between 1 and 100.
- `"NextToken"`: The NextToken value that's returned from a previous paginated
ListConfigurationPolicies request where MaxResults was used but the results exceeded the
value of that parameter. Pagination continues from the MaxResults was used but the results
exceeded the value of that parameter. Pagination continues from the end of the previous
response that returned the NextToken value. This value is null when there are no more
results to return.
"""
function list_configuration_policies(; aws_config::AbstractAWSConfig=global_aws_config())
return securityhub(
"GET",
"/configurationPolicy/list";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_configuration_policies(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"GET",
"/configurationPolicy/list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_configuration_policy_associations()
list_configuration_policy_associations(params::Dict{String,<:Any})
Provides information about the associations for your configuration policies and
self-managed behavior. Only the Security Hub delegated administrator can invoke this
operation from the home Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Options for filtering the ListConfigurationPolicyAssociations response. You
can filter by the Amazon Resource Name (ARN) or universally unique identifier (UUID) of a
configuration, AssociationType, or AssociationStatus.
- `"MaxResults"`: The maximum number of results that's returned by
ListConfigurationPolicies in each page of the response. When this parameter is used,
ListConfigurationPolicyAssociations returns the specified number of results in a single
page and a NextToken response element. You can see the remaining results of the initial
request by sending another ListConfigurationPolicyAssociations request with the returned
NextToken value. A valid range for MaxResults is between 1 and 100.
- `"NextToken"`: The NextToken value that's returned from a previous paginated
ListConfigurationPolicyAssociations request where MaxResults was used but the results
exceeded the value of that parameter. Pagination continues from the end of the previous
response that returned the NextToken value. This value is null when there are no more
results to return.
"""
function list_configuration_policy_associations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"POST",
"/configurationPolicyAssociation/list";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_configuration_policy_associations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"POST",
"/configurationPolicyAssociation/list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_enabled_products_for_import()
list_enabled_products_for_import(params::Dict{String,<:Any})
Lists all findings-generating solutions (products) that you are subscribed to receive
findings from in Security Hub.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of items to return in the response.
- `"NextToken"`: The token that is required for pagination. On your first call to the
ListEnabledProductsForImport operation, set the value of this parameter to NULL. For
subsequent calls to the operation, to continue listing data, set the value of this
parameter to the value returned from the previous response.
"""
function list_enabled_products_for_import(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"GET",
"/productSubscriptions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_enabled_products_for_import(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"GET",
"/productSubscriptions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_finding_aggregators()
list_finding_aggregators(params::Dict{String,<:Any})
If finding aggregation is enabled, then ListFindingAggregators returns the ARN of the
finding aggregator. You can run this operation from any 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. This operation currently only
returns a single result.
- `"NextToken"`: The token returned with the previous set of results. Identifies the next
set of results to return.
"""
function list_finding_aggregators(; aws_config::AbstractAWSConfig=global_aws_config())
return securityhub(
"GET",
"/findingAggregator/list";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_finding_aggregators(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"GET",
"/findingAggregator/list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_invitations()
list_invitations(params::Dict{String,<:Any})
Lists all Security Hub membership invitations that were sent to the current Amazon Web
Services account. This operation is only used by accounts that are managed by invitation.
Accounts that are managed using the integration with Organizations do not receive
invitations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of items to return in the response.
- `"NextToken"`: The token that is required for pagination. On your first call to the
ListInvitations operation, set the value of this parameter to NULL. For subsequent calls to
the operation, to continue listing data, set the value of this parameter to the value
returned from the previous response.
"""
function list_invitations(; aws_config::AbstractAWSConfig=global_aws_config())
return securityhub(
"GET", "/invitations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_invitations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"GET",
"/invitations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_members()
list_members(params::Dict{String,<:Any})
Lists details about all member accounts for the current Security Hub administrator account.
The results include both member accounts that belong to an organization and member accounts
that were invited manually.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of items to return in the response.
- `"NextToken"`: The token that is required for pagination. On your first call to the
ListMembers operation, set the value of this parameter to NULL. For subsequent calls to the
operation, to continue listing data, set the value of this parameter to the value returned
from the previous response.
- `"OnlyAssociated"`: Specifies which member accounts to include in the response based on
their relationship status with the administrator account. The default value is TRUE. If
OnlyAssociated is set to TRUE, the response includes member accounts whose relationship
status with the administrator account is set to ENABLED. If OnlyAssociated is set to FALSE,
the response includes all existing member accounts.
"""
function list_members(; aws_config::AbstractAWSConfig=global_aws_config())
return securityhub(
"GET", "/members"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_members(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"GET", "/members", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_organization_admin_accounts()
list_organization_admin_accounts(params::Dict{String,<:Any})
Lists the Security Hub administrator accounts. 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 items to return in the response.
- `"NextToken"`: The token that is required for pagination. On your first call to the
ListOrganizationAdminAccounts operation, set the value of this parameter to NULL. For
subsequent calls to the operation, to continue listing data, set the value of this
parameter to the value returned from the previous response.
"""
function list_organization_admin_accounts(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"GET", "/organization/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 securityhub(
"GET",
"/organization/admin",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_security_control_definitions()
list_security_control_definitions(params::Dict{String,<:Any})
Lists all of the security controls that apply to a specified standard.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: An optional parameter that limits the total results of the API response
to the specified number. If this parameter isn't provided in the request, the results
include the first 25 security controls that apply to the specified standard. The results
also include a NextToken parameter that you can use in a subsequent API call to get the
next 25 controls. This repeats until all controls for the standard are returned.
- `"NextToken"`: Optional pagination parameter.
- `"StandardsArn"`: The Amazon Resource Name (ARN) of the standard that you want to view
controls for.
"""
function list_security_control_definitions(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"GET",
"/securityControls/definitions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_security_control_definitions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"GET",
"/securityControls/definitions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_standards_control_associations(security_control_id)
list_standards_control_associations(security_control_id, params::Dict{String,<:Any})
Specifies whether a control is currently enabled or disabled in each enabled standard in
the calling account.
# Arguments
- `security_control_id`: The identifier of the control (identified with SecurityControlId,
SecurityControlArn, or a mix of both parameters) that you want to determine the enablement
status of in each enabled standard.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: An optional parameter that limits the total results of the API response
to the specified number. If this parameter isn't provided in the request, the results
include the first 25 standard and control associations. The results also include a
NextToken parameter that you can use in a subsequent API call to get the next 25
associations. This repeats until all associations for the specified control are returned.
The number of results is limited by the number of supported Security Hub standards that
you've enabled in the calling account.
- `"NextToken"`: Optional pagination parameter.
"""
function list_standards_control_associations(
SecurityControlId; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"GET",
"/associations",
Dict{String,Any}("SecurityControlId" => SecurityControlId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_standards_control_associations(
SecurityControlId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"GET",
"/associations",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("SecurityControlId" => SecurityControlId), 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 a resource.
# Arguments
- `resource_arn`: The ARN of the resource to retrieve tags for.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"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 securityhub(
"GET",
"/tags/$(ResourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_configuration_policy_association(configuration_policy_identifier, target)
start_configuration_policy_association(configuration_policy_identifier, target, params::Dict{String,<:Any})
Associates a target account, organizational unit, or the root with a specified
configuration. The target can be associated with a configuration policy or self-managed
behavior. Only the Security Hub delegated administrator can invoke this operation from the
home Region.
# Arguments
- `configuration_policy_identifier`: The Amazon Resource Name (ARN) of a configuration
policy, the universally unique identifier (UUID) of a configuration policy, or a value of
SELF_MANAGED_SECURITY_HUB for a self-managed configuration.
- `target`: The identifier of the target account, organizational unit, or the root to
associate with the specified configuration.
"""
function start_configuration_policy_association(
ConfigurationPolicyIdentifier, Target; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"POST",
"/configurationPolicyAssociation/associate",
Dict{String,Any}(
"ConfigurationPolicyIdentifier" => ConfigurationPolicyIdentifier,
"Target" => Target,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_configuration_policy_association(
ConfigurationPolicyIdentifier,
Target,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"POST",
"/configurationPolicyAssociation/associate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigurationPolicyIdentifier" => ConfigurationPolicyIdentifier,
"Target" => Target,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_configuration_policy_disassociation(configuration_policy_identifier)
start_configuration_policy_disassociation(configuration_policy_identifier, params::Dict{String,<:Any})
Disassociates a target account, organizational unit, or the root from a specified
configuration. When you disassociate a configuration from its target, the target inherits
the configuration of the closest parent. If there’s no configuration to inherit, the
target retains its settings but becomes a self-managed account. A target can be
disassociated from a configuration policy or self-managed behavior. Only the Security Hub
delegated administrator can invoke this operation from the home Region.
# Arguments
- `configuration_policy_identifier`: The Amazon Resource Name (ARN) of a configuration
policy, the universally unique identifier (UUID) of a configuration policy, or a value of
SELF_MANAGED_SECURITY_HUB for a self-managed configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Target"`: The identifier of the target account, organizational unit, or the root to
disassociate from the specified configuration.
"""
function start_configuration_policy_disassociation(
ConfigurationPolicyIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"POST",
"/configurationPolicyAssociation/disassociate",
Dict{String,Any}("ConfigurationPolicyIdentifier" => ConfigurationPolicyIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_configuration_policy_disassociation(
ConfigurationPolicyIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"POST",
"/configurationPolicyAssociation/disassociate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigurationPolicyIdentifier" => ConfigurationPolicyIdentifier
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds one or more tags to a resource.
# Arguments
- `resource_arn`: The ARN of the resource to apply the tags to.
- `tags`: The tags to add to the resource. You can add up to 50 tags at a time. The tag
keys can be no longer than 128 characters. The tag values can be no longer than 256
characters.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return securityhub(
"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 securityhub(
"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 a resource.
# Arguments
- `resource_arn`: The ARN of the resource to remove the tags from.
- `tag_keys`: The tag keys associated with the tags to remove from the resource. You can
remove up to 50 tags at a time.
"""
function untag_resource(
ResourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"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 securityhub(
"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_action_target(action_target_arn)
update_action_target(action_target_arn, params::Dict{String,<:Any})
Updates the name and description of a custom action target in Security Hub.
# Arguments
- `action_target_arn`: The ARN of the custom action target to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The updated description for the custom action target.
- `"Name"`: The updated name of the custom action target.
"""
function update_action_target(
ActionTargetArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"PATCH",
"/actionTargets/$(ActionTargetArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_action_target(
ActionTargetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"PATCH",
"/actionTargets/$(ActionTargetArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_configuration_policy(identifier)
update_configuration_policy(identifier, params::Dict{String,<:Any})
Updates a configuration policy. Only the Security Hub delegated administrator can invoke
this operation from the home Region.
# Arguments
- `identifier`: The Amazon Resource Name (ARN) or universally unique identifier (UUID) of
the configuration policy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConfigurationPolicy"`: An object that defines how Security Hub is configured. It
includes whether Security Hub is enabled or disabled, a list of enabled security standards,
a list of enabled or disabled security controls, and a list of custom parameter values for
specified controls. If you provide a list of security controls that are enabled in the
configuration policy, Security Hub disables all other controls (including newly released
controls). If you provide a list of security controls that are disabled in the
configuration policy, Security Hub enables all other controls (including newly released
controls). When updating a configuration policy, provide a complete list of standards that
you want to enable and a complete list of controls that you want to enable or disable. The
updated configuration replaces the current configuration.
- `"Description"`: The description of the configuration policy.
- `"Name"`: The name of the configuration policy. Alphanumeric characters and the
following ASCII characters are permitted: -, ., !, *, /.
- `"UpdatedReason"`: The reason for updating the configuration policy.
"""
function update_configuration_policy(
Identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"PATCH",
"/configurationPolicy/$(Identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_configuration_policy(
Identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"PATCH",
"/configurationPolicy/$(Identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_finding_aggregator(finding_aggregator_arn, region_linking_mode)
update_finding_aggregator(finding_aggregator_arn, region_linking_mode, params::Dict{String,<:Any})
Updates the finding aggregation configuration. Used to update the Region linking mode and
the list of included or excluded Regions. You cannot use UpdateFindingAggregator to change
the aggregation Region. You must run UpdateFindingAggregator from the current aggregation
Region.
# Arguments
- `finding_aggregator_arn`: The ARN of the finding aggregator. To obtain the ARN, use
ListFindingAggregators.
- `region_linking_mode`: Indicates whether to aggregate findings from all of the available
Regions in the current partition. Also determines whether to automatically aggregate
findings from new Regions as Security Hub supports them and you opt into them. The selected
option also determines how to use the Regions provided in the Regions list. The options are
as follows: ALL_REGIONS - Indicates to aggregate findings from all of the Regions where
Security Hub is enabled. When you choose this option, Security Hub also automatically
aggregates findings from new Regions as Security Hub supports them and you opt into them.
ALL_REGIONS_EXCEPT_SPECIFIED - Indicates to aggregate findings from all of the Regions
where Security Hub is enabled, except for the Regions listed in the Regions parameter. When
you choose this option, Security Hub also automatically aggregates findings from new
Regions as Security Hub supports them and you opt into them. SPECIFIED_REGIONS -
Indicates to aggregate findings only from the Regions listed in the Regions parameter.
Security Hub does not automatically aggregate findings from new Regions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Regions"`: If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a
space-separated list of Regions that do not aggregate findings to the aggregation Region.
If RegionLinkingMode is SPECIFIED_REGIONS, then this is a space-separated list of Regions
that do aggregate findings to the aggregation Region.
"""
function update_finding_aggregator(
FindingAggregatorArn,
RegionLinkingMode;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"PATCH",
"/findingAggregator/update",
Dict{String,Any}(
"FindingAggregatorArn" => FindingAggregatorArn,
"RegionLinkingMode" => RegionLinkingMode,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_finding_aggregator(
FindingAggregatorArn,
RegionLinkingMode,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"PATCH",
"/findingAggregator/update",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FindingAggregatorArn" => FindingAggregatorArn,
"RegionLinkingMode" => RegionLinkingMode,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_findings(filters)
update_findings(filters, params::Dict{String,<:Any})
UpdateFindings is a deprecated operation. Instead of UpdateFindings, use the
BatchUpdateFindings operation. Updates the Note and RecordState of the Security
Hub-aggregated findings that the filter attributes specify. Any member account that can
view the finding also sees the update to the finding. Finding updates made with
UpdateFindings might not be persisted if the same finding is later updated by the finding
provider through the BatchImportFindings operation.
# Arguments
- `filters`: A collection of attributes that specify which findings you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Note"`: The updated note for the finding.
- `"RecordState"`: The updated record state for the finding.
"""
function update_findings(Filters; aws_config::AbstractAWSConfig=global_aws_config())
return securityhub(
"PATCH",
"/findings",
Dict{String,Any}("Filters" => Filters);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_findings(
Filters, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"PATCH",
"/findings",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Filters" => Filters), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_insight(insight_arn)
update_insight(insight_arn, params::Dict{String,<:Any})
Updates the Security Hub insight identified by the specified insight ARN.
# Arguments
- `insight_arn`: The ARN of the insight that you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: The updated filters that define this insight.
- `"GroupByAttribute"`: The updated GroupBy attribute that defines this insight.
- `"Name"`: The updated name for the insight.
"""
function update_insight(InsightArn; aws_config::AbstractAWSConfig=global_aws_config())
return securityhub(
"PATCH",
"/insights/$(InsightArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_insight(
InsightArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"PATCH",
"/insights/$(InsightArn)",
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 configuration of your organization in Security Hub. Only the Security Hub
administrator account can invoke this operation.
# Arguments
- `auto_enable`: Whether to automatically enable Security Hub in new member accounts when
they join the organization. If set to true, then Security Hub is automatically enabled in
new accounts. If set to false, then Security Hub isn't enabled in new accounts
automatically. The default value is false. If the ConfigurationType of your organization is
set to CENTRAL, then this field is set to false and can't be changed in the home Region and
linked Regions. However, in that case, the delegated administrator can create a
configuration policy in which Security Hub is enabled and associate the policy with new
organization accounts.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AutoEnableStandards"`: Whether to automatically enable Security Hub default standards
in new member accounts when they join the organization. The default value of this parameter
is equal to DEFAULT. If equal to DEFAULT, then Security Hub default standards are
automatically enabled for new member accounts. If equal to NONE, then default standards are
not automatically enabled for new member accounts. If the ConfigurationType of your
organization is set to CENTRAL, then this field is set to NONE and can't be changed in the
home Region and linked Regions. However, in that case, the delegated administrator can
create a configuration policy in which specific security standards are enabled and
associate the policy with new organization accounts.
- `"OrganizationConfiguration"`:
"""
function update_organization_configuration(
AutoEnable; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"POST",
"/organization/configuration",
Dict{String,Any}("AutoEnable" => AutoEnable);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_organization_configuration(
AutoEnable,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"POST",
"/organization/configuration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AutoEnable" => AutoEnable), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_security_control(parameters, security_control_id)
update_security_control(parameters, security_control_id, params::Dict{String,<:Any})
Updates the properties of a security control.
# Arguments
- `parameters`: An object that specifies which security control parameters to update.
- `security_control_id`: The Amazon Resource Name (ARN) or ID of the control to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LastUpdateReason"`: The most recent reason for updating the properties of the security
control. This field accepts alphanumeric characters in addition to white spaces, dashes,
and underscores.
"""
function update_security_control(
Parameters, SecurityControlId; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"PATCH",
"/securityControl/update",
Dict{String,Any}(
"Parameters" => Parameters, "SecurityControlId" => SecurityControlId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_security_control(
Parameters,
SecurityControlId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"PATCH",
"/securityControl/update",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Parameters" => Parameters, "SecurityControlId" => SecurityControlId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_security_hub_configuration()
update_security_hub_configuration(params::Dict{String,<:Any})
Updates configuration options for Security Hub.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AutoEnableControls"`: Whether to automatically enable new controls when they are added
to standards that are enabled. By default, this is set to true, and new controls are
enabled automatically. To not automatically enable new controls, set this to false.
- `"ControlFindingGenerator"`: Updates whether the calling account has consolidated control
findings turned on. If the value for this field is set to SECURITY_CONTROL, Security Hub
generates a single finding for a control check even when the check applies to multiple
enabled standards. If the value for this field is set to STANDARD_CONTROL, Security Hub
generates separate findings for a control check when the check applies to multiple enabled
standards. For accounts that are part of an organization, this value can only be updated in
the administrator account.
"""
function update_security_hub_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"PATCH", "/accounts"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function update_security_hub_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"PATCH", "/accounts", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
update_standards_control(standards_control_arn)
update_standards_control(standards_control_arn, params::Dict{String,<:Any})
Used to control whether an individual security standard control is enabled or disabled.
# Arguments
- `standards_control_arn`: The ARN of the security standard control to enable or disable.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ControlStatus"`: The updated status of the security standard control.
- `"DisabledReason"`: A description of the reason why you are disabling a security standard
control. If you are disabling a control, then this is required.
"""
function update_standards_control(
StandardsControlArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return securityhub(
"PATCH",
"/standards/control/$(StandardsControlArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_standards_control(
StandardsControlArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securityhub(
"PATCH",
"/standards/control/$(StandardsControlArn)",
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 | 44515 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: securitylake
using AWS.Compat
using AWS.UUIDs
"""
create_aws_log_source(sources)
create_aws_log_source(sources, params::Dict{String,<:Any})
Adds a natively supported Amazon Web Service as an Amazon Security Lake source. Enables
source types for member accounts in required Amazon Web Services Regions, based on the
parameters you specify. You can choose any source type in any Region for either accounts
that are part of a trusted organization or standalone accounts. Once you add an Amazon Web
Service as a source, Security Lake starts collecting logs and events from it. You can use
this API only to enable natively supported Amazon Web Services as a source. Use
CreateCustomLogSource to enable data collection from a custom source.
# Arguments
- `sources`: Specify the natively-supported Amazon Web Services service to add as a source
in Security Lake.
"""
function create_aws_log_source(sources; aws_config::AbstractAWSConfig=global_aws_config())
return securitylake(
"POST",
"/v1/datalake/logsources/aws",
Dict{String,Any}("sources" => sources);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_aws_log_source(
sources, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securitylake(
"POST",
"/v1/datalake/logsources/aws",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("sources" => sources), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_custom_log_source(configuration, source_name)
create_custom_log_source(configuration, source_name, params::Dict{String,<:Any})
Adds a third-party custom source in Amazon Security Lake, from the Amazon Web Services
Region where you want to create a custom source. Security Lake can collect logs and events
from third-party custom sources. After creating the appropriate IAM role to invoke Glue
crawler, use this API to add a custom source name in Security Lake. This operation creates
a partition in the Amazon S3 bucket for Security Lake as the target location for log files
from the custom source. In addition, this operation also creates an associated Glue table
and an Glue crawler.
# Arguments
- `configuration`: The configuration for the third-party custom source.
- `source_name`: Specify the name for a third-party custom source. This must be a
Regionally unique value.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"eventClasses"`: The Open Cybersecurity Schema Framework (OCSF) event classes which
describes the type of data that the custom source will send to Security Lake. The supported
event classes are: ACCESS_ACTIVITY FILE_ACTIVITY KERNEL_ACTIVITY
KERNEL_EXTENSION MEMORY_ACTIVITY MODULE_ACTIVITY PROCESS_ACTIVITY
REGISTRY_KEY_ACTIVITY REGISTRY_VALUE_ACTIVITY RESOURCE_ACTIVITY
SCHEDULED_JOB_ACTIVITY SECURITY_FINDING ACCOUNT_CHANGE AUTHENTICATION
AUTHORIZATION ENTITY_MANAGEMENT_AUDIT DHCP_ACTIVITY NETWORK_ACTIVITY
DNS_ACTIVITY FTP_ACTIVITY HTTP_ACTIVITY RDP_ACTIVITY SMB_ACTIVITY
SSH_ACTIVITY CONFIG_STATE INVENTORY_INFO EMAIL_ACTIVITY API_ACTIVITY
CLOUD_API
- `"sourceVersion"`: Specify the source version for the third-party custom source, to limit
log collection to a specific version of custom data source.
"""
function create_custom_log_source(
configuration, sourceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return securitylake(
"POST",
"/v1/datalake/logsources/custom",
Dict{String,Any}("configuration" => configuration, "sourceName" => sourceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_custom_log_source(
configuration,
sourceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securitylake(
"POST",
"/v1/datalake/logsources/custom",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"configuration" => configuration, "sourceName" => sourceName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_data_lake(configurations, meta_store_manager_role_arn)
create_data_lake(configurations, meta_store_manager_role_arn, params::Dict{String,<:Any})
Initializes an Amazon Security Lake instance with the provided (or default) configuration.
You can enable Security Lake in Amazon Web Services Regions with customized settings before
enabling log collection in Regions. To specify particular Regions, configure these Regions
using the configurations parameter. If you have already enabled Security Lake in a Region
when you call this command, the command will update the Region if you provide new
configuration parameters. If you have not already enabled Security Lake in the Region when
you call this API, it will set up the data lake in the Region with the specified
configurations. When you enable Security Lake, it starts ingesting security data after the
CreateAwsLogSource call. This includes ingesting security data from sources, storing data,
and making data accessible to subscribers. Security Lake also enables all the existing
settings and resources that it stores or maintains for your Amazon Web Services account in
the current Region, including security log and event data. For more information, see the
Amazon Security Lake User Guide.
# Arguments
- `configurations`: Specify the Region or Regions that will contribute data to the rollup
region.
- `meta_store_manager_role_arn`: The Amazon Resource Name (ARN) used to create and update
the Glue table. This table contains partitions generated by the ingestion and normalization
of Amazon Web Services log sources and custom sources.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: An array of objects, one for each tag to associate with the data lake
configuration. For each tag, you must specify both a tag key and a tag value. A tag value
cannot be null, but it can be an empty string.
"""
function create_data_lake(
configurations,
metaStoreManagerRoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securitylake(
"POST",
"/v1/datalake",
Dict{String,Any}(
"configurations" => configurations,
"metaStoreManagerRoleArn" => metaStoreManagerRoleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_data_lake(
configurations,
metaStoreManagerRoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securitylake(
"POST",
"/v1/datalake",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"configurations" => configurations,
"metaStoreManagerRoleArn" => metaStoreManagerRoleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_data_lake_exception_subscription(notification_endpoint, subscription_protocol)
create_data_lake_exception_subscription(notification_endpoint, subscription_protocol, params::Dict{String,<:Any})
Creates the specified notification subscription in Amazon Security Lake for the
organization you specify.
# Arguments
- `notification_endpoint`: The Amazon Web Services account where you want to receive
exception notifications.
- `subscription_protocol`: The subscription protocol to which exception notifications are
posted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"exceptionTimeToLive"`: The expiration period and time-to-live (TTL).
"""
function create_data_lake_exception_subscription(
notificationEndpoint,
subscriptionProtocol;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securitylake(
"POST",
"/v1/datalake/exceptions/subscription",
Dict{String,Any}(
"notificationEndpoint" => notificationEndpoint,
"subscriptionProtocol" => subscriptionProtocol,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_data_lake_exception_subscription(
notificationEndpoint,
subscriptionProtocol,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securitylake(
"POST",
"/v1/datalake/exceptions/subscription",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"notificationEndpoint" => notificationEndpoint,
"subscriptionProtocol" => subscriptionProtocol,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_data_lake_organization_configuration()
create_data_lake_organization_configuration(params::Dict{String,<:Any})
Automatically enables Amazon Security Lake for new member accounts in your organization.
Security Lake is not automatically enabled for any existing member accounts in your
organization.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"autoEnableNewAccount"`: Enable Security Lake with the specified configuration settings,
to begin collecting security data for new accounts in your organization.
"""
function create_data_lake_organization_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return securitylake(
"POST",
"/v1/datalake/organization/configuration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_data_lake_organization_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securitylake(
"POST",
"/v1/datalake/organization/configuration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_subscriber(sources, subscriber_identity, subscriber_name)
create_subscriber(sources, subscriber_identity, subscriber_name, params::Dict{String,<:Any})
Creates a subscription permission for accounts that are already enabled in Amazon Security
Lake. You can create a subscriber with access to data in the current Amazon Web Services
Region.
# Arguments
- `sources`: The supported Amazon Web Services from which logs and events are collected.
Security Lake supports log and event collection for natively supported Amazon Web Services.
- `subscriber_identity`: The Amazon Web Services identity used to access your data.
- `subscriber_name`: The name of your Security Lake subscriber account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accessTypes"`: The Amazon S3 or Lake Formation access type.
- `"subscriberDescription"`: The description for your subscriber account in Security Lake.
- `"tags"`: An array of objects, one for each tag to associate with the subscriber. For
each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but
it can be an empty string.
"""
function create_subscriber(
sources,
subscriberIdentity,
subscriberName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securitylake(
"POST",
"/v1/subscribers",
Dict{String,Any}(
"sources" => sources,
"subscriberIdentity" => subscriberIdentity,
"subscriberName" => subscriberName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_subscriber(
sources,
subscriberIdentity,
subscriberName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securitylake(
"POST",
"/v1/subscribers",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"sources" => sources,
"subscriberIdentity" => subscriberIdentity,
"subscriberName" => subscriberName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_subscriber_notification(configuration, subscriber_id)
create_subscriber_notification(configuration, subscriber_id, params::Dict{String,<:Any})
Notifies the subscriber when new data is written to the data lake for the sources that the
subscriber consumes in Security Lake. You can create only one subscriber notification per
subscriber.
# Arguments
- `configuration`: Specify the configuration using which you want to create the subscriber
notification.
- `subscriber_id`: The subscriber ID for the notification subscription.
"""
function create_subscriber_notification(
configuration, subscriberId; aws_config::AbstractAWSConfig=global_aws_config()
)
return securitylake(
"POST",
"/v1/subscribers/$(subscriberId)/notification",
Dict{String,Any}("configuration" => configuration);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_subscriber_notification(
configuration,
subscriberId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securitylake(
"POST",
"/v1/subscribers/$(subscriberId)/notification",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("configuration" => configuration), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_aws_log_source(sources)
delete_aws_log_source(sources, params::Dict{String,<:Any})
Removes a natively supported Amazon Web Service as an Amazon Security Lake source. You can
remove a source for one or more Regions. When you remove the source, Security Lake stops
collecting data from that source in the specified Regions and accounts, and subscribers can
no longer consume new data from the source. However, subscribers can still consume data
that Security Lake collected from the source before removal. You can choose any source type
in any Amazon Web Services Region for either accounts that are part of a trusted
organization or standalone accounts.
# Arguments
- `sources`: Specify the natively-supported Amazon Web Services service to remove as a
source in Security Lake.
"""
function delete_aws_log_source(sources; aws_config::AbstractAWSConfig=global_aws_config())
return securitylake(
"POST",
"/v1/datalake/logsources/aws/delete",
Dict{String,Any}("sources" => sources);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_aws_log_source(
sources, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securitylake(
"POST",
"/v1/datalake/logsources/aws/delete",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("sources" => sources), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_custom_log_source(source_name)
delete_custom_log_source(source_name, params::Dict{String,<:Any})
Removes a custom log source from Amazon Security Lake, to stop sending data from the custom
source to Security Lake.
# Arguments
- `source_name`: The source name of custom log source that you want to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"sourceVersion"`: The source version for the third-party custom source. You can limit
the custom source removal to the specified source version.
"""
function delete_custom_log_source(
sourceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return securitylake(
"DELETE",
"/v1/datalake/logsources/custom/$(sourceName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_custom_log_source(
sourceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securitylake(
"DELETE",
"/v1/datalake/logsources/custom/$(sourceName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_data_lake(regions)
delete_data_lake(regions, params::Dict{String,<:Any})
When you disable Amazon Security Lake from your account, Security Lake is disabled in all
Amazon Web Services Regions and it stops collecting data from your sources. Also, this API
automatically takes steps to remove the account from Security Lake. However, Security Lake
retains all of your existing settings and the resources that it created in your Amazon Web
Services account in the current Amazon Web Services Region. The DeleteDataLake operation
does not delete the data that is stored in your Amazon S3 bucket, which is owned by your
Amazon Web Services account. For more information, see the Amazon Security Lake User Guide.
# Arguments
- `regions`: The list of Regions where Security Lake is enabled.
"""
function delete_data_lake(regions; aws_config::AbstractAWSConfig=global_aws_config())
return securitylake(
"POST",
"/v1/datalake/delete",
Dict{String,Any}("regions" => regions);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_data_lake(
regions, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securitylake(
"POST",
"/v1/datalake/delete",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("regions" => regions), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_data_lake_exception_subscription()
delete_data_lake_exception_subscription(params::Dict{String,<:Any})
Deletes the specified notification subscription in Amazon Security Lake for the
organization you specify.
"""
function delete_data_lake_exception_subscription(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return securitylake(
"DELETE",
"/v1/datalake/exceptions/subscription";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_data_lake_exception_subscription(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securitylake(
"DELETE",
"/v1/datalake/exceptions/subscription",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_data_lake_organization_configuration()
delete_data_lake_organization_configuration(params::Dict{String,<:Any})
Turns off automatic enablement of Amazon Security Lake for member accounts that are added
to an organization in Organizations. Only the delegated Security Lake administrator for an
organization can perform this operation. If the delegated Security Lake administrator
performs this operation, new member accounts won't automatically contribute data to the
data lake.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"autoEnableNewAccount"`: Turns off automatic enablement of Security Lake for member
accounts that are added to an organization.
"""
function delete_data_lake_organization_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return securitylake(
"POST",
"/v1/datalake/organization/configuration/delete";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_data_lake_organization_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securitylake(
"POST",
"/v1/datalake/organization/configuration/delete",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_subscriber(subscriber_id)
delete_subscriber(subscriber_id, params::Dict{String,<:Any})
Deletes the subscription permission and all notification settings for accounts that are
already enabled in Amazon Security Lake. When you run DeleteSubscriber, the subscriber will
no longer consume data from Security Lake and the subscriber is removed. This operation
deletes the subscriber and removes access to data in the current Amazon Web Services Region.
# Arguments
- `subscriber_id`: A value created by Security Lake that uniquely identifies your
DeleteSubscriber API request.
"""
function delete_subscriber(subscriberId; aws_config::AbstractAWSConfig=global_aws_config())
return securitylake(
"DELETE",
"/v1/subscribers/$(subscriberId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_subscriber(
subscriberId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securitylake(
"DELETE",
"/v1/subscribers/$(subscriberId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_subscriber_notification(subscriber_id)
delete_subscriber_notification(subscriber_id, params::Dict{String,<:Any})
Deletes the specified notification subscription in Amazon Security Lake for the
organization you specify.
# Arguments
- `subscriber_id`: The ID of the Security Lake subscriber account.
"""
function delete_subscriber_notification(
subscriberId; aws_config::AbstractAWSConfig=global_aws_config()
)
return securitylake(
"DELETE",
"/v1/subscribers/$(subscriberId)/notification";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_subscriber_notification(
subscriberId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securitylake(
"DELETE",
"/v1/subscribers/$(subscriberId)/notification",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_data_lake_delegated_administrator()
deregister_data_lake_delegated_administrator(params::Dict{String,<:Any})
Deletes the Amazon Security Lake delegated administrator account for the organization. This
API can only be called by the organization management account. The organization management
account cannot be the delegated administrator account.
"""
function deregister_data_lake_delegated_administrator(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return securitylake(
"DELETE",
"/v1/datalake/delegate";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_data_lake_delegated_administrator(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securitylake(
"DELETE",
"/v1/datalake/delegate",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_data_lake_exception_subscription()
get_data_lake_exception_subscription(params::Dict{String,<:Any})
Retrieves the details of exception notifications for the account in Amazon Security Lake.
"""
function get_data_lake_exception_subscription(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return securitylake(
"GET",
"/v1/datalake/exceptions/subscription";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_data_lake_exception_subscription(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securitylake(
"GET",
"/v1/datalake/exceptions/subscription",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_data_lake_organization_configuration()
get_data_lake_organization_configuration(params::Dict{String,<:Any})
Retrieves the configuration that will be automatically set up for accounts added to the
organization after the organization has onboarded to Amazon Security Lake. This API does
not take input parameters.
"""
function get_data_lake_organization_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return securitylake(
"GET",
"/v1/datalake/organization/configuration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_data_lake_organization_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securitylake(
"GET",
"/v1/datalake/organization/configuration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_data_lake_sources()
get_data_lake_sources(params::Dict{String,<:Any})
Retrieves a snapshot of the current Region, including whether Amazon Security Lake is
enabled for those accounts and which sources Security Lake is collecting data from.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accounts"`: The Amazon Web Services account ID for which a static snapshot of the
current Amazon Web Services Region, including enabled accounts and log sources, is
retrieved.
- `"maxResults"`: The maximum limit of accounts for which the static snapshot of the
current Region, including enabled accounts and log sources, is retrieved.
- `"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 an HTTP 400 InvalidToken error.
"""
function get_data_lake_sources(; aws_config::AbstractAWSConfig=global_aws_config())
return securitylake(
"POST",
"/v1/datalake/sources";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_data_lake_sources(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securitylake(
"POST",
"/v1/datalake/sources",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_subscriber(subscriber_id)
get_subscriber(subscriber_id, params::Dict{String,<:Any})
Retrieves the subscription information for the specified subscription ID. You can get
information about a specific subscriber.
# Arguments
- `subscriber_id`: A value created by Amazon Security Lake that uniquely identifies your
GetSubscriber API request.
"""
function get_subscriber(subscriberId; aws_config::AbstractAWSConfig=global_aws_config())
return securitylake(
"GET",
"/v1/subscribers/$(subscriberId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_subscriber(
subscriberId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securitylake(
"GET",
"/v1/subscribers/$(subscriberId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_data_lake_exceptions()
list_data_lake_exceptions(params::Dict{String,<:Any})
Lists the Amazon Security Lake exceptions that you can use to find the source of problems
and fix them.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: List the maximum number of failures in Security Lake.
- `"nextToken"`: List 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 an HTTP 400 InvalidToken error.
- `"regions"`: The Amazon Web Services Regions from which exceptions are retrieved.
"""
function list_data_lake_exceptions(; aws_config::AbstractAWSConfig=global_aws_config())
return securitylake(
"POST",
"/v1/datalake/exceptions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_data_lake_exceptions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securitylake(
"POST",
"/v1/datalake/exceptions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_data_lakes()
list_data_lakes(params::Dict{String,<:Any})
Retrieves the Amazon Security Lake configuration object for the specified Amazon Web
Services Regions. You can use this operation to determine whether Security Lake is enabled
for a Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"regions"`: The list of Regions where Security Lake is enabled.
"""
function list_data_lakes(; aws_config::AbstractAWSConfig=global_aws_config())
return securitylake(
"GET", "/v1/datalakes"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_data_lakes(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securitylake(
"GET",
"/v1/datalakes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_log_sources()
list_log_sources(params::Dict{String,<:Any})
Retrieves the log sources in the current Amazon Web Services Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accounts"`: The list of Amazon Web Services accounts for which log sources are
displayed.
- `"maxResults"`: The maximum number of accounts for which the log sources are displayed.
- `"nextToken"`: If nextToken is returned, there are more results available. You can repeat
the call using the returned token to retrieve the next page.
- `"regions"`: The list of Regions for which log sources are displayed.
- `"sources"`: The list of sources for which log sources are displayed.
"""
function list_log_sources(; aws_config::AbstractAWSConfig=global_aws_config())
return securitylake(
"POST",
"/v1/datalake/logsources/list";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_log_sources(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securitylake(
"POST",
"/v1/datalake/logsources/list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_subscribers()
list_subscribers(params::Dict{String,<:Any})
List all subscribers for the specific Amazon Security Lake account ID. You can retrieve a
list of subscriptions associated with a specific organization or 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 accounts for which the configuration is displayed.
- `"nextToken"`: If nextToken is returned, there are more results available. You can repeat
the call using the returned token to retrieve the next page.
"""
function list_subscribers(; aws_config::AbstractAWSConfig=global_aws_config())
return securitylake(
"GET", "/v1/subscribers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_subscribers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return securitylake(
"GET",
"/v1/subscribers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Retrieves the tags (keys and values) that are associated with an Amazon Security Lake
resource: a subscriber, or the data lake configuration for your Amazon Web Services account
in a particular Amazon Web Services Region.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the Amazon Security Lake resource for
which you want to retrieve the tags.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return securitylake(
"GET",
"/v1/tags/$(resourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securitylake(
"GET",
"/v1/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_data_lake_delegated_administrator(account_id)
register_data_lake_delegated_administrator(account_id, params::Dict{String,<:Any})
Designates the Amazon Security Lake delegated administrator account for the organization.
This API can only be called by the organization management account. The organization
management account cannot be the delegated administrator account.
# Arguments
- `account_id`: The Amazon Web Services account ID of the Security Lake delegated
administrator.
"""
function register_data_lake_delegated_administrator(
accountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return securitylake(
"POST",
"/v1/datalake/delegate",
Dict{String,Any}("accountId" => accountId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_data_lake_delegated_administrator(
accountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securitylake(
"POST",
"/v1/datalake/delegate",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("accountId" => accountId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds or updates one or more tags that are associated with an Amazon Security Lake resource:
a subscriber, or the data lake configuration for your Amazon Web Services account in a
particular Amazon Web Services Region. A tag is a label that you can define and associate
with Amazon Web Services resources. Each tag consists of a required tag key and an
associated tag value. A tag key is a general label that acts as a category for a more
specific tag value. A tag value acts as a descriptor for a tag key. Tags can help you
identify, categorize, and manage resources in different ways, such as by owner,
environment, or other criteria. For more information, see Tagging Amazon Security Lake
resources in the Amazon Security Lake User Guide.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the Amazon Security Lake resource to
add or update the tags for.
- `tags`: An array of objects, one for each tag (key and value) to associate with the
Amazon Security Lake resource. For each tag, you must specify both a tag key and a tag
value. A tag value cannot be null, but it can be an empty string.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return securitylake(
"POST",
"/v1/tags/$(resourceArn)",
Dict{String,Any}("tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resourceArn,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securitylake(
"POST",
"/v1/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tags" => tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes one or more tags (keys and values) from an Amazon Security Lake resource: a
subscriber, or the data lake configuration for your Amazon Web Services account in a
particular Amazon Web Services Region.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the Amazon Security Lake resource to
remove one or more tags from.
- `tag_keys`: A list of one or more tag keys. For each value in the list, specify the tag
key for a tag to remove from the Amazon Security Lake resource.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return securitylake(
"DELETE",
"/v1/tags/$(resourceArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securitylake(
"DELETE",
"/v1/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_data_lake(configurations)
update_data_lake(configurations, params::Dict{String,<:Any})
Specifies where to store your security data and for how long. You can add a rollup Region
to consolidate data from multiple Amazon Web Services Regions.
# Arguments
- `configurations`: Specify the Region or Regions that will contribute data to the rollup
region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"metaStoreManagerRoleArn"`: The Amazon Resource Name (ARN) used to create and update the
Glue table. This table contains partitions generated by the ingestion and normalization of
Amazon Web Services log sources and custom sources.
"""
function update_data_lake(configurations; aws_config::AbstractAWSConfig=global_aws_config())
return securitylake(
"PUT",
"/v1/datalake",
Dict{String,Any}("configurations" => configurations);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_data_lake(
configurations,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securitylake(
"PUT",
"/v1/datalake",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("configurations" => configurations), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_data_lake_exception_subscription(notification_endpoint, subscription_protocol)
update_data_lake_exception_subscription(notification_endpoint, subscription_protocol, params::Dict{String,<:Any})
Updates the specified notification subscription in Amazon Security Lake for the
organization you specify.
# Arguments
- `notification_endpoint`: The account that is subscribed to receive exception
notifications.
- `subscription_protocol`: The subscription protocol to which exception messages are posted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"exceptionTimeToLive"`: The time-to-live (TTL) for the exception message to remain.
"""
function update_data_lake_exception_subscription(
notificationEndpoint,
subscriptionProtocol;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securitylake(
"PUT",
"/v1/datalake/exceptions/subscription",
Dict{String,Any}(
"notificationEndpoint" => notificationEndpoint,
"subscriptionProtocol" => subscriptionProtocol,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_data_lake_exception_subscription(
notificationEndpoint,
subscriptionProtocol,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securitylake(
"PUT",
"/v1/datalake/exceptions/subscription",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"notificationEndpoint" => notificationEndpoint,
"subscriptionProtocol" => subscriptionProtocol,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_subscriber(subscriber_id)
update_subscriber(subscriber_id, params::Dict{String,<:Any})
Updates an existing subscription for the given Amazon Security Lake account ID. You can
update a subscriber by changing the sources that the subscriber consumes data from.
# Arguments
- `subscriber_id`: A value created by Security Lake that uniquely identifies your
subscription.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"sources"`: The supported Amazon Web Services from which logs and events are collected.
For the list of supported Amazon Web Services, see the Amazon Security Lake User Guide.
- `"subscriberDescription"`: The description of the Security Lake account subscriber.
- `"subscriberIdentity"`: The AWS identity used to access your data.
- `"subscriberName"`: The name of the Security Lake account subscriber.
"""
function update_subscriber(subscriberId; aws_config::AbstractAWSConfig=global_aws_config())
return securitylake(
"PUT",
"/v1/subscribers/$(subscriberId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_subscriber(
subscriberId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securitylake(
"PUT",
"/v1/subscribers/$(subscriberId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_subscriber_notification(configuration, subscriber_id)
update_subscriber_notification(configuration, subscriber_id, params::Dict{String,<:Any})
Updates an existing notification method for the subscription (SQS or HTTPs endpoint) or
switches the notification subscription endpoint for a subscriber.
# Arguments
- `configuration`: The configuration for subscriber notification.
- `subscriber_id`: The subscription ID for which the subscription notification is specified.
"""
function update_subscriber_notification(
configuration, subscriberId; aws_config::AbstractAWSConfig=global_aws_config()
)
return securitylake(
"PUT",
"/v1/subscribers/$(subscriberId)/notification",
Dict{String,Any}("configuration" => configuration);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_subscriber_notification(
configuration,
subscriberId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return securitylake(
"PUT",
"/v1/subscribers/$(subscriberId)/notification",
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 | 22699 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: serverlessapplicationrepository
using AWS.Compat
using AWS.UUIDs
"""
create_application(author, description, name)
create_application(author, description, name, params::Dict{String,<:Any})
Creates an application, optionally including an AWS SAM file to create the first
application version in the same call.
# Arguments
- `author`: The name of the author publishing the app.Minimum length=1. Maximum
length=127.Pattern \"^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?\";
- `description`: The description of the application.Minimum length=1. Maximum length=256
- `name`: The name of the application that you want to publish.Minimum length=1. Maximum
length=140Pattern: \"[a-zA-Z0-9-]+\";
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"homePageUrl"`: A URL with more information about the application, for example the
location of your GitHub repository for the application.
- `"labels"`: Labels to improve discovery of apps in search results.Minimum length=1.
Maximum length=127. Maximum number of labels: 10Pattern: \"^[a-zA-Z0-9+-_:/@]+\";
- `"licenseBody"`: A local text file that contains the license of the app that matches the
spdxLicenseID value of your application.
The file has the format
file://<path>/<filename>.Maximum size 5 MBYou can specify only one of licenseBody and
licenseUrl; otherwise, an error results.
- `"licenseUrl"`: A link to the S3 object that contains the license of the app that matches
the spdxLicenseID value of your application.Maximum size 5 MBYou can specify only one of
licenseBody and licenseUrl; otherwise, an error results.
- `"readmeBody"`: A local text readme file in Markdown language that contains a more
detailed description of the application and how it works.
The file has the format
file://<path>/<filename>.Maximum size 5 MBYou can specify only one of readmeBody and
readmeUrl; otherwise, an error results.
- `"readmeUrl"`: A link to the S3 object in Markdown language that contains a more detailed
description of the application and how it works.Maximum size 5 MBYou can specify only one
of readmeBody and readmeUrl; otherwise, an error results.
- `"semanticVersion"`: The semantic version of the application:
https://semver.org/
- `"sourceCodeArchiveUrl"`: A link to the S3 object that contains the ZIP archive of the
source code for this version of your application.Maximum size 50 MB
- `"sourceCodeUrl"`: A link to a public repository for the source code of your application,
for example the URL of a specific GitHub commit.
- `"spdxLicenseId"`: A valid identifier from https://spdx.org/licenses/.
- `"templateBody"`: The local raw packaged AWS SAM template file of your application.
The
file has the format file://<path>/<filename>.You can specify only one of templateBody
and templateUrl; otherwise an error results.
- `"templateUrl"`: A link to the S3 object containing the packaged AWS SAM template of your
application.You can specify only one of templateBody and templateUrl; otherwise an error
results.
"""
function create_application(
author, description, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return serverlessapplicationrepository(
"POST",
"/applications",
Dict{String,Any}("author" => author, "description" => description, "name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_application(
author,
description,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return serverlessapplicationrepository(
"POST",
"/applications",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"author" => author, "description" => description, "name" => name
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_application_version(application_id, semantic_version)
create_application_version(application_id, semantic_version, params::Dict{String,<:Any})
Creates an application version.
# Arguments
- `application_id`: The Amazon Resource Name (ARN) of the application.
- `semantic_version`: The semantic version of the new version.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"sourceCodeArchiveUrl"`: A link to the S3 object that contains the ZIP archive of the
source code for this version of your application.Maximum size 50 MB
- `"sourceCodeUrl"`: A link to a public repository for the source code of your application,
for example the URL of a specific GitHub commit.
- `"templateBody"`: The raw packaged AWS SAM template of your application.
- `"templateUrl"`: A link to the packaged AWS SAM template of your application.
"""
function create_application_version(
applicationId, semanticVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return serverlessapplicationrepository(
"PUT",
"/applications/$(applicationId)/versions/$(semanticVersion)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_application_version(
applicationId,
semanticVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return serverlessapplicationrepository(
"PUT",
"/applications/$(applicationId)/versions/$(semanticVersion)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_cloud_formation_change_set(application_id, stack_name)
create_cloud_formation_change_set(application_id, stack_name, params::Dict{String,<:Any})
Creates an AWS CloudFormation change set for the given application.
# Arguments
- `application_id`: The Amazon Resource Name (ARN) of the application.
- `stack_name`: This property corresponds to the parameter of the same name for the AWS
CloudFormation CreateChangeSet
API.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"capabilities"`: A list of values that you must specify before you can deploy certain
applications.
Some applications might include resources that can affect permissions in
your AWS
account, for example, by creating new AWS Identity and Access Management (IAM)
users.
For those applications, you must explicitly acknowledge their capabilities by
specifying this parameter.The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM,
CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.The following resources require you
to specify CAPABILITY_IAM or
CAPABILITY_NAMED_IAM:
AWS::IAM::Group,
AWS::IAM::InstanceProfile,
AWS::IAM::Policy, and
AWS::IAM::Role.
If the application
contains IAM resources, you can specify either CAPABILITY_IAM
or CAPABILITY_NAMED_IAM. If
the application contains IAM resources
with custom names, you must specify
CAPABILITY_NAMED_IAM.The following resources require you to specify
CAPABILITY_RESOURCE_POLICY:
AWS::Lambda::Permission,
AWS::IAM:Policy,
AWS::ApplicationAutoScaling::ScalingPolicy,
AWS::S3::BucketPolicy,
AWS::SQS::QueuePolicy,
and
AWS::SNS:TopicPolicy.Applications that contain one or more nested applications require
you to specify
CAPABILITY_AUTO_EXPAND.If your application template contains any of the
above resources, we recommend that you review
all permissions associated with the
application before deploying. If you don't specify
this parameter for an application that
requires capabilities, the call will fail.
- `"changeSetName"`: This property corresponds to the parameter of the same name for the
AWS CloudFormation CreateChangeSet
API.
- `"clientToken"`: This property corresponds to the parameter of the same name for the AWS
CloudFormation CreateChangeSet
API.
- `"description"`: This property corresponds to the parameter of the same name for the AWS
CloudFormation CreateChangeSet
API.
- `"notificationArns"`: This property corresponds to the parameter of the same name for the
AWS CloudFormation CreateChangeSet
API.
- `"parameterOverrides"`: A list of parameter values for the parameters of the application.
- `"resourceTypes"`: This property corresponds to the parameter of the same name for the
AWS CloudFormation CreateChangeSet
API.
- `"rollbackConfiguration"`: This property corresponds to the parameter of the same name
for the AWS CloudFormation CreateChangeSet
API.
- `"semanticVersion"`: The semantic version of the application:
https://semver.org/
- `"tags"`: This property corresponds to the parameter of the same name for the AWS
CloudFormation CreateChangeSet
API.
- `"templateId"`: The UUID returned by CreateCloudFormationTemplate.Pattern:
[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}
"""
function create_cloud_formation_change_set(
applicationId, stackName; aws_config::AbstractAWSConfig=global_aws_config()
)
return serverlessapplicationrepository(
"POST",
"/applications/$(applicationId)/changesets",
Dict{String,Any}("stackName" => stackName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_cloud_formation_change_set(
applicationId,
stackName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return serverlessapplicationrepository(
"POST",
"/applications/$(applicationId)/changesets",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("stackName" => stackName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_cloud_formation_template(application_id)
create_cloud_formation_template(application_id, params::Dict{String,<:Any})
Creates an AWS CloudFormation template.
# Arguments
- `application_id`: The Amazon Resource Name (ARN) of the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"semanticVersion"`: The semantic version of the application:
https://semver.org/
"""
function create_cloud_formation_template(
applicationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return serverlessapplicationrepository(
"POST",
"/applications/$(applicationId)/templates";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_cloud_formation_template(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return serverlessapplicationrepository(
"POST",
"/applications/$(applicationId)/templates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_application(application_id)
delete_application(application_id, params::Dict{String,<:Any})
Deletes the specified application.
# Arguments
- `application_id`: The Amazon Resource Name (ARN) of the application.
"""
function delete_application(
applicationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return serverlessapplicationrepository(
"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 serverlessapplicationrepository(
"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})
Gets the specified application.
# Arguments
- `application_id`: The Amazon Resource Name (ARN) of the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"semanticVersion"`: The semantic version of the application to get.
"""
function get_application(applicationId; aws_config::AbstractAWSConfig=global_aws_config())
return serverlessapplicationrepository(
"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 serverlessapplicationrepository(
"GET",
"/applications/$(applicationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_application_policy(application_id)
get_application_policy(application_id, params::Dict{String,<:Any})
Retrieves the policy for the application.
# Arguments
- `application_id`: The Amazon Resource Name (ARN) of the application.
"""
function get_application_policy(
applicationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return serverlessapplicationrepository(
"GET",
"/applications/$(applicationId)/policy";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_application_policy(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return serverlessapplicationrepository(
"GET",
"/applications/$(applicationId)/policy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_cloud_formation_template(application_id, template_id)
get_cloud_formation_template(application_id, template_id, params::Dict{String,<:Any})
Gets the specified AWS CloudFormation template.
# Arguments
- `application_id`: The Amazon Resource Name (ARN) of the application.
- `template_id`: The UUID returned by CreateCloudFormationTemplate.Pattern:
[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}
"""
function get_cloud_formation_template(
applicationId, templateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return serverlessapplicationrepository(
"GET",
"/applications/$(applicationId)/templates/$(templateId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_cloud_formation_template(
applicationId,
templateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return serverlessapplicationrepository(
"GET",
"/applications/$(applicationId)/templates/$(templateId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_application_dependencies(application_id)
list_application_dependencies(application_id, params::Dict{String,<:Any})
Retrieves the list of applications nested in the containing application.
# Arguments
- `application_id`: The Amazon Resource Name (ARN) of the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxItems"`: The total number of items to return.
- `"nextToken"`: A token to specify where to start paginating.
- `"semanticVersion"`: The semantic version of the application to get.
"""
function list_application_dependencies(
applicationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return serverlessapplicationrepository(
"GET",
"/applications/$(applicationId)/dependencies";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_application_dependencies(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return serverlessapplicationrepository(
"GET",
"/applications/$(applicationId)/dependencies",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_application_versions(application_id)
list_application_versions(application_id, params::Dict{String,<:Any})
Lists versions for the specified application.
# Arguments
- `application_id`: The Amazon Resource Name (ARN) of the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxItems"`: The total number of items to return.
- `"nextToken"`: A token to specify where to start paginating.
"""
function list_application_versions(
applicationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return serverlessapplicationrepository(
"GET",
"/applications/$(applicationId)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_application_versions(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return serverlessapplicationrepository(
"GET",
"/applications/$(applicationId)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_applications()
list_applications(params::Dict{String,<:Any})
Lists applications owned by the requester.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxItems"`: The total number of items to return.
- `"nextToken"`: A token to specify where to start paginating.
"""
function list_applications(; aws_config::AbstractAWSConfig=global_aws_config())
return serverlessapplicationrepository(
"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 serverlessapplicationrepository(
"GET",
"/applications",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_application_policy(application_id, statements)
put_application_policy(application_id, statements, params::Dict{String,<:Any})
Sets the permission policy for an application. For the list of actions supported for this
operation, see
Application
Permissions
.
# Arguments
- `application_id`: The Amazon Resource Name (ARN) of the application.
- `statements`: An array of policy statements applied to the application.
"""
function put_application_policy(
applicationId, statements; aws_config::AbstractAWSConfig=global_aws_config()
)
return serverlessapplicationrepository(
"PUT",
"/applications/$(applicationId)/policy",
Dict{String,Any}("statements" => statements);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_application_policy(
applicationId,
statements,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return serverlessapplicationrepository(
"PUT",
"/applications/$(applicationId)/policy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("statements" => statements), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
unshare_application(application_id, organization_id)
unshare_application(application_id, organization_id, params::Dict{String,<:Any})
Unshares an application from an AWS Organization.This operation can be called only from the
organization's master account.
# Arguments
- `application_id`: The Amazon Resource Name (ARN) of the application.
- `organization_id`: The AWS Organization ID to unshare the application from.
"""
function unshare_application(
applicationId, organizationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return serverlessapplicationrepository(
"POST",
"/applications/$(applicationId)/unshare",
Dict{String,Any}("organizationId" => organizationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function unshare_application(
applicationId,
organizationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return serverlessapplicationrepository(
"POST",
"/applications/$(applicationId)/unshare",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("organizationId" => organizationId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_application(application_id)
update_application(application_id, params::Dict{String,<:Any})
Updates the specified application.
# Arguments
- `application_id`: The Amazon Resource Name (ARN) of the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"author"`: The name of the author publishing the app.Minimum length=1. Maximum
length=127.Pattern \"^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?\";
- `"description"`: The description of the application.Minimum length=1. Maximum length=256
- `"homePageUrl"`: A URL with more information about the application, for example the
location of your GitHub repository for the application.
- `"labels"`: Labels to improve discovery of apps in search results.Minimum length=1.
Maximum length=127. Maximum number of labels: 10Pattern: \"^[a-zA-Z0-9+-_:/@]+\";
- `"readmeBody"`: A text readme file in Markdown language that contains a more detailed
description of the application and how it works.Maximum size 5 MB
- `"readmeUrl"`: A link to the readme file in Markdown language that contains a more
detailed description of the application and how it works.Maximum size 5 MB
"""
function update_application(
applicationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return serverlessapplicationrepository(
"PATCH",
"/applications/$(applicationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_application(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return serverlessapplicationrepository(
"PATCH",
"/applications/$(applicationId)",
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 | 162720 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: service_catalog
using AWS.Compat
using AWS.UUIDs
"""
accept_portfolio_share(portfolio_id)
accept_portfolio_share(portfolio_id, params::Dict{String,<:Any})
Accepts an offer to share the specified portfolio.
# Arguments
- `portfolio_id`: The portfolio identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"PortfolioShareType"`: The type of shared portfolios to accept. The default is to accept
imported portfolios. AWS_ORGANIZATIONS - Accept portfolios shared by the management
account of your organization. IMPORTED - Accept imported portfolios.
AWS_SERVICECATALOG - Not supported. (Throws ResourceNotFoundException.) For example, aws
servicecatalog accept-portfolio-share --portfolio-id \"port-2qwzkwxt3y5fk\"
--portfolio-share-type AWS_ORGANIZATIONS
"""
function accept_portfolio_share(
PortfolioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"AcceptPortfolioShare",
Dict{String,Any}("PortfolioId" => PortfolioId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function accept_portfolio_share(
PortfolioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"AcceptPortfolioShare",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PortfolioId" => PortfolioId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_budget_with_resource(budget_name, resource_id)
associate_budget_with_resource(budget_name, resource_id, params::Dict{String,<:Any})
Associates the specified budget with the specified resource.
# Arguments
- `budget_name`: The name of the budget you want to associate.
- `resource_id`: The resource identifier. Either a portfolio-id or a product-id.
"""
function associate_budget_with_resource(
BudgetName, ResourceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"AssociateBudgetWithResource",
Dict{String,Any}("BudgetName" => BudgetName, "ResourceId" => ResourceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_budget_with_resource(
BudgetName,
ResourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"AssociateBudgetWithResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("BudgetName" => BudgetName, "ResourceId" => ResourceId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_principal_with_portfolio(portfolio_id, principal_arn, principal_type)
associate_principal_with_portfolio(portfolio_id, principal_arn, principal_type, params::Dict{String,<:Any})
Associates the specified principal ARN with the specified portfolio. If you share the
portfolio with principal name sharing enabled, the PrincipalARN association is included in
the share. The PortfolioID, PrincipalARN, and PrincipalType parameters are required. You
can associate a maximum of 10 Principals with a portfolio using PrincipalType as
IAM_PATTERN. When you associate a principal with portfolio, a potential privilege
escalation path may occur when that portfolio is then shared with other accounts. For a
user in a recipient account who is not an Service Catalog Admin, but still has the ability
to create Principals (Users/Groups/Roles), that user could create a role that matches a
principal name association for the portfolio. Although this user may not know which
principal names are associated through Service Catalog, they may be able to guess the user.
If this potential escalation path is a concern, then Service Catalog recommends using
PrincipalType as IAM. With this configuration, the PrincipalARN must already exist in the
recipient account before it can be associated.
# Arguments
- `portfolio_id`: The portfolio identifier.
- `principal_arn`: The ARN of the principal (user, role, or group). If the PrincipalType is
IAM, the supported value is a fully defined IAM Amazon Resource Name (ARN). If the
PrincipalType is IAM_PATTERN, the supported value is an IAM ARN without an AccountID in the
following format: arn:partition:iam:::resource-type/resource-id The ARN resource-id can
be either: A fully formed resource-id. For example, arn:aws:iam:::role/resource-name or
arn:aws:iam:::role/resource-path/resource-name A wildcard ARN. The wildcard ARN accepts
IAM_PATTERN values with a \"*\" or \"?\" in the resource-id segment of the ARN. For example
arn:partition:service:::resource-type/resource-path/resource-name. The new symbols are
exclusive to the resource-path and resource-name and cannot replace the resource-type or
other ARN values. The ARN path and principal name allow unlimited wildcard characters.
Examples of an acceptable wildcard ARN: arn:aws:iam:::role/ResourceName_*
arn:aws:iam:::role/*/ResourceName_? Examples of an unacceptable wildcard ARN:
arn:aws:iam:::*/ResourceName You can associate multiple IAM_PATTERNs even if the account
has no principal with that name. The \"?\" wildcard character matches zero or one of any
character. This is similar to \".?\" in regular regex context. The \"*\" wildcard character
matches any number of any characters. This is similar to \".*\" in regular regex context.
In the IAM Principal ARN format
(arn:partition:iam:::resource-type/resource-path/resource-name), valid resource-type values
include user/, group/, or role/. The \"?\" and \"*\" characters are allowed only after the
resource-type in the resource-id segment. You can use special characters anywhere within
the resource-id. The \"*\" character also matches the \"/\" character, allowing paths to
be formed within the resource-id. For example, arn:aws:iam:::role/*/ResourceName_? matches
both arn:aws:iam:::role/pathA/pathB/ResourceName_1 and
arn:aws:iam:::role/pathA/ResourceName_1.
- `principal_type`: The principal type. The supported value is IAM if you use a fully
defined Amazon Resource Name (ARN), or IAM_PATTERN if you use an ARN with no accountID,
with or without wildcard characters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
"""
function associate_principal_with_portfolio(
PortfolioId,
PrincipalARN,
PrincipalType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"AssociatePrincipalWithPortfolio",
Dict{String,Any}(
"PortfolioId" => PortfolioId,
"PrincipalARN" => PrincipalARN,
"PrincipalType" => PrincipalType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_principal_with_portfolio(
PortfolioId,
PrincipalARN,
PrincipalType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"AssociatePrincipalWithPortfolio",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PortfolioId" => PortfolioId,
"PrincipalARN" => PrincipalARN,
"PrincipalType" => PrincipalType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_product_with_portfolio(portfolio_id, product_id)
associate_product_with_portfolio(portfolio_id, product_id, params::Dict{String,<:Any})
Associates the specified product with the specified portfolio. A delegated admin is
authorized to invoke this command.
# Arguments
- `portfolio_id`: The portfolio identifier.
- `product_id`: The product identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"SourcePortfolioId"`: The identifier of the source portfolio.
"""
function associate_product_with_portfolio(
PortfolioId, ProductId; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"AssociateProductWithPortfolio",
Dict{String,Any}("PortfolioId" => PortfolioId, "ProductId" => ProductId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_product_with_portfolio(
PortfolioId,
ProductId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"AssociateProductWithPortfolio",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("PortfolioId" => PortfolioId, "ProductId" => ProductId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_service_action_with_provisioning_artifact(product_id, provisioning_artifact_id, service_action_id)
associate_service_action_with_provisioning_artifact(product_id, provisioning_artifact_id, service_action_id, params::Dict{String,<:Any})
Associates a self-service action with a provisioning artifact.
# Arguments
- `product_id`: The product identifier. For example, prod-abcdzk7xy33qa.
- `provisioning_artifact_id`: The identifier of the provisioning artifact. For example,
pa-4abcdjnxjj6ne.
- `service_action_id`: The self-service action identifier. For example, act-fs7abcd89wxyz.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"IdempotencyToken"`: A unique identifier that you provide to ensure idempotency. If
multiple requests from the same Amazon Web Services account use the same idempotency token,
the same response is returned for each repeated request.
"""
function associate_service_action_with_provisioning_artifact(
ProductId,
ProvisioningArtifactId,
ServiceActionId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"AssociateServiceActionWithProvisioningArtifact",
Dict{String,Any}(
"ProductId" => ProductId,
"ProvisioningArtifactId" => ProvisioningArtifactId,
"ServiceActionId" => ServiceActionId,
"IdempotencyToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_service_action_with_provisioning_artifact(
ProductId,
ProvisioningArtifactId,
ServiceActionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"AssociateServiceActionWithProvisioningArtifact",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ProductId" => ProductId,
"ProvisioningArtifactId" => ProvisioningArtifactId,
"ServiceActionId" => ServiceActionId,
"IdempotencyToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_tag_option_with_resource(resource_id, tag_option_id)
associate_tag_option_with_resource(resource_id, tag_option_id, params::Dict{String,<:Any})
Associate the specified TagOption with the specified portfolio or product.
# Arguments
- `resource_id`: The resource identifier.
- `tag_option_id`: The TagOption identifier.
"""
function associate_tag_option_with_resource(
ResourceId, TagOptionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"AssociateTagOptionWithResource",
Dict{String,Any}("ResourceId" => ResourceId, "TagOptionId" => TagOptionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_tag_option_with_resource(
ResourceId,
TagOptionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"AssociateTagOptionWithResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceId" => ResourceId, "TagOptionId" => TagOptionId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_associate_service_action_with_provisioning_artifact(service_action_associations)
batch_associate_service_action_with_provisioning_artifact(service_action_associations, params::Dict{String,<:Any})
Associates multiple self-service actions with provisioning artifacts.
# Arguments
- `service_action_associations`: One or more associations, each consisting of the Action
ID, the Product ID, and the Provisioning Artifact ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
"""
function batch_associate_service_action_with_provisioning_artifact(
ServiceActionAssociations; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"BatchAssociateServiceActionWithProvisioningArtifact",
Dict{String,Any}("ServiceActionAssociations" => ServiceActionAssociations);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_associate_service_action_with_provisioning_artifact(
ServiceActionAssociations,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"BatchAssociateServiceActionWithProvisioningArtifact",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ServiceActionAssociations" => ServiceActionAssociations),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_disassociate_service_action_from_provisioning_artifact(service_action_associations)
batch_disassociate_service_action_from_provisioning_artifact(service_action_associations, params::Dict{String,<:Any})
Disassociates a batch of self-service actions from the specified provisioning artifact.
# Arguments
- `service_action_associations`: One or more associations, each consisting of the Action
ID, the Product ID, and the Provisioning Artifact ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
"""
function batch_disassociate_service_action_from_provisioning_artifact(
ServiceActionAssociations; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"BatchDisassociateServiceActionFromProvisioningArtifact",
Dict{String,Any}("ServiceActionAssociations" => ServiceActionAssociations);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_disassociate_service_action_from_provisioning_artifact(
ServiceActionAssociations,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"BatchDisassociateServiceActionFromProvisioningArtifact",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ServiceActionAssociations" => ServiceActionAssociations),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
copy_product(idempotency_token, source_product_arn)
copy_product(idempotency_token, source_product_arn, params::Dict{String,<:Any})
Copies the specified source product to the specified target product or a new product. You
can copy a product to the same account or another account. You can copy a product to the
same Region or another Region. If you copy a product to another account, you must first
share the product in a portfolio using CreatePortfolioShare. This operation is performed
asynchronously. To track the progress of the operation, use DescribeCopyProductStatus.
# Arguments
- `idempotency_token`: A unique identifier that you provide to ensure idempotency. If
multiple requests differ only by the idempotency token, the same response is returned for
each repeated request.
- `source_product_arn`: The Amazon Resource Name (ARN) of the source product.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"CopyOptions"`: The copy options. If the value is CopyTags, the tags from the source
product are copied to the target product.
- `"SourceProvisioningArtifactIdentifiers"`: The identifiers of the provisioning artifacts
(also known as versions) of the product to copy. By default, all provisioning artifacts are
copied.
- `"TargetProductId"`: The identifier of the target product. By default, a new product is
created.
- `"TargetProductName"`: A name for the target product. The default is the name of the
source product.
"""
function copy_product(
IdempotencyToken, SourceProductArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"CopyProduct",
Dict{String,Any}(
"IdempotencyToken" => IdempotencyToken, "SourceProductArn" => SourceProductArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function copy_product(
IdempotencyToken,
SourceProductArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"CopyProduct",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IdempotencyToken" => IdempotencyToken,
"SourceProductArn" => SourceProductArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_constraint(idempotency_token, parameters, portfolio_id, product_id, type)
create_constraint(idempotency_token, parameters, portfolio_id, product_id, type, params::Dict{String,<:Any})
Creates a constraint. A delegated admin is authorized to invoke this command.
# Arguments
- `idempotency_token`: A unique identifier that you provide to ensure idempotency. If
multiple requests differ only by the idempotency token, the same response is returned for
each repeated request.
- `parameters`: The constraint parameters, in JSON format. The syntax depends on the
constraint type as follows: LAUNCH You are required to specify either the RoleArn or the
LocalRoleName but can't use both. Specify the RoleArn property as follows: {\"RoleArn\" :
\"arn:aws:iam::123456789012:role/LaunchRole\"} Specify the LocalRoleName property as
follows: {\"LocalRoleName\": \"SCBasicLaunchRole\"} If you specify the LocalRoleName
property, when an account uses the launch constraint, the IAM role with that name in the
account will be used. This allows launch-role constraints to be account-agnostic so the
administrator can create fewer resources per shared account. The given role name must
exist in the account used to create the launch constraint and the account of the user who
launches a product with this launch constraint. You cannot have both a LAUNCH and a
STACKSET constraint. You also cannot have more than one LAUNCH constraint on a product and
portfolio. NOTIFICATION Specify the NotificationArns property as follows:
{\"NotificationArns\" : [\"arn:aws:sns:us-east-1:123456789012:Topic\"]} RESOURCE_UPDATE
Specify the TagUpdatesOnProvisionedProduct property as follows:
{\"Version\":\"2.0\",\"Properties\":{\"TagUpdateOnProvisionedProduct\":\"String\"}} The
TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.
STACKSET Specify the Parameters property as follows: {\"Version\": \"String\",
\"Properties\": {\"AccountList\": [ \"String\" ], \"RegionList\": [ \"String\" ],
\"AdminRole\": \"String\", \"ExecutionRole\": \"String\"}} You cannot have both a LAUNCH
and a STACKSET constraint. You also cannot have more than one STACKSET constraint on a
product and portfolio. Products with a STACKSET constraint will launch an CloudFormation
stack set. TEMPLATE Specify the Rules property. For more information, see Template
Constraint Rules.
- `portfolio_id`: The portfolio identifier.
- `product_id`: The product identifier.
- `type`: The type of constraint. LAUNCH NOTIFICATION RESOURCE_UPDATE
STACKSET TEMPLATE
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"Description"`: The description of the constraint.
"""
function create_constraint(
IdempotencyToken,
Parameters,
PortfolioId,
ProductId,
Type;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"CreateConstraint",
Dict{String,Any}(
"IdempotencyToken" => IdempotencyToken,
"Parameters" => Parameters,
"PortfolioId" => PortfolioId,
"ProductId" => ProductId,
"Type" => Type,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_constraint(
IdempotencyToken,
Parameters,
PortfolioId,
ProductId,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"CreateConstraint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IdempotencyToken" => IdempotencyToken,
"Parameters" => Parameters,
"PortfolioId" => PortfolioId,
"ProductId" => ProductId,
"Type" => Type,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_portfolio(display_name, idempotency_token, provider_name)
create_portfolio(display_name, idempotency_token, provider_name, params::Dict{String,<:Any})
Creates a portfolio. A delegated admin is authorized to invoke this command.
# Arguments
- `display_name`: The name to use for display purposes.
- `idempotency_token`: A unique identifier that you provide to ensure idempotency. If
multiple requests differ only by the idempotency token, the same response is returned for
each repeated request.
- `provider_name`: The name of the portfolio provider.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"Description"`: The description of the portfolio.
- `"Tags"`: One or more tags.
"""
function create_portfolio(
DisplayName,
IdempotencyToken,
ProviderName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"CreatePortfolio",
Dict{String,Any}(
"DisplayName" => DisplayName,
"IdempotencyToken" => IdempotencyToken,
"ProviderName" => ProviderName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_portfolio(
DisplayName,
IdempotencyToken,
ProviderName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"CreatePortfolio",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DisplayName" => DisplayName,
"IdempotencyToken" => IdempotencyToken,
"ProviderName" => ProviderName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_portfolio_share(portfolio_id)
create_portfolio_share(portfolio_id, params::Dict{String,<:Any})
Shares the specified portfolio with the specified account or organization node. Shares to
an organization node can only be created by the management account of an organization or by
a delegated administrator. You can share portfolios to an organization, an organizational
unit, or a specific account. Note that if a delegated admin is de-registered, they can no
longer create portfolio shares. AWSOrganizationsAccess must be enabled in order to create
a portfolio share to an organization node. You can't share a shared resource, including
portfolios that contain a shared product. If the portfolio share with the specified account
or organization node already exists, this action will have no effect and will not return an
error. To update an existing share, you must use the UpdatePortfolioShare API instead.
When you associate a principal with portfolio, a potential privilege escalation path may
occur when that portfolio is then shared with other accounts. For a user in a recipient
account who is not an Service Catalog Admin, but still has the ability to create Principals
(Users/Groups/Roles), that user could create a role that matches a principal name
association for the portfolio. Although this user may not know which principal names are
associated through Service Catalog, they may be able to guess the user. If this potential
escalation path is a concern, then Service Catalog recommends using PrincipalType as IAM.
With this configuration, the PrincipalARN must already exist in the recipient account
before it can be associated.
# Arguments
- `portfolio_id`: The portfolio identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"AccountId"`: The Amazon Web Services account ID. For example, 123456789012.
- `"OrganizationNode"`: The organization node to whom you are going to share. When you pass
OrganizationNode, it creates PortfolioShare for all of the Amazon Web Services accounts
that are associated to the OrganizationNode. The output returns a PortfolioShareToken,
which enables the administrator to monitor the status of the PortfolioShare creation
process.
- `"SharePrincipals"`: This parameter is only supported for portfolios with an
OrganizationalNode Type of ORGANIZATION or ORGANIZATIONAL_UNIT. Enables or disables
Principal sharing when creating the portfolio share. If you do not provide this flag,
principal sharing is disabled. When you enable Principal Name Sharing for a portfolio
share, the share recipient account end users with a principal that matches any of the
associated IAM patterns can provision products from the portfolio. Once shared, the share
recipient can view associations of PrincipalType: IAM_PATTERN on their portfolio. You can
create the principals in the recipient account before or after creating the share.
- `"ShareTagOptions"`: Enables or disables TagOptions sharing when creating the portfolio
share. If this flag is not provided, TagOptions sharing is disabled.
"""
function create_portfolio_share(
PortfolioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"CreatePortfolioShare",
Dict{String,Any}("PortfolioId" => PortfolioId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_portfolio_share(
PortfolioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"CreatePortfolioShare",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PortfolioId" => PortfolioId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_product(idempotency_token, name, owner, product_type)
create_product(idempotency_token, name, owner, product_type, params::Dict{String,<:Any})
Creates a product. A delegated admin is authorized to invoke this command. The user or role
that performs this operation must have the cloudformation:GetTemplate IAM policy
permission. This policy permission is required when using the ImportFromPhysicalId template
source in the information data section.
# Arguments
- `idempotency_token`: A unique identifier that you provide to ensure idempotency. If
multiple requests differ only by the idempotency token, the same response is returned for
each repeated request.
- `name`: The name of the product.
- `owner`: The owner of the product.
- `product_type`: The type of product.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"Description"`: The description of the product.
- `"Distributor"`: The distributor of the product.
- `"ProvisioningArtifactParameters"`: The configuration of the provisioning artifact.
- `"SourceConnection"`: Specifies connection details for the created product and syncs the
product to the connection source artifact. This automatically manages the product's
artifacts based on changes to the source. The SourceConnection parameter consists of the
following sub-fields. Type ConnectionParamters
- `"SupportDescription"`: The support information about the product.
- `"SupportEmail"`: The contact email for product support.
- `"SupportUrl"`: The contact URL for product support. ^https?:/// / is the pattern used
to validate SupportUrl.
- `"Tags"`: One or more tags.
"""
function create_product(
IdempotencyToken,
Name,
Owner,
ProductType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"CreateProduct",
Dict{String,Any}(
"IdempotencyToken" => IdempotencyToken,
"Name" => Name,
"Owner" => Owner,
"ProductType" => ProductType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_product(
IdempotencyToken,
Name,
Owner,
ProductType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"CreateProduct",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IdempotencyToken" => IdempotencyToken,
"Name" => Name,
"Owner" => Owner,
"ProductType" => ProductType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_provisioned_product_plan(idempotency_token, plan_name, plan_type, product_id, provisioned_product_name, provisioning_artifact_id)
create_provisioned_product_plan(idempotency_token, plan_name, plan_type, product_id, provisioned_product_name, provisioning_artifact_id, params::Dict{String,<:Any})
Creates a plan. A plan includes the list of resources to be created (when provisioning a
new product) or modified (when updating a provisioned product) when the plan is executed.
You can create one plan for each provisioned product. To create a plan for an existing
provisioned product, the product status must be AVAILABLE or TAINTED. To view the resource
changes in the change set, use DescribeProvisionedProductPlan. To create or modify the
provisioned product, use ExecuteProvisionedProductPlan.
# Arguments
- `idempotency_token`: A unique identifier that you provide to ensure idempotency. If
multiple requests differ only by the idempotency token, the same response is returned for
each repeated request.
- `plan_name`: The name of the plan.
- `plan_type`: The plan type.
- `product_id`: The product identifier.
- `provisioned_product_name`: A user-friendly name for the provisioned product. This value
must be unique for the Amazon Web Services account and cannot be updated after the product
is provisioned.
- `provisioning_artifact_id`: The identifier of the provisioning artifact.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"NotificationArns"`: Passed to CloudFormation. The SNS topic ARNs to which to publish
stack-related events.
- `"PathId"`: The path identifier of the product. This value is optional if the product has
a default path, and required if the product has more than one path. To list the paths for a
product, use ListLaunchPaths.
- `"ProvisioningParameters"`: Parameters specified by the administrator that are required
for provisioning the product.
- `"Tags"`: One or more tags. If the plan is for an existing provisioned product, the
product must have a RESOURCE_UPDATE constraint with TagUpdatesOnProvisionedProduct set to
ALLOWED to allow tag updates.
"""
function create_provisioned_product_plan(
IdempotencyToken,
PlanName,
PlanType,
ProductId,
ProvisionedProductName,
ProvisioningArtifactId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"CreateProvisionedProductPlan",
Dict{String,Any}(
"IdempotencyToken" => IdempotencyToken,
"PlanName" => PlanName,
"PlanType" => PlanType,
"ProductId" => ProductId,
"ProvisionedProductName" => ProvisionedProductName,
"ProvisioningArtifactId" => ProvisioningArtifactId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_provisioned_product_plan(
IdempotencyToken,
PlanName,
PlanType,
ProductId,
ProvisionedProductName,
ProvisioningArtifactId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"CreateProvisionedProductPlan",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IdempotencyToken" => IdempotencyToken,
"PlanName" => PlanName,
"PlanType" => PlanType,
"ProductId" => ProductId,
"ProvisionedProductName" => ProvisionedProductName,
"ProvisioningArtifactId" => ProvisioningArtifactId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_provisioning_artifact(idempotency_token, parameters, product_id)
create_provisioning_artifact(idempotency_token, parameters, product_id, params::Dict{String,<:Any})
Creates a provisioning artifact (also known as a version) for the specified product. You
cannot create a provisioning artifact for a product that was shared with you. The user or
role that performs this operation must have the cloudformation:GetTemplate IAM policy
permission. This policy permission is required when using the ImportFromPhysicalId template
source in the information data section.
# Arguments
- `idempotency_token`: A unique identifier that you provide to ensure idempotency. If
multiple requests differ only by the idempotency token, the same response is returned for
each repeated request.
- `parameters`: The configuration for the provisioning artifact.
- `product_id`: The product identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
"""
function create_provisioning_artifact(
IdempotencyToken,
Parameters,
ProductId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"CreateProvisioningArtifact",
Dict{String,Any}(
"IdempotencyToken" => IdempotencyToken,
"Parameters" => Parameters,
"ProductId" => ProductId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_provisioning_artifact(
IdempotencyToken,
Parameters,
ProductId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"CreateProvisioningArtifact",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IdempotencyToken" => IdempotencyToken,
"Parameters" => Parameters,
"ProductId" => ProductId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_service_action(definition, definition_type, idempotency_token, name)
create_service_action(definition, definition_type, idempotency_token, name, params::Dict{String,<:Any})
Creates a self-service action.
# Arguments
- `definition`: The self-service action definition. Can be one of the following: Name The
name of the Amazon Web Services Systems Manager document (SSM document). For example,
AWS-RestartEC2Instance. If you are using a shared SSM document, you must provide the ARN
instead of the name. Version The Amazon Web Services Systems Manager automation document
version. For example, \"Version\": \"1\" AssumeRole The Amazon Resource Name (ARN) of
the role that performs the self-service actions on your behalf. For example,
\"AssumeRole\": \"arn:aws:iam::12345678910:role/ActionRole\". To reuse the provisioned
product launch role, set to \"AssumeRole\": \"LAUNCH_ROLE\". Parameters The list of
parameters in JSON format. For example: [{\"Name\":\"InstanceId\",\"Type\":\"TARGET\"}] or
[{\"Name\":\"InstanceId\",\"Type\":\"TEXT_VALUE\"}].
- `definition_type`: The service action definition type. For example, SSM_AUTOMATION.
- `idempotency_token`: A unique identifier that you provide to ensure idempotency. If
multiple requests differ only by the idempotency token, the same response is returned for
each repeated request.
- `name`: The self-service action name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"Description"`: The self-service action description.
"""
function create_service_action(
Definition,
DefinitionType,
IdempotencyToken,
Name;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"CreateServiceAction",
Dict{String,Any}(
"Definition" => Definition,
"DefinitionType" => DefinitionType,
"IdempotencyToken" => IdempotencyToken,
"Name" => Name,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_service_action(
Definition,
DefinitionType,
IdempotencyToken,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"CreateServiceAction",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Definition" => Definition,
"DefinitionType" => DefinitionType,
"IdempotencyToken" => IdempotencyToken,
"Name" => Name,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_tag_option(key, value)
create_tag_option(key, value, params::Dict{String,<:Any})
Creates a TagOption.
# Arguments
- `key`: The TagOption key.
- `value`: The TagOption value.
"""
function create_tag_option(Key, Value; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog(
"CreateTagOption",
Dict{String,Any}("Key" => Key, "Value" => Value);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_tag_option(
Key,
Value,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"CreateTagOption",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Key" => Key, "Value" => Value), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_constraint(id)
delete_constraint(id, params::Dict{String,<:Any})
Deletes the specified constraint. A delegated admin is authorized to invoke this command.
# Arguments
- `id`: The identifier of the constraint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
"""
function delete_constraint(Id; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog(
"DeleteConstraint",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_constraint(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"DeleteConstraint",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_portfolio(id)
delete_portfolio(id, params::Dict{String,<:Any})
Deletes the specified portfolio. You cannot delete a portfolio if it was shared with you or
if it has associated products, users, constraints, or shared accounts. A delegated admin is
authorized to invoke this command.
# Arguments
- `id`: The portfolio identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
"""
function delete_portfolio(Id; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog(
"DeletePortfolio",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_portfolio(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"DeletePortfolio",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_portfolio_share(portfolio_id)
delete_portfolio_share(portfolio_id, params::Dict{String,<:Any})
Stops sharing the specified portfolio with the specified account or organization node.
Shares to an organization node can only be deleted by the management account of an
organization or by a delegated administrator. Note that if a delegated admin is
de-registered, portfolio shares created from that account are removed.
# Arguments
- `portfolio_id`: The portfolio identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"AccountId"`: The Amazon Web Services account ID.
- `"OrganizationNode"`: The organization node to whom you are going to stop sharing.
"""
function delete_portfolio_share(
PortfolioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"DeletePortfolioShare",
Dict{String,Any}("PortfolioId" => PortfolioId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_portfolio_share(
PortfolioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"DeletePortfolioShare",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PortfolioId" => PortfolioId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_product(id)
delete_product(id, params::Dict{String,<:Any})
Deletes the specified product. You cannot delete a product if it was shared with you or is
associated with a portfolio. A delegated admin is authorized to invoke this command.
# Arguments
- `id`: The product identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
"""
function delete_product(Id; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog(
"DeleteProduct",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_product(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"DeleteProduct",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_provisioned_product_plan(plan_id)
delete_provisioned_product_plan(plan_id, params::Dict{String,<:Any})
Deletes the specified plan.
# Arguments
- `plan_id`: The plan identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"IgnoreErrors"`: If set to true, Service Catalog stops managing the specified
provisioned product even if it cannot delete the underlying resources.
"""
function delete_provisioned_product_plan(
PlanId; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"DeleteProvisionedProductPlan",
Dict{String,Any}("PlanId" => PlanId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_provisioned_product_plan(
PlanId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"DeleteProvisionedProductPlan",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("PlanId" => PlanId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_provisioning_artifact(product_id, provisioning_artifact_id)
delete_provisioning_artifact(product_id, provisioning_artifact_id, params::Dict{String,<:Any})
Deletes the specified provisioning artifact (also known as a version) for the specified
product. You cannot delete a provisioning artifact associated with a product that was
shared with you. You cannot delete the last provisioning artifact for a product, because a
product must have at least one provisioning artifact.
# Arguments
- `product_id`: The product identifier.
- `provisioning_artifact_id`: The identifier of the provisioning artifact.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
"""
function delete_provisioning_artifact(
ProductId, ProvisioningArtifactId; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"DeleteProvisioningArtifact",
Dict{String,Any}(
"ProductId" => ProductId, "ProvisioningArtifactId" => ProvisioningArtifactId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_provisioning_artifact(
ProductId,
ProvisioningArtifactId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"DeleteProvisioningArtifact",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ProductId" => ProductId,
"ProvisioningArtifactId" => ProvisioningArtifactId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_service_action(id)
delete_service_action(id, params::Dict{String,<:Any})
Deletes a self-service action.
# Arguments
- `id`: The self-service action identifier. For example, act-fs7abcd89wxyz.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"IdempotencyToken"`: A unique identifier that you provide to ensure idempotency. If
multiple requests from the same Amazon Web Services account use the same idempotency token,
the same response is returned for each repeated request.
"""
function delete_service_action(Id; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog(
"DeleteServiceAction",
Dict{String,Any}("Id" => Id, "IdempotencyToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_service_action(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"DeleteServiceAction",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Id" => Id, "IdempotencyToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_tag_option(id)
delete_tag_option(id, params::Dict{String,<:Any})
Deletes the specified TagOption. You cannot delete a TagOption if it is associated with a
product or portfolio.
# Arguments
- `id`: The TagOption identifier.
"""
function delete_tag_option(Id; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog(
"DeleteTagOption",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_tag_option(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"DeleteTagOption",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_constraint(id)
describe_constraint(id, params::Dict{String,<:Any})
Gets information about the specified constraint.
# Arguments
- `id`: The identifier of the constraint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
"""
function describe_constraint(Id; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog(
"DescribeConstraint",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_constraint(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"DescribeConstraint",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_copy_product_status(copy_product_token)
describe_copy_product_status(copy_product_token, params::Dict{String,<:Any})
Gets the status of the specified copy product operation.
# Arguments
- `copy_product_token`: The token for the copy product operation. This token is returned by
CopyProduct.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
"""
function describe_copy_product_status(
CopyProductToken; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"DescribeCopyProductStatus",
Dict{String,Any}("CopyProductToken" => CopyProductToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_copy_product_status(
CopyProductToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"DescribeCopyProductStatus",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("CopyProductToken" => CopyProductToken), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_portfolio(id)
describe_portfolio(id, params::Dict{String,<:Any})
Gets information about the specified portfolio. A delegated admin is authorized to invoke
this command.
# Arguments
- `id`: The portfolio identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
"""
function describe_portfolio(Id; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog(
"DescribePortfolio",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_portfolio(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"DescribePortfolio",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_portfolio_share_status(portfolio_share_token)
describe_portfolio_share_status(portfolio_share_token, params::Dict{String,<:Any})
Gets the status of the specified portfolio share operation. This API can only be called by
the management account in the organization or by a delegated admin.
# Arguments
- `portfolio_share_token`: The token for the portfolio share operation. This token is
returned either by CreatePortfolioShare or by DeletePortfolioShare.
"""
function describe_portfolio_share_status(
PortfolioShareToken; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"DescribePortfolioShareStatus",
Dict{String,Any}("PortfolioShareToken" => PortfolioShareToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_portfolio_share_status(
PortfolioShareToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"DescribePortfolioShareStatus",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("PortfolioShareToken" => PortfolioShareToken),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_portfolio_shares(portfolio_id, type)
describe_portfolio_shares(portfolio_id, type, params::Dict{String,<:Any})
Returns a summary of each of the portfolio shares that were created for the specified
portfolio. You can use this API to determine which accounts or organizational nodes this
portfolio have been shared, whether the recipient entity has imported the share, and
whether TagOptions are included with the share. The PortfolioId and Type parameters are
both required.
# Arguments
- `portfolio_id`: The unique identifier of the portfolio for which shares will be retrieved.
- `type`: The type of portfolio share to summarize. This field acts as a filter on the type
of portfolio share, which can be one of the following: 1. ACCOUNT - Represents an external
account to account share. 2. ORGANIZATION - Represents a share to an organization. This
share is available to every account in the organization. 3. ORGANIZATIONAL_UNIT -
Represents a share to an organizational unit. 4. ORGANIZATION_MEMBER_ACCOUNT - Represents a
share to an account in the organization.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PageSize"`: The maximum number of items to return with this call.
- `"PageToken"`: The page token for the next set of results. To retrieve the first set of
results, use null.
"""
function describe_portfolio_shares(
PortfolioId, Type; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"DescribePortfolioShares",
Dict{String,Any}("PortfolioId" => PortfolioId, "Type" => Type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_portfolio_shares(
PortfolioId,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"DescribePortfolioShares",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("PortfolioId" => PortfolioId, "Type" => Type),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_product()
describe_product(params::Dict{String,<:Any})
Gets information about the specified product. Running this operation with administrator
access results in a failure. DescribeProductAsAdmin should be used instead.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"Id"`: The product identifier.
- `"Name"`: The product name.
"""
function describe_product(; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog(
"DescribeProduct"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_product(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"DescribeProduct", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_product_as_admin()
describe_product_as_admin(params::Dict{String,<:Any})
Gets information about the specified product. This operation is run with administrator
access.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"Id"`: The product identifier.
- `"Name"`: The product name.
- `"SourcePortfolioId"`: The unique identifier of the shared portfolio that the specified
product is associated with. You can provide this parameter to retrieve the shared
TagOptions associated with the product. If this parameter is provided and if TagOptions
sharing is enabled in the portfolio share, the API returns both local and shared TagOptions
associated with the product. Otherwise only local TagOptions will be returned.
"""
function describe_product_as_admin(; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog(
"DescribeProductAsAdmin"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_product_as_admin(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"DescribeProductAsAdmin",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_product_view(id)
describe_product_view(id, params::Dict{String,<:Any})
Gets information about the specified product.
# Arguments
- `id`: The product view identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
"""
function describe_product_view(Id; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog(
"DescribeProductView",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_product_view(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"DescribeProductView",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_provisioned_product()
describe_provisioned_product(params::Dict{String,<:Any})
Gets information about the specified provisioned product.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"Id"`: The provisioned product identifier. You must provide the name or ID, but not
both. If you do not provide a name or ID, or you provide both name and ID, an
InvalidParametersException will occur.
- `"Name"`: The name of the provisioned product. You must provide the name or ID, but not
both. If you do not provide a name or ID, or you provide both name and ID, an
InvalidParametersException will occur.
"""
function describe_provisioned_product(; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog(
"DescribeProvisionedProduct"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_provisioned_product(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"DescribeProvisionedProduct",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_provisioned_product_plan(plan_id)
describe_provisioned_product_plan(plan_id, params::Dict{String,<:Any})
Gets information about the resource changes for the specified plan.
# Arguments
- `plan_id`: The plan identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"PageSize"`: The maximum number of items to return with this call.
- `"PageToken"`: The page token for the next set of results. To retrieve the first set of
results, use null.
"""
function describe_provisioned_product_plan(
PlanId; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"DescribeProvisionedProductPlan",
Dict{String,Any}("PlanId" => PlanId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_provisioned_product_plan(
PlanId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"DescribeProvisionedProductPlan",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("PlanId" => PlanId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_provisioning_artifact()
describe_provisioning_artifact(params::Dict{String,<:Any})
Gets information about the specified provisioning artifact (also known as a version) for
the specified product.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"IncludeProvisioningArtifactParameters"`: Indicates if the API call response does or
does not include additional details about the provisioning parameters.
- `"ProductId"`: The product identifier.
- `"ProductName"`: The product name.
- `"ProvisioningArtifactId"`: The identifier of the provisioning artifact.
- `"ProvisioningArtifactName"`: The provisioning artifact name.
- `"Verbose"`: Indicates whether a verbose level of detail is enabled.
"""
function describe_provisioning_artifact(; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog(
"DescribeProvisioningArtifact";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_provisioning_artifact(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"DescribeProvisioningArtifact",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_provisioning_parameters()
describe_provisioning_parameters(params::Dict{String,<:Any})
Gets information about the configuration required to provision the specified product using
the specified provisioning artifact. If the output contains a TagOption key with an empty
list of values, there is a TagOption conflict for that key. The end user cannot take action
to fix the conflict, and launch is not blocked. In subsequent calls to ProvisionProduct, do
not include conflicted TagOption keys as tags, or this causes the error \"Parameter
validation failed: Missing required parameter in Tags[N]:Value\". Tag the provisioned
product with the value sc-tagoption-conflict-portfolioId-productId.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"PathId"`: The path identifier of the product. This value is optional if the product has
a default path, and required if the product has more than one path. To list the paths for a
product, use ListLaunchPaths. You must provide the name or ID, but not both.
- `"PathName"`: The name of the path. You must provide the name or ID, but not both.
- `"ProductId"`: The product identifier. You must provide the product name or ID, but not
both.
- `"ProductName"`: The name of the product. You must provide the name or ID, but not both.
- `"ProvisioningArtifactId"`: The identifier of the provisioning artifact. You must provide
the name or ID, but not both.
- `"ProvisioningArtifactName"`: The name of the provisioning artifact. You must provide the
name or ID, but not both.
"""
function describe_provisioning_parameters(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"DescribeProvisioningParameters";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_provisioning_parameters(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"DescribeProvisioningParameters",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_record(id)
describe_record(id, params::Dict{String,<:Any})
Gets information about the specified request operation. Use this operation after calling a
request operation (for example, ProvisionProduct, TerminateProvisionedProduct, or
UpdateProvisionedProduct). If a provisioned product was transferred to a new owner using
UpdateProvisionedProductProperties, the new owner will be able to describe all past records
for that product. The previous owner will no longer be able to describe the records, but
will be able to use ListRecordHistory to see the product's history from when he was the
owner.
# Arguments
- `id`: The record identifier of the provisioned product. This identifier is returned by
the request operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"PageSize"`: The maximum number of items to return with this call.
- `"PageToken"`: The page token for the next set of results. To retrieve the first set of
results, use null.
"""
function describe_record(Id; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog(
"DescribeRecord",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_record(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"DescribeRecord",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_service_action(id)
describe_service_action(id, params::Dict{String,<:Any})
Describes a self-service action.
# Arguments
- `id`: The self-service action identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
"""
function describe_service_action(Id; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog(
"DescribeServiceAction",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_service_action(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"DescribeServiceAction",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_service_action_execution_parameters(provisioned_product_id, service_action_id)
describe_service_action_execution_parameters(provisioned_product_id, service_action_id, params::Dict{String,<:Any})
Finds the default parameters for a specific self-service action on a specific provisioned
product and returns a map of the results to the user.
# Arguments
- `provisioned_product_id`: The identifier of the provisioned product.
- `service_action_id`: The self-service action identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
"""
function describe_service_action_execution_parameters(
ProvisionedProductId, ServiceActionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"DescribeServiceActionExecutionParameters",
Dict{String,Any}(
"ProvisionedProductId" => ProvisionedProductId,
"ServiceActionId" => ServiceActionId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_service_action_execution_parameters(
ProvisionedProductId,
ServiceActionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"DescribeServiceActionExecutionParameters",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ProvisionedProductId" => ProvisionedProductId,
"ServiceActionId" => ServiceActionId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_tag_option(id)
describe_tag_option(id, params::Dict{String,<:Any})
Gets information about the specified TagOption.
# Arguments
- `id`: The TagOption identifier.
"""
function describe_tag_option(Id; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog(
"DescribeTagOption",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_tag_option(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"DescribeTagOption",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_awsorganizations_access()
disable_awsorganizations_access(params::Dict{String,<:Any})
Disable portfolio sharing through the Organizations service. This command will not delete
your current shares, but prevents you from creating new shares throughout your
organization. Current shares are not kept in sync with your organization structure if the
structure changes after calling this API. Only the management account in the organization
can call this API. You cannot call this API if there are active delegated administrators in
the organization. Note that a delegated administrator is not authorized to invoke
DisableAWSOrganizationsAccess. If you share an Service Catalog portfolio in an
organization within Organizations, and then disable Organizations access for Service
Catalog, the portfolio access permissions will not sync with the latest changes to the
organization structure. Specifically, accounts that you removed from the organization after
disabling Service Catalog access will retain access to the previously shared portfolio.
"""
function disable_awsorganizations_access(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"DisableAWSOrganizationsAccess";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_awsorganizations_access(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"DisableAWSOrganizationsAccess",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_budget_from_resource(budget_name, resource_id)
disassociate_budget_from_resource(budget_name, resource_id, params::Dict{String,<:Any})
Disassociates the specified budget from the specified resource.
# Arguments
- `budget_name`: The name of the budget you want to disassociate.
- `resource_id`: The resource identifier you want to disassociate from. Either a
portfolio-id or a product-id.
"""
function disassociate_budget_from_resource(
BudgetName, ResourceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"DisassociateBudgetFromResource",
Dict{String,Any}("BudgetName" => BudgetName, "ResourceId" => ResourceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_budget_from_resource(
BudgetName,
ResourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"DisassociateBudgetFromResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("BudgetName" => BudgetName, "ResourceId" => ResourceId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_principal_from_portfolio(portfolio_id, principal_arn)
disassociate_principal_from_portfolio(portfolio_id, principal_arn, params::Dict{String,<:Any})
Disassociates a previously associated principal ARN from a specified portfolio. The
PrincipalType and PrincipalARN must match the AssociatePrincipalWithPortfolio call request
details. For example, to disassociate an association created with a PrincipalARN of
PrincipalType IAM you must use the PrincipalType IAM when calling
DisassociatePrincipalFromPortfolio. For portfolios that have been shared with principal
name sharing enabled: after disassociating a principal, share recipient accounts will no
longer be able to provision products in this portfolio using a role matching the name of
the associated principal. For more information, review associate-principal-with-portfolio
in the Amazon Web Services CLI Command Reference. If you disassociate a principal from a
portfolio, with PrincipalType as IAM, the same principal will still have access to the
portfolio if it matches one of the associated principals of type IAM_PATTERN. To fully
remove access for a principal, verify all the associated Principals of type IAM_PATTERN,
and then ensure you disassociate any IAM_PATTERN principals that match the principal whose
access you are removing.
# Arguments
- `portfolio_id`: The portfolio identifier.
- `principal_arn`: The ARN of the principal (user, role, or group). This field allows an
ARN with no accountID with or without wildcard characters if PrincipalType is IAM_PATTERN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"PrincipalType"`: The supported value is IAM if you use a fully defined ARN, or
IAM_PATTERN if you specify an IAM ARN with no AccountId, with or without wildcard
characters.
"""
function disassociate_principal_from_portfolio(
PortfolioId, PrincipalARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"DisassociatePrincipalFromPortfolio",
Dict{String,Any}("PortfolioId" => PortfolioId, "PrincipalARN" => PrincipalARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_principal_from_portfolio(
PortfolioId,
PrincipalARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"DisassociatePrincipalFromPortfolio",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PortfolioId" => PortfolioId, "PrincipalARN" => PrincipalARN
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_product_from_portfolio(portfolio_id, product_id)
disassociate_product_from_portfolio(portfolio_id, product_id, params::Dict{String,<:Any})
Disassociates the specified product from the specified portfolio. A delegated admin is
authorized to invoke this command.
# Arguments
- `portfolio_id`: The portfolio identifier.
- `product_id`: The product identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
"""
function disassociate_product_from_portfolio(
PortfolioId, ProductId; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"DisassociateProductFromPortfolio",
Dict{String,Any}("PortfolioId" => PortfolioId, "ProductId" => ProductId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_product_from_portfolio(
PortfolioId,
ProductId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"DisassociateProductFromPortfolio",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("PortfolioId" => PortfolioId, "ProductId" => ProductId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_service_action_from_provisioning_artifact(product_id, provisioning_artifact_id, service_action_id)
disassociate_service_action_from_provisioning_artifact(product_id, provisioning_artifact_id, service_action_id, params::Dict{String,<:Any})
Disassociates the specified self-service action association from the specified provisioning
artifact.
# Arguments
- `product_id`: The product identifier. For example, prod-abcdzk7xy33qa.
- `provisioning_artifact_id`: The identifier of the provisioning artifact. For example,
pa-4abcdjnxjj6ne.
- `service_action_id`: The self-service action identifier. For example, act-fs7abcd89wxyz.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"IdempotencyToken"`: A unique identifier that you provide to ensure idempotency. If
multiple requests from the same Amazon Web Services account use the same idempotency token,
the same response is returned for each repeated request.
"""
function disassociate_service_action_from_provisioning_artifact(
ProductId,
ProvisioningArtifactId,
ServiceActionId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"DisassociateServiceActionFromProvisioningArtifact",
Dict{String,Any}(
"ProductId" => ProductId,
"ProvisioningArtifactId" => ProvisioningArtifactId,
"ServiceActionId" => ServiceActionId,
"IdempotencyToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_service_action_from_provisioning_artifact(
ProductId,
ProvisioningArtifactId,
ServiceActionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"DisassociateServiceActionFromProvisioningArtifact",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ProductId" => ProductId,
"ProvisioningArtifactId" => ProvisioningArtifactId,
"ServiceActionId" => ServiceActionId,
"IdempotencyToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_tag_option_from_resource(resource_id, tag_option_id)
disassociate_tag_option_from_resource(resource_id, tag_option_id, params::Dict{String,<:Any})
Disassociates the specified TagOption from the specified resource.
# Arguments
- `resource_id`: The resource identifier.
- `tag_option_id`: The TagOption identifier.
"""
function disassociate_tag_option_from_resource(
ResourceId, TagOptionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"DisassociateTagOptionFromResource",
Dict{String,Any}("ResourceId" => ResourceId, "TagOptionId" => TagOptionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_tag_option_from_resource(
ResourceId,
TagOptionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"DisassociateTagOptionFromResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceId" => ResourceId, "TagOptionId" => TagOptionId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_awsorganizations_access()
enable_awsorganizations_access(params::Dict{String,<:Any})
Enable portfolio sharing feature through Organizations. This API will allow Service Catalog
to receive updates on your organization in order to sync your shares with the current
structure. This API can only be called by the management account in the organization. When
you call this API, Service Catalog calls organizations:EnableAWSServiceAccess on your
behalf so that your shares stay in sync with any changes in your Organizations structure.
Note that a delegated administrator is not authorized to invoke
EnableAWSOrganizationsAccess. If you have previously disabled Organizations access for
Service Catalog, and then enable access again, the portfolio access permissions might not
sync with the latest changes to the organization structure. Specifically, accounts that you
removed from the organization after disabling Service Catalog access, and before you
enabled access again, can retain access to the previously shared portfolio. As a result, an
account that has been removed from the organization might still be able to create or manage
Amazon Web Services resources when it is no longer authorized to do so. Amazon Web Services
is working to resolve this issue.
"""
function enable_awsorganizations_access(; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog(
"EnableAWSOrganizationsAccess";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_awsorganizations_access(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"EnableAWSOrganizationsAccess",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
execute_provisioned_product_plan(idempotency_token, plan_id)
execute_provisioned_product_plan(idempotency_token, plan_id, params::Dict{String,<:Any})
Provisions or modifies a product based on the resource changes for the specified plan.
# Arguments
- `idempotency_token`: A unique identifier that you provide to ensure idempotency. If
multiple requests differ only by the idempotency token, the same response is returned for
each repeated request.
- `plan_id`: The plan identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
"""
function execute_provisioned_product_plan(
IdempotencyToken, PlanId; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"ExecuteProvisionedProductPlan",
Dict{String,Any}("IdempotencyToken" => IdempotencyToken, "PlanId" => PlanId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function execute_provisioned_product_plan(
IdempotencyToken,
PlanId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"ExecuteProvisionedProductPlan",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IdempotencyToken" => IdempotencyToken, "PlanId" => PlanId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
execute_provisioned_product_service_action(execute_token, provisioned_product_id, service_action_id)
execute_provisioned_product_service_action(execute_token, provisioned_product_id, service_action_id, params::Dict{String,<:Any})
Executes a self-service action against a provisioned product.
# Arguments
- `execute_token`: An idempotency token that uniquely identifies the execute request.
- `provisioned_product_id`: The identifier of the provisioned product.
- `service_action_id`: The self-service action identifier. For example, act-fs7abcd89wxyz.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"Parameters"`: A map of all self-service action parameters and their values. If a
provided parameter is of a special type, such as TARGET, the provided value will override
the default value generated by Service Catalog. If the parameters field is not provided, no
additional parameters are passed and default values will be used for any special parameters
such as TARGET.
"""
function execute_provisioned_product_service_action(
ExecuteToken,
ProvisionedProductId,
ServiceActionId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"ExecuteProvisionedProductServiceAction",
Dict{String,Any}(
"ExecuteToken" => ExecuteToken,
"ProvisionedProductId" => ProvisionedProductId,
"ServiceActionId" => ServiceActionId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function execute_provisioned_product_service_action(
ExecuteToken,
ProvisionedProductId,
ServiceActionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"ExecuteProvisionedProductServiceAction",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ExecuteToken" => ExecuteToken,
"ProvisionedProductId" => ProvisionedProductId,
"ServiceActionId" => ServiceActionId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_awsorganizations_access_status()
get_awsorganizations_access_status(params::Dict{String,<:Any})
Get the Access Status for Organizations portfolio share feature. This API can only be
called by the management account in the organization or by a delegated admin.
"""
function get_awsorganizations_access_status(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"GetAWSOrganizationsAccessStatus";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_awsorganizations_access_status(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"GetAWSOrganizationsAccessStatus",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_provisioned_product_outputs()
get_provisioned_product_outputs(params::Dict{String,<:Any})
This API takes either a ProvisonedProductId or a ProvisionedProductName, along with a list
of one or more output keys, and responds with the key/value pairs of those outputs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"OutputKeys"`: The list of keys that the API should return with their values. If none
are provided, the API will return all outputs of the provisioned product.
- `"PageSize"`: The maximum number of items to return with this call.
- `"PageToken"`: The page token for the next set of results. To retrieve the first set of
results, use null.
- `"ProvisionedProductId"`: The identifier of the provisioned product that you want the
outputs from.
- `"ProvisionedProductName"`: The name of the provisioned product that you want the outputs
from.
"""
function get_provisioned_product_outputs(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"GetProvisionedProductOutputs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_provisioned_product_outputs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"GetProvisionedProductOutputs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
import_as_provisioned_product(idempotency_token, physical_id, product_id, provisioned_product_name, provisioning_artifact_id)
import_as_provisioned_product(idempotency_token, physical_id, product_id, provisioned_product_name, provisioning_artifact_id, params::Dict{String,<:Any})
Requests the import of a resource as an Service Catalog provisioned product that is
associated to an Service Catalog product and provisioning artifact. Once imported, all
supported governance actions are supported on the provisioned product. Resource import
only supports CloudFormation stack ARNs. CloudFormation StackSets, and non-root nested
stacks, are not supported. The CloudFormation stack must have one of the following
statuses to be imported: CREATE_COMPLETE, UPDATE_COMPLETE, UPDATE_ROLLBACK_COMPLETE,
IMPORT_COMPLETE, and IMPORT_ROLLBACK_COMPLETE. Import of the resource requires that the
CloudFormation stack template matches the associated Service Catalog product provisioning
artifact. When you import an existing CloudFormation stack into a portfolio, Service
Catalog does not apply the product's associated constraints during the import process.
Service Catalog applies the constraints after you call UpdateProvisionedProduct for the
provisioned product. The user or role that performs this operation must have the
cloudformation:GetTemplate and cloudformation:DescribeStacks IAM policy permissions. You
can only import one provisioned product at a time. The product's CloudFormation stack must
have the IMPORT_COMPLETE status before you import another.
# Arguments
- `idempotency_token`: A unique identifier that you provide to ensure idempotency. If
multiple requests differ only by the idempotency token, the same response is returned for
each repeated request.
- `physical_id`: The unique identifier of the resource to be imported. It only currently
supports CloudFormation stack IDs.
- `product_id`: The product identifier.
- `provisioned_product_name`: The user-friendly name of the provisioned product. The value
must be unique for the Amazon Web Services account. The name cannot be updated after the
product is provisioned.
- `provisioning_artifact_id`: The identifier of the provisioning artifact.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
"""
function import_as_provisioned_product(
IdempotencyToken,
PhysicalId,
ProductId,
ProvisionedProductName,
ProvisioningArtifactId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"ImportAsProvisionedProduct",
Dict{String,Any}(
"IdempotencyToken" => IdempotencyToken,
"PhysicalId" => PhysicalId,
"ProductId" => ProductId,
"ProvisionedProductName" => ProvisionedProductName,
"ProvisioningArtifactId" => ProvisioningArtifactId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function import_as_provisioned_product(
IdempotencyToken,
PhysicalId,
ProductId,
ProvisionedProductName,
ProvisioningArtifactId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"ImportAsProvisionedProduct",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IdempotencyToken" => IdempotencyToken,
"PhysicalId" => PhysicalId,
"ProductId" => ProductId,
"ProvisionedProductName" => ProvisionedProductName,
"ProvisioningArtifactId" => ProvisioningArtifactId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_accepted_portfolio_shares()
list_accepted_portfolio_shares(params::Dict{String,<:Any})
Lists all imported portfolios for which account-to-account shares were accepted by this
account. By specifying the PortfolioShareType, you can list portfolios for which
organizational shares were accepted by this account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"PageSize"`: The maximum number of items to return with this call.
- `"PageToken"`: The page token for the next set of results. To retrieve the first set of
results, use null.
- `"PortfolioShareType"`: The type of shared portfolios to list. The default is to list
imported portfolios. AWS_ORGANIZATIONS - List portfolios accepted and shared via
organizational sharing by the management account or delegated administrator of your
organization. AWS_SERVICECATALOG - Deprecated type. IMPORTED - List imported
portfolios that have been accepted and shared through account-to-account sharing.
"""
function list_accepted_portfolio_shares(; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog(
"ListAcceptedPortfolioShares";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_accepted_portfolio_shares(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"ListAcceptedPortfolioShares",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_budgets_for_resource(resource_id)
list_budgets_for_resource(resource_id, params::Dict{String,<:Any})
Lists all the budgets associated to the specified resource.
# Arguments
- `resource_id`: The resource identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"PageSize"`: The maximum number of items to return with this call.
- `"PageToken"`: The page token for the next set of results. To retrieve the first set of
results, use null.
"""
function list_budgets_for_resource(
ResourceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"ListBudgetsForResource",
Dict{String,Any}("ResourceId" => ResourceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_budgets_for_resource(
ResourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"ListBudgetsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceId" => ResourceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_constraints_for_portfolio(portfolio_id)
list_constraints_for_portfolio(portfolio_id, params::Dict{String,<:Any})
Lists the constraints for the specified portfolio and product.
# Arguments
- `portfolio_id`: The portfolio identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"PageSize"`: The maximum number of items to return with this call.
- `"PageToken"`: The page token for the next set of results. To retrieve the first set of
results, use null.
- `"ProductId"`: The product identifier.
"""
function list_constraints_for_portfolio(
PortfolioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"ListConstraintsForPortfolio",
Dict{String,Any}("PortfolioId" => PortfolioId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_constraints_for_portfolio(
PortfolioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"ListConstraintsForPortfolio",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PortfolioId" => PortfolioId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_launch_paths(product_id)
list_launch_paths(product_id, params::Dict{String,<:Any})
Lists the paths to the specified product. A path describes how the user gets access to a
specified product and is necessary when provisioning a product. A path also determines the
constraints that are put on a product. A path is dependent on a specific product, porfolio,
and principal. When provisioning a product that's been added to a portfolio, you must
grant your user, group, or role access to the portfolio. For more information, see Granting
users access in the Service Catalog User Guide.
# Arguments
- `product_id`: The product identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"PageSize"`: The maximum number of items to return with this call.
- `"PageToken"`: The page token for the next set of results. To retrieve the first set of
results, use null.
"""
function list_launch_paths(ProductId; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog(
"ListLaunchPaths",
Dict{String,Any}("ProductId" => ProductId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_launch_paths(
ProductId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"ListLaunchPaths",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ProductId" => ProductId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_organization_portfolio_access(organization_node_type, portfolio_id)
list_organization_portfolio_access(organization_node_type, portfolio_id, params::Dict{String,<:Any})
Lists the organization nodes that have access to the specified portfolio. This API can only
be called by the management account in the organization or by a delegated admin. If a
delegated admin is de-registered, they can no longer perform this operation.
# Arguments
- `organization_node_type`: The organization node type that will be returned in the output.
ORGANIZATION - Organization that has access to the portfolio. ORGANIZATIONAL_UNIT -
Organizational unit that has access to the portfolio within your organization. ACCOUNT -
Account that has access to the portfolio within your organization.
- `portfolio_id`: The portfolio identifier. For example, port-2abcdext3y5fk.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"PageSize"`: The maximum number of items to return with this call.
- `"PageToken"`: The page token for the next set of results. To retrieve the first set of
results, use null.
"""
function list_organization_portfolio_access(
OrganizationNodeType, PortfolioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"ListOrganizationPortfolioAccess",
Dict{String,Any}(
"OrganizationNodeType" => OrganizationNodeType, "PortfolioId" => PortfolioId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_organization_portfolio_access(
OrganizationNodeType,
PortfolioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"ListOrganizationPortfolioAccess",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"OrganizationNodeType" => OrganizationNodeType,
"PortfolioId" => PortfolioId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_portfolio_access(portfolio_id)
list_portfolio_access(portfolio_id, params::Dict{String,<:Any})
Lists the account IDs that have access to the specified portfolio. A delegated admin can
list the accounts that have access to the shared portfolio. Note that if a delegated admin
is de-registered, they can no longer perform this operation.
# Arguments
- `portfolio_id`: The portfolio identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"OrganizationParentId"`: The ID of an organization node the portfolio is shared with.
All children of this node with an inherited portfolio share will be returned.
- `"PageSize"`: The maximum number of items to return with this call.
- `"PageToken"`: The page token for the next set of results. To retrieve the first set of
results, use null.
"""
function list_portfolio_access(
PortfolioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"ListPortfolioAccess",
Dict{String,Any}("PortfolioId" => PortfolioId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_portfolio_access(
PortfolioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"ListPortfolioAccess",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PortfolioId" => PortfolioId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_portfolios()
list_portfolios(params::Dict{String,<:Any})
Lists all portfolios in the catalog.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"PageSize"`: The maximum number of items to return with this call.
- `"PageToken"`: The page token for the next set of results. To retrieve the first set of
results, use null.
"""
function list_portfolios(; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog(
"ListPortfolios"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_portfolios(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"ListPortfolios", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_portfolios_for_product(product_id)
list_portfolios_for_product(product_id, params::Dict{String,<:Any})
Lists all portfolios that the specified product is associated with.
# Arguments
- `product_id`: The product identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"PageSize"`: The maximum number of items to return with this call.
- `"PageToken"`: The page token for the next set of results. To retrieve the first set of
results, use null.
"""
function list_portfolios_for_product(
ProductId; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"ListPortfoliosForProduct",
Dict{String,Any}("ProductId" => ProductId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_portfolios_for_product(
ProductId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"ListPortfoliosForProduct",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ProductId" => ProductId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_principals_for_portfolio(portfolio_id)
list_principals_for_portfolio(portfolio_id, params::Dict{String,<:Any})
Lists all PrincipalARNs and corresponding PrincipalTypes associated with the specified
portfolio.
# Arguments
- `portfolio_id`: The portfolio identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"PageSize"`: The maximum number of items to return with this call.
- `"PageToken"`: The page token for the next set of results. To retrieve the first set of
results, use null.
"""
function list_principals_for_portfolio(
PortfolioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"ListPrincipalsForPortfolio",
Dict{String,Any}("PortfolioId" => PortfolioId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_principals_for_portfolio(
PortfolioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"ListPrincipalsForPortfolio",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PortfolioId" => PortfolioId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_provisioned_product_plans()
list_provisioned_product_plans(params::Dict{String,<:Any})
Lists the plans for the specified provisioned product or all plans to which the user has
access.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"AccessLevelFilter"`: The access level to use to obtain results. The default is User.
- `"PageSize"`: The maximum number of items to return with this call.
- `"PageToken"`: The page token for the next set of results. To retrieve the first set of
results, use null.
- `"ProvisionProductId"`: The product identifier.
"""
function list_provisioned_product_plans(; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog(
"ListProvisionedProductPlans";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_provisioned_product_plans(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"ListProvisionedProductPlans",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_provisioning_artifacts(product_id)
list_provisioning_artifacts(product_id, params::Dict{String,<:Any})
Lists all provisioning artifacts (also known as versions) for the specified product.
# Arguments
- `product_id`: The product identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
"""
function list_provisioning_artifacts(
ProductId; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"ListProvisioningArtifacts",
Dict{String,Any}("ProductId" => ProductId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_provisioning_artifacts(
ProductId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"ListProvisioningArtifacts",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ProductId" => ProductId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_provisioning_artifacts_for_service_action(service_action_id)
list_provisioning_artifacts_for_service_action(service_action_id, params::Dict{String,<:Any})
Lists all provisioning artifacts (also known as versions) for the specified self-service
action.
# Arguments
- `service_action_id`: The self-service action identifier. For example, act-fs7abcd89wxyz.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"PageSize"`: The maximum number of items to return with this call.
- `"PageToken"`: The page token for the next set of results. To retrieve the first set of
results, use null.
"""
function list_provisioning_artifacts_for_service_action(
ServiceActionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"ListProvisioningArtifactsForServiceAction",
Dict{String,Any}("ServiceActionId" => ServiceActionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_provisioning_artifacts_for_service_action(
ServiceActionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"ListProvisioningArtifactsForServiceAction",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ServiceActionId" => ServiceActionId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_record_history()
list_record_history(params::Dict{String,<:Any})
Lists the specified requests or all performed requests.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"AccessLevelFilter"`: The access level to use to obtain results. The default is User.
- `"PageSize"`: The maximum number of items to return with this call.
- `"PageToken"`: The page token for the next set of results. To retrieve the first set of
results, use null.
- `"SearchFilter"`: The search filter to scope the results.
"""
function list_record_history(; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog(
"ListRecordHistory"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_record_history(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"ListRecordHistory", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_resources_for_tag_option(tag_option_id)
list_resources_for_tag_option(tag_option_id, params::Dict{String,<:Any})
Lists the resources associated with the specified TagOption.
# Arguments
- `tag_option_id`: The TagOption identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PageSize"`: The maximum number of items to return with this call.
- `"PageToken"`: The page token for the next set of results. To retrieve the first set of
results, use null.
- `"ResourceType"`: The resource type. Portfolio Product
"""
function list_resources_for_tag_option(
TagOptionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"ListResourcesForTagOption",
Dict{String,Any}("TagOptionId" => TagOptionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_resources_for_tag_option(
TagOptionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"ListResourcesForTagOption",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TagOptionId" => TagOptionId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_service_actions()
list_service_actions(params::Dict{String,<:Any})
Lists all self-service actions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"PageSize"`: The maximum number of items to return with this call.
- `"PageToken"`: The page token for the next set of results. To retrieve the first set of
results, use null.
"""
function list_service_actions(; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog(
"ListServiceActions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_service_actions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"ListServiceActions", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_service_actions_for_provisioning_artifact(product_id, provisioning_artifact_id)
list_service_actions_for_provisioning_artifact(product_id, provisioning_artifact_id, params::Dict{String,<:Any})
Returns a paginated list of self-service actions associated with the specified Product ID
and Provisioning Artifact ID.
# Arguments
- `product_id`: The product identifier. For example, prod-abcdzk7xy33qa.
- `provisioning_artifact_id`: The identifier of the provisioning artifact. For example,
pa-4abcdjnxjj6ne.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"PageSize"`: The maximum number of items to return with this call.
- `"PageToken"`: The page token for the next set of results. To retrieve the first set of
results, use null.
"""
function list_service_actions_for_provisioning_artifact(
ProductId, ProvisioningArtifactId; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"ListServiceActionsForProvisioningArtifact",
Dict{String,Any}(
"ProductId" => ProductId, "ProvisioningArtifactId" => ProvisioningArtifactId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_service_actions_for_provisioning_artifact(
ProductId,
ProvisioningArtifactId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"ListServiceActionsForProvisioningArtifact",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ProductId" => ProductId,
"ProvisioningArtifactId" => ProvisioningArtifactId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_stack_instances_for_provisioned_product(provisioned_product_id)
list_stack_instances_for_provisioned_product(provisioned_product_id, params::Dict{String,<:Any})
Returns summary information about stack instances that are associated with the specified
CFN_STACKSET type provisioned product. You can filter for stack instances that are
associated with a specific Amazon Web Services account name or Region.
# Arguments
- `provisioned_product_id`: The identifier of the provisioned product.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"PageSize"`: The maximum number of items to return with this call.
- `"PageToken"`: The page token for the next set of results. To retrieve the first set of
results, use null.
"""
function list_stack_instances_for_provisioned_product(
ProvisionedProductId; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"ListStackInstancesForProvisionedProduct",
Dict{String,Any}("ProvisionedProductId" => ProvisionedProductId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_stack_instances_for_provisioned_product(
ProvisionedProductId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"ListStackInstancesForProvisionedProduct",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ProvisionedProductId" => ProvisionedProductId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tag_options()
list_tag_options(params::Dict{String,<:Any})
Lists the specified TagOptions or all TagOptions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: The search filters. If no search filters are specified, the output includes
all TagOptions.
- `"PageSize"`: The maximum number of items to return with this call.
- `"PageToken"`: The page token for the next set of results. To retrieve the first set of
results, use null.
"""
function list_tag_options(; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog(
"ListTagOptions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_tag_options(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"ListTagOptions", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
notify_provision_product_engine_workflow_result(idempotency_token, record_id, status, workflow_token)
notify_provision_product_engine_workflow_result(idempotency_token, record_id, status, workflow_token, params::Dict{String,<:Any})
Notifies the result of the provisioning engine execution.
# Arguments
- `idempotency_token`: The idempotency token that identifies the provisioning engine
execution.
- `record_id`: The identifier of the record.
- `status`: The status of the provisioning engine execution.
- `workflow_token`: The encrypted contents of the provisioning engine execution payload
that Service Catalog sends after the Terraform product provisioning workflow starts.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FailureReason"`: The reason why the provisioning engine execution failed.
- `"Outputs"`: The output of the provisioning engine execution.
- `"ResourceIdentifier"`: The ID for the provisioned product resources that are part of a
resource group.
"""
function notify_provision_product_engine_workflow_result(
IdempotencyToken,
RecordId,
Status,
WorkflowToken;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"NotifyProvisionProductEngineWorkflowResult",
Dict{String,Any}(
"IdempotencyToken" => IdempotencyToken,
"RecordId" => RecordId,
"Status" => Status,
"WorkflowToken" => WorkflowToken,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function notify_provision_product_engine_workflow_result(
IdempotencyToken,
RecordId,
Status,
WorkflowToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"NotifyProvisionProductEngineWorkflowResult",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IdempotencyToken" => IdempotencyToken,
"RecordId" => RecordId,
"Status" => Status,
"WorkflowToken" => WorkflowToken,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
notify_terminate_provisioned_product_engine_workflow_result(idempotency_token, record_id, status, workflow_token)
notify_terminate_provisioned_product_engine_workflow_result(idempotency_token, record_id, status, workflow_token, params::Dict{String,<:Any})
Notifies the result of the terminate engine execution.
# Arguments
- `idempotency_token`: The idempotency token that identifies the terminate engine
execution.
- `record_id`: The identifier of the record.
- `status`: The status of the terminate engine execution.
- `workflow_token`: The encrypted contents of the terminate engine execution payload that
Service Catalog sends after the Terraform product terminate workflow starts.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FailureReason"`: The reason why the terminate engine execution failed.
"""
function notify_terminate_provisioned_product_engine_workflow_result(
IdempotencyToken,
RecordId,
Status,
WorkflowToken;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"NotifyTerminateProvisionedProductEngineWorkflowResult",
Dict{String,Any}(
"IdempotencyToken" => IdempotencyToken,
"RecordId" => RecordId,
"Status" => Status,
"WorkflowToken" => WorkflowToken,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function notify_terminate_provisioned_product_engine_workflow_result(
IdempotencyToken,
RecordId,
Status,
WorkflowToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"NotifyTerminateProvisionedProductEngineWorkflowResult",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IdempotencyToken" => IdempotencyToken,
"RecordId" => RecordId,
"Status" => Status,
"WorkflowToken" => WorkflowToken,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
notify_update_provisioned_product_engine_workflow_result(idempotency_token, record_id, status, workflow_token)
notify_update_provisioned_product_engine_workflow_result(idempotency_token, record_id, status, workflow_token, params::Dict{String,<:Any})
Notifies the result of the update engine execution.
# Arguments
- `idempotency_token`: The idempotency token that identifies the update engine execution.
- `record_id`: The identifier of the record.
- `status`: The status of the update engine execution.
- `workflow_token`: The encrypted contents of the update engine execution payload that
Service Catalog sends after the Terraform product update workflow starts.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FailureReason"`: The reason why the update engine execution failed.
- `"Outputs"`: The output of the update engine execution.
"""
function notify_update_provisioned_product_engine_workflow_result(
IdempotencyToken,
RecordId,
Status,
WorkflowToken;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"NotifyUpdateProvisionedProductEngineWorkflowResult",
Dict{String,Any}(
"IdempotencyToken" => IdempotencyToken,
"RecordId" => RecordId,
"Status" => Status,
"WorkflowToken" => WorkflowToken,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function notify_update_provisioned_product_engine_workflow_result(
IdempotencyToken,
RecordId,
Status,
WorkflowToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"NotifyUpdateProvisionedProductEngineWorkflowResult",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IdempotencyToken" => IdempotencyToken,
"RecordId" => RecordId,
"Status" => Status,
"WorkflowToken" => WorkflowToken,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
provision_product(provision_token, provisioned_product_name)
provision_product(provision_token, provisioned_product_name, params::Dict{String,<:Any})
Provisions the specified product. A provisioned product is a resourced instance of a
product. For example, provisioning a product that's based on an CloudFormation template
launches an CloudFormation stack and its underlying resources. You can check the status of
this request using DescribeRecord. If the request contains a tag key with an empty list
of values, there's a tag conflict for that key. Don't include conflicted keys as tags, or
this will cause the error \"Parameter validation failed: Missing required parameter in
Tags[N]:Value\". When provisioning a product that's been added to a portfolio, you must
grant your user, group, or role access to the portfolio. For more information, see Granting
users access in the Service Catalog User Guide.
# Arguments
- `provision_token`: An idempotency token that uniquely identifies the provisioning request.
- `provisioned_product_name`: A user-friendly name for the provisioned product. This value
must be unique for the Amazon Web Services account and cannot be updated after the product
is provisioned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"NotificationArns"`: Passed to CloudFormation. The SNS topic ARNs to which to publish
stack-related events.
- `"PathId"`: The path identifier of the product. This value is optional if the product has
a default path, and required if the product has more than one path. To list the paths for a
product, use ListLaunchPaths. You must provide the name or ID, but not both.
- `"PathName"`: The name of the path. You must provide the name or ID, but not both.
- `"ProductId"`: The product identifier. You must provide the name or ID, but not both.
- `"ProductName"`: The name of the product. You must provide the name or ID, but not both.
- `"ProvisioningArtifactId"`: The identifier of the provisioning artifact. You must provide
the name or ID, but not both.
- `"ProvisioningArtifactName"`: The name of the provisioning artifact. You must provide the
name or ID, but not both.
- `"ProvisioningParameters"`: Parameters specified by the administrator that are required
for provisioning the product.
- `"ProvisioningPreferences"`: An object that contains information about the provisioning
preferences for a stack set.
- `"Tags"`: One or more tags.
"""
function provision_product(
ProvisionToken,
ProvisionedProductName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"ProvisionProduct",
Dict{String,Any}(
"ProvisionToken" => ProvisionToken,
"ProvisionedProductName" => ProvisionedProductName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function provision_product(
ProvisionToken,
ProvisionedProductName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"ProvisionProduct",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ProvisionToken" => ProvisionToken,
"ProvisionedProductName" => ProvisionedProductName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reject_portfolio_share(portfolio_id)
reject_portfolio_share(portfolio_id, params::Dict{String,<:Any})
Rejects an offer to share the specified portfolio.
# Arguments
- `portfolio_id`: The portfolio identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"PortfolioShareType"`: The type of shared portfolios to reject. The default is to reject
imported portfolios. AWS_ORGANIZATIONS - Reject portfolios shared by the management
account of your organization. IMPORTED - Reject imported portfolios.
AWS_SERVICECATALOG - Not supported. (Throws ResourceNotFoundException.) For example, aws
servicecatalog reject-portfolio-share --portfolio-id \"port-2qwzkwxt3y5fk\"
--portfolio-share-type AWS_ORGANIZATIONS
"""
function reject_portfolio_share(
PortfolioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"RejectPortfolioShare",
Dict{String,Any}("PortfolioId" => PortfolioId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reject_portfolio_share(
PortfolioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"RejectPortfolioShare",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PortfolioId" => PortfolioId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
scan_provisioned_products()
scan_provisioned_products(params::Dict{String,<:Any})
Lists the provisioned products that are available (not terminated). To use additional
filtering, see SearchProvisionedProducts.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"AccessLevelFilter"`: The access level to use to obtain results. The default is User.
- `"PageSize"`: The maximum number of items to return with this call.
- `"PageToken"`: The page token for the next set of results. To retrieve the first set of
results, use null.
"""
function scan_provisioned_products(; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog(
"ScanProvisionedProducts"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function scan_provisioned_products(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"ScanProvisionedProducts",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_products()
search_products(params::Dict{String,<:Any})
Gets information about the products to which the caller has access.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"Filters"`: The search filters. If no search filters are specified, the output includes
all products to which the caller has access.
- `"PageSize"`: The maximum number of items to return with this call.
- `"PageToken"`: The page token for the next set of results. To retrieve the first set of
results, use null.
- `"SortBy"`: The sort field. If no value is specified, the results are not sorted.
- `"SortOrder"`: The sort order. If no value is specified, the results are not sorted.
"""
function search_products(; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog(
"SearchProducts"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function search_products(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"SearchProducts", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
search_products_as_admin()
search_products_as_admin(params::Dict{String,<:Any})
Gets information about the products for the specified portfolio or all products.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"Filters"`: The search filters. If no search filters are specified, the output includes
all products to which the administrator has access.
- `"PageSize"`: The maximum number of items to return with this call.
- `"PageToken"`: The page token for the next set of results. To retrieve the first set of
results, use null.
- `"PortfolioId"`: The portfolio identifier.
- `"ProductSource"`: Access level of the source of the product.
- `"SortBy"`: The sort field. If no value is specified, the results are not sorted.
- `"SortOrder"`: The sort order. If no value is specified, the results are not sorted.
"""
function search_products_as_admin(; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog(
"SearchProductsAsAdmin"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function search_products_as_admin(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"SearchProductsAsAdmin",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_provisioned_products()
search_provisioned_products(params::Dict{String,<:Any})
Gets information about the provisioned products that meet the specified criteria.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"AccessLevelFilter"`: The access level to use to obtain results. The default is User.
- `"Filters"`: The search filters. When the key is SearchQuery, the searchable fields are
arn, createdTime, id, lastRecordId, idempotencyToken, name, physicalId, productId,
provisioningArtifactId, type, status, tags, userArn, userArnSession,
lastProvisioningRecordId, lastSuccessfulProvisioningRecordId, productName, and
provisioningArtifactName. Example: \"SearchQuery\":[\"status:AVAILABLE\"]
- `"PageSize"`: The maximum number of items to return with this call.
- `"PageToken"`: The page token for the next set of results. To retrieve the first set of
results, use null.
- `"SortBy"`: The sort field. If no value is specified, the results are not sorted. The
valid values are arn, id, name, and lastRecordId.
- `"SortOrder"`: The sort order. If no value is specified, the results are not sorted.
"""
function search_provisioned_products(; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog(
"SearchProvisionedProducts"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function search_provisioned_products(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"SearchProvisionedProducts",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
terminate_provisioned_product(terminate_token)
terminate_provisioned_product(terminate_token, params::Dict{String,<:Any})
Terminates the specified provisioned product. This operation does not delete any records
associated with the provisioned product. You can check the status of this request using
DescribeRecord.
# Arguments
- `terminate_token`: An idempotency token that uniquely identifies the termination request.
This token is only valid during the termination process. After the provisioned product is
terminated, subsequent requests to terminate the same provisioned product always return
ResourceNotFound.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"IgnoreErrors"`: If set to true, Service Catalog stops managing the specified
provisioned product even if it cannot delete the underlying resources.
- `"ProvisionedProductId"`: The identifier of the provisioned product. You cannot specify
both ProvisionedProductName and ProvisionedProductId.
- `"ProvisionedProductName"`: The name of the provisioned product. You cannot specify both
ProvisionedProductName and ProvisionedProductId.
- `"RetainPhysicalResources"`: When this boolean parameter is set to true, the
TerminateProvisionedProduct API deletes the Service Catalog provisioned product. However,
it does not remove the CloudFormation stack, stack set, or the underlying resources of the
deleted provisioned product. The default value is false.
"""
function terminate_provisioned_product(
TerminateToken; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"TerminateProvisionedProduct",
Dict{String,Any}("TerminateToken" => TerminateToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function terminate_provisioned_product(
TerminateToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"TerminateProvisionedProduct",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TerminateToken" => TerminateToken), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_constraint(id)
update_constraint(id, params::Dict{String,<:Any})
Updates the specified constraint.
# Arguments
- `id`: The identifier of the constraint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"Description"`: The updated description of the constraint.
- `"Parameters"`: The constraint parameters, in JSON format. The syntax depends on the
constraint type as follows: LAUNCH You are required to specify either the RoleArn or the
LocalRoleName but can't use both. Specify the RoleArn property as follows: {\"RoleArn\" :
\"arn:aws:iam::123456789012:role/LaunchRole\"} Specify the LocalRoleName property as
follows: {\"LocalRoleName\": \"SCBasicLaunchRole\"} If you specify the LocalRoleName
property, when an account uses the launch constraint, the IAM role with that name in the
account will be used. This allows launch-role constraints to be account-agnostic so the
administrator can create fewer resources per shared account. The given role name must
exist in the account used to create the launch constraint and the account of the user who
launches a product with this launch constraint. You cannot have both a LAUNCH and a
STACKSET constraint. You also cannot have more than one LAUNCH constraint on a product and
portfolio. NOTIFICATION Specify the NotificationArns property as follows:
{\"NotificationArns\" : [\"arn:aws:sns:us-east-1:123456789012:Topic\"]} RESOURCE_UPDATE
Specify the TagUpdatesOnProvisionedProduct property as follows:
{\"Version\":\"2.0\",\"Properties\":{\"TagUpdateOnProvisionedProduct\":\"String\"}} The
TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.
STACKSET Specify the Parameters property as follows: {\"Version\": \"String\",
\"Properties\": {\"AccountList\": [ \"String\" ], \"RegionList\": [ \"String\" ],
\"AdminRole\": \"String\", \"ExecutionRole\": \"String\"}} You cannot have both a LAUNCH
and a STACKSET constraint. You also cannot have more than one STACKSET constraint on a
product and portfolio. Products with a STACKSET constraint will launch an CloudFormation
stack set. TEMPLATE Specify the Rules property. For more information, see Template
Constraint Rules.
"""
function update_constraint(Id; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog(
"UpdateConstraint",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_constraint(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"UpdateConstraint",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_portfolio(id)
update_portfolio(id, params::Dict{String,<:Any})
Updates the specified portfolio. You cannot update a product that was shared with you.
# Arguments
- `id`: The portfolio identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"AddTags"`: The tags to add.
- `"Description"`: The updated description of the portfolio.
- `"DisplayName"`: The name to use for display purposes.
- `"ProviderName"`: The updated name of the portfolio provider.
- `"RemoveTags"`: The tags to remove.
"""
function update_portfolio(Id; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog(
"UpdatePortfolio",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_portfolio(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"UpdatePortfolio",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_portfolio_share(portfolio_id)
update_portfolio_share(portfolio_id, params::Dict{String,<:Any})
Updates the specified portfolio share. You can use this API to enable or disable TagOptions
sharing or Principal sharing for an existing portfolio share. The portfolio share cannot
be updated if the CreatePortfolioShare operation is IN_PROGRESS, as the share is not
available to recipient entities. In this case, you must wait for the portfolio share to be
completed. You must provide the accountId or organization node in the input, but not both.
If the portfolio is shared to both an external account and an organization node, and both
shares need to be updated, you must invoke UpdatePortfolioShare separately for each share
type. This API cannot be used for removing the portfolio share. You must use
DeletePortfolioShare API for that action. When you associate a principal with portfolio,
a potential privilege escalation path may occur when that portfolio is then shared with
other accounts. For a user in a recipient account who is not an Service Catalog Admin, but
still has the ability to create Principals (Users/Groups/Roles), that user could create a
role that matches a principal name association for the portfolio. Although this user may
not know which principal names are associated through Service Catalog, they may be able to
guess the user. If this potential escalation path is a concern, then Service Catalog
recommends using PrincipalType as IAM. With this configuration, the PrincipalARN must
already exist in the recipient account before it can be associated.
# Arguments
- `portfolio_id`: The unique identifier of the portfolio for which the share will be
updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"AccountId"`: The Amazon Web Services account Id of the recipient account. This field is
required when updating an external account to account type share.
- `"OrganizationNode"`:
- `"SharePrincipals"`: A flag to enables or disables Principals sharing in the portfolio.
If this field is not provided, the current state of the Principals sharing on the portfolio
share will not be modified.
- `"ShareTagOptions"`: Enables or disables TagOptions sharing for the portfolio share. If
this field is not provided, the current state of TagOptions sharing on the portfolio share
will not be modified.
"""
function update_portfolio_share(
PortfolioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"UpdatePortfolioShare",
Dict{String,Any}("PortfolioId" => PortfolioId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_portfolio_share(
PortfolioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"UpdatePortfolioShare",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PortfolioId" => PortfolioId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_product(id)
update_product(id, params::Dict{String,<:Any})
Updates the specified product.
# Arguments
- `id`: The product identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"AddTags"`: The tags to add to the product.
- `"Description"`: The updated description of the product.
- `"Distributor"`: The updated distributor of the product.
- `"Name"`: The updated product name.
- `"Owner"`: The updated owner of the product.
- `"RemoveTags"`: The tags to remove from the product.
- `"SourceConnection"`: Specifies connection details for the updated product and syncs the
product to the connection source artifact. This automatically manages the product's
artifacts based on changes to the source. The SourceConnection parameter consists of the
following sub-fields. Type ConnectionParamters
- `"SupportDescription"`: The updated support description for the product.
- `"SupportEmail"`: The updated support email for the product.
- `"SupportUrl"`: The updated support URL for the product.
"""
function update_product(Id; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog(
"UpdateProduct",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_product(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"UpdateProduct",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_provisioned_product(update_token)
update_provisioned_product(update_token, params::Dict{String,<:Any})
Requests updates to the configuration of the specified provisioned product. If there are
tags associated with the object, they cannot be updated or added. Depending on the specific
updates requested, this operation can update with no interruption, with some interruption,
or replace the provisioned product entirely. You can check the status of this request using
DescribeRecord.
# Arguments
- `update_token`: The idempotency token that uniquely identifies the provisioning update
request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"PathId"`: The path identifier. This value is optional if the product has a default
path, and required if the product has more than one path. You must provide the name or ID,
but not both.
- `"PathName"`: The name of the path. You must provide the name or ID, but not both.
- `"ProductId"`: The identifier of the product. You must provide the name or ID, but not
both.
- `"ProductName"`: The name of the product. You must provide the name or ID, but not both.
- `"ProvisionedProductId"`: The identifier of the provisioned product. You must provide the
name or ID, but not both.
- `"ProvisionedProductName"`: The name of the provisioned product. You cannot specify both
ProvisionedProductName and ProvisionedProductId.
- `"ProvisioningArtifactId"`: The identifier of the provisioning artifact.
- `"ProvisioningArtifactName"`: The name of the provisioning artifact. You must provide the
name or ID, but not both.
- `"ProvisioningParameters"`: The new parameters.
- `"ProvisioningPreferences"`: An object that contains information about the provisioning
preferences for a stack set.
- `"Tags"`: One or more tags. Requires the product to have RESOURCE_UPDATE constraint with
TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates.
"""
function update_provisioned_product(
UpdateToken; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"UpdateProvisionedProduct",
Dict{String,Any}("UpdateToken" => UpdateToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_provisioned_product(
UpdateToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"UpdateProvisionedProduct",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UpdateToken" => UpdateToken), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_provisioned_product_properties(idempotency_token, provisioned_product_id, provisioned_product_properties)
update_provisioned_product_properties(idempotency_token, provisioned_product_id, provisioned_product_properties, params::Dict{String,<:Any})
Requests updates to the properties of the specified provisioned product.
# Arguments
- `idempotency_token`: The idempotency token that uniquely identifies the provisioning
product update request.
- `provisioned_product_id`: The identifier of the provisioned product.
- `provisioned_product_properties`: A map that contains the provisioned product properties
to be updated. The LAUNCH_ROLE key accepts role ARNs. This key allows an administrator to
call UpdateProvisionedProductProperties to update the launch role that is associated with a
provisioned product. This role is used when an end user calls a provisioning operation such
as UpdateProvisionedProduct, TerminateProvisionedProduct, or
ExecuteProvisionedProductServiceAction. Only a role ARN is valid. A user ARN is invalid.
The OWNER key accepts user ARNs, IAM role ARNs, and STS assumed-role ARNs. The owner is the
user that has permission to see, update, terminate, and execute service actions in the
provisioned product. The administrator can change the owner of a provisioned product to
another IAM or STS entity within the same account. Both end user owners and administrators
can see ownership history of the provisioned product using the ListRecordHistory API. The
new owner can describe all past records for the provisioned product using the
DescribeRecord API. The previous owner can no longer use DescribeRecord, but can still see
the product's history from when he was an owner using ListRecordHistory. If a provisioned
product ownership is assigned to an end user, they can see and perform any action through
the API or Service Catalog console such as update, terminate, and execute service actions.
If an end user provisions a product and the owner is updated to someone else, they will no
longer be able to see or perform any actions through API or the Service Catalog console on
that provisioned product.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
"""
function update_provisioned_product_properties(
IdempotencyToken,
ProvisionedProductId,
ProvisionedProductProperties;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"UpdateProvisionedProductProperties",
Dict{String,Any}(
"IdempotencyToken" => IdempotencyToken,
"ProvisionedProductId" => ProvisionedProductId,
"ProvisionedProductProperties" => ProvisionedProductProperties,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_provisioned_product_properties(
IdempotencyToken,
ProvisionedProductId,
ProvisionedProductProperties,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"UpdateProvisionedProductProperties",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IdempotencyToken" => IdempotencyToken,
"ProvisionedProductId" => ProvisionedProductId,
"ProvisionedProductProperties" => ProvisionedProductProperties,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_provisioning_artifact(product_id, provisioning_artifact_id)
update_provisioning_artifact(product_id, provisioning_artifact_id, params::Dict{String,<:Any})
Updates the specified provisioning artifact (also known as a version) for the specified
product. You cannot update a provisioning artifact for a product that was shared with you.
# Arguments
- `product_id`: The product identifier.
- `provisioning_artifact_id`: The identifier of the provisioning artifact.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"Active"`: Indicates whether the product version is active. Inactive provisioning
artifacts are invisible to end users. End users cannot launch or update a provisioned
product from an inactive provisioning artifact.
- `"Description"`: The updated description of the provisioning artifact.
- `"Guidance"`: Information set by the administrator to provide guidance to end users about
which provisioning artifacts to use. The DEFAULT value indicates that the product version
is active. The administrator can set the guidance to DEPRECATED to inform users that the
product version is deprecated. Users are able to make updates to a provisioned product of a
deprecated version but cannot launch new provisioned products using a deprecated version.
- `"Name"`: The updated name of the provisioning artifact.
"""
function update_provisioning_artifact(
ProductId, ProvisioningArtifactId; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"UpdateProvisioningArtifact",
Dict{String,Any}(
"ProductId" => ProductId, "ProvisioningArtifactId" => ProvisioningArtifactId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_provisioning_artifact(
ProductId,
ProvisioningArtifactId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog(
"UpdateProvisioningArtifact",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ProductId" => ProductId,
"ProvisioningArtifactId" => ProvisioningArtifactId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_service_action(id)
update_service_action(id, params::Dict{String,<:Any})
Updates a self-service action.
# Arguments
- `id`: The self-service action identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptLanguage"`: The language code. jp - Japanese zh - Chinese
- `"Definition"`: A map that defines the self-service action.
- `"Description"`: The self-service action description.
- `"Name"`: The self-service action name.
"""
function update_service_action(Id; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog(
"UpdateServiceAction",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_service_action(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"UpdateServiceAction",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_tag_option(id)
update_tag_option(id, params::Dict{String,<:Any})
Updates the specified TagOption.
# Arguments
- `id`: The TagOption identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Active"`: The updated active state.
- `"Value"`: The updated value.
"""
function update_tag_option(Id; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog(
"UpdateTagOption",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_tag_option(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog(
"UpdateTagOption",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 32263 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: service_catalog_appregistry
using AWS.Compat
using AWS.UUIDs
"""
associate_attribute_group(application, attribute_group)
associate_attribute_group(application, attribute_group, params::Dict{String,<:Any})
Associates an attribute group with an application to augment the application's metadata
with the group's attributes. This feature enables applications to be described with
user-defined details that are machine-readable, such as third-party integrations.
# Arguments
- `application`: The name, ID, or ARN of the application.
- `attribute_group`: The name, ID, or ARN of the attribute group that holds the attributes
to describe the application.
"""
function associate_attribute_group(
application, attributeGroup; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog_appregistry(
"PUT",
"/applications/$(application)/attribute-groups/$(attributeGroup)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_attribute_group(
application,
attributeGroup,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog_appregistry(
"PUT",
"/applications/$(application)/attribute-groups/$(attributeGroup)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_resource(application, resource, resource_type)
associate_resource(application, resource, resource_type, params::Dict{String,<:Any})
Associates a resource with an application. The resource can be specified by its ARN or
name. The application can be specified by ARN, ID, or name. Minimum permissions You
must have the following permissions to associate a resource using the OPTIONS parameter set
to APPLY_APPLICATION_TAG. tag:GetResources tag:TagResources You must also have
these additional permissions if you don't use the AWSServiceCatalogAppRegistryFullAccess
policy. For more information, see AWSServiceCatalogAppRegistryFullAccess in the AppRegistry
Administrator Guide. resource-groups:AssociateResource cloudformation:UpdateStack
cloudformation:DescribeStacks In addition, you must have the tagging permission
defined by the Amazon Web Services service that creates the resource. For more information,
see TagResources in the Resource Groups Tagging API Reference.
# Arguments
- `application`: The name, ID, or ARN of the application.
- `resource`: The name or ID of the resource of which the application will be associated.
- `resource_type`: The type of resource of which the application will be associated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"options"`: Determines whether an application tag is applied or skipped.
"""
function associate_resource(
application, resource, resourceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog_appregistry(
"PUT",
"/applications/$(application)/resources/$(resourceType)/$(resource)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_resource(
application,
resource,
resourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog_appregistry(
"PUT",
"/applications/$(application)/resources/$(resourceType)/$(resource)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_application(client_token, name)
create_application(client_token, name, params::Dict{String,<:Any})
Creates a new application that is the top-level node in a hierarchy of related cloud
resource abstractions.
# Arguments
- `client_token`: A unique identifier that you provide to ensure idempotency. 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, the
retry fails.
- `name`: The name of the application. The name must be unique in the region in which you
are creating the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the application.
- `"tags"`: Key-value pairs you can use to associate with the application.
"""
function create_application(
clientToken, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog_appregistry(
"POST",
"/applications",
Dict{String,Any}("clientToken" => clientToken, "name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_application(
clientToken,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog_appregistry(
"POST",
"/applications",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("clientToken" => clientToken, "name" => name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_attribute_group(attributes, client_token, name)
create_attribute_group(attributes, client_token, name, params::Dict{String,<:Any})
Creates a new attribute group as a container for user-defined attributes. This feature
enables users to have full control over their cloud application's metadata in a rich
machine-readable format to facilitate integration with automated workflows and third-party
tools.
# Arguments
- `attributes`: A JSON string in the form of nested key-value pairs that represent the
attributes in the group and describes an application and its components.
- `client_token`: A unique identifier that you provide to ensure idempotency. 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, the
retry fails.
- `name`: The name of the attribute group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the attribute group that the user provides.
- `"tags"`: Key-value pairs you can use to associate with the attribute group.
"""
function create_attribute_group(
attributes, clientToken, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog_appregistry(
"POST",
"/attribute-groups",
Dict{String,Any}(
"attributes" => attributes, "clientToken" => clientToken, "name" => name
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_attribute_group(
attributes,
clientToken,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog_appregistry(
"POST",
"/attribute-groups",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"attributes" => attributes, "clientToken" => clientToken, "name" => name
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_application(application)
delete_application(application, params::Dict{String,<:Any})
Deletes an application that is specified either by its application ID, name, or ARN. All
associated attribute groups and resources must be disassociated from it before deleting an
application.
# Arguments
- `application`: The name, ID, or ARN of the application.
"""
function delete_application(application; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog_appregistry(
"DELETE",
"/applications/$(application)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_application(
application,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog_appregistry(
"DELETE",
"/applications/$(application)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_attribute_group(attribute_group)
delete_attribute_group(attribute_group, params::Dict{String,<:Any})
Deletes an attribute group, specified either by its attribute group ID, name, or ARN.
# Arguments
- `attribute_group`: The name, ID, or ARN of the attribute group that holds the attributes
to describe the application.
"""
function delete_attribute_group(
attributeGroup; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog_appregistry(
"DELETE",
"/attribute-groups/$(attributeGroup)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_attribute_group(
attributeGroup,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog_appregistry(
"DELETE",
"/attribute-groups/$(attributeGroup)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_attribute_group(application, attribute_group)
disassociate_attribute_group(application, attribute_group, params::Dict{String,<:Any})
Disassociates an attribute group from an application to remove the extra attributes
contained in the attribute group from the application's metadata. This operation reverts
AssociateAttributeGroup.
# Arguments
- `application`: The name, ID, or ARN of the application.
- `attribute_group`: The name, ID, or ARN of the attribute group that holds the attributes
to describe the application.
"""
function disassociate_attribute_group(
application, attributeGroup; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog_appregistry(
"DELETE",
"/applications/$(application)/attribute-groups/$(attributeGroup)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_attribute_group(
application,
attributeGroup,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog_appregistry(
"DELETE",
"/applications/$(application)/attribute-groups/$(attributeGroup)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_resource(application, resource, resource_type)
disassociate_resource(application, resource, resource_type, params::Dict{String,<:Any})
Disassociates a resource from application. Both the resource and the application can be
specified either by ID or name. Minimum permissions You must have the following
permissions to remove a resource that's been associated with an application using the
APPLY_APPLICATION_TAG option for AssociateResource. tag:GetResources
tag:UntagResources You must also have the following permissions if you don't use the
AWSServiceCatalogAppRegistryFullAccess policy. For more information, see
AWSServiceCatalogAppRegistryFullAccess in the AppRegistry Administrator Guide.
resource-groups:DisassociateResource cloudformation:UpdateStack
cloudformation:DescribeStacks In addition, you must have the tagging permission
defined by the Amazon Web Services service that creates the resource. For more information,
see UntagResources in the Resource Groups Tagging API Reference.
# Arguments
- `application`: The name or ID of the application.
- `resource`: The name or ID of the resource.
- `resource_type`: The type of the resource that is being disassociated.
"""
function disassociate_resource(
application, resource, resourceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog_appregistry(
"DELETE",
"/applications/$(application)/resources/$(resourceType)/$(resource)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_resource(
application,
resource,
resourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog_appregistry(
"DELETE",
"/applications/$(application)/resources/$(resourceType)/$(resource)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_application(application)
get_application(application, params::Dict{String,<:Any})
Retrieves metadata information about one of your applications. The application can be
specified by its ARN, ID, or name (which is unique within one account in one region at a
given point in time). Specify by ARN or ID in automated workflows if you want to make sure
that the exact same application is returned or a ResourceNotFoundException is thrown,
avoiding the ABA addressing problem.
# Arguments
- `application`: The name, ID, or ARN of the application.
"""
function get_application(application; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog_appregistry(
"GET",
"/applications/$(application)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_application(
application,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog_appregistry(
"GET",
"/applications/$(application)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_associated_resource(application, resource, resource_type)
get_associated_resource(application, resource, resource_type, params::Dict{String,<:Any})
Gets the resource associated with the application.
# Arguments
- `application`: The name, ID, or ARN of the application.
- `resource`: The name or ID of the resource associated with the application.
- `resource_type`: The type of resource associated with the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return. If the parameter is omitted, it
defaults to 25. The value is optional.
- `"nextToken"`: A unique pagination token for each page of results. Make the call again
with the returned token to retrieve the next page of results.
- `"resourceTagStatus"`: States whether an application tag is applied, not applied, in the
process of being applied, or skipped.
"""
function get_associated_resource(
application, resource, resourceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog_appregistry(
"GET",
"/applications/$(application)/resources/$(resourceType)/$(resource)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_associated_resource(
application,
resource,
resourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog_appregistry(
"GET",
"/applications/$(application)/resources/$(resourceType)/$(resource)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_attribute_group(attribute_group)
get_attribute_group(attribute_group, params::Dict{String,<:Any})
Retrieves an attribute group by its ARN, ID, or name. The attribute group can be specified
by its ARN, ID, or name.
# Arguments
- `attribute_group`: The name, ID, or ARN of the attribute group that holds the attributes
to describe the application.
"""
function get_attribute_group(
attributeGroup; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog_appregistry(
"GET",
"/attribute-groups/$(attributeGroup)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_attribute_group(
attributeGroup,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog_appregistry(
"GET",
"/attribute-groups/$(attributeGroup)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_configuration()
get_configuration(params::Dict{String,<:Any})
Retrieves a TagKey configuration from an account.
"""
function get_configuration(; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog_appregistry(
"GET", "/configuration"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog_appregistry(
"GET",
"/configuration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_applications()
list_applications(params::Dict{String,<:Any})
Retrieves a list of all of your applications. Results are paginated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The upper bound of the number of results to return (cannot exceed 25). If
this parameter is omitted, it defaults to 25. This value is optional.
- `"nextToken"`: The token to use to get the next page of results after a previous API
call.
"""
function list_applications(; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog_appregistry(
"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 service_catalog_appregistry(
"GET",
"/applications",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_associated_attribute_groups(application)
list_associated_attribute_groups(application, params::Dict{String,<:Any})
Lists all attribute groups that are associated with specified application. Results are
paginated.
# Arguments
- `application`: The name or ID of the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The upper bound of the number of results to return (cannot exceed 25). If
this parameter is omitted, it defaults to 25. This value is optional.
- `"nextToken"`: The token to use to get the next page of results after a previous API
call.
"""
function list_associated_attribute_groups(
application; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog_appregistry(
"GET",
"/applications/$(application)/attribute-groups";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_associated_attribute_groups(
application,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog_appregistry(
"GET",
"/applications/$(application)/attribute-groups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_associated_resources(application)
list_associated_resources(application, params::Dict{String,<:Any})
Lists all of the resources that are associated with the specified application. Results are
paginated. If you share an application, and a consumer account associates a tag query to
the application, all of the users who can access the application can also view the tag
values in all accounts that are associated with it using this API.
# Arguments
- `application`: The name, ID, or ARN of the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The upper bound of the number of results to return (cannot exceed 25). If
this parameter is omitted, it defaults to 25. This value is optional.
- `"nextToken"`: The token to use to get the next page of results after a previous API
call.
"""
function list_associated_resources(
application; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog_appregistry(
"GET",
"/applications/$(application)/resources";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_associated_resources(
application,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog_appregistry(
"GET",
"/applications/$(application)/resources",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_attribute_groups()
list_attribute_groups(params::Dict{String,<:Any})
Lists all attribute groups which you have access to. Results are paginated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The upper bound of the number of results to return (cannot exceed 25). If
this parameter is omitted, it defaults to 25. This value is optional.
- `"nextToken"`: The token to use to get the next page of results after a previous API
call.
"""
function list_attribute_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog_appregistry(
"GET", "/attribute-groups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_attribute_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog_appregistry(
"GET",
"/attribute-groups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_attribute_groups_for_application(application)
list_attribute_groups_for_application(application, params::Dict{String,<:Any})
Lists the details of all attribute groups associated with a specific application. The
results display in pages.
# Arguments
- `application`: The name or ID of the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The upper bound of the number of results to return. The value cannot
exceed 25. If you omit this parameter, it defaults to 25. This value is optional.
- `"nextToken"`: This token retrieves the next page of results after a previous API call.
"""
function list_attribute_groups_for_application(
application; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog_appregistry(
"GET",
"/applications/$(application)/attribute-group-details";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_attribute_groups_for_application(
application,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog_appregistry(
"GET",
"/applications/$(application)/attribute-group-details",
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 of the tags on the resource.
# Arguments
- `resource_arn`: The Amazon resource name (ARN) that specifies the resource.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog_appregistry(
"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 service_catalog_appregistry(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_configuration(configuration)
put_configuration(configuration, params::Dict{String,<:Any})
Associates a TagKey configuration to an account.
# Arguments
- `configuration`: Associates a TagKey configuration to an account.
"""
function put_configuration(configuration; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog_appregistry(
"PUT",
"/configuration",
Dict{String,Any}("configuration" => configuration);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_configuration(
configuration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog_appregistry(
"PUT",
"/configuration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("configuration" => configuration), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
sync_resource(resource, resource_type)
sync_resource(resource, resource_type, params::Dict{String,<:Any})
Syncs the resource with current AppRegistry records. Specifically, the resource’s
AppRegistry system tags sync with its associated application. We remove the resource's
AppRegistry system tags if it does not associate with the application. The caller must have
permissions to read and update the resource.
# Arguments
- `resource`: An entity you can work with and specify with a name or ID. Examples include
an Amazon EC2 instance, an Amazon Web Services CloudFormation stack, or an Amazon S3 bucket.
- `resource_type`: The type of resource of which the application will be associated.
"""
function sync_resource(
resource, resourceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog_appregistry(
"POST",
"/sync/$(resourceType)/$(resource)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function sync_resource(
resource,
resourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog_appregistry(
"POST",
"/sync/$(resourceType)/$(resource)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Assigns one or more tags (key-value pairs) to the specified resource. 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. This operation returns an empty response if the
call was successful.
# Arguments
- `resource_arn`: The Amazon resource name (ARN) that specifies the resource.
- `tags`: The new or modified tags for the resource.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog_appregistry(
"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 service_catalog_appregistry(
"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. This operation returns an empty response if the call was
successful.
# Arguments
- `resource_arn`: The Amazon resource name (ARN) that specifies the resource.
- `tag_keys`: A list of the tag keys to remove from the specified resource.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog_appregistry(
"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 service_catalog_appregistry(
"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)
update_application(application, params::Dict{String,<:Any})
Updates an existing application with new attributes.
# Arguments
- `application`: The name, ID, or ARN of the application that will be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The new description of the application.
- `"name"`: Deprecated: The new name of the application. The name must be unique in the
region in which you are updating the application. Please do not use this field as we have
stopped supporting name updates.
"""
function update_application(application; aws_config::AbstractAWSConfig=global_aws_config())
return service_catalog_appregistry(
"PATCH",
"/applications/$(application)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_application(
application,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog_appregistry(
"PATCH",
"/applications/$(application)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_attribute_group(attribute_group)
update_attribute_group(attribute_group, params::Dict{String,<:Any})
Updates an existing attribute group with new details.
# Arguments
- `attribute_group`: The name, ID, or ARN of the attribute group that holds the attributes
to describe the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"attributes"`: A JSON string in the form of nested key-value pairs that represent the
attributes in the group and describes an application and its components.
- `"description"`: The description of the attribute group that the user provides.
- `"name"`: Deprecated: The new name of the attribute group. The name must be unique in the
region in which you are updating the attribute group. Please do not use this field as we
have stopped supporting name updates.
"""
function update_attribute_group(
attributeGroup; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_catalog_appregistry(
"PATCH",
"/attribute-groups/$(attributeGroup)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_attribute_group(
attributeGroup,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_catalog_appregistry(
"PATCH",
"/attribute-groups/$(attributeGroup)",
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 | 33210 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: service_quotas
using AWS.Compat
using AWS.UUIDs
"""
associate_service_quota_template()
associate_service_quota_template(params::Dict{String,<:Any})
Associates your quota request template with your organization. When a new Amazon Web
Services account is created in your organization, the quota increase requests in the
template are automatically applied to the account. You can add a quota increase request for
any adjustable quota to your template.
"""
function associate_service_quota_template(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return service_quotas(
"AssociateServiceQuotaTemplate";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_service_quota_template(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_quotas(
"AssociateServiceQuotaTemplate",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_service_quota_increase_request_from_template(aws_region, quota_code, service_code)
delete_service_quota_increase_request_from_template(aws_region, quota_code, service_code, params::Dict{String,<:Any})
Deletes the quota increase request for the specified quota from your quota request template.
# Arguments
- `aws_region`: Specifies the Amazon Web Services Region for which the request was made.
- `quota_code`: Specifies the quota identifier. To find the quota code for a specific
quota, use the ListServiceQuotas operation, and look for the QuotaCode response in the
output for the quota you want.
- `service_code`: Specifies the service identifier. To find the service code value for an
Amazon Web Services service, use the ListServices operation.
"""
function delete_service_quota_increase_request_from_template(
AwsRegion, QuotaCode, ServiceCode; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_quotas(
"DeleteServiceQuotaIncreaseRequestFromTemplate",
Dict{String,Any}(
"AwsRegion" => AwsRegion, "QuotaCode" => QuotaCode, "ServiceCode" => ServiceCode
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_service_quota_increase_request_from_template(
AwsRegion,
QuotaCode,
ServiceCode,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_quotas(
"DeleteServiceQuotaIncreaseRequestFromTemplate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AwsRegion" => AwsRegion,
"QuotaCode" => QuotaCode,
"ServiceCode" => ServiceCode,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_service_quota_template()
disassociate_service_quota_template(params::Dict{String,<:Any})
Disables your quota request template. After a template is disabled, the quota increase
requests in the template are not applied to new Amazon Web Services accounts in your
organization. Disabling a quota request template does not apply its quota increase requests.
"""
function disassociate_service_quota_template(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return service_quotas(
"DisassociateServiceQuotaTemplate";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_service_quota_template(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_quotas(
"DisassociateServiceQuotaTemplate",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_association_for_service_quota_template()
get_association_for_service_quota_template(params::Dict{String,<:Any})
Retrieves the status of the association for the quota request template.
"""
function get_association_for_service_quota_template(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return service_quotas(
"GetAssociationForServiceQuotaTemplate";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_association_for_service_quota_template(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_quotas(
"GetAssociationForServiceQuotaTemplate",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_awsdefault_service_quota(quota_code, service_code)
get_awsdefault_service_quota(quota_code, service_code, params::Dict{String,<:Any})
Retrieves the default value for the specified quota. The default value does not reflect any
quota increases.
# Arguments
- `quota_code`: Specifies the quota identifier. To find the quota code for a specific
quota, use the ListServiceQuotas operation, and look for the QuotaCode response in the
output for the quota you want.
- `service_code`: Specifies the service identifier. To find the service code value for an
Amazon Web Services service, use the ListServices operation.
"""
function get_awsdefault_service_quota(
QuotaCode, ServiceCode; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_quotas(
"GetAWSDefaultServiceQuota",
Dict{String,Any}("QuotaCode" => QuotaCode, "ServiceCode" => ServiceCode);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_awsdefault_service_quota(
QuotaCode,
ServiceCode,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_quotas(
"GetAWSDefaultServiceQuota",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("QuotaCode" => QuotaCode, "ServiceCode" => ServiceCode),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_requested_service_quota_change(request_id)
get_requested_service_quota_change(request_id, params::Dict{String,<:Any})
Retrieves information about the specified quota increase request.
# Arguments
- `request_id`: Specifies the ID of the quota increase request.
"""
function get_requested_service_quota_change(
RequestId; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_quotas(
"GetRequestedServiceQuotaChange",
Dict{String,Any}("RequestId" => RequestId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_requested_service_quota_change(
RequestId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_quotas(
"GetRequestedServiceQuotaChange",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RequestId" => RequestId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_service_quota(quota_code, service_code)
get_service_quota(quota_code, service_code, params::Dict{String,<:Any})
Retrieves the applied quota value for the specified quota. For some quotas, only the
default values are available. If the applied quota value is not available for a quota, the
quota is not retrieved.
# Arguments
- `quota_code`: Specifies the quota identifier. To find the quota code for a specific
quota, use the ListServiceQuotas operation, and look for the QuotaCode response in the
output for the quota you want.
- `service_code`: Specifies the service identifier. To find the service code value for an
Amazon Web Services service, use the ListServices operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ContextId"`: Specifies the Amazon Web Services account or resource to which the quota
applies. The value in this field depends on the context scope associated with the specified
service quota.
"""
function get_service_quota(
QuotaCode, ServiceCode; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_quotas(
"GetServiceQuota",
Dict{String,Any}("QuotaCode" => QuotaCode, "ServiceCode" => ServiceCode);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_service_quota(
QuotaCode,
ServiceCode,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_quotas(
"GetServiceQuota",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("QuotaCode" => QuotaCode, "ServiceCode" => ServiceCode),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_service_quota_increase_request_from_template(aws_region, quota_code, service_code)
get_service_quota_increase_request_from_template(aws_region, quota_code, service_code, params::Dict{String,<:Any})
Retrieves information about the specified quota increase request in your quota request
template.
# Arguments
- `aws_region`: Specifies the Amazon Web Services Region for which you made the request.
- `quota_code`: Specifies the quota identifier. To find the quota code for a specific
quota, use the ListServiceQuotas operation, and look for the QuotaCode response in the
output for the quota you want.
- `service_code`: Specifies the service identifier. To find the service code value for an
Amazon Web Services service, use the ListServices operation.
"""
function get_service_quota_increase_request_from_template(
AwsRegion, QuotaCode, ServiceCode; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_quotas(
"GetServiceQuotaIncreaseRequestFromTemplate",
Dict{String,Any}(
"AwsRegion" => AwsRegion, "QuotaCode" => QuotaCode, "ServiceCode" => ServiceCode
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_service_quota_increase_request_from_template(
AwsRegion,
QuotaCode,
ServiceCode,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_quotas(
"GetServiceQuotaIncreaseRequestFromTemplate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AwsRegion" => AwsRegion,
"QuotaCode" => QuotaCode,
"ServiceCode" => ServiceCode,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_awsdefault_service_quotas(service_code)
list_awsdefault_service_quotas(service_code, params::Dict{String,<:Any})
Lists the default values for the quotas for the specified Amazon Web Service. A default
value does not reflect any quota increases.
# Arguments
- `service_code`: Specifies the service identifier. To find the service code value for an
Amazon Web Services service, use the ListServices operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Specifies the maximum number of results that you want included on each
page of the response. If you do not include this parameter, it defaults to a value
appropriate to the operation. If additional items exist beyond those included in the
current response, the NextToken response element is present and has a value (is not null).
Include that value as the NextToken request parameter in the next call to the operation to
get the next part of the results. An API operation can return fewer results than the
maximum even when there are more results available. You should check NextToken after every
operation to ensure that you receive all of the results.
- `"NextToken"`: Specifies a value for receiving additional results after you receive a
NextToken response in a previous request. A NextToken response indicates that more output
is available. Set this parameter to the value of the previous call's NextToken response to
indicate where the output should continue from.
"""
function list_awsdefault_service_quotas(
ServiceCode; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_quotas(
"ListAWSDefaultServiceQuotas",
Dict{String,Any}("ServiceCode" => ServiceCode);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_awsdefault_service_quotas(
ServiceCode,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_quotas(
"ListAWSDefaultServiceQuotas",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ServiceCode" => ServiceCode), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_requested_service_quota_change_history()
list_requested_service_quota_change_history(params::Dict{String,<:Any})
Retrieves the quota increase requests for the specified Amazon Web Service.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Specifies the maximum number of results that you want included on each
page of the response. If you do not include this parameter, it defaults to a value
appropriate to the operation. If additional items exist beyond those included in the
current response, the NextToken response element is present and has a value (is not null).
Include that value as the NextToken request parameter in the next call to the operation to
get the next part of the results. An API operation can return fewer results than the
maximum even when there are more results available. You should check NextToken after every
operation to ensure that you receive all of the results.
- `"NextToken"`: Specifies a value for receiving additional results after you receive a
NextToken response in a previous request. A NextToken response indicates that more output
is available. Set this parameter to the value of the previous call's NextToken response to
indicate where the output should continue from.
- `"QuotaRequestedAtLevel"`: Specifies at which level within the Amazon Web Services
account the quota request applies to.
- `"ServiceCode"`: Specifies the service identifier. To find the service code value for an
Amazon Web Services service, use the ListServices operation.
- `"Status"`: Specifies that you want to filter the results to only the requests with the
matching status.
"""
function list_requested_service_quota_change_history(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return service_quotas(
"ListRequestedServiceQuotaChangeHistory";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_requested_service_quota_change_history(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_quotas(
"ListRequestedServiceQuotaChangeHistory",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_requested_service_quota_change_history_by_quota(quota_code, service_code)
list_requested_service_quota_change_history_by_quota(quota_code, service_code, params::Dict{String,<:Any})
Retrieves the quota increase requests for the specified quota.
# Arguments
- `quota_code`: Specifies the quota identifier. To find the quota code for a specific
quota, use the ListServiceQuotas operation, and look for the QuotaCode response in the
output for the quota you want.
- `service_code`: Specifies the service identifier. To find the service code value for an
Amazon Web Services service, use the ListServices operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Specifies the maximum number of results that you want included on each
page of the response. If you do not include this parameter, it defaults to a value
appropriate to the operation. If additional items exist beyond those included in the
current response, the NextToken response element is present and has a value (is not null).
Include that value as the NextToken request parameter in the next call to the operation to
get the next part of the results. An API operation can return fewer results than the
maximum even when there are more results available. You should check NextToken after every
operation to ensure that you receive all of the results.
- `"NextToken"`: Specifies a value for receiving additional results after you receive a
NextToken response in a previous request. A NextToken response indicates that more output
is available. Set this parameter to the value of the previous call's NextToken response to
indicate where the output should continue from.
- `"QuotaRequestedAtLevel"`: Specifies at which level within the Amazon Web Services
account the quota request applies to.
- `"Status"`: Specifies that you want to filter the results to only the requests with the
matching status.
"""
function list_requested_service_quota_change_history_by_quota(
QuotaCode, ServiceCode; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_quotas(
"ListRequestedServiceQuotaChangeHistoryByQuota",
Dict{String,Any}("QuotaCode" => QuotaCode, "ServiceCode" => ServiceCode);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_requested_service_quota_change_history_by_quota(
QuotaCode,
ServiceCode,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_quotas(
"ListRequestedServiceQuotaChangeHistoryByQuota",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("QuotaCode" => QuotaCode, "ServiceCode" => ServiceCode),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_service_quota_increase_requests_in_template()
list_service_quota_increase_requests_in_template(params::Dict{String,<:Any})
Lists the quota increase requests in the specified quota request template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AwsRegion"`: Specifies the Amazon Web Services Region for which you made the request.
- `"MaxResults"`: Specifies the maximum number of results that you want included on each
page of the response. If you do not include this parameter, it defaults to a value
appropriate to the operation. If additional items exist beyond those included in the
current response, the NextToken response element is present and has a value (is not null).
Include that value as the NextToken request parameter in the next call to the operation to
get the next part of the results. An API operation can return fewer results than the
maximum even when there are more results available. You should check NextToken after every
operation to ensure that you receive all of the results.
- `"NextToken"`: Specifies a value for receiving additional results after you receive a
NextToken response in a previous request. A NextToken response indicates that more output
is available. Set this parameter to the value of the previous call's NextToken response to
indicate where the output should continue from.
- `"ServiceCode"`: Specifies the service identifier. To find the service code value for an
Amazon Web Services service, use the ListServices operation.
"""
function list_service_quota_increase_requests_in_template(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return service_quotas(
"ListServiceQuotaIncreaseRequestsInTemplate";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_service_quota_increase_requests_in_template(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_quotas(
"ListServiceQuotaIncreaseRequestsInTemplate",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_service_quotas(service_code)
list_service_quotas(service_code, params::Dict{String,<:Any})
Lists the applied quota values for the specified Amazon Web Service. For some quotas, only
the default values are available. If the applied quota value is not available for a quota,
the quota is not retrieved.
# Arguments
- `service_code`: Specifies the service identifier. To find the service code value for an
Amazon Web Services service, use the ListServices operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Specifies the maximum number of results that you want included on each
page of the response. If you do not include this parameter, it defaults to a value
appropriate to the operation. If additional items exist beyond those included in the
current response, the NextToken response element is present and has a value (is not null).
Include that value as the NextToken request parameter in the next call to the operation to
get the next part of the results. An API operation can return fewer results than the
maximum even when there are more results available. You should check NextToken after every
operation to ensure that you receive all of the results.
- `"NextToken"`: Specifies a value for receiving additional results after you receive a
NextToken response in a previous request. A NextToken response indicates that more output
is available. Set this parameter to the value of the previous call's NextToken response to
indicate where the output should continue from.
- `"QuotaAppliedAtLevel"`: Specifies at which level of granularity that the quota value is
applied.
- `"QuotaCode"`: Specifies the quota identifier. To find the quota code for a specific
quota, use the ListServiceQuotas operation, and look for the QuotaCode response in the
output for the quota you want.
"""
function list_service_quotas(ServiceCode; aws_config::AbstractAWSConfig=global_aws_config())
return service_quotas(
"ListServiceQuotas",
Dict{String,Any}("ServiceCode" => ServiceCode);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_service_quotas(
ServiceCode,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_quotas(
"ListServiceQuotas",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ServiceCode" => ServiceCode), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_services()
list_services(params::Dict{String,<:Any})
Lists the names and codes for the Amazon Web Services integrated with Service Quotas.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Specifies the maximum number of results that you want included on each
page of the response. If you do not include this parameter, it defaults to a value
appropriate to the operation. If additional items exist beyond those included in the
current response, the NextToken response element is present and has a value (is not null).
Include that value as the NextToken request parameter in the next call to the operation to
get the next part of the results. An API operation can return fewer results than the
maximum even when there are more results available. You should check NextToken after every
operation to ensure that you receive all of the results.
- `"NextToken"`: Specifies a value for receiving additional results after you receive a
NextToken response in a previous request. A NextToken response indicates that more output
is available. Set this parameter to the value of the previous call's NextToken response to
indicate where the output should continue from.
"""
function list_services(; aws_config::AbstractAWSConfig=global_aws_config())
return service_quotas(
"ListServices"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_services(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_quotas(
"ListServices", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Returns a list of the tags assigned to the specified applied quota.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) for the applied quota for which you want
to list tags. You can get this information by using the Service Quotas console, or by
listing the quotas using the list-service-quotas CLI command or the ListServiceQuotas
Amazon Web Services API operation.
"""
function list_tags_for_resource(
ResourceARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_quotas(
"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 service_quotas(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceARN" => ResourceARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_service_quota_increase_request_into_template(aws_region, desired_value, quota_code, service_code)
put_service_quota_increase_request_into_template(aws_region, desired_value, quota_code, service_code, params::Dict{String,<:Any})
Adds a quota increase request to your quota request template.
# Arguments
- `aws_region`: Specifies the Amazon Web Services Region to which the template applies.
- `desired_value`: Specifies the new, increased value for the quota.
- `quota_code`: Specifies the quota identifier. To find the quota code for a specific
quota, use the ListServiceQuotas operation, and look for the QuotaCode response in the
output for the quota you want.
- `service_code`: Specifies the service identifier. To find the service code value for an
Amazon Web Services service, use the ListServices operation.
"""
function put_service_quota_increase_request_into_template(
AwsRegion,
DesiredValue,
QuotaCode,
ServiceCode;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_quotas(
"PutServiceQuotaIncreaseRequestIntoTemplate",
Dict{String,Any}(
"AwsRegion" => AwsRegion,
"DesiredValue" => DesiredValue,
"QuotaCode" => QuotaCode,
"ServiceCode" => ServiceCode,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_service_quota_increase_request_into_template(
AwsRegion,
DesiredValue,
QuotaCode,
ServiceCode,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_quotas(
"PutServiceQuotaIncreaseRequestIntoTemplate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AwsRegion" => AwsRegion,
"DesiredValue" => DesiredValue,
"QuotaCode" => QuotaCode,
"ServiceCode" => ServiceCode,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
request_service_quota_increase(desired_value, quota_code, service_code)
request_service_quota_increase(desired_value, quota_code, service_code, params::Dict{String,<:Any})
Submits a quota increase request for the specified quota.
# Arguments
- `desired_value`: Specifies the new, increased value for the quota.
- `quota_code`: Specifies the quota identifier. To find the quota code for a specific
quota, use the ListServiceQuotas operation, and look for the QuotaCode response in the
output for the quota you want.
- `service_code`: Specifies the service identifier. To find the service code value for an
Amazon Web Services service, use the ListServices operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ContextId"`: Specifies the Amazon Web Services account or resource to which the quota
applies. The value in this field depends on the context scope associated with the specified
service quota.
"""
function request_service_quota_increase(
DesiredValue, QuotaCode, ServiceCode; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_quotas(
"RequestServiceQuotaIncrease",
Dict{String,Any}(
"DesiredValue" => DesiredValue,
"QuotaCode" => QuotaCode,
"ServiceCode" => ServiceCode,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function request_service_quota_increase(
DesiredValue,
QuotaCode,
ServiceCode,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return service_quotas(
"RequestServiceQuotaIncrease",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DesiredValue" => DesiredValue,
"QuotaCode" => QuotaCode,
"ServiceCode" => ServiceCode,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds tags to the specified applied quota. You can include one or more tags to add to the
quota.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) for the applied quota. You can get this
information by using the Service Quotas console, or by listing the quotas using the
list-service-quotas CLI command or the ListServiceQuotas Amazon Web Services API operation.
- `tags`: The tags that you want to add to the resource.
"""
function tag_resource(ResourceARN, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return service_quotas(
"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 service_quotas(
"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 the specified applied quota. You can specify one or more tags to remove.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) for the applied quota that you want to
untag. You can get this information by using the Service Quotas console, or by listing the
quotas using the list-service-quotas CLI command or the ListServiceQuotas Amazon Web
Services API operation.
- `tag_keys`: The keys of the tags that you want to remove from the resource.
"""
function untag_resource(
ResourceARN, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return service_quotas(
"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 service_quotas(
"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 | 52612 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: servicediscovery
using AWS.Compat
using AWS.UUIDs
"""
create_http_namespace(name)
create_http_namespace(name, params::Dict{String,<:Any})
Creates an HTTP namespace. Service instances registered using an HTTP namespace can be
discovered using a DiscoverInstances request but can't be discovered using DNS. For the
current quota on the number of namespaces that you can create using the same Amazon Web
Services account, see Cloud Map quotas in the Cloud Map Developer Guide.
# Arguments
- `name`: The name that you want to assign to this namespace.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreatorRequestId"`: A unique string that identifies the request and that allows failed
CreateHttpNamespace requests to be retried without the risk of running the operation twice.
CreatorRequestId can be any unique string (for example, a date/time stamp).
- `"Description"`: A description for the namespace.
- `"Tags"`: The tags to add to the namespace. Each tag consists of a key and an optional
value that you define. Tags keys can be up to 128 characters in length, and tag values can
be up to 256 characters in length.
"""
function create_http_namespace(Name; aws_config::AbstractAWSConfig=global_aws_config())
return servicediscovery(
"CreateHttpNamespace",
Dict{String,Any}("Name" => Name, "CreatorRequestId" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_http_namespace(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return servicediscovery(
"CreateHttpNamespace",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Name" => Name, "CreatorRequestId" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_private_dns_namespace(name, vpc)
create_private_dns_namespace(name, vpc, params::Dict{String,<:Any})
Creates a private namespace based on DNS, which is visible only inside a specified Amazon
VPC. The namespace defines your service naming scheme. For example, if you name your
namespace example.com and name your service backend, the resulting DNS name for the service
is backend.example.com. Service instances that are registered using a private DNS namespace
can be discovered using either a DiscoverInstances request or using DNS. For the current
quota on the number of namespaces that you can create using the same Amazon Web Services
account, see Cloud Map quotas in the Cloud Map Developer Guide.
# Arguments
- `name`: The name that you want to assign to this namespace. When you create a private DNS
namespace, Cloud Map automatically creates an Amazon Route 53 private hosted zone that has
the same name as the namespace.
- `vpc`: The ID of the Amazon VPC that you want to associate the namespace with.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreatorRequestId"`: A unique string that identifies the request and that allows failed
CreatePrivateDnsNamespace requests to be retried without the risk of running the operation
twice. CreatorRequestId can be any unique string (for example, a date/timestamp).
- `"Description"`: A description for the namespace.
- `"Properties"`: Properties for the private DNS namespace.
- `"Tags"`: The tags to add to the namespace. Each tag consists of a key and an optional
value that you define. Tags keys can be up to 128 characters in length, and tag values can
be up to 256 characters in length.
"""
function create_private_dns_namespace(
Name, Vpc; aws_config::AbstractAWSConfig=global_aws_config()
)
return servicediscovery(
"CreatePrivateDnsNamespace",
Dict{String,Any}(
"Name" => Name, "Vpc" => Vpc, "CreatorRequestId" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_private_dns_namespace(
Name,
Vpc,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return servicediscovery(
"CreatePrivateDnsNamespace",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Name" => Name, "Vpc" => Vpc, "CreatorRequestId" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_public_dns_namespace(name)
create_public_dns_namespace(name, params::Dict{String,<:Any})
Creates a public namespace based on DNS, which is visible on the internet. The namespace
defines your service naming scheme. For example, if you name your namespace example.com and
name your service backend, the resulting DNS name for the service is backend.example.com.
You can discover instances that were registered with a public DNS namespace by using either
a DiscoverInstances request or using DNS. For the current quota on the number of namespaces
that you can create using the same Amazon Web Services account, see Cloud Map quotas in the
Cloud Map Developer Guide. The CreatePublicDnsNamespace API operation is not supported in
the Amazon Web Services GovCloud (US) Regions.
# Arguments
- `name`: The name that you want to assign to this namespace. Do not include sensitive
information in the name. The name is publicly available using DNS queries.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreatorRequestId"`: A unique string that identifies the request and that allows failed
CreatePublicDnsNamespace requests to be retried without the risk of running the operation
twice. CreatorRequestId can be any unique string (for example, a date/timestamp).
- `"Description"`: A description for the namespace.
- `"Properties"`: Properties for the public DNS namespace.
- `"Tags"`: The tags to add to the namespace. Each tag consists of a key and an optional
value that you define. Tags keys can be up to 128 characters in length, and tag values can
be up to 256 characters in length.
"""
function create_public_dns_namespace(
Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return servicediscovery(
"CreatePublicDnsNamespace",
Dict{String,Any}("Name" => Name, "CreatorRequestId" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_public_dns_namespace(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return servicediscovery(
"CreatePublicDnsNamespace",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Name" => Name, "CreatorRequestId" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_service(name)
create_service(name, params::Dict{String,<:Any})
Creates a service. This action defines the configuration for the following entities: For
public and private DNS namespaces, one of the following combinations of DNS records in
Amazon Route 53: A AAAA A and AAAA SRV CNAME Optionally, a health
check After you create the service, you can submit a RegisterInstance request, and Cloud
Map uses the values in the configuration to create the specified entities. For the current
quota on the number of instances that you can register using the same namespace and using
the same service, see Cloud Map quotas in the Cloud Map Developer Guide.
# Arguments
- `name`: The name that you want to assign to the service. Do not include sensitive
information in the name if the namespace is discoverable by public DNS queries. If you
want Cloud Map to create an SRV record when you register an instance and you're using a
system that requires a specific SRV format, such as HAProxy, specify the following for
Name: Start the name with an underscore (_), such as _exampleservice. End the name with
._protocol, such as ._tcp. When you register an instance, Cloud Map creates an SRV record
and assigns a name to the record by concatenating the service name and the namespace name
(for example, _exampleservice._tcp.example.com). For services that are accessible by DNS
queries, you can't create multiple services with names that differ only by case (such as
EXAMPLE and example). Otherwise, these services have the same DNS name and can't be
distinguished. However, if you use a namespace that's only accessible by API calls, then
you can create services that with names that differ only by case.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreatorRequestId"`: A unique string that identifies the request and that allows failed
CreateService requests to be retried without the risk of running the operation twice.
CreatorRequestId can be any unique string (for example, a date/timestamp).
- `"Description"`: A description for the service.
- `"DnsConfig"`: A complex type that contains information about the Amazon Route 53
records that you want Cloud Map to create when you register an instance.
- `"HealthCheckConfig"`: Public DNS and HTTP namespaces only. A complex type that contains
settings for an optional Route 53 health check. If you specify settings for a health
check, Cloud Map associates the health check with all the Route 53 DNS records that you
specify in DnsConfig. If you specify a health check configuration, you can specify either
HealthCheckCustomConfig or HealthCheckConfig but not both. For information about the
charges for health checks, see Cloud Map Pricing.
- `"HealthCheckCustomConfig"`: A complex type that contains information about an optional
custom health check. If you specify a health check configuration, you can specify either
HealthCheckCustomConfig or HealthCheckConfig but not both. You can't add, update, or
delete a HealthCheckCustomConfig configuration from an existing service.
- `"NamespaceId"`: The ID of the namespace that you want to use to create the service. The
namespace ID must be specified, but it can be specified either here or in the DnsConfig
object.
- `"Tags"`: The tags to add to the service. Each tag consists of a key and an optional
value that you define. Tags keys can be up to 128 characters in length, and tag values can
be up to 256 characters in length.
- `"Type"`: If present, specifies that the service instances are only discoverable using
the DiscoverInstances API operation. No DNS records is registered for the service
instances. The only valid value is HTTP.
"""
function create_service(Name; aws_config::AbstractAWSConfig=global_aws_config())
return servicediscovery(
"CreateService",
Dict{String,Any}("Name" => Name, "CreatorRequestId" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_service(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return servicediscovery(
"CreateService",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Name" => Name, "CreatorRequestId" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_namespace(id)
delete_namespace(id, params::Dict{String,<:Any})
Deletes a namespace from the current account. If the namespace still contains one or more
services, the request fails.
# Arguments
- `id`: The ID of the namespace that you want to delete.
"""
function delete_namespace(Id; aws_config::AbstractAWSConfig=global_aws_config())
return servicediscovery(
"DeleteNamespace",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_namespace(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return servicediscovery(
"DeleteNamespace",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_service(id)
delete_service(id, params::Dict{String,<:Any})
Deletes a specified service. If the service still contains one or more registered
instances, the request fails.
# Arguments
- `id`: The ID of the service that you want to delete.
"""
function delete_service(Id; aws_config::AbstractAWSConfig=global_aws_config())
return servicediscovery(
"DeleteService",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_service(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return servicediscovery(
"DeleteService",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_instance(instance_id, service_id)
deregister_instance(instance_id, service_id, params::Dict{String,<:Any})
Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created
for the specified instance.
# Arguments
- `instance_id`: The value that you specified for Id in the RegisterInstance request.
- `service_id`: The ID of the service that the instance is associated with.
"""
function deregister_instance(
InstanceId, ServiceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return servicediscovery(
"DeregisterInstance",
Dict{String,Any}("InstanceId" => InstanceId, "ServiceId" => ServiceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_instance(
InstanceId,
ServiceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return servicediscovery(
"DeregisterInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InstanceId" => InstanceId, "ServiceId" => ServiceId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
discover_instances(namespace_name, service_name)
discover_instances(namespace_name, service_name, params::Dict{String,<:Any})
Discovers registered instances for a specified namespace and service. You can use
DiscoverInstances to discover instances for any type of namespace. DiscoverInstances
returns a randomized list of instances allowing customers to distribute traffic evenly
across instances. For public and private DNS namespaces, you can also use DNS queries to
discover instances.
# Arguments
- `namespace_name`: The HttpName name of the namespace. It's found in the HttpProperties
member of the Properties member of the namespace. In most cases, Name and HttpName match.
However, if you reuse Name for namespace creation, a generated hash is added to HttpName to
distinguish the two.
- `service_name`: The name of the service that you specified when you registered the
instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"HealthStatus"`: The health status of the instances that you want to discover. This
parameter is ignored for services that don't have a health check configured, and all
instances are returned. HEALTHY Returns healthy instances. UNHEALTHY Returns unhealthy
instances. ALL Returns all instances. HEALTHY_OR_ELSE_ALL Returns healthy instances,
unless none are reporting a healthy state. In that case, return all instances. This is also
called failing open.
- `"MaxResults"`: The maximum number of instances that you want Cloud Map to return in the
response to a DiscoverInstances request. If you don't specify a value for MaxResults, Cloud
Map returns up to 100 instances.
- `"OptionalParameters"`: Opportunistic filters to scope the results based on custom
attributes. If there are instances that match both the filters specified in both the
QueryParameters parameter and this parameter, all of these instances are returned.
Otherwise, the filters are ignored, and only instances that match the filters that are
specified in the QueryParameters parameter are returned.
- `"QueryParameters"`: Filters to scope the results based on custom attributes for the
instance (for example, {version=v1, az=1a}). Only instances that match all the specified
key-value pairs are returned.
"""
function discover_instances(
NamespaceName, ServiceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return servicediscovery(
"DiscoverInstances",
Dict{String,Any}("NamespaceName" => NamespaceName, "ServiceName" => ServiceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function discover_instances(
NamespaceName,
ServiceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return servicediscovery(
"DiscoverInstances",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"NamespaceName" => NamespaceName, "ServiceName" => ServiceName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
discover_instances_revision(namespace_name, service_name)
discover_instances_revision(namespace_name, service_name, params::Dict{String,<:Any})
Discovers the increasing revision associated with an instance.
# Arguments
- `namespace_name`: The HttpName name of the namespace. It's found in the HttpProperties
member of the Properties member of the namespace.
- `service_name`: The name of the service that you specified when you registered the
instance.
"""
function discover_instances_revision(
NamespaceName, ServiceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return servicediscovery(
"DiscoverInstancesRevision",
Dict{String,Any}("NamespaceName" => NamespaceName, "ServiceName" => ServiceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function discover_instances_revision(
NamespaceName,
ServiceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return servicediscovery(
"DiscoverInstancesRevision",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"NamespaceName" => NamespaceName, "ServiceName" => ServiceName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_instance(instance_id, service_id)
get_instance(instance_id, service_id, params::Dict{String,<:Any})
Gets information about a specified instance.
# Arguments
- `instance_id`: The ID of the instance that you want to get information about.
- `service_id`: The ID of the service that the instance is associated with.
"""
function get_instance(
InstanceId, ServiceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return servicediscovery(
"GetInstance",
Dict{String,Any}("InstanceId" => InstanceId, "ServiceId" => ServiceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_instance(
InstanceId,
ServiceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return servicediscovery(
"GetInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InstanceId" => InstanceId, "ServiceId" => ServiceId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_instances_health_status(service_id)
get_instances_health_status(service_id, params::Dict{String,<:Any})
Gets the current health status (Healthy, Unhealthy, or Unknown) of one or more instances
that are associated with a specified service. There's a brief delay between when you
register an instance and when the health status for the instance is available.
# Arguments
- `service_id`: The ID of the service that the instance is associated with.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Instances"`: An array that contains the IDs of all the instances that you want to get
the health status for. If you omit Instances, Cloud Map returns the health status for all
the instances that are associated with the specified service. To get the IDs for the
instances that you've registered by using a specified service, submit a ListInstances
request.
- `"MaxResults"`: The maximum number of instances that you want Cloud Map to return in the
response to a GetInstancesHealthStatus request. If you don't specify a value for
MaxResults, Cloud Map returns up to 100 instances.
- `"NextToken"`: For the first GetInstancesHealthStatus request, omit this value. If more
than MaxResults instances match the specified criteria, you can submit another
GetInstancesHealthStatus request to get the next group of results. Specify the value of
NextToken from the previous response in the next request.
"""
function get_instances_health_status(
ServiceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return servicediscovery(
"GetInstancesHealthStatus",
Dict{String,Any}("ServiceId" => ServiceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_instances_health_status(
ServiceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return servicediscovery(
"GetInstancesHealthStatus",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ServiceId" => ServiceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_namespace(id)
get_namespace(id, params::Dict{String,<:Any})
Gets information about a namespace.
# Arguments
- `id`: The ID of the namespace that you want to get information about.
"""
function get_namespace(Id; aws_config::AbstractAWSConfig=global_aws_config())
return servicediscovery(
"GetNamespace",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_namespace(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return servicediscovery(
"GetNamespace",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_operation(operation_id)
get_operation(operation_id, params::Dict{String,<:Any})
Gets information about any operation that returns an operation ID in the response, such as
a CreateHttpNamespace request. To get a list of operations that match specified criteria,
see ListOperations.
# Arguments
- `operation_id`: The ID of the operation that you want to get more information about.
"""
function get_operation(OperationId; aws_config::AbstractAWSConfig=global_aws_config())
return servicediscovery(
"GetOperation",
Dict{String,Any}("OperationId" => OperationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_operation(
OperationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return servicediscovery(
"GetOperation",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("OperationId" => OperationId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_service(id)
get_service(id, params::Dict{String,<:Any})
Gets the settings for a specified service.
# Arguments
- `id`: The ID of the service that you want to get settings for.
"""
function get_service(Id; aws_config::AbstractAWSConfig=global_aws_config())
return servicediscovery(
"GetService",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_service(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return servicediscovery(
"GetService",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_instances(service_id)
list_instances(service_id, params::Dict{String,<:Any})
Lists summary information about the instances that you registered by using a specified
service.
# Arguments
- `service_id`: The ID of the service that you want to list instances for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of instances that you want Cloud Map to return in the
response to a ListInstances request. If you don't specify a value for MaxResults, Cloud Map
returns up to 100 instances.
- `"NextToken"`: For the first ListInstances request, omit this value. If more than
MaxResults instances match the specified criteria, you can submit another ListInstances
request to get the next group of results. Specify the value of NextToken from the previous
response in the next request.
"""
function list_instances(ServiceId; aws_config::AbstractAWSConfig=global_aws_config())
return servicediscovery(
"ListInstances",
Dict{String,Any}("ServiceId" => ServiceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_instances(
ServiceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return servicediscovery(
"ListInstances",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ServiceId" => ServiceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_namespaces()
list_namespaces(params::Dict{String,<:Any})
Lists summary information about the namespaces that were created by the current Amazon Web
Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: A complex type that contains specifications for the namespaces that you want
to list. If you specify more than one filter, a namespace must match all filters to be
returned by ListNamespaces.
- `"MaxResults"`: The maximum number of namespaces that you want Cloud Map to return in the
response to a ListNamespaces request. If you don't specify a value for MaxResults, Cloud
Map returns up to 100 namespaces.
- `"NextToken"`: For the first ListNamespaces request, omit this value. If the response
contains NextToken, submit another ListNamespaces request to get the next group of results.
Specify the value of NextToken from the previous response in the next request. Cloud Map
gets MaxResults namespaces and then filters them based on the specified criteria. It's
possible that no namespaces in the first MaxResults namespaces matched the specified
criteria but that subsequent groups of MaxResults namespaces do contain namespaces that
match the criteria.
"""
function list_namespaces(; aws_config::AbstractAWSConfig=global_aws_config())
return servicediscovery(
"ListNamespaces"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_namespaces(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return servicediscovery(
"ListNamespaces", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_operations()
list_operations(params::Dict{String,<:Any})
Lists operations that match the criteria that you specify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: A complex type that contains specifications for the operations that you want
to list, for example, operations that you started between a specified start date and end
date. If you specify more than one filter, an operation must match all filters to be
returned by ListOperations.
- `"MaxResults"`: The maximum number of items that you want Cloud Map to return in the
response to a ListOperations request. If you don't specify a value for MaxResults, Cloud
Map returns up to 100 operations.
- `"NextToken"`: For the first ListOperations request, omit this value. If the response
contains NextToken, submit another ListOperations request to get the next group of results.
Specify the value of NextToken from the previous response in the next request. Cloud Map
gets MaxResults operations and then filters them based on the specified criteria. It's
possible that no operations in the first MaxResults operations matched the specified
criteria but that subsequent groups of MaxResults operations do contain operations that
match the criteria.
"""
function list_operations(; aws_config::AbstractAWSConfig=global_aws_config())
return servicediscovery(
"ListOperations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_operations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return servicediscovery(
"ListOperations", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_services()
list_services(params::Dict{String,<:Any})
Lists summary information for all the services that are associated with one or more
namespaces.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: A complex type that contains specifications for the namespaces that you want
to list services for. If you specify more than one filter, an operation must match all
filters to be returned by ListServices.
- `"MaxResults"`: The maximum number of services that you want Cloud Map to return in the
response to a ListServices request. If you don't specify a value for MaxResults, Cloud Map
returns up to 100 services.
- `"NextToken"`: For the first ListServices request, omit this value. If the response
contains NextToken, submit another ListServices request to get the next group of results.
Specify the value of NextToken from the previous response in the next request. Cloud Map
gets MaxResults services and then filters them based on the specified criteria. It's
possible that no services in the first MaxResults services matched the specified criteria
but that subsequent groups of MaxResults services do contain services that match the
criteria.
"""
function list_services(; aws_config::AbstractAWSConfig=global_aws_config())
return servicediscovery(
"ListServices"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_services(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return servicediscovery(
"ListServices", 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.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource that you want to retrieve
tags for.
"""
function list_tags_for_resource(
ResourceARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return servicediscovery(
"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 servicediscovery(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceARN" => ResourceARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_instance(attributes, instance_id, service_id)
register_instance(attributes, instance_id, service_id, params::Dict{String,<:Any})
Creates or updates one or more records and, optionally, creates a health check based on the
settings in a specified service. When you submit a RegisterInstance request, the following
occurs: For each DNS record that you define in the service that's specified by ServiceId,
a record is created or updated in the hosted zone that's associated with the corresponding
namespace. If the service includes HealthCheckConfig, a health check is created based on
the settings in the health check configuration. The health check, if any, is associated
with each of the new or updated records. One RegisterInstance request must complete
before you can submit another request and specify the same service ID and instance ID. For
more information, see CreateService. When Cloud Map receives a DNS query for the specified
DNS name, it returns the applicable value: If the health check is healthy: returns all
the records If the health check is unhealthy: returns the applicable value for the last
healthy instance If you didn't specify a health check configuration: returns all the
records For the current quota on the number of instances that you can register using the
same namespace and using the same service, see Cloud Map quotas in the Cloud Map Developer
Guide.
# Arguments
- `attributes`: A string map that contains the following information for the service that
you specify in ServiceId: The attributes that apply to the records that are defined in
the service. For each attribute, the applicable value. Do not include sensitive
information in the attributes if the namespace is discoverable by public DNS queries. The
following are the supported attribute keys. AWS_ALIAS_DNS_NAME If you want Cloud Map to
create an Amazon Route 53 alias record that routes traffic to an Elastic Load Balancing
load balancer, specify the DNS name that's associated with the load balancer. For
information about how to get the DNS name, see \"DNSName\" in the topic AliasTarget in the
Route 53 API Reference. Note the following: The configuration for the service that's
specified by ServiceId must include settings for an A record, an AAAA record, or both. In
the service that's specified by ServiceId, the value of RoutingPolicy must be WEIGHTED.
If the service that's specified by ServiceId includes HealthCheckConfig settings, Cloud Map
will create the Route 53 health check, but it doesn't associate the health check with the
alias record. Cloud Map currently doesn't support creating alias records that route
traffic to Amazon Web Services resources other than Elastic Load Balancing load balancers.
If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the
AWS_INSTANCE attributes. The AWS_ALIAS_DNS_NAME is not supported in the GovCloud (US)
Regions. AWS_EC2_INSTANCE_ID HTTP namespaces only. The Amazon EC2 instance ID for the
instance. If the AWS_EC2_INSTANCE_ID attribute is specified, then the only other attribute
that can be specified is AWS_INIT_HEALTH_STATUS. When the AWS_EC2_INSTANCE_ID attribute is
specified, then the AWS_INSTANCE_IPV4 attribute will be filled out with the primary private
IPv4 address. AWS_INIT_HEALTH_STATUS If the service configuration includes
HealthCheckCustomConfig, you can optionally use AWS_INIT_HEALTH_STATUS to specify the
initial status of the custom health check, HEALTHY or UNHEALTHY. If you don't specify a
value for AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY. AWS_INSTANCE_CNAME If
the service configuration includes a CNAME record, the domain name that you want Route 53
to return in response to DNS queries (for example, example.com). This value is required if
the service specified by ServiceId includes settings for an CNAME record.
AWS_INSTANCE_IPV4 If the service configuration includes an A record, the IPv4 address that
you want Route 53 to return in response to DNS queries (for example, 192.0.2.44). This
value is required if the service specified by ServiceId includes settings for an A record.
If the service includes settings for an SRV record, you must specify a value for
AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both. AWS_INSTANCE_IPV6 If the service
configuration includes an AAAA record, the IPv6 address that you want Route 53 to return
in response to DNS queries (for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345). This
value is required if the service specified by ServiceId includes settings for an AAAA
record. If the service includes settings for an SRV record, you must specify a value for
AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both. AWS_INSTANCE_PORT If the service includes
an SRV record, the value that you want Route 53 to return for the port. If the service
includes HealthCheckConfig, the port on the endpoint that you want Route 53 to send
requests to. This value is required if you specified settings for an SRV record or a
Route 53 health check when you created the service. Custom attributes You can add up to
30 custom attributes. For each key-value pair, the maximum length of the attribute name is
255 characters, and the maximum length of the attribute value is 1,024 characters. The
total size of all provided attributes (sum of all keys and values) must not exceed 5,000
characters.
- `instance_id`: An identifier that you want to associate with the instance. Note the
following: If the service that's specified by ServiceId includes settings for an SRV
record, the value of InstanceId is automatically included as part of the value for the SRV
record. For more information, see DnsRecord > Type. You can use this value to update
an existing instance. To register a new instance, you must specify a value that's unique
among instances that you register by using the same service. If you specify an existing
InstanceId and ServiceId, Cloud Map updates the existing DNS records, if any. If there's
also an existing health check, Cloud Map deletes the old health check and creates a new
one. The health check isn't deleted immediately, so it will still appear for a while if
you submit a ListHealthChecks request, for example. Do not include sensitive
information in InstanceId if the namespace is discoverable by public DNS queries and any
Type member of DnsRecord for the service contains SRV because the InstanceId is
discoverable by public DNS queries.
- `service_id`: The ID of the service that you want to use for settings for the instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreatorRequestId"`: A unique string that identifies the request and that allows failed
RegisterInstance requests to be retried without the risk of executing the operation twice.
You must use a unique CreatorRequestId string every time you submit a RegisterInstance
request if you're registering additional instances for the same namespace and service.
CreatorRequestId can be any unique string (for example, a date/time stamp).
"""
function register_instance(
Attributes, InstanceId, ServiceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return servicediscovery(
"RegisterInstance",
Dict{String,Any}(
"Attributes" => Attributes,
"InstanceId" => InstanceId,
"ServiceId" => ServiceId,
"CreatorRequestId" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_instance(
Attributes,
InstanceId,
ServiceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return servicediscovery(
"RegisterInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Attributes" => Attributes,
"InstanceId" => InstanceId,
"ServiceId" => ServiceId,
"CreatorRequestId" => 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})
Adds one or more tags to the specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource that you want to retrieve
tags for.
- `tags`: The tags to add to the specified resource. Specifying the tag key is required.
You can set the value of a tag to an empty string, but you can't set the value of a tag to
null.
"""
function tag_resource(ResourceARN, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return servicediscovery(
"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 servicediscovery(
"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 resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource that you want to retrieve
tags for.
- `tag_keys`: The tag keys to remove from the specified resource.
"""
function untag_resource(
ResourceARN, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return servicediscovery(
"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 servicediscovery(
"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_http_namespace(id, namespace)
update_http_namespace(id, namespace, params::Dict{String,<:Any})
Updates an HTTP namespace.
# Arguments
- `id`: The ID of the namespace that you want to update.
- `namespace`: Updated properties for the the HTTP namespace.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"UpdaterRequestId"`: A unique string that identifies the request and that allows failed
UpdateHttpNamespace requests to be retried without the risk of running the operation twice.
UpdaterRequestId can be any unique string (for example, a date/timestamp).
"""
function update_http_namespace(
Id, Namespace; aws_config::AbstractAWSConfig=global_aws_config()
)
return servicediscovery(
"UpdateHttpNamespace",
Dict{String,Any}(
"Id" => Id, "Namespace" => Namespace, "UpdaterRequestId" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_http_namespace(
Id,
Namespace,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return servicediscovery(
"UpdateHttpNamespace",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Id" => Id,
"Namespace" => Namespace,
"UpdaterRequestId" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_instance_custom_health_status(instance_id, service_id, status)
update_instance_custom_health_status(instance_id, service_id, status, params::Dict{String,<:Any})
Submits a request to change the health status of a custom health check to healthy or
unhealthy. You can use UpdateInstanceCustomHealthStatus to change the status only for
custom health checks, which you define using HealthCheckCustomConfig when you create a
service. You can't use it to change the status for Route 53 health checks, which you
define using HealthCheckConfig. For more information, see HealthCheckCustomConfig.
# Arguments
- `instance_id`: The ID of the instance that you want to change the health status for.
- `service_id`: The ID of the service that includes the configuration for the custom health
check that you want to change the status for.
- `status`: The new status of the instance, HEALTHY or UNHEALTHY.
"""
function update_instance_custom_health_status(
InstanceId, ServiceId, Status; aws_config::AbstractAWSConfig=global_aws_config()
)
return servicediscovery(
"UpdateInstanceCustomHealthStatus",
Dict{String,Any}(
"InstanceId" => InstanceId, "ServiceId" => ServiceId, "Status" => Status
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_instance_custom_health_status(
InstanceId,
ServiceId,
Status,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return servicediscovery(
"UpdateInstanceCustomHealthStatus",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceId" => InstanceId, "ServiceId" => ServiceId, "Status" => Status
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_private_dns_namespace(id, namespace)
update_private_dns_namespace(id, namespace, params::Dict{String,<:Any})
Updates a private DNS namespace.
# Arguments
- `id`: The ID of the namespace that you want to update.
- `namespace`: Updated properties for the private DNS namespace.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"UpdaterRequestId"`: A unique string that identifies the request and that allows failed
UpdatePrivateDnsNamespace requests to be retried without the risk of running the operation
twice. UpdaterRequestId can be any unique string (for example, a date/timestamp).
"""
function update_private_dns_namespace(
Id, Namespace; aws_config::AbstractAWSConfig=global_aws_config()
)
return servicediscovery(
"UpdatePrivateDnsNamespace",
Dict{String,Any}(
"Id" => Id, "Namespace" => Namespace, "UpdaterRequestId" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_private_dns_namespace(
Id,
Namespace,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return servicediscovery(
"UpdatePrivateDnsNamespace",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Id" => Id,
"Namespace" => Namespace,
"UpdaterRequestId" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_public_dns_namespace(id, namespace)
update_public_dns_namespace(id, namespace, params::Dict{String,<:Any})
Updates a public DNS namespace.
# Arguments
- `id`: The ID of the namespace being updated.
- `namespace`: Updated properties for the public DNS namespace.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"UpdaterRequestId"`: A unique string that identifies the request and that allows failed
UpdatePublicDnsNamespace requests to be retried without the risk of running the operation
twice. UpdaterRequestId can be any unique string (for example, a date/timestamp).
"""
function update_public_dns_namespace(
Id, Namespace; aws_config::AbstractAWSConfig=global_aws_config()
)
return servicediscovery(
"UpdatePublicDnsNamespace",
Dict{String,Any}(
"Id" => Id, "Namespace" => Namespace, "UpdaterRequestId" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_public_dns_namespace(
Id,
Namespace,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return servicediscovery(
"UpdatePublicDnsNamespace",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Id" => Id,
"Namespace" => Namespace,
"UpdaterRequestId" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_service(id, service)
update_service(id, service, params::Dict{String,<:Any})
Submits a request to perform the following operations: Update the TTL setting for
existing DnsRecords configurations Add, update, or delete HealthCheckConfig for a
specified service You can't add, update, or delete a HealthCheckCustomConfig
configuration. For public and private DNS namespaces, note the following: If you omit
any existing DnsRecords or HealthCheckConfig configurations from an UpdateService request,
the configurations are deleted from the service. If you omit an existing
HealthCheckCustomConfig configuration from an UpdateService request, the configuration
isn't deleted from the service. When you update settings for a service, Cloud Map also
updates the corresponding settings in all the records and health checks that were created
by using the specified service.
# Arguments
- `id`: The ID of the service that you want to update.
- `service`: A complex type that contains the new settings for the service.
"""
function update_service(Id, Service; aws_config::AbstractAWSConfig=global_aws_config())
return servicediscovery(
"UpdateService",
Dict{String,Any}("Id" => Id, "Service" => Service);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_service(
Id,
Service,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return servicediscovery(
"UpdateService",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Id" => Id, "Service" => Service), 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 | 133589 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: ses
using AWS.Compat
using AWS.UUIDs
"""
clone_receipt_rule_set(original_rule_set_name, rule_set_name)
clone_receipt_rule_set(original_rule_set_name, rule_set_name, params::Dict{String,<:Any})
Creates a receipt rule set by cloning an existing one. All receipt rules and configurations
are copied to the new receipt rule set and are completely independent of the source rule
set. For information about setting up rule sets, see the Amazon SES Developer Guide. You
can execute this operation no more than once per second.
# Arguments
- `original_rule_set_name`: The name of the rule set to clone.
- `rule_set_name`: The name of the rule set to create. The name must meet the following
requirements: Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or
dashes (-). Start and end with a letter or number. Contain 64 characters or fewer.
"""
function clone_receipt_rule_set(
OriginalRuleSetName, RuleSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"CloneReceiptRuleSet",
Dict{String,Any}(
"OriginalRuleSetName" => OriginalRuleSetName, "RuleSetName" => RuleSetName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function clone_receipt_rule_set(
OriginalRuleSetName,
RuleSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"CloneReceiptRuleSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"OriginalRuleSetName" => OriginalRuleSetName,
"RuleSetName" => RuleSetName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_configuration_set(configuration_set)
create_configuration_set(configuration_set, params::Dict{String,<:Any})
Creates a configuration set. Configuration sets enable you to publish email sending events.
For information about using configuration sets, see the Amazon SES Developer Guide. You can
execute this operation no more than once per second.
# Arguments
- `configuration_set`: A data structure that contains the name of the configuration set.
"""
function create_configuration_set(
ConfigurationSet; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"CreateConfigurationSet",
Dict{String,Any}("ConfigurationSet" => ConfigurationSet);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_configuration_set(
ConfigurationSet,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"CreateConfigurationSet",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ConfigurationSet" => ConfigurationSet), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_configuration_set_event_destination(configuration_set_name, event_destination)
create_configuration_set_event_destination(configuration_set_name, event_destination, params::Dict{String,<:Any})
Creates a configuration set event destination. When you create or update an event
destination, you must provide one, and only one, destination. The destination can be
CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).
An event destination is the Amazon Web Services service to which Amazon SES publishes the
email sending events associated with a configuration set. For information about using
configuration sets, see the Amazon SES Developer Guide. You can execute this operation no
more than once per second.
# Arguments
- `configuration_set_name`: The name of the configuration set that the event destination
should be associated with.
- `event_destination`: An object that describes the Amazon Web Services service that email
sending event where information is published.
"""
function create_configuration_set_event_destination(
ConfigurationSetName,
EventDestination;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"CreateConfigurationSetEventDestination",
Dict{String,Any}(
"ConfigurationSetName" => ConfigurationSetName,
"EventDestination" => EventDestination,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_configuration_set_event_destination(
ConfigurationSetName,
EventDestination,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"CreateConfigurationSetEventDestination",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigurationSetName" => ConfigurationSetName,
"EventDestination" => EventDestination,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_configuration_set_tracking_options(configuration_set_name, tracking_options)
create_configuration_set_tracking_options(configuration_set_name, tracking_options, params::Dict{String,<:Any})
Creates an association between a configuration set and a custom domain for open and click
event tracking. By default, images and links used for tracking open and click events are
hosted on domains operated by Amazon SES. You can configure a subdomain of your own to
handle these events. For information about using custom domains, see the Amazon SES
Developer Guide.
# Arguments
- `configuration_set_name`: The name of the configuration set that the tracking options
should be associated with.
- `tracking_options`:
"""
function create_configuration_set_tracking_options(
ConfigurationSetName, TrackingOptions; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"CreateConfigurationSetTrackingOptions",
Dict{String,Any}(
"ConfigurationSetName" => ConfigurationSetName,
"TrackingOptions" => TrackingOptions,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_configuration_set_tracking_options(
ConfigurationSetName,
TrackingOptions,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"CreateConfigurationSetTrackingOptions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigurationSetName" => ConfigurationSetName,
"TrackingOptions" => TrackingOptions,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_custom_verification_email_template(failure_redirection_url, from_email_address, success_redirection_url, template_content, template_name, template_subject)
create_custom_verification_email_template(failure_redirection_url, from_email_address, success_redirection_url, template_content, template_name, template_subject, params::Dict{String,<:Any})
Creates a new custom verification email template. For more information about custom
verification email templates, see Using Custom Verification Email Templates in the Amazon
SES Developer Guide. You can execute this operation no more than once per second.
# Arguments
- `failure_redirection_url`: The URL that the recipient of the verification email is sent
to if his or her address is not successfully verified.
- `from_email_address`: The email address that the custom verification email is sent from.
- `success_redirection_url`: The URL that the recipient of the verification email is sent
to if his or her address is successfully verified.
- `template_content`: The content of the custom verification email. The total size of the
email must be less than 10 MB. The message body may contain HTML, with some limitations.
For more information, see Custom Verification Email Frequently Asked Questions in the
Amazon SES Developer Guide.
- `template_name`: The name of the custom verification email template.
- `template_subject`: The subject line of the custom verification email.
"""
function create_custom_verification_email_template(
FailureRedirectionURL,
FromEmailAddress,
SuccessRedirectionURL,
TemplateContent,
TemplateName,
TemplateSubject;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"CreateCustomVerificationEmailTemplate",
Dict{String,Any}(
"FailureRedirectionURL" => FailureRedirectionURL,
"FromEmailAddress" => FromEmailAddress,
"SuccessRedirectionURL" => SuccessRedirectionURL,
"TemplateContent" => TemplateContent,
"TemplateName" => TemplateName,
"TemplateSubject" => TemplateSubject,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_custom_verification_email_template(
FailureRedirectionURL,
FromEmailAddress,
SuccessRedirectionURL,
TemplateContent,
TemplateName,
TemplateSubject,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"CreateCustomVerificationEmailTemplate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FailureRedirectionURL" => FailureRedirectionURL,
"FromEmailAddress" => FromEmailAddress,
"SuccessRedirectionURL" => SuccessRedirectionURL,
"TemplateContent" => TemplateContent,
"TemplateName" => TemplateName,
"TemplateSubject" => TemplateSubject,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_receipt_filter(filter)
create_receipt_filter(filter, params::Dict{String,<:Any})
Creates a new IP address filter. For information about setting up IP address filters, see
the Amazon SES Developer Guide. You can execute this operation no more than once per second.
# Arguments
- `filter`: A data structure that describes the IP address filter to create, which consists
of a name, an IP address range, and whether to allow or block mail from it.
"""
function create_receipt_filter(Filter; aws_config::AbstractAWSConfig=global_aws_config())
return ses(
"CreateReceiptFilter",
Dict{String,Any}("Filter" => Filter);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_receipt_filter(
Filter, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"CreateReceiptFilter",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Filter" => Filter), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_receipt_rule(rule, rule_set_name)
create_receipt_rule(rule, rule_set_name, params::Dict{String,<:Any})
Creates a receipt rule. For information about setting up receipt rules, see the Amazon SES
Developer Guide. You can execute this operation no more than once per second.
# Arguments
- `rule`: A data structure that contains the specified rule's name, actions, recipients,
domains, enabled status, scan status, and TLS policy.
- `rule_set_name`: The name of the rule set where the receipt rule is added.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"After"`: The name of an existing rule after which the new rule is placed. If this
parameter is null, the new rule is inserted at the beginning of the rule list.
"""
function create_receipt_rule(
Rule, RuleSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"CreateReceiptRule",
Dict{String,Any}("Rule" => Rule, "RuleSetName" => RuleSetName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_receipt_rule(
Rule,
RuleSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"CreateReceiptRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Rule" => Rule, "RuleSetName" => RuleSetName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_receipt_rule_set(rule_set_name)
create_receipt_rule_set(rule_set_name, params::Dict{String,<:Any})
Creates an empty receipt rule set. For information about setting up receipt rule sets, see
the Amazon SES Developer Guide. You can execute this operation no more than once per second.
# Arguments
- `rule_set_name`: The name of the rule set to create. The name must meet the following
requirements: Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or
dashes (-). Start and end with a letter or number. Contain 64 characters or fewer.
"""
function create_receipt_rule_set(
RuleSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"CreateReceiptRuleSet",
Dict{String,Any}("RuleSetName" => RuleSetName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_receipt_rule_set(
RuleSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"CreateReceiptRuleSet",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RuleSetName" => RuleSetName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_template(template)
create_template(template, params::Dict{String,<:Any})
Creates an email template. Email templates enable you to send personalized email to one or
more destinations in a single operation. For more information, see the Amazon SES Developer
Guide. You can execute this operation no more than once per second.
# Arguments
- `template`: The content of the email, composed of a subject line and either an HTML part
or a text-only part.
"""
function create_template(Template; aws_config::AbstractAWSConfig=global_aws_config())
return ses(
"CreateTemplate",
Dict{String,Any}("Template" => Template);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_template(
Template,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"CreateTemplate",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Template" => Template), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_configuration_set(configuration_set_name)
delete_configuration_set(configuration_set_name, params::Dict{String,<:Any})
Deletes a configuration set. Configuration sets enable you to publish email sending events.
For information about using configuration sets, see the Amazon SES Developer Guide. You can
execute this operation no more than once per second.
# Arguments
- `configuration_set_name`: The name of the configuration set to delete.
"""
function delete_configuration_set(
ConfigurationSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"DeleteConfigurationSet",
Dict{String,Any}("ConfigurationSetName" => ConfigurationSetName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_configuration_set(
ConfigurationSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"DeleteConfigurationSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ConfigurationSetName" => ConfigurationSetName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_configuration_set_event_destination(configuration_set_name, event_destination_name)
delete_configuration_set_event_destination(configuration_set_name, event_destination_name, params::Dict{String,<:Any})
Deletes a configuration set event destination. Configuration set event destinations are
associated with configuration sets, which enable you to publish email sending events. For
information about using configuration sets, see the Amazon SES Developer Guide. You can
execute this operation no more than once per second.
# Arguments
- `configuration_set_name`: The name of the configuration set from which to delete the
event destination.
- `event_destination_name`: The name of the event destination to delete.
"""
function delete_configuration_set_event_destination(
ConfigurationSetName,
EventDestinationName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"DeleteConfigurationSetEventDestination",
Dict{String,Any}(
"ConfigurationSetName" => ConfigurationSetName,
"EventDestinationName" => EventDestinationName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_configuration_set_event_destination(
ConfigurationSetName,
EventDestinationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"DeleteConfigurationSetEventDestination",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigurationSetName" => ConfigurationSetName,
"EventDestinationName" => EventDestinationName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_configuration_set_tracking_options(configuration_set_name)
delete_configuration_set_tracking_options(configuration_set_name, params::Dict{String,<:Any})
Deletes an association between a configuration set and a custom domain for open and click
event tracking. By default, images and links used for tracking open and click events are
hosted on domains operated by Amazon SES. You can configure a subdomain of your own to
handle these events. For information about using custom domains, see the Amazon SES
Developer Guide. Deleting this kind of association results in emails sent using the
specified configuration set to capture open and click events using the standard, Amazon
SES-operated domains.
# Arguments
- `configuration_set_name`: The name of the configuration set.
"""
function delete_configuration_set_tracking_options(
ConfigurationSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"DeleteConfigurationSetTrackingOptions",
Dict{String,Any}("ConfigurationSetName" => ConfigurationSetName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_configuration_set_tracking_options(
ConfigurationSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"DeleteConfigurationSetTrackingOptions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ConfigurationSetName" => ConfigurationSetName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_custom_verification_email_template(template_name)
delete_custom_verification_email_template(template_name, params::Dict{String,<:Any})
Deletes an existing custom verification email template. For more information about custom
verification email templates, see Using Custom Verification Email Templates in the Amazon
SES Developer Guide. You can execute this operation no more than once per second.
# Arguments
- `template_name`: The name of the custom verification email template to delete.
"""
function delete_custom_verification_email_template(
TemplateName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"DeleteCustomVerificationEmailTemplate",
Dict{String,Any}("TemplateName" => TemplateName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_custom_verification_email_template(
TemplateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"DeleteCustomVerificationEmailTemplate",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TemplateName" => TemplateName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_identity(identity)
delete_identity(identity, params::Dict{String,<:Any})
Deletes the specified identity (an email address or a domain) from the list of verified
identities. You can execute this operation no more than once per second.
# Arguments
- `identity`: The identity to be removed from the list of identities for the Amazon Web
Services account.
"""
function delete_identity(Identity; aws_config::AbstractAWSConfig=global_aws_config())
return ses(
"DeleteIdentity",
Dict{String,Any}("Identity" => Identity);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_identity(
Identity,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"DeleteIdentity",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Identity" => Identity), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_identity_policy(identity, policy_name)
delete_identity_policy(identity, policy_name, params::Dict{String,<:Any})
Deletes the specified sending authorization policy for the given identity (an email address
or a domain). This operation returns successfully even if a policy with the specified name
does not exist. This operation is for the identity owner only. If you have not verified
the identity, it returns an error. Sending authorization is a feature that enables an
identity owner to authorize other senders to use its identities. For information about
using sending authorization, see the Amazon SES Developer Guide. You can execute this
operation no more than once per second.
# Arguments
- `identity`: The identity that is associated with the policy to delete. You can specify
the identity by using its name or by using its Amazon Resource Name (ARN). Examples:
[email protected], example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com. To
successfully call this operation, you must own the identity.
- `policy_name`: The name of the policy to be deleted.
"""
function delete_identity_policy(
Identity, PolicyName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"DeleteIdentityPolicy",
Dict{String,Any}("Identity" => Identity, "PolicyName" => PolicyName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_identity_policy(
Identity,
PolicyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"DeleteIdentityPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Identity" => Identity, "PolicyName" => PolicyName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_receipt_filter(filter_name)
delete_receipt_filter(filter_name, params::Dict{String,<:Any})
Deletes the specified IP address filter. For information about managing IP address filters,
see the Amazon SES Developer Guide. You can execute this operation no more than once per
second.
# Arguments
- `filter_name`: The name of the IP address filter to delete.
"""
function delete_receipt_filter(
FilterName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"DeleteReceiptFilter",
Dict{String,Any}("FilterName" => FilterName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_receipt_filter(
FilterName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"DeleteReceiptFilter",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("FilterName" => FilterName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_receipt_rule(rule_name, rule_set_name)
delete_receipt_rule(rule_name, rule_set_name, params::Dict{String,<:Any})
Deletes the specified receipt rule. For information about managing receipt rules, see the
Amazon SES Developer Guide. You can execute this operation no more than once per second.
# Arguments
- `rule_name`: The name of the receipt rule to delete.
- `rule_set_name`: The name of the receipt rule set that contains the receipt rule to
delete.
"""
function delete_receipt_rule(
RuleName, RuleSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"DeleteReceiptRule",
Dict{String,Any}("RuleName" => RuleName, "RuleSetName" => RuleSetName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_receipt_rule(
RuleName,
RuleSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"DeleteReceiptRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("RuleName" => RuleName, "RuleSetName" => RuleSetName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_receipt_rule_set(rule_set_name)
delete_receipt_rule_set(rule_set_name, params::Dict{String,<:Any})
Deletes the specified receipt rule set and all of the receipt rules it contains. The
currently active rule set cannot be deleted. For information about managing receipt rule
sets, see the Amazon SES Developer Guide. You can execute this operation no more than once
per second.
# Arguments
- `rule_set_name`: The name of the receipt rule set to delete.
"""
function delete_receipt_rule_set(
RuleSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"DeleteReceiptRuleSet",
Dict{String,Any}("RuleSetName" => RuleSetName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_receipt_rule_set(
RuleSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"DeleteReceiptRuleSet",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RuleSetName" => RuleSetName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_template(template_name)
delete_template(template_name, params::Dict{String,<:Any})
Deletes an email template. You can execute this operation no more than once per second.
# Arguments
- `template_name`: The name of the template to be deleted.
"""
function delete_template(TemplateName; aws_config::AbstractAWSConfig=global_aws_config())
return ses(
"DeleteTemplate",
Dict{String,Any}("TemplateName" => TemplateName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_template(
TemplateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"DeleteTemplate",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TemplateName" => TemplateName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_verified_email_address(email_address)
delete_verified_email_address(email_address, params::Dict{String,<:Any})
Deprecated. Use the DeleteIdentity operation to delete email addresses and domains.
# Arguments
- `email_address`: An email address to be removed from the list of verified addresses.
"""
function delete_verified_email_address(
EmailAddress; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"DeleteVerifiedEmailAddress",
Dict{String,Any}("EmailAddress" => EmailAddress);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_verified_email_address(
EmailAddress,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"DeleteVerifiedEmailAddress",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EmailAddress" => EmailAddress), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_active_receipt_rule_set()
describe_active_receipt_rule_set(params::Dict{String,<:Any})
Returns the metadata and receipt rules for the receipt rule set that is currently active.
For information about setting up receipt rule sets, see the Amazon SES Developer Guide. You
can execute this operation no more than once per second.
"""
function describe_active_receipt_rule_set(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"DescribeActiveReceiptRuleSet";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_active_receipt_rule_set(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"DescribeActiveReceiptRuleSet",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_configuration_set(configuration_set_name)
describe_configuration_set(configuration_set_name, params::Dict{String,<:Any})
Returns the details of the specified configuration set. For information about using
configuration sets, see the Amazon SES Developer Guide. You can execute this operation no
more than once per second.
# Arguments
- `configuration_set_name`: The name of the configuration set to describe.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConfigurationSetAttributeNames"`: A list of configuration set attributes to return.
"""
function describe_configuration_set(
ConfigurationSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"DescribeConfigurationSet",
Dict{String,Any}("ConfigurationSetName" => ConfigurationSetName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_configuration_set(
ConfigurationSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"DescribeConfigurationSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ConfigurationSetName" => ConfigurationSetName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_receipt_rule(rule_name, rule_set_name)
describe_receipt_rule(rule_name, rule_set_name, params::Dict{String,<:Any})
Returns the details of the specified receipt rule. For information about setting up receipt
rules, see the Amazon SES Developer Guide. You can execute this operation no more than once
per second.
# Arguments
- `rule_name`: The name of the receipt rule.
- `rule_set_name`: The name of the receipt rule set that the receipt rule belongs to.
"""
function describe_receipt_rule(
RuleName, RuleSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"DescribeReceiptRule",
Dict{String,Any}("RuleName" => RuleName, "RuleSetName" => RuleSetName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_receipt_rule(
RuleName,
RuleSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"DescribeReceiptRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("RuleName" => RuleName, "RuleSetName" => RuleSetName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_receipt_rule_set(rule_set_name)
describe_receipt_rule_set(rule_set_name, params::Dict{String,<:Any})
Returns the details of the specified receipt rule set. For information about managing
receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no
more than once per second.
# Arguments
- `rule_set_name`: The name of the receipt rule set to describe.
"""
function describe_receipt_rule_set(
RuleSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"DescribeReceiptRuleSet",
Dict{String,Any}("RuleSetName" => RuleSetName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_receipt_rule_set(
RuleSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"DescribeReceiptRuleSet",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RuleSetName" => RuleSetName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_account_sending_enabled()
get_account_sending_enabled(params::Dict{String,<:Any})
Returns the email sending status of the Amazon SES account for the current Region. You can
execute this operation no more than once per second.
"""
function get_account_sending_enabled(; aws_config::AbstractAWSConfig=global_aws_config())
return ses(
"GetAccountSendingEnabled"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_account_sending_enabled(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"GetAccountSendingEnabled",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_custom_verification_email_template(template_name)
get_custom_verification_email_template(template_name, params::Dict{String,<:Any})
Returns the custom email verification template for the template name you specify. For more
information about custom verification email templates, see Using Custom Verification Email
Templates in the Amazon SES Developer Guide. You can execute this operation no more than
once per second.
# Arguments
- `template_name`: The name of the custom verification email template to retrieve.
"""
function get_custom_verification_email_template(
TemplateName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"GetCustomVerificationEmailTemplate",
Dict{String,Any}("TemplateName" => TemplateName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_custom_verification_email_template(
TemplateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"GetCustomVerificationEmailTemplate",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TemplateName" => TemplateName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_identity_dkim_attributes(identities)
get_identity_dkim_attributes(identities, params::Dict{String,<:Any})
Returns the current status of Easy DKIM signing for an entity. For domain name identities,
this operation also returns the DKIM tokens that are required for Easy DKIM signing, and
whether Amazon SES has successfully verified that these tokens have been published. This
operation takes a list of identities as input and returns the following information for
each: Whether Easy DKIM signing is enabled or disabled. A set of DKIM tokens that
represent the identity. If the identity is an email address, the tokens represent the
domain of that address. Whether Amazon SES has successfully verified the DKIM tokens
published in the domain's DNS. This information is only returned for domain name
identities, not for email addresses. This operation is throttled at one request per
second and can only get DKIM attributes for up to 100 identities at a time. For more
information about creating DNS records using DKIM tokens, go to the Amazon SES Developer
Guide.
# Arguments
- `identities`: A list of one or more verified identities - email addresses, domains, or
both.
"""
function get_identity_dkim_attributes(
Identities; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"GetIdentityDkimAttributes",
Dict{String,Any}("Identities" => Identities);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_identity_dkim_attributes(
Identities,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"GetIdentityDkimAttributes",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Identities" => Identities), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_identity_mail_from_domain_attributes(identities)
get_identity_mail_from_domain_attributes(identities, params::Dict{String,<:Any})
Returns the custom MAIL FROM attributes for a list of identities (email addresses :
domains). This operation is throttled at one request per second and can only get custom
MAIL FROM attributes for up to 100 identities at a time.
# Arguments
- `identities`: A list of one or more identities.
"""
function get_identity_mail_from_domain_attributes(
Identities; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"GetIdentityMailFromDomainAttributes",
Dict{String,Any}("Identities" => Identities);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_identity_mail_from_domain_attributes(
Identities,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"GetIdentityMailFromDomainAttributes",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Identities" => Identities), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_identity_notification_attributes(identities)
get_identity_notification_attributes(identities, params::Dict{String,<:Any})
Given a list of verified identities (email addresses and/or domains), returns a structure
describing identity notification attributes. This operation is throttled at one request per
second and can only get notification attributes for up to 100 identities at a time. For
more information about using notifications with Amazon SES, see the Amazon SES Developer
Guide.
# Arguments
- `identities`: A list of one or more identities. You can specify an identity by using its
name or by using its Amazon Resource Name (ARN). Examples: [email protected], example.com,
arn:aws:ses:us-east-1:123456789012:identity/example.com.
"""
function get_identity_notification_attributes(
Identities; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"GetIdentityNotificationAttributes",
Dict{String,Any}("Identities" => Identities);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_identity_notification_attributes(
Identities,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"GetIdentityNotificationAttributes",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Identities" => Identities), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_identity_policies(identity, policy_names)
get_identity_policies(identity, policy_names, params::Dict{String,<:Any})
Returns the requested sending authorization policies for the given identity (an email
address or a domain). The policies are returned as a map of policy names to policy
contents. You can retrieve a maximum of 20 policies at a time. This operation is for the
identity owner only. If you have not verified the identity, it returns an error. Sending
authorization is a feature that enables an identity owner to authorize other senders to use
its identities. For information about using sending authorization, see the Amazon SES
Developer Guide. You can execute this operation no more than once per second.
# Arguments
- `identity`: The identity for which the policies are retrieved. You can specify an
identity by using its name or by using its Amazon Resource Name (ARN). Examples:
[email protected], example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com. To
successfully call this operation, you must own the identity.
- `policy_names`: A list of the names of policies to be retrieved. You can retrieve a
maximum of 20 policies at a time. If you do not know the names of the policies that are
attached to the identity, you can use ListIdentityPolicies.
"""
function get_identity_policies(
Identity, PolicyNames; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"GetIdentityPolicies",
Dict{String,Any}("Identity" => Identity, "PolicyNames" => PolicyNames);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_identity_policies(
Identity,
PolicyNames,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"GetIdentityPolicies",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Identity" => Identity, "PolicyNames" => PolicyNames),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_identity_verification_attributes(identities)
get_identity_verification_attributes(identities, params::Dict{String,<:Any})
Given a list of identities (email addresses and/or domains), returns the verification
status and (for domain identities) the verification token for each identity. The
verification status of an email address is \"Pending\" until the email address owner clicks
the link within the verification email that Amazon SES sent to that address. If the email
address owner clicks the link within 24 hours, the verification status of the email address
changes to \"Success\". If the link is not clicked within 24 hours, the verification status
changes to \"Failed.\" In that case, to verify the email address, you must restart the
verification process from the beginning. For domain identities, the domain's verification
status is \"Pending\" as Amazon SES searches for the required TXT record in the DNS
settings of the domain. When Amazon SES detects the record, the domain's verification
status changes to \"Success\". If Amazon SES is unable to detect the record within 72
hours, the domain's verification status changes to \"Failed.\" In that case, to verify the
domain, you must restart the verification process from the beginning. This operation is
throttled at one request per second and can only get verification attributes for up to 100
identities at a time.
# Arguments
- `identities`: A list of identities.
"""
function get_identity_verification_attributes(
Identities; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"GetIdentityVerificationAttributes",
Dict{String,Any}("Identities" => Identities);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_identity_verification_attributes(
Identities,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"GetIdentityVerificationAttributes",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Identities" => Identities), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_send_quota()
get_send_quota(params::Dict{String,<:Any})
Provides the sending limits for the Amazon SES account. You can execute this operation no
more than once per second.
"""
function get_send_quota(; aws_config::AbstractAWSConfig=global_aws_config())
return ses("GetSendQuota"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_send_quota(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"GetSendQuota", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_send_statistics()
get_send_statistics(params::Dict{String,<:Any})
Provides sending statistics for the current Amazon Web Services Region. The result is a
list of data points, representing the last two weeks of sending activity. Each data point
in the list contains statistics for a 15-minute period of time. You can execute this
operation no more than once per second.
"""
function get_send_statistics(; aws_config::AbstractAWSConfig=global_aws_config())
return ses("GetSendStatistics"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_send_statistics(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"GetSendStatistics", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_template(template_name)
get_template(template_name, params::Dict{String,<:Any})
Displays the template object (which includes the Subject line, HTML part and text part) for
the template you specify. You can execute this operation no more than once per second.
# Arguments
- `template_name`: The name of the template to retrieve.
"""
function get_template(TemplateName; aws_config::AbstractAWSConfig=global_aws_config())
return ses(
"GetTemplate",
Dict{String,Any}("TemplateName" => TemplateName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_template(
TemplateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"GetTemplate",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TemplateName" => TemplateName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_configuration_sets()
list_configuration_sets(params::Dict{String,<:Any})
Provides a list of the configuration sets associated with your Amazon SES account in the
current Amazon Web Services Region. For information about using configuration sets, see
Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide. You can
execute this operation no more than once per second. This operation returns up to 1,000
configuration sets each time it is run. If your Amazon SES account has more than 1,000
configuration sets, this operation also returns NextToken. You can then execute the
ListConfigurationSets operation again, passing the NextToken parameter and the value of the
NextToken element to retrieve additional results.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxItems"`: The number of configuration sets to return.
- `"NextToken"`: A token returned from a previous call to ListConfigurationSets to indicate
the position of the configuration set in the configuration set list.
"""
function list_configuration_sets(; aws_config::AbstractAWSConfig=global_aws_config())
return ses(
"ListConfigurationSets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_configuration_sets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"ListConfigurationSets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_custom_verification_email_templates()
list_custom_verification_email_templates(params::Dict{String,<:Any})
Lists the existing custom verification email templates for your account in the current
Amazon Web Services Region. For more information about custom verification email templates,
see Using Custom Verification Email Templates in the Amazon SES Developer Guide. You can
execute this operation no more than once per second.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of custom verification email templates to return. This
value must be at least 1 and less than or equal to 50. If you do not specify a value, or if
you specify a value less than 1 or greater than 50, the operation returns up to 50 results.
- `"NextToken"`: An array the contains the name and creation time stamp for each template
in your Amazon SES account.
"""
function list_custom_verification_email_templates(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"ListCustomVerificationEmailTemplates";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_custom_verification_email_templates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"ListCustomVerificationEmailTemplates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_identities()
list_identities(params::Dict{String,<:Any})
Returns a list containing all of the identities (email addresses and domains) for your
Amazon Web Services account in the current Amazon Web Services Region, regardless of
verification status. You can execute this operation no more than once per second. It's
recommended that for successive pagination calls of this API, you continue to the use the
same parameter/value pairs as used in the original call, e.g., if you used
IdentityType=Domain in the the original call and received a NextToken in the response, you
should continue providing the IdentityType=Domain parameter for further NextToken calls;
however, if you didn't provide the IdentityType parameter in the original call, then
continue to not provide it for successive pagination calls. Using this protocol will ensure
consistent results.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IdentityType"`: The type of the identities to list. Possible values are
\"EmailAddress\" and \"Domain\". If this parameter is omitted, then all identities are
listed.
- `"MaxItems"`: The maximum number of identities per page. Possible values are 1-1000
inclusive.
- `"NextToken"`: The token to use for pagination.
"""
function list_identities(; aws_config::AbstractAWSConfig=global_aws_config())
return ses("ListIdentities"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_identities(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"ListIdentities", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_identity_policies(identity)
list_identity_policies(identity, params::Dict{String,<:Any})
Returns a list of sending authorization policies that are attached to the given identity
(an email address or a domain). This operation returns only a list. To get the actual
policy content, use GetIdentityPolicies. This operation is for the identity owner only. If
you have not verified the identity, it returns an error. Sending authorization is a
feature that enables an identity owner to authorize other senders to use its identities.
For information about using sending authorization, see the Amazon SES Developer Guide. You
can execute this operation no more than once per second.
# Arguments
- `identity`: The identity that is associated with the policy for which the policies are
listed. You can specify an identity by using its name or by using its Amazon Resource Name
(ARN). Examples: [email protected], example.com,
arn:aws:ses:us-east-1:123456789012:identity/example.com. To successfully call this
operation, you must own the identity.
"""
function list_identity_policies(Identity; aws_config::AbstractAWSConfig=global_aws_config())
return ses(
"ListIdentityPolicies",
Dict{String,Any}("Identity" => Identity);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_identity_policies(
Identity,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"ListIdentityPolicies",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Identity" => Identity), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_receipt_filters()
list_receipt_filters(params::Dict{String,<:Any})
Lists the IP address filters associated with your Amazon Web Services account in the
current Amazon Web Services Region. For information about managing IP address filters, see
the Amazon SES Developer Guide. You can execute this operation no more than once per second.
"""
function list_receipt_filters(; aws_config::AbstractAWSConfig=global_aws_config())
return ses("ListReceiptFilters"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_receipt_filters(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"ListReceiptFilters", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_receipt_rule_sets()
list_receipt_rule_sets(params::Dict{String,<:Any})
Lists the receipt rule sets that exist under your Amazon Web Services account in the
current Amazon Web Services Region. If there are additional receipt rule sets to be
retrieved, you receive a NextToken that you can provide to the next call to
ListReceiptRuleSets to retrieve the additional entries. For information about managing
receipt rule sets, see the Amazon SES Developer Guide. You can execute this operation no
more than once per second.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: A token returned from a previous call to ListReceiptRuleSets to indicate
the position in the receipt rule set list.
"""
function list_receipt_rule_sets(; aws_config::AbstractAWSConfig=global_aws_config())
return ses(
"ListReceiptRuleSets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_receipt_rule_sets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"ListReceiptRuleSets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_templates()
list_templates(params::Dict{String,<:Any})
Lists the email templates present in your Amazon SES account in the current Amazon Web
Services Region. You can execute this operation no more than once per second.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxItems"`: The maximum number of templates to return. This value must be at least 1
and less than or equal to 100. If more than 100 items are requested, the page size will
automatically set to 100. If you do not specify a value, 10 is the default page size.
- `"NextToken"`: A token returned from a previous call to ListTemplates to indicate the
position in the list of email templates.
"""
function list_templates(; aws_config::AbstractAWSConfig=global_aws_config())
return ses("ListTemplates"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_templates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"ListTemplates", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_verified_email_addresses()
list_verified_email_addresses(params::Dict{String,<:Any})
Deprecated. Use the ListIdentities operation to list the email addresses and domains
associated with your account.
"""
function list_verified_email_addresses(; aws_config::AbstractAWSConfig=global_aws_config())
return ses(
"ListVerifiedEmailAddresses"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_verified_email_addresses(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"ListVerifiedEmailAddresses",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_configuration_set_delivery_options(configuration_set_name)
put_configuration_set_delivery_options(configuration_set_name, params::Dict{String,<:Any})
Adds or updates the delivery options for a configuration set.
# Arguments
- `configuration_set_name`: The name of the configuration set.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeliveryOptions"`: Specifies whether messages that use the configuration set are
required to use Transport Layer Security (TLS).
"""
function put_configuration_set_delivery_options(
ConfigurationSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"PutConfigurationSetDeliveryOptions",
Dict{String,Any}("ConfigurationSetName" => ConfigurationSetName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_configuration_set_delivery_options(
ConfigurationSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"PutConfigurationSetDeliveryOptions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ConfigurationSetName" => ConfigurationSetName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_identity_policy(identity, policy, policy_name)
put_identity_policy(identity, policy, policy_name, params::Dict{String,<:Any})
Adds or updates a sending authorization policy for the specified identity (an email address
or a domain). This operation is for the identity owner only. If you have not verified the
identity, it returns an error. Sending authorization is a feature that enables an identity
owner to authorize other senders to use its identities. For information about using sending
authorization, see the Amazon SES Developer Guide. You can execute this operation no more
than once per second.
# Arguments
- `identity`: The identity to which that the policy applies. You can specify an identity by
using its name or by using its Amazon Resource Name (ARN). Examples: [email protected],
example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com. To successfully call
this operation, you must own the identity.
- `policy`: The text of the policy in JSON format. The policy cannot exceed 4 KB. For
information about the syntax of sending authorization policies, see the Amazon SES
Developer Guide.
- `policy_name`: The name of the policy. The policy name cannot exceed 64 characters and
can only include alphanumeric characters, dashes, and underscores.
"""
function put_identity_policy(
Identity, Policy, PolicyName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"PutIdentityPolicy",
Dict{String,Any}(
"Identity" => Identity, "Policy" => Policy, "PolicyName" => PolicyName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_identity_policy(
Identity,
Policy,
PolicyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"PutIdentityPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Identity" => Identity, "Policy" => Policy, "PolicyName" => PolicyName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reorder_receipt_rule_set(rule_names, rule_set_name)
reorder_receipt_rule_set(rule_names, rule_set_name, params::Dict{String,<:Any})
Reorders the receipt rules within a receipt rule set. All of the rules in the rule set
must be represented in this request. That is, it is error if the reorder request doesn't
explicitly position all of the rules. For information about managing receipt rule sets,
see the Amazon SES Developer Guide. You can execute this operation no more than once per
second.
# Arguments
- `rule_names`: The specified receipt rule set's receipt rules, in order.
- `rule_set_name`: The name of the receipt rule set to reorder.
"""
function reorder_receipt_rule_set(
RuleNames, RuleSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"ReorderReceiptRuleSet",
Dict{String,Any}("RuleNames" => RuleNames, "RuleSetName" => RuleSetName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reorder_receipt_rule_set(
RuleNames,
RuleSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"ReorderReceiptRuleSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("RuleNames" => RuleNames, "RuleSetName" => RuleSetName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_bounce(bounce_sender, bounced_recipient_info_list, original_message_id)
send_bounce(bounce_sender, bounced_recipient_info_list, original_message_id, params::Dict{String,<:Any})
Generates and sends a bounce message to the sender of an email you received through Amazon
SES. You can only use this operation on an email up to 24 hours after you receive it. You
cannot use this operation to send generic bounces for mail that was not received by Amazon
SES. For information about receiving email through Amazon SES, see the Amazon SES
Developer Guide. You can execute this operation no more than once per second.
# Arguments
- `bounce_sender`: The address to use in the \"From\" header of the bounce message. This
must be an identity that you have verified with Amazon SES.
- `bounced_recipient_info_list`: A list of recipients of the bounced message, including the
information required to create the Delivery Status Notifications (DSNs) for the recipients.
You must specify at least one BouncedRecipientInfo in the list.
- `original_message_id`: The message ID of the message to be bounced.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BounceSenderArn"`: This parameter is used only for sending authorization. It is the ARN
of the identity that is associated with the sending authorization policy that permits you
to use the address in the \"From\" header of the bounce. For more information about sending
authorization, see the Amazon SES Developer Guide.
- `"Explanation"`: Human-readable text for the bounce message to explain the failure. If
not specified, the text is auto-generated based on the bounced recipient information.
- `"MessageDsn"`: Message-related DSN fields. If not specified, Amazon SES chooses the
values.
"""
function send_bounce(
BounceSender,
BouncedRecipientInfoList,
OriginalMessageId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"SendBounce",
Dict{String,Any}(
"BounceSender" => BounceSender,
"BouncedRecipientInfoList" => BouncedRecipientInfoList,
"OriginalMessageId" => OriginalMessageId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_bounce(
BounceSender,
BouncedRecipientInfoList,
OriginalMessageId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"SendBounce",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"BounceSender" => BounceSender,
"BouncedRecipientInfoList" => BouncedRecipientInfoList,
"OriginalMessageId" => OriginalMessageId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_bulk_templated_email(destinations, source, template)
send_bulk_templated_email(destinations, source, template, params::Dict{String,<:Any})
Composes an email message to multiple destinations. The message body is created using an
email template. To send email using this operation, your call must meet the following
requirements: The call must refer to an existing email template. You can create email
templates using CreateTemplate. The message must be sent from a verified email address or
domain. If your account is still in the Amazon SES sandbox, you may send only to verified
addresses or domains, or to email addresses associated with the Amazon SES Mailbox
Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon
SES Developer Guide. The maximum message size is 10 MB. Each Destination parameter
must include at least one recipient email address. The recipient address can be a To:
address, a CC: address, or a BCC: address. If a recipient email address is invalid (that
is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message
is rejected, even if the message contains other recipients that are valid. The message
may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need
to send an email message to a larger audience, you can divide your recipient list into
groups of 50 or fewer, and then call the SendBulkTemplatedEmail operation several times to
send the message to each group. The number of destinations you can contact in a single
call can be limited by your account's maximum sending rate.
# Arguments
- `destinations`: One or more Destination objects. All of the recipients in a Destination
receive the same version of the email. You can specify up to 50 Destination objects within
a Destinations array.
- `source`: The email address that is sending the email. This email address must be either
individually verified with Amazon SES, or from a domain that has been verified with Amazon
SES. For information about verifying identities, see the Amazon SES Developer Guide. If you
are sending on behalf of another user and have been permitted to do so by a sending
authorization policy, then you must also specify the SourceArn parameter. For more
information about sending authorization, see the Amazon SES Developer Guide. Amazon SES
does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the
email address string must be 7-bit ASCII. If you want to send to or from email addresses
that contain Unicode characters in the domain part of an address, you must encode the
domain using Punycode. Punycode is not permitted in the local part of the email address
(the part before the @ sign) nor in the \"friendly from\" name. If you want to use Unicode
characters in the \"friendly from\" name, you must encode the \"friendly from\" name using
MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For
more information about Punycode, see RFC 3492.
- `template`: The template to use when sending this email.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConfigurationSetName"`: The name of the configuration set to use when you send an email
using SendBulkTemplatedEmail.
- `"DefaultTags"`: A list of tags, in the form of name/value pairs, to apply to an email
that you send to a destination using SendBulkTemplatedEmail.
- `"DefaultTemplateData"`: A list of replacement values to apply to the template when
replacement data is not specified in a Destination object. These values act as a default or
fallback option when no other data is available. The template data is a JSON object,
typically consisting of key-value pairs in which the keys correspond to replacement tags in
the email template.
- `"ReplyToAddresses"`: The reply-to email address(es) for the message. If the recipient
replies to the message, each reply-to address receives the reply.
- `"ReturnPath"`: The email address that bounces and complaints are forwarded to when
feedback forwarding is enabled. If the message cannot be delivered to the recipient, then
an error message is returned from the recipient's ISP; this message is forwarded to the
email address specified by the ReturnPath parameter. The ReturnPath parameter is never
overwritten. This email address must be either individually verified with Amazon SES, or
from a domain that has been verified with Amazon SES.
- `"ReturnPathArn"`: This parameter is used only for sending authorization. It is the ARN
of the identity that is associated with the sending authorization policy that permits you
to use the email address specified in the ReturnPath parameter. For example, if the owner
of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com)
attaches a policy to it that authorizes you to use [email protected], then you would
specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com,
and the ReturnPath to be [email protected]. For more information about sending
authorization, see the Amazon SES Developer Guide.
- `"SourceArn"`: This parameter is used only for sending authorization. It is the ARN of
the identity that is associated with the sending authorization policy that permits you to
send for the email address specified in the Source parameter. For example, if the owner of
example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com)
attaches a policy to it that authorizes you to send from [email protected], then you would
specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and
the Source to be [email protected]. For more information about sending authorization, see
the Amazon SES Developer Guide.
- `"TemplateArn"`: The ARN of the template to use when sending this email.
"""
function send_bulk_templated_email(
Destinations, Source, Template; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"SendBulkTemplatedEmail",
Dict{String,Any}(
"Destinations" => Destinations, "Source" => Source, "Template" => Template
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_bulk_templated_email(
Destinations,
Source,
Template,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"SendBulkTemplatedEmail",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Destinations" => Destinations,
"Source" => Source,
"Template" => Template,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_custom_verification_email(email_address, template_name)
send_custom_verification_email(email_address, template_name, params::Dict{String,<:Any})
Adds an email address to the list of identities for your Amazon SES account in the current
Amazon Web Services Region and attempts to verify it. As a result of executing this
operation, a customized verification email is sent to the specified address. To use this
operation, you must first create a custom verification email template. For more information
about creating and using custom verification email templates, see Using Custom Verification
Email Templates in the Amazon SES Developer Guide. You can execute this operation no more
than once per second.
# Arguments
- `email_address`: The email address to verify.
- `template_name`: The name of the custom verification email template to use when sending
the verification email.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConfigurationSetName"`: Name of a configuration set to use when sending the
verification email.
"""
function send_custom_verification_email(
EmailAddress, TemplateName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"SendCustomVerificationEmail",
Dict{String,Any}("EmailAddress" => EmailAddress, "TemplateName" => TemplateName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_custom_verification_email(
EmailAddress,
TemplateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"SendCustomVerificationEmail",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EmailAddress" => EmailAddress, "TemplateName" => TemplateName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_email(destination, message, source)
send_email(destination, message, source, params::Dict{String,<:Any})
Composes an email message and immediately queues it for sending. To send email using this
operation, your message must meet the following requirements: The message must be sent
from a verified email address or domain. If you attempt to send email using a non-verified
address or domain, the operation results in an \"Email address not verified\" error. If
your account is still in the Amazon SES sandbox, you may only send to verified addresses or
domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more
information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
The maximum message size is 10 MB. The message must include at least one recipient email
address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a
recipient email address is invalid (that is, it is not in the format
UserName@[SubDomain.]Domain.TopLevelDomain), the entire message is rejected, even if the
message contains other recipients that are valid. The message may not include more than
50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to
a larger audience, you can divide your recipient list into groups of 50 or fewer, and then
call the SendEmail operation several times to send the message to each group. For every
message that you send, the total number of recipients (including each recipient in the To:,
CC: and BCC: fields) is counted against the maximum number of emails you can send in a
24-hour period (your sending quota). For more information about sending quotas in Amazon
SES, see Managing Your Amazon SES Sending Limits in the Amazon SES Developer Guide.
# Arguments
- `destination`: The destination for this email, composed of To:, CC:, and BCC: fields.
- `message`: The message to be sent.
- `source`: The email address that is sending the email. This email address must be either
individually verified with Amazon SES, or from a domain that has been verified with Amazon
SES. For information about verifying identities, see the Amazon SES Developer Guide. If you
are sending on behalf of another user and have been permitted to do so by a sending
authorization policy, then you must also specify the SourceArn parameter. For more
information about sending authorization, see the Amazon SES Developer Guide. Amazon SES
does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the
email address string must be 7-bit ASCII. If you want to send to or from email addresses
that contain Unicode characters in the domain part of an address, you must encode the
domain using Punycode. Punycode is not permitted in the local part of the email address
(the part before the @ sign) nor in the \"friendly from\" name. If you want to use Unicode
characters in the \"friendly from\" name, you must encode the \"friendly from\" name using
MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For
more information about Punycode, see RFC 3492.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConfigurationSetName"`: The name of the configuration set to use when you send an email
using SendEmail.
- `"ReplyToAddresses"`: The reply-to email address(es) for the message. If the recipient
replies to the message, each reply-to address receives the reply.
- `"ReturnPath"`: The email address that bounces and complaints are forwarded to when
feedback forwarding is enabled. If the message cannot be delivered to the recipient, then
an error message is returned from the recipient's ISP; this message is forwarded to the
email address specified by the ReturnPath parameter. The ReturnPath parameter is never
overwritten. This email address must be either individually verified with Amazon SES, or
from a domain that has been verified with Amazon SES.
- `"ReturnPathArn"`: This parameter is used only for sending authorization. It is the ARN
of the identity that is associated with the sending authorization policy that permits you
to use the email address specified in the ReturnPath parameter. For example, if the owner
of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com)
attaches a policy to it that authorizes you to use [email protected], then you would
specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com,
and the ReturnPath to be [email protected]. For more information about sending
authorization, see the Amazon SES Developer Guide.
- `"SourceArn"`: This parameter is used only for sending authorization. It is the ARN of
the identity that is associated with the sending authorization policy that permits you to
send for the email address specified in the Source parameter. For example, if the owner of
example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com)
attaches a policy to it that authorizes you to send from [email protected], then you would
specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and
the Source to be [email protected]. For more information about sending authorization, see
the Amazon SES Developer Guide.
- `"Tags"`: A list of tags, in the form of name/value pairs, to apply to an email that you
send using SendEmail. Tags correspond to characteristics of the email that you define, so
that you can publish email sending events.
"""
function send_email(
Destination, Message, Source; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"SendEmail",
Dict{String,Any}(
"Destination" => Destination, "Message" => Message, "Source" => Source
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_email(
Destination,
Message,
Source,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"SendEmail",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Destination" => Destination, "Message" => Message, "Source" => Source
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_raw_email(raw_message)
send_raw_email(raw_message, params::Dict{String,<:Any})
Composes an email message and immediately queues it for sending. This operation is more
flexible than the SendEmail operation. When you use the SendRawEmail operation, you can
specify the headers of the message as well as its content. This flexibility is useful, for
example, when you need to send a multipart MIME email (such a message that contains both a
text and an HTML version). You can also use this operation to send messages that include
attachments. The SendRawEmail operation has the following requirements: You can only send
email from verified email addresses or domains. If you try to send email from an address
that isn't verified, the operation results in an \"Email address not verified\" error. If
your account is still in the Amazon SES sandbox, you can only send email to other verified
addresses in your account, or to addresses that are associated with the Amazon SES mailbox
simulator. The maximum message size, including attachments, is 10 MB. Each message has
to include at least one recipient address. A recipient address includes any address on the
To:, CC:, or BCC: lines. If you send a single message to more than one recipient address,
and one of the recipient addresses isn't in a valid format (that is, it's not in the format
UserName@[SubDomain.]Domain.TopLevelDomain), Amazon SES rejects the entire message, even if
the other addresses are valid. Each message can include up to 50 recipient addresses
across the To:, CC:, or BCC: lines. If you need to send a single message to more than 50
recipients, you have to split the list of recipient addresses into groups of less than 50
recipients, and send separate messages to each group. Amazon SES allows you to specify
8-bit Content-Transfer-Encoding for MIME message parts. However, if Amazon SES has to
modify the contents of your message (for example, if you use open and click tracking),
8-bit content isn't preserved. For this reason, we highly recommend that you encode all
content that isn't 7-bit ASCII. For more information, see MIME Encoding in the Amazon SES
Developer Guide. Additionally, keep the following considerations in mind when using the
SendRawEmail operation: Although you can customize the message headers when using the
SendRawEmail operation, Amazon SES automatically applies its own Message-ID and Date
headers; if you passed these headers when creating the message, they are overwritten by the
values that Amazon SES provides. If you are using sending authorization to send on behalf
of another user, SendRawEmail enables you to specify the cross-account identity for the
email's Source, From, and Return-Path parameters in one of two ways: you can pass optional
parameters SourceArn, FromArn, and/or ReturnPathArn, or you can include the following
X-headers in the header of your raw email: X-SES-SOURCE-ARN X-SES-FROM-ARN
X-SES-RETURN-PATH-ARN Don't include these X-headers in the DKIM signature. Amazon SES
removes these before it sends the email. If you only specify the SourceIdentityArn
parameter, Amazon SES sets the From and Return-Path addresses to the same identity that you
specified. For more information about sending authorization, see the Using Sending
Authorization with Amazon SES in the Amazon SES Developer Guide. For every message that
you send, the total number of recipients (including each recipient in the To:, CC: and BCC:
fields) is counted against the maximum number of emails you can send in a 24-hour period
(your sending quota). For more information about sending quotas in Amazon SES, see Managing
Your Amazon SES Sending Limits in the Amazon SES Developer Guide.
# Arguments
- `raw_message`: The raw email message itself. The message has to meet the following
criteria: The message has to contain a header and a body, separated by a blank line.
All of the required header fields must be present in the message. Each part of a
multipart MIME message must be formatted properly. Attachments must be of a content type
that Amazon SES supports. For a list on unsupported content types, see Unsupported
Attachment Types in the Amazon SES Developer Guide. The entire message must be
base64-encoded. If any of the MIME parts in your message contain content that is outside
of the 7-bit ASCII character range, we highly recommend that you encode that content. For
more information, see Sending Raw Email in the Amazon SES Developer Guide. Per RFC 5321,
the maximum length of each line of text, including the <CRLF>, must not exceed 1,000
characters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConfigurationSetName"`: The name of the configuration set to use when you send an email
using SendRawEmail.
- `"Destinations"`: A list of destinations for the message, consisting of To:, CC:, and
BCC: addresses.
- `"FromArn"`: This parameter is used only for sending authorization. It is the ARN of the
identity that is associated with the sending authorization policy that permits you to
specify a particular \"From\" address in the header of the raw email. Instead of using this
parameter, you can use the X-header X-SES-FROM-ARN in the raw message of the email. If you
use both the FromArn parameter and the corresponding X-header, Amazon SES uses the value of
the FromArn parameter. For information about when to use this parameter, see the
description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.
- `"ReturnPathArn"`: This parameter is used only for sending authorization. It is the ARN
of the identity that is associated with the sending authorization policy that permits you
to use the email address specified in the ReturnPath parameter. For example, if the owner
of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com)
attaches a policy to it that authorizes you to use [email protected], then you would
specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com,
and the ReturnPath to be [email protected]. Instead of using this parameter, you can use
the X-header X-SES-RETURN-PATH-ARN in the raw message of the email. If you use both the
ReturnPathArn parameter and the corresponding X-header, Amazon SES uses the value of the
ReturnPathArn parameter. For information about when to use this parameter, see the
description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.
- `"Source"`: The identity's email address. If you do not provide a value for this
parameter, you must specify a \"From\" address in the raw text of the message. (You can
also specify both.) Amazon SES does not support the SMTPUTF8 extension, as described
inRFC6531. For this reason, the email address string must be 7-bit ASCII. If you want to
send to or from email addresses that contain Unicode characters in the domain part of an
address, you must encode the domain using Punycode. Punycode is not permitted in the local
part of the email address (the part before the @ sign) nor in the \"friendly from\" name.
If you want to use Unicode characters in the \"friendly from\" name, you must encode the
\"friendly from\" name using MIME encoded-word syntax, as described in Sending raw email
using the Amazon SES API. For more information about Punycode, see RFC 3492. If you
specify the Source parameter and have feedback forwarding enabled, then bounces and
complaints are sent to this email address. This takes precedence over any Return-Path
header that you might include in the raw text of the message.
- `"SourceArn"`: This parameter is used only for sending authorization. It is the ARN of
the identity that is associated with the sending authorization policy that permits you to
send for the email address specified in the Source parameter. For example, if the owner of
example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com)
attaches a policy to it that authorizes you to send from [email protected], then you would
specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and
the Source to be [email protected]. Instead of using this parameter, you can use the
X-header X-SES-SOURCE-ARN in the raw message of the email. If you use both the SourceArn
parameter and the corresponding X-header, Amazon SES uses the value of the SourceArn
parameter. For information about when to use this parameter, see the description of
SendRawEmail in this guide, or see the Amazon SES Developer Guide.
- `"Tags"`: A list of tags, in the form of name/value pairs, to apply to an email that you
send using SendRawEmail. Tags correspond to characteristics of the email that you define,
so that you can publish email sending events.
"""
function send_raw_email(RawMessage; aws_config::AbstractAWSConfig=global_aws_config())
return ses(
"SendRawEmail",
Dict{String,Any}("RawMessage" => RawMessage);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_raw_email(
RawMessage,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"SendRawEmail",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RawMessage" => RawMessage), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_templated_email(destination, source, template, template_data)
send_templated_email(destination, source, template, template_data, params::Dict{String,<:Any})
Composes an email message using an email template and immediately queues it for sending. To
send email using this operation, your call must meet the following requirements: The call
must refer to an existing email template. You can create email templates using the
CreateTemplate operation. The message must be sent from a verified email address or
domain. If your account is still in the Amazon SES sandbox, you may only send to verified
addresses or domains, or to email addresses associated with the Amazon SES Mailbox
Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon
SES Developer Guide. The maximum message size is 10 MB. Calls to the
SendTemplatedEmail operation may only include one Destination parameter. A destination is a
set of recipients that receives the same version of the email. The Destination parameter
can include up to 50 recipients, across the To:, CC: and BCC: fields. The Destination
parameter must include at least one recipient email address. The recipient address can be a
To: address, a CC: address, or a BCC: address. If a recipient email address is invalid
(that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire
message is rejected, even if the message contains other recipients that are valid. If
your call to the SendTemplatedEmail operation includes all of the required parameters,
Amazon SES accepts it and returns a Message ID. However, if Amazon SES can't render the
email because the template contains errors, it doesn't send the email. Additionally,
because it already accepted the message, Amazon SES doesn't return a message stating that
it was unable to send the email. For these reasons, we highly recommend that you set up
Amazon SES to send you notifications when Rendering Failure events occur. For more
information, see Sending Personalized Email Using the Amazon SES API in the Amazon Simple
Email Service Developer Guide.
# Arguments
- `destination`: The destination for this email, composed of To:, CC:, and BCC: fields. A
Destination can include up to 50 recipients across these three fields.
- `source`: The email address that is sending the email. This email address must be either
individually verified with Amazon SES, or from a domain that has been verified with Amazon
SES. For information about verifying identities, see the Amazon SES Developer Guide. If you
are sending on behalf of another user and have been permitted to do so by a sending
authorization policy, then you must also specify the SourceArn parameter. For more
information about sending authorization, see the Amazon SES Developer Guide. Amazon SES
does not support the SMTPUTF8 extension, as described in RFC6531. for this reason, The
email address string must be 7-bit ASCII. If you want to send to or from email addresses
that contain Unicode characters in the domain part of an address, you must encode the
domain using Punycode. Punycode is not permitted in the local part of the email address
(the part before the @ sign) nor in the \"friendly from\" name. If you want to use Unicode
characters in the \"friendly from\" name, you must encode the \"friendly from\" name using
MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For
more information about Punycode, see RFC 3492.
- `template`: The template to use when sending this email.
- `template_data`: A list of replacement values to apply to the template. This parameter is
a JSON object, typically consisting of key-value pairs in which the keys correspond to
replacement tags in the email template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConfigurationSetName"`: The name of the configuration set to use when you send an email
using SendTemplatedEmail.
- `"ReplyToAddresses"`: The reply-to email address(es) for the message. If the recipient
replies to the message, each reply-to address receives the reply.
- `"ReturnPath"`: The email address that bounces and complaints are forwarded to when
feedback forwarding is enabled. If the message cannot be delivered to the recipient, then
an error message is returned from the recipient's ISP; this message is forwarded to the
email address specified by the ReturnPath parameter. The ReturnPath parameter is never
overwritten. This email address must be either individually verified with Amazon SES, or
from a domain that has been verified with Amazon SES.
- `"ReturnPathArn"`: This parameter is used only for sending authorization. It is the ARN
of the identity that is associated with the sending authorization policy that permits you
to use the email address specified in the ReturnPath parameter. For example, if the owner
of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com)
attaches a policy to it that authorizes you to use [email protected], then you would
specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com,
and the ReturnPath to be [email protected]. For more information about sending
authorization, see the Amazon SES Developer Guide.
- `"SourceArn"`: This parameter is used only for sending authorization. It is the ARN of
the identity that is associated with the sending authorization policy that permits you to
send for the email address specified in the Source parameter. For example, if the owner of
example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com)
attaches a policy to it that authorizes you to send from [email protected], then you would
specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and
the Source to be [email protected]. For more information about sending authorization, see
the Amazon SES Developer Guide.
- `"Tags"`: A list of tags, in the form of name/value pairs, to apply to an email that you
send using SendTemplatedEmail. Tags correspond to characteristics of the email that you
define, so that you can publish email sending events.
- `"TemplateArn"`: The ARN of the template to use when sending this email.
"""
function send_templated_email(
Destination,
Source,
Template,
TemplateData;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"SendTemplatedEmail",
Dict{String,Any}(
"Destination" => Destination,
"Source" => Source,
"Template" => Template,
"TemplateData" => TemplateData,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_templated_email(
Destination,
Source,
Template,
TemplateData,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"SendTemplatedEmail",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Destination" => Destination,
"Source" => Source,
"Template" => Template,
"TemplateData" => TemplateData,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_active_receipt_rule_set()
set_active_receipt_rule_set(params::Dict{String,<:Any})
Sets the specified receipt rule set as the active receipt rule set. To disable your
email-receiving through Amazon SES completely, you can call this operation with RuleSetName
set to null. For information about managing receipt rule sets, see the Amazon SES
Developer Guide. You can execute this operation no more than once per second.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"RuleSetName"`: The name of the receipt rule set to make active. Setting this value to
null disables all email receiving.
"""
function set_active_receipt_rule_set(; aws_config::AbstractAWSConfig=global_aws_config())
return ses(
"SetActiveReceiptRuleSet"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function set_active_receipt_rule_set(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"SetActiveReceiptRuleSet",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_identity_dkim_enabled(dkim_enabled, identity)
set_identity_dkim_enabled(dkim_enabled, identity, params::Dict{String,<:Any})
Enables or disables Easy DKIM signing of email sent from an identity. If Easy DKIM signing
is enabled for a domain, then Amazon SES uses DKIM to sign all email that it sends from
addresses on that domain. If Easy DKIM signing is enabled for an email address, then Amazon
SES uses DKIM to sign all email it sends from that address. For email addresses (for
example, [email protected]), you can only enable DKIM signing if the corresponding domain
(in this case, example.com) has been set up to use Easy DKIM. You can enable DKIM signing
for an identity at any time after you start the verification process for the identity, even
if the verification process isn't complete. You can execute this operation no more than
once per second. For more information about Easy DKIM signing, go to the Amazon SES
Developer Guide.
# Arguments
- `dkim_enabled`: Sets whether DKIM signing is enabled for an identity. Set to true to
enable DKIM signing for this identity; false to disable it.
- `identity`: The identity for which DKIM signing should be enabled or disabled.
"""
function set_identity_dkim_enabled(
DkimEnabled, Identity; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"SetIdentityDkimEnabled",
Dict{String,Any}("DkimEnabled" => DkimEnabled, "Identity" => Identity);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_identity_dkim_enabled(
DkimEnabled,
Identity,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"SetIdentityDkimEnabled",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DkimEnabled" => DkimEnabled, "Identity" => Identity),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_identity_feedback_forwarding_enabled(forwarding_enabled, identity)
set_identity_feedback_forwarding_enabled(forwarding_enabled, identity, params::Dict{String,<:Any})
Given an identity (an email address or a domain), enables or disables whether Amazon SES
forwards bounce and complaint notifications as email. Feedback forwarding can only be
disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both
bounces and complaints. Feedback forwarding does not apply to delivery notifications.
Delivery notifications are only available through Amazon SNS. You can execute this
operation no more than once per second. For more information about using notifications with
Amazon SES, see the Amazon SES Developer Guide.
# Arguments
- `forwarding_enabled`: Sets whether Amazon SES forwards bounce and complaint notifications
as email. true specifies that Amazon SES forwards bounce and complaint notifications as
email, in addition to any Amazon SNS topic publishing otherwise specified. false specifies
that Amazon SES publishes bounce and complaint notifications only through Amazon SNS. This
value can only be set to false when Amazon SNS topics are set for both Bounce and Complaint
notification types.
- `identity`: The identity for which to set bounce and complaint notification forwarding.
Examples: [email protected], example.com.
"""
function set_identity_feedback_forwarding_enabled(
ForwardingEnabled, Identity; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"SetIdentityFeedbackForwardingEnabled",
Dict{String,Any}("ForwardingEnabled" => ForwardingEnabled, "Identity" => Identity);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_identity_feedback_forwarding_enabled(
ForwardingEnabled,
Identity,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"SetIdentityFeedbackForwardingEnabled",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ForwardingEnabled" => ForwardingEnabled, "Identity" => Identity
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_identity_headers_in_notifications_enabled(enabled, identity, notification_type)
set_identity_headers_in_notifications_enabled(enabled, identity, notification_type, params::Dict{String,<:Any})
Given an identity (an email address or a domain), sets whether Amazon SES includes the
original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications
of a specified type. You can execute this operation no more than once per second. For more
information about using notifications with Amazon SES, see the Amazon SES Developer Guide.
# Arguments
- `enabled`: Sets whether Amazon SES includes the original email headers in Amazon SNS
notifications of the specified notification type. A value of true specifies that Amazon SES
includes headers in notifications, and a value of false specifies that Amazon SES does not
include headers in notifications. This value can only be set when NotificationType is
already set to use a particular Amazon SNS topic.
- `identity`: The identity for which to enable or disable headers in notifications.
Examples: [email protected], example.com.
- `notification_type`: The notification type for which to enable or disable headers in
notifications.
"""
function set_identity_headers_in_notifications_enabled(
Enabled, Identity, NotificationType; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"SetIdentityHeadersInNotificationsEnabled",
Dict{String,Any}(
"Enabled" => Enabled,
"Identity" => Identity,
"NotificationType" => NotificationType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_identity_headers_in_notifications_enabled(
Enabled,
Identity,
NotificationType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"SetIdentityHeadersInNotificationsEnabled",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Enabled" => Enabled,
"Identity" => Identity,
"NotificationType" => NotificationType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_identity_mail_from_domain(identity)
set_identity_mail_from_domain(identity, params::Dict{String,<:Any})
Enables or disables the custom MAIL FROM domain setup for a verified identity (an email
address or a domain). To send emails using the specified MAIL FROM domain, you must add an
MX record to your MAIL FROM domain's DNS settings. To ensure that your emails pass Sender
Policy Framework (SPF) checks, you must also add or update an SPF record. For more
information, see the Amazon SES Developer Guide. You can execute this operation no more
than once per second.
# Arguments
- `identity`: The verified identity.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BehaviorOnMXFailure"`: The action for Amazon SES to take if it cannot successfully read
the required MX record when you send an email. If you choose UseDefaultValue, Amazon SES
uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you choose
RejectMessage, Amazon SES returns a MailFromDomainNotVerified error and not send the email.
The action specified in BehaviorOnMXFailure is taken when the custom MAIL FROM domain setup
is in the Pending, Failed, and TemporaryFailure states.
- `"MailFromDomain"`: The custom MAIL FROM domain for the verified identity to use. The
MAIL FROM domain must 1) be a subdomain of the verified identity, 2) not be used in a
\"From\" address if the MAIL FROM domain is the destination of email feedback forwarding
(for more information, see the Amazon SES Developer Guide), and 3) not be used to receive
emails. A value of null disables the custom MAIL FROM setting for the identity.
"""
function set_identity_mail_from_domain(
Identity; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"SetIdentityMailFromDomain",
Dict{String,Any}("Identity" => Identity);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_identity_mail_from_domain(
Identity,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"SetIdentityMailFromDomain",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Identity" => Identity), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_identity_notification_topic(identity, notification_type)
set_identity_notification_topic(identity, notification_type, params::Dict{String,<:Any})
Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when delivering
notifications. When you use this operation, you specify a verified identity, such as an
email address or domain. When you send an email that uses the chosen identity in the Source
field, Amazon SES sends notifications to the topic you specified. You can send bounce,
complaint, or delivery notifications (or any combination of the three) to the Amazon SNS
topic that you specify. You can execute this operation no more than once per second. For
more information about feedback notification, see the Amazon SES Developer Guide.
# Arguments
- `identity`: The identity (email address or domain) for the Amazon SNS topic. You can
only specify a verified identity for this parameter. You can specify an identity by using
its name or by using its Amazon Resource Name (ARN). The following examples are all valid
identities: [email protected], example.com,
arn:aws:ses:us-east-1:123456789012:identity/example.com.
- `notification_type`: The type of notifications that are published to the specified Amazon
SNS topic.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SnsTopic"`: The Amazon Resource Name (ARN) of the Amazon SNS topic. If the parameter is
omitted from the request or a null value is passed, SnsTopic is cleared and publishing is
disabled.
"""
function set_identity_notification_topic(
Identity, NotificationType; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"SetIdentityNotificationTopic",
Dict{String,Any}("Identity" => Identity, "NotificationType" => NotificationType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_identity_notification_topic(
Identity,
NotificationType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"SetIdentityNotificationTopic",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Identity" => Identity, "NotificationType" => NotificationType
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_receipt_rule_position(rule_name, rule_set_name)
set_receipt_rule_position(rule_name, rule_set_name, params::Dict{String,<:Any})
Sets the position of the specified receipt rule in the receipt rule set. For information
about managing receipt rules, see the Amazon SES Developer Guide. You can execute this
operation no more than once per second.
# Arguments
- `rule_name`: The name of the receipt rule to reposition.
- `rule_set_name`: The name of the receipt rule set that contains the receipt rule to
reposition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"After"`: The name of the receipt rule after which to place the specified receipt rule.
"""
function set_receipt_rule_position(
RuleName, RuleSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"SetReceiptRulePosition",
Dict{String,Any}("RuleName" => RuleName, "RuleSetName" => RuleSetName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_receipt_rule_position(
RuleName,
RuleSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"SetReceiptRulePosition",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("RuleName" => RuleName, "RuleSetName" => RuleSetName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
test_render_template(template_data, template_name)
test_render_template(template_data, template_name, params::Dict{String,<:Any})
Creates a preview of the MIME content of an email when provided with a template and a set
of replacement data. You can execute this operation no more than once per second.
# Arguments
- `template_data`: A list of replacement values to apply to the template. This parameter is
a JSON object, typically consisting of key-value pairs in which the keys correspond to
replacement tags in the email template.
- `template_name`: The name of the template to render.
"""
function test_render_template(
TemplateData, TemplateName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"TestRenderTemplate",
Dict{String,Any}("TemplateData" => TemplateData, "TemplateName" => TemplateName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function test_render_template(
TemplateData,
TemplateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"TestRenderTemplate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TemplateData" => TemplateData, "TemplateName" => TemplateName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_account_sending_enabled()
update_account_sending_enabled(params::Dict{String,<:Any})
Enables or disables email sending across your entire Amazon SES account in the current
Amazon Web Services Region. You can use this operation in conjunction with Amazon
CloudWatch alarms to temporarily pause email sending across your Amazon SES account in a
given Amazon Web Services Region when reputation metrics (such as your bounce or complaint
rates) reach certain thresholds. You can execute this operation no more than once per
second.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Enabled"`: Describes whether email sending is enabled or disabled for your Amazon SES
account in the current Amazon Web Services Region.
"""
function update_account_sending_enabled(; aws_config::AbstractAWSConfig=global_aws_config())
return ses(
"UpdateAccountSendingEnabled";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_account_sending_enabled(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"UpdateAccountSendingEnabled",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_configuration_set_event_destination(configuration_set_name, event_destination)
update_configuration_set_event_destination(configuration_set_name, event_destination, params::Dict{String,<:Any})
Updates the event destination of a configuration set. Event destinations are associated
with configuration sets, which enable you to publish email sending events to Amazon
CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).
For information about using configuration sets, see Monitoring Your Amazon SES Sending
Activity in the Amazon SES Developer Guide. When you create or update an event
destination, you must provide one, and only one, destination. The destination can be Amazon
CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).
You can execute this operation no more than once per second.
# Arguments
- `configuration_set_name`: The name of the configuration set that contains the event
destination.
- `event_destination`: The event destination object.
"""
function update_configuration_set_event_destination(
ConfigurationSetName,
EventDestination;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"UpdateConfigurationSetEventDestination",
Dict{String,Any}(
"ConfigurationSetName" => ConfigurationSetName,
"EventDestination" => EventDestination,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_configuration_set_event_destination(
ConfigurationSetName,
EventDestination,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"UpdateConfigurationSetEventDestination",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigurationSetName" => ConfigurationSetName,
"EventDestination" => EventDestination,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_configuration_set_reputation_metrics_enabled(configuration_set_name, enabled)
update_configuration_set_reputation_metrics_enabled(configuration_set_name, enabled, params::Dict{String,<:Any})
Enables or disables the publishing of reputation metrics for emails sent using a specific
configuration set in a given Amazon Web Services Region. Reputation metrics include bounce
and complaint rates. These metrics are published to Amazon CloudWatch. By using CloudWatch,
you can create alarms when bounce or complaint rates exceed certain thresholds. You can
execute this operation no more than once per second.
# Arguments
- `configuration_set_name`: The name of the configuration set to update.
- `enabled`: Describes whether or not Amazon SES publishes reputation metrics for the
configuration set, such as bounce and complaint rates, to Amazon CloudWatch.
"""
function update_configuration_set_reputation_metrics_enabled(
ConfigurationSetName, Enabled; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"UpdateConfigurationSetReputationMetricsEnabled",
Dict{String,Any}(
"ConfigurationSetName" => ConfigurationSetName, "Enabled" => Enabled
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_configuration_set_reputation_metrics_enabled(
ConfigurationSetName,
Enabled,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"UpdateConfigurationSetReputationMetricsEnabled",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigurationSetName" => ConfigurationSetName, "Enabled" => Enabled
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_configuration_set_sending_enabled(configuration_set_name, enabled)
update_configuration_set_sending_enabled(configuration_set_name, enabled, params::Dict{String,<:Any})
Enables or disables email sending for messages sent using a specific configuration set in a
given Amazon Web Services Region. You can use this operation in conjunction with Amazon
CloudWatch alarms to temporarily pause email sending for a configuration set when the
reputation metrics for that configuration set (such as your bounce on complaint rate)
exceed certain thresholds. You can execute this operation no more than once per second.
# Arguments
- `configuration_set_name`: The name of the configuration set to update.
- `enabled`: Describes whether email sending is enabled or disabled for the configuration
set.
"""
function update_configuration_set_sending_enabled(
ConfigurationSetName, Enabled; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"UpdateConfigurationSetSendingEnabled",
Dict{String,Any}(
"ConfigurationSetName" => ConfigurationSetName, "Enabled" => Enabled
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_configuration_set_sending_enabled(
ConfigurationSetName,
Enabled,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"UpdateConfigurationSetSendingEnabled",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigurationSetName" => ConfigurationSetName, "Enabled" => Enabled
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_configuration_set_tracking_options(configuration_set_name, tracking_options)
update_configuration_set_tracking_options(configuration_set_name, tracking_options, params::Dict{String,<:Any})
Modifies an association between a configuration set and a custom domain for open and click
event tracking. By default, images and links used for tracking open and click events are
hosted on domains operated by Amazon SES. You can configure a subdomain of your own to
handle these events. For information about using custom domains, see the Amazon SES
Developer Guide.
# Arguments
- `configuration_set_name`: The name of the configuration set.
- `tracking_options`:
"""
function update_configuration_set_tracking_options(
ConfigurationSetName, TrackingOptions; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"UpdateConfigurationSetTrackingOptions",
Dict{String,Any}(
"ConfigurationSetName" => ConfigurationSetName,
"TrackingOptions" => TrackingOptions,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_configuration_set_tracking_options(
ConfigurationSetName,
TrackingOptions,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"UpdateConfigurationSetTrackingOptions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigurationSetName" => ConfigurationSetName,
"TrackingOptions" => TrackingOptions,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_custom_verification_email_template(template_name)
update_custom_verification_email_template(template_name, params::Dict{String,<:Any})
Updates an existing custom verification email template. For more information about custom
verification email templates, see Using Custom Verification Email Templates in the Amazon
SES Developer Guide. You can execute this operation no more than once per second.
# Arguments
- `template_name`: The name of the custom verification email template to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FailureRedirectionURL"`: The URL that the recipient of the verification email is sent
to if his or her address is not successfully verified.
- `"FromEmailAddress"`: The email address that the custom verification email is sent from.
- `"SuccessRedirectionURL"`: The URL that the recipient of the verification email is sent
to if his or her address is successfully verified.
- `"TemplateContent"`: The content of the custom verification email. The total size of the
email must be less than 10 MB. The message body may contain HTML, with some limitations.
For more information, see Custom Verification Email Frequently Asked Questions in the
Amazon SES Developer Guide.
- `"TemplateSubject"`: The subject line of the custom verification email.
"""
function update_custom_verification_email_template(
TemplateName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"UpdateCustomVerificationEmailTemplate",
Dict{String,Any}("TemplateName" => TemplateName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_custom_verification_email_template(
TemplateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"UpdateCustomVerificationEmailTemplate",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TemplateName" => TemplateName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_receipt_rule(rule, rule_set_name)
update_receipt_rule(rule, rule_set_name, params::Dict{String,<:Any})
Updates a receipt rule. For information about managing receipt rules, see the Amazon SES
Developer Guide. You can execute this operation no more than once per second.
# Arguments
- `rule`: A data structure that contains the updated receipt rule information.
- `rule_set_name`: The name of the receipt rule set that the receipt rule belongs to.
"""
function update_receipt_rule(
Rule, RuleSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"UpdateReceiptRule",
Dict{String,Any}("Rule" => Rule, "RuleSetName" => RuleSetName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_receipt_rule(
Rule,
RuleSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"UpdateReceiptRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Rule" => Rule, "RuleSetName" => RuleSetName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_template(template)
update_template(template, params::Dict{String,<:Any})
Updates an email template. Email templates enable you to send personalized email to one or
more destinations in a single operation. For more information, see the Amazon SES Developer
Guide. You can execute this operation no more than once per second.
# Arguments
- `template`:
"""
function update_template(Template; aws_config::AbstractAWSConfig=global_aws_config())
return ses(
"UpdateTemplate",
Dict{String,Any}("Template" => Template);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_template(
Template,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"UpdateTemplate",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Template" => Template), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
verify_domain_dkim(domain)
verify_domain_dkim(domain, params::Dict{String,<:Any})
Returns a set of DKIM tokens for a domain identity. When you execute the VerifyDomainDkim
operation, the domain that you specify is added to the list of identities that are
associated with your account. This is true even if you haven't already associated the
domain with your account by using the VerifyDomainIdentity operation. However, you can't
send email from the domain until you either successfully verify it or you successfully set
up DKIM for it. You use the tokens that are generated by this operation to create CNAME
records. When Amazon SES detects that you've added these records to the DNS configuration
for a domain, you can start sending email from that domain. You can start sending email
even if you haven't added the TXT record provided by the VerifyDomainIdentity operation to
the DNS configuration for your domain. All email that you send from the domain is
authenticated using DKIM. To create the CNAME records for DKIM authentication, use the
following values: Name: token._domainkey.example.com Type: CNAME Value:
token.dkim.amazonses.com In the preceding example, replace token with one of the tokens
that are generated when you execute this operation. Replace example.com with your domain.
Repeat this process for each token that's generated by this operation. You can execute this
operation no more than once per second.
# Arguments
- `domain`: The name of the domain to be verified for Easy DKIM signing.
"""
function verify_domain_dkim(Domain; aws_config::AbstractAWSConfig=global_aws_config())
return ses(
"VerifyDomainDkim",
Dict{String,Any}("Domain" => Domain);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function verify_domain_dkim(
Domain, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"VerifyDomainDkim",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Domain" => Domain), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
verify_domain_identity(domain)
verify_domain_identity(domain, params::Dict{String,<:Any})
Adds a domain to the list of identities for your Amazon SES account in the current Amazon
Web Services Region and attempts to verify it. For more information about verifying
domains, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide. You
can execute this operation no more than once per second.
# Arguments
- `domain`: The domain to be verified.
"""
function verify_domain_identity(Domain; aws_config::AbstractAWSConfig=global_aws_config())
return ses(
"VerifyDomainIdentity",
Dict{String,Any}("Domain" => Domain);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function verify_domain_identity(
Domain, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"VerifyDomainIdentity",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Domain" => Domain), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
verify_email_address(email_address)
verify_email_address(email_address, params::Dict{String,<:Any})
Deprecated. Use the VerifyEmailIdentity operation to verify a new email address.
# Arguments
- `email_address`: The email address to be verified.
"""
function verify_email_address(
EmailAddress; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"VerifyEmailAddress",
Dict{String,Any}("EmailAddress" => EmailAddress);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function verify_email_address(
EmailAddress,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"VerifyEmailAddress",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EmailAddress" => EmailAddress), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
verify_email_identity(email_address)
verify_email_identity(email_address, params::Dict{String,<:Any})
Adds an email address to the list of identities for your Amazon SES account in the current
Amazon Web Services Region and attempts to verify it. As a result of executing this
operation, a verification email is sent to the specified address. You can execute this
operation no more than once per second.
# Arguments
- `email_address`: The email address to be verified.
"""
function verify_email_identity(
EmailAddress; aws_config::AbstractAWSConfig=global_aws_config()
)
return ses(
"VerifyEmailIdentity",
Dict{String,Any}("EmailAddress" => EmailAddress);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function verify_email_identity(
EmailAddress,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ses(
"VerifyEmailIdentity",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EmailAddress" => EmailAddress), 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 | 140357 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: sesv2
using AWS.Compat
using AWS.UUIDs
"""
batch_get_metric_data(queries)
batch_get_metric_data(queries, params::Dict{String,<:Any})
Retrieves batches of metric data collected based on your sending activity. You can execute
this operation no more than 16 times per second, and with at most 160 queries from the
batches per second (cumulative).
# Arguments
- `queries`: A list of queries for metrics to be retrieved.
"""
function batch_get_metric_data(Queries; aws_config::AbstractAWSConfig=global_aws_config())
return sesv2(
"POST",
"/v2/email/metrics/batch",
Dict{String,Any}("Queries" => Queries);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_metric_data(
Queries, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"POST",
"/v2/email/metrics/batch",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Queries" => Queries), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_export_job(job_id)
cancel_export_job(job_id, params::Dict{String,<:Any})
Cancels an export job.
# Arguments
- `job_id`: The export job ID.
"""
function cancel_export_job(JobId; aws_config::AbstractAWSConfig=global_aws_config())
return sesv2(
"PUT",
"/v2/email/export-jobs/$(JobId)/cancel";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_export_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"PUT",
"/v2/email/export-jobs/$(JobId)/cancel",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_configuration_set(configuration_set_name)
create_configuration_set(configuration_set_name, params::Dict{String,<:Any})
Create a configuration set. Configuration sets are groups of rules that you can apply to
the emails that you send. You apply a configuration set to an email by specifying the name
of the configuration set when you call the Amazon SES API v2. When you apply a
configuration set to an email, all of the rules in that configuration set are applied to
the email.
# Arguments
- `configuration_set_name`: The name of the configuration set. The name can contain up to
64 alphanumeric characters, including letters, numbers, hyphens (-) and underscores (_)
only.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeliveryOptions"`: An object that defines the dedicated IP pool that is used to send
emails that you send using the configuration set.
- `"ReputationOptions"`: An object that defines whether or not Amazon SES collects
reputation metrics for the emails that you send that use the configuration set.
- `"SendingOptions"`: An object that defines whether or not Amazon SES can send email that
you send using the configuration set.
- `"SuppressionOptions"`:
- `"Tags"`: An array of objects that define the tags (keys and values) to associate with
the configuration set.
- `"TrackingOptions"`: An object that defines the open and click tracking options for
emails that you send using the configuration set.
- `"VdmOptions"`: An object that defines the VDM options for emails that you send using the
configuration set.
"""
function create_configuration_set(
ConfigurationSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"POST",
"/v2/email/configuration-sets",
Dict{String,Any}("ConfigurationSetName" => ConfigurationSetName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_configuration_set(
ConfigurationSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"POST",
"/v2/email/configuration-sets",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ConfigurationSetName" => ConfigurationSetName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_configuration_set_event_destination(configuration_set_name, event_destination, event_destination_name)
create_configuration_set_event_destination(configuration_set_name, event_destination, event_destination_name, params::Dict{String,<:Any})
Create an event destination. Events include message sends, deliveries, opens, clicks,
bounces, and complaints. Event destinations are places that you can send information about
these events to. For example, you can send event data to Amazon EventBridge and associate a
rule to send the event to the specified target. A single configuration set can include more
than one event destination.
# Arguments
- `configuration_set_name`: The name of the configuration set .
- `event_destination`: An object that defines the event destination.
- `event_destination_name`: A name that identifies the event destination within the
configuration set.
"""
function create_configuration_set_event_destination(
ConfigurationSetName,
EventDestination,
EventDestinationName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"POST",
"/v2/email/configuration-sets/$(ConfigurationSetName)/event-destinations",
Dict{String,Any}(
"EventDestination" => EventDestination,
"EventDestinationName" => EventDestinationName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_configuration_set_event_destination(
ConfigurationSetName,
EventDestination,
EventDestinationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"POST",
"/v2/email/configuration-sets/$(ConfigurationSetName)/event-destinations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EventDestination" => EventDestination,
"EventDestinationName" => EventDestinationName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_contact(contact_list_name, email_address)
create_contact(contact_list_name, email_address, params::Dict{String,<:Any})
Creates a contact, which is an end-user who is receiving the email, and adds them to a
contact list.
# Arguments
- `contact_list_name`: The name of the contact list to which the contact should be added.
- `email_address`: The contact's email address.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AttributesData"`: The attribute data attached to a contact.
- `"TopicPreferences"`: The contact's preferences for being opted-in to or opted-out of
topics.
- `"UnsubscribeAll"`: A boolean value status noting if the contact is unsubscribed from all
contact list topics.
"""
function create_contact(
ContactListName, EmailAddress; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"POST",
"/v2/email/contact-lists/$(ContactListName)/contacts",
Dict{String,Any}("EmailAddress" => EmailAddress);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_contact(
ContactListName,
EmailAddress,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"POST",
"/v2/email/contact-lists/$(ContactListName)/contacts",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EmailAddress" => EmailAddress), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_contact_list(contact_list_name)
create_contact_list(contact_list_name, params::Dict{String,<:Any})
Creates a contact list.
# Arguments
- `contact_list_name`: The name of the contact list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of what the contact list is about.
- `"Tags"`: The tags associated with a contact list.
- `"Topics"`: An interest group, theme, or label within a list. A contact list can have
multiple topics.
"""
function create_contact_list(
ContactListName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"POST",
"/v2/email/contact-lists",
Dict{String,Any}("ContactListName" => ContactListName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_contact_list(
ContactListName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"POST",
"/v2/email/contact-lists",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ContactListName" => ContactListName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_custom_verification_email_template(failure_redirection_url, from_email_address, success_redirection_url, template_content, template_name, template_subject)
create_custom_verification_email_template(failure_redirection_url, from_email_address, success_redirection_url, template_content, template_name, template_subject, params::Dict{String,<:Any})
Creates a new custom verification email template. For more information about custom
verification email templates, see Using custom verification email templates in the Amazon
SES Developer Guide. You can execute this operation no more than once per second.
# Arguments
- `failure_redirection_url`: The URL that the recipient of the verification email is sent
to if his or her address is not successfully verified.
- `from_email_address`: The email address that the custom verification email is sent from.
- `success_redirection_url`: The URL that the recipient of the verification email is sent
to if his or her address is successfully verified.
- `template_content`: The content of the custom verification email. The total size of the
email must be less than 10 MB. The message body may contain HTML, with some limitations.
For more information, see Custom verification email frequently asked questions in the
Amazon SES Developer Guide.
- `template_name`: The name of the custom verification email template.
- `template_subject`: The subject line of the custom verification email.
"""
function create_custom_verification_email_template(
FailureRedirectionURL,
FromEmailAddress,
SuccessRedirectionURL,
TemplateContent,
TemplateName,
TemplateSubject;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"POST",
"/v2/email/custom-verification-email-templates",
Dict{String,Any}(
"FailureRedirectionURL" => FailureRedirectionURL,
"FromEmailAddress" => FromEmailAddress,
"SuccessRedirectionURL" => SuccessRedirectionURL,
"TemplateContent" => TemplateContent,
"TemplateName" => TemplateName,
"TemplateSubject" => TemplateSubject,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_custom_verification_email_template(
FailureRedirectionURL,
FromEmailAddress,
SuccessRedirectionURL,
TemplateContent,
TemplateName,
TemplateSubject,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"POST",
"/v2/email/custom-verification-email-templates",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FailureRedirectionURL" => FailureRedirectionURL,
"FromEmailAddress" => FromEmailAddress,
"SuccessRedirectionURL" => SuccessRedirectionURL,
"TemplateContent" => TemplateContent,
"TemplateName" => TemplateName,
"TemplateSubject" => TemplateSubject,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dedicated_ip_pool(pool_name)
create_dedicated_ip_pool(pool_name, params::Dict{String,<:Any})
Create a new pool of dedicated IP addresses. A pool can include one or more dedicated IP
addresses that are associated with your Amazon Web Services account. You can associate a
pool with a configuration set. When you send an email that uses that configuration set, the
message is sent from one of the addresses in the associated pool.
# Arguments
- `pool_name`: The name of the dedicated IP pool.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ScalingMode"`: The type of scaling mode.
- `"Tags"`: An object that defines the tags (keys and values) that you want to associate
with the pool.
"""
function create_dedicated_ip_pool(
PoolName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"POST",
"/v2/email/dedicated-ip-pools",
Dict{String,Any}("PoolName" => PoolName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dedicated_ip_pool(
PoolName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"POST",
"/v2/email/dedicated-ip-pools",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PoolName" => PoolName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_deliverability_test_report(content, from_email_address)
create_deliverability_test_report(content, from_email_address, params::Dict{String,<:Any})
Create a new predictive inbox placement test. Predictive inbox placement tests can help you
predict how your messages will be handled by various email providers around the world. When
you perform a predictive inbox placement test, you provide a sample message that contains
the content that you plan to send to your customers. Amazon SES then sends that message to
special email addresses spread across several major email providers. After about 24 hours,
the test is complete, and you can use the GetDeliverabilityTestReport operation to view the
results of the test.
# Arguments
- `content`: The HTML body of the message that you sent when you performed the predictive
inbox placement test.
- `from_email_address`: The email address that the predictive inbox placement test email
was sent from.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ReportName"`: A unique name that helps you to identify the predictive inbox placement
test when you retrieve the results.
- `"Tags"`: An array of objects that define the tags (keys and values) that you want to
associate with the predictive inbox placement test.
"""
function create_deliverability_test_report(
Content, FromEmailAddress; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"POST",
"/v2/email/deliverability-dashboard/test",
Dict{String,Any}("Content" => Content, "FromEmailAddress" => FromEmailAddress);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_deliverability_test_report(
Content,
FromEmailAddress,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"POST",
"/v2/email/deliverability-dashboard/test",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Content" => Content, "FromEmailAddress" => FromEmailAddress
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_email_identity(email_identity)
create_email_identity(email_identity, params::Dict{String,<:Any})
Starts the process of verifying an email identity. An identity is an email address or
domain that you use when you send email. Before you can use an identity to send email, you
first have to verify it. By verifying an identity, you demonstrate that you're the owner of
the identity, and that you've given Amazon SES API v2 permission to send email from the
identity. When you verify an email address, Amazon SES sends an email to the address. Your
email address is verified as soon as you follow the link in the verification email. When
you verify a domain without specifying the DkimSigningAttributes object, this operation
provides a set of DKIM tokens. You can convert these tokens into CNAME records, which you
then add to the DNS configuration for your domain. Your domain is verified when Amazon SES
detects these records in the DNS configuration for your domain. This verification method is
known as Easy DKIM. Alternatively, you can perform the verification process by providing
your own public-private key pair. This verification method is known as Bring Your Own DKIM
(BYODKIM). To use BYODKIM, your call to the CreateEmailIdentity operation has to include
the DkimSigningAttributes object. When you specify this object, you provide a selector (a
component of the DNS record name that identifies the public key to use for DKIM
authentication) and a private key. When you verify a domain, this operation provides a set
of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the
DNS configuration for your domain. Your domain is verified when Amazon SES detects these
records in the DNS configuration for your domain. For some DNS providers, it can take 72
hours or more to complete the domain verification process. Additionally, you can associate
an existing configuration set with the email identity that you're verifying.
# Arguments
- `email_identity`: The email address or domain to verify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConfigurationSetName"`: The configuration set to use by default when sending from this
identity. Note that any configuration set defined in the email sending request takes
precedence.
- `"DkimSigningAttributes"`: If your request includes this object, Amazon SES configures
the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or,
configures the key length to be used for Easy DKIM. You can only specify this object if the
email identity is a domain, as opposed to an address.
- `"Tags"`: An array of objects that define the tags (keys and values) to associate with
the email identity.
"""
function create_email_identity(
EmailIdentity; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"POST",
"/v2/email/identities",
Dict{String,Any}("EmailIdentity" => EmailIdentity);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_email_identity(
EmailIdentity,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"POST",
"/v2/email/identities",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EmailIdentity" => EmailIdentity), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_email_identity_policy(email_identity, policy, policy_name)
create_email_identity_policy(email_identity, policy, policy_name, params::Dict{String,<:Any})
Creates the specified sending authorization policy for the given identity (an email address
or a domain). This API is for the identity owner only. If you have not verified the
identity, this API will return an error. Sending authorization is a feature that enables
an identity owner to authorize other senders to use its identities. For information about
using sending authorization, see the Amazon SES Developer Guide. You can execute this
operation no more than once per second.
# Arguments
- `email_identity`: The email identity.
- `policy`: The text of the policy in JSON format. The policy cannot exceed 4 KB. For
information about the syntax of sending authorization policies, see the Amazon SES
Developer Guide.
- `policy_name`: The name of the policy. The policy name cannot exceed 64 characters and
can only include alphanumeric characters, dashes, and underscores.
"""
function create_email_identity_policy(
EmailIdentity, Policy, PolicyName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"POST",
"/v2/email/identities/$(EmailIdentity)/policies/$(PolicyName)",
Dict{String,Any}("Policy" => Policy);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_email_identity_policy(
EmailIdentity,
Policy,
PolicyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"POST",
"/v2/email/identities/$(EmailIdentity)/policies/$(PolicyName)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Policy" => Policy), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_email_template(template_content, template_name)
create_email_template(template_content, template_name, params::Dict{String,<:Any})
Creates an email template. Email templates enable you to send personalized email to one or
more destinations in a single API operation. For more information, see the Amazon SES
Developer Guide. You can execute this operation no more than once per second.
# Arguments
- `template_content`: The content of the email template, composed of a subject line, an
HTML part, and a text-only part.
- `template_name`: The name of the template.
"""
function create_email_template(
TemplateContent, TemplateName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"POST",
"/v2/email/templates",
Dict{String,Any}(
"TemplateContent" => TemplateContent, "TemplateName" => TemplateName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_email_template(
TemplateContent,
TemplateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"POST",
"/v2/email/templates",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TemplateContent" => TemplateContent, "TemplateName" => TemplateName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_export_job(export_data_source, export_destination)
create_export_job(export_data_source, export_destination, params::Dict{String,<:Any})
Creates an export job for a data source and destination. You can execute this operation no
more than once per second.
# Arguments
- `export_data_source`: The data source for the export job.
- `export_destination`: The destination for the export job.
"""
function create_export_job(
ExportDataSource, ExportDestination; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"POST",
"/v2/email/export-jobs",
Dict{String,Any}(
"ExportDataSource" => ExportDataSource, "ExportDestination" => ExportDestination
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_export_job(
ExportDataSource,
ExportDestination,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"POST",
"/v2/email/export-jobs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ExportDataSource" => ExportDataSource,
"ExportDestination" => ExportDestination,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_import_job(import_data_source, import_destination)
create_import_job(import_data_source, import_destination, params::Dict{String,<:Any})
Creates an import job for a data destination.
# Arguments
- `import_data_source`: The data source for the import job.
- `import_destination`: The destination for the import job.
"""
function create_import_job(
ImportDataSource, ImportDestination; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"POST",
"/v2/email/import-jobs",
Dict{String,Any}(
"ImportDataSource" => ImportDataSource, "ImportDestination" => ImportDestination
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_import_job(
ImportDataSource,
ImportDestination,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"POST",
"/v2/email/import-jobs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ImportDataSource" => ImportDataSource,
"ImportDestination" => ImportDestination,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_configuration_set(configuration_set_name)
delete_configuration_set(configuration_set_name, params::Dict{String,<:Any})
Delete an existing configuration set. Configuration sets are groups of rules that you can
apply to the emails you send. You apply a configuration set to an email by including a
reference to the configuration set in the headers of the email. When you apply a
configuration set to an email, all of the rules in that configuration set are applied to
the email.
# Arguments
- `configuration_set_name`: The name of the configuration set.
"""
function delete_configuration_set(
ConfigurationSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"DELETE",
"/v2/email/configuration-sets/$(ConfigurationSetName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_configuration_set(
ConfigurationSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"DELETE",
"/v2/email/configuration-sets/$(ConfigurationSetName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_configuration_set_event_destination(configuration_set_name, event_destination_name)
delete_configuration_set_event_destination(configuration_set_name, event_destination_name, params::Dict{String,<:Any})
Delete an event destination. Events include message sends, deliveries, opens, clicks,
bounces, and complaints. Event destinations are places that you can send information about
these events to. For example, you can send event data to Amazon EventBridge and associate a
rule to send the event to the specified target.
# Arguments
- `configuration_set_name`: The name of the configuration set that contains the event
destination to delete.
- `event_destination_name`: The name of the event destination to delete.
"""
function delete_configuration_set_event_destination(
ConfigurationSetName,
EventDestinationName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"DELETE",
"/v2/email/configuration-sets/$(ConfigurationSetName)/event-destinations/$(EventDestinationName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_configuration_set_event_destination(
ConfigurationSetName,
EventDestinationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"DELETE",
"/v2/email/configuration-sets/$(ConfigurationSetName)/event-destinations/$(EventDestinationName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_contact(contact_list_name, email_address)
delete_contact(contact_list_name, email_address, params::Dict{String,<:Any})
Removes a contact from a contact list.
# Arguments
- `contact_list_name`: The name of the contact list from which the contact should be
removed.
- `email_address`: The contact's email address.
"""
function delete_contact(
ContactListName, EmailAddress; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"DELETE",
"/v2/email/contact-lists/$(ContactListName)/contacts/$(EmailAddress)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_contact(
ContactListName,
EmailAddress,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"DELETE",
"/v2/email/contact-lists/$(ContactListName)/contacts/$(EmailAddress)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_contact_list(contact_list_name)
delete_contact_list(contact_list_name, params::Dict{String,<:Any})
Deletes a contact list and all of the contacts on that list.
# Arguments
- `contact_list_name`: The name of the contact list.
"""
function delete_contact_list(
ContactListName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"DELETE",
"/v2/email/contact-lists/$(ContactListName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_contact_list(
ContactListName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"DELETE",
"/v2/email/contact-lists/$(ContactListName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_custom_verification_email_template(template_name)
delete_custom_verification_email_template(template_name, params::Dict{String,<:Any})
Deletes an existing custom verification email template. For more information about custom
verification email templates, see Using custom verification email templates in the Amazon
SES Developer Guide. You can execute this operation no more than once per second.
# Arguments
- `template_name`: The name of the custom verification email template that you want to
delete.
"""
function delete_custom_verification_email_template(
TemplateName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"DELETE",
"/v2/email/custom-verification-email-templates/$(TemplateName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_custom_verification_email_template(
TemplateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"DELETE",
"/v2/email/custom-verification-email-templates/$(TemplateName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dedicated_ip_pool(pool_name)
delete_dedicated_ip_pool(pool_name, params::Dict{String,<:Any})
Delete a dedicated IP pool.
# Arguments
- `pool_name`: The name of the dedicated IP pool that you want to delete.
"""
function delete_dedicated_ip_pool(
PoolName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"DELETE",
"/v2/email/dedicated-ip-pools/$(PoolName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_dedicated_ip_pool(
PoolName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"DELETE",
"/v2/email/dedicated-ip-pools/$(PoolName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_email_identity(email_identity)
delete_email_identity(email_identity, params::Dict{String,<:Any})
Deletes an email identity. An identity can be either an email address or a domain name.
# Arguments
- `email_identity`: The identity (that is, the email address or domain) to delete.
"""
function delete_email_identity(
EmailIdentity; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"DELETE",
"/v2/email/identities/$(EmailIdentity)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_email_identity(
EmailIdentity,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"DELETE",
"/v2/email/identities/$(EmailIdentity)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_email_identity_policy(email_identity, policy_name)
delete_email_identity_policy(email_identity, policy_name, params::Dict{String,<:Any})
Deletes the specified sending authorization policy for the given identity (an email address
or a domain). This API returns successfully even if a policy with the specified name does
not exist. This API is for the identity owner only. If you have not verified the identity,
this API will return an error. Sending authorization is a feature that enables an identity
owner to authorize other senders to use its identities. For information about using sending
authorization, see the Amazon SES Developer Guide. You can execute this operation no more
than once per second.
# Arguments
- `email_identity`: The email identity.
- `policy_name`: The name of the policy. The policy name cannot exceed 64 characters and
can only include alphanumeric characters, dashes, and underscores.
"""
function delete_email_identity_policy(
EmailIdentity, PolicyName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"DELETE",
"/v2/email/identities/$(EmailIdentity)/policies/$(PolicyName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_email_identity_policy(
EmailIdentity,
PolicyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"DELETE",
"/v2/email/identities/$(EmailIdentity)/policies/$(PolicyName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_email_template(template_name)
delete_email_template(template_name, params::Dict{String,<:Any})
Deletes an email template. You can execute this operation no more than once per second.
# Arguments
- `template_name`: The name of the template to be deleted.
"""
function delete_email_template(
TemplateName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"DELETE",
"/v2/email/templates/$(TemplateName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_email_template(
TemplateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"DELETE",
"/v2/email/templates/$(TemplateName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_suppressed_destination(email_address)
delete_suppressed_destination(email_address, params::Dict{String,<:Any})
Removes an email address from the suppression list for your account.
# Arguments
- `email_address`: The suppressed email destination to remove from the account suppression
list.
"""
function delete_suppressed_destination(
EmailAddress; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"DELETE",
"/v2/email/suppression/addresses/$(EmailAddress)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_suppressed_destination(
EmailAddress,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"DELETE",
"/v2/email/suppression/addresses/$(EmailAddress)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_account()
get_account(params::Dict{String,<:Any})
Obtain information about the email-sending status and capabilities of your Amazon SES
account in the current Amazon Web Services Region.
"""
function get_account(; aws_config::AbstractAWSConfig=global_aws_config())
return sesv2(
"GET", "/v2/email/account"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_account(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"GET",
"/v2/email/account",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_blacklist_reports(blacklist_item_names)
get_blacklist_reports(blacklist_item_names, params::Dict{String,<:Any})
Retrieve a list of the blacklists that your dedicated IP addresses appear on.
# Arguments
- `blacklist_item_names`: A list of IP addresses that you want to retrieve blacklist
information about. You can only specify the dedicated IP addresses that you use to send
email using Amazon SES or Amazon Pinpoint.
"""
function get_blacklist_reports(
BlacklistItemNames; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"GET",
"/v2/email/deliverability-dashboard/blacklist-report",
Dict{String,Any}("BlacklistItemNames" => BlacklistItemNames);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_blacklist_reports(
BlacklistItemNames,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"GET",
"/v2/email/deliverability-dashboard/blacklist-report",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("BlacklistItemNames" => BlacklistItemNames), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_configuration_set(configuration_set_name)
get_configuration_set(configuration_set_name, params::Dict{String,<:Any})
Get information about an existing configuration set, including the dedicated IP pool that
it's associated with, whether or not it's enabled for sending email, and more.
Configuration sets are groups of rules that you can apply to the emails you send. You apply
a configuration set to an email by including a reference to the configuration set in the
headers of the email. When you apply a configuration set to an email, all of the rules in
that configuration set are applied to the email.
# Arguments
- `configuration_set_name`: The name of the configuration set.
"""
function get_configuration_set(
ConfigurationSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"GET",
"/v2/email/configuration-sets/$(ConfigurationSetName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_configuration_set(
ConfigurationSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"GET",
"/v2/email/configuration-sets/$(ConfigurationSetName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_configuration_set_event_destinations(configuration_set_name)
get_configuration_set_event_destinations(configuration_set_name, params::Dict{String,<:Any})
Retrieve a list of event destinations that are associated with a configuration set. Events
include message sends, deliveries, opens, clicks, bounces, and complaints. Event
destinations are places that you can send information about these events to. For example,
you can send event data to Amazon EventBridge and associate a rule to send the event to the
specified target.
# Arguments
- `configuration_set_name`: The name of the configuration set that contains the event
destination.
"""
function get_configuration_set_event_destinations(
ConfigurationSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"GET",
"/v2/email/configuration-sets/$(ConfigurationSetName)/event-destinations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_configuration_set_event_destinations(
ConfigurationSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"GET",
"/v2/email/configuration-sets/$(ConfigurationSetName)/event-destinations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_contact(contact_list_name, email_address)
get_contact(contact_list_name, email_address, params::Dict{String,<:Any})
Returns a contact from a contact list.
# Arguments
- `contact_list_name`: The name of the contact list to which the contact belongs.
- `email_address`: The contact's email address.
"""
function get_contact(
ContactListName, EmailAddress; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"GET",
"/v2/email/contact-lists/$(ContactListName)/contacts/$(EmailAddress)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_contact(
ContactListName,
EmailAddress,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"GET",
"/v2/email/contact-lists/$(ContactListName)/contacts/$(EmailAddress)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_contact_list(contact_list_name)
get_contact_list(contact_list_name, params::Dict{String,<:Any})
Returns contact list metadata. It does not return any information about the contacts
present in the list.
# Arguments
- `contact_list_name`: The name of the contact list.
"""
function get_contact_list(
ContactListName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"GET",
"/v2/email/contact-lists/$(ContactListName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_contact_list(
ContactListName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"GET",
"/v2/email/contact-lists/$(ContactListName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_custom_verification_email_template(template_name)
get_custom_verification_email_template(template_name, params::Dict{String,<:Any})
Returns the custom email verification template for the template name you specify. For more
information about custom verification email templates, see Using custom verification email
templates in the Amazon SES Developer Guide. You can execute this operation no more than
once per second.
# Arguments
- `template_name`: The name of the custom verification email template that you want to
retrieve.
"""
function get_custom_verification_email_template(
TemplateName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"GET",
"/v2/email/custom-verification-email-templates/$(TemplateName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_custom_verification_email_template(
TemplateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"GET",
"/v2/email/custom-verification-email-templates/$(TemplateName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_dedicated_ip(ip)
get_dedicated_ip(ip, params::Dict{String,<:Any})
Get information about a dedicated IP address, including the name of the dedicated IP pool
that it's associated with, as well information about the automatic warm-up process for the
address.
# Arguments
- `ip`: The IP address that you want to obtain more information about. The value you
specify has to be a dedicated IP address that's assocaited with your Amazon Web Services
account.
"""
function get_dedicated_ip(IP; aws_config::AbstractAWSConfig=global_aws_config())
return sesv2(
"GET",
"/v2/email/dedicated-ips/$(IP)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_dedicated_ip(
IP, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"GET",
"/v2/email/dedicated-ips/$(IP)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_dedicated_ip_pool(pool_name)
get_dedicated_ip_pool(pool_name, params::Dict{String,<:Any})
Retrieve information about the dedicated pool.
# Arguments
- `pool_name`: The name of the dedicated IP pool to retrieve.
"""
function get_dedicated_ip_pool(PoolName; aws_config::AbstractAWSConfig=global_aws_config())
return sesv2(
"GET",
"/v2/email/dedicated-ip-pools/$(PoolName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_dedicated_ip_pool(
PoolName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"GET",
"/v2/email/dedicated-ip-pools/$(PoolName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_dedicated_ips()
get_dedicated_ips(params::Dict{String,<:Any})
List the dedicated IP addresses that are associated with your Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: A token returned from a previous call to GetDedicatedIps to indicate the
position of the dedicated IP pool in the list of IP pools.
- `"PageSize"`: The number of results to show in a single call to GetDedicatedIpsRequest.
If the number of results is larger than the number you specified in this parameter, then
the response includes a NextToken element, which you can use to obtain additional results.
- `"PoolName"`: The name of the IP pool that the dedicated IP address is associated with.
"""
function get_dedicated_ips(; aws_config::AbstractAWSConfig=global_aws_config())
return sesv2(
"GET",
"/v2/email/dedicated-ips";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_dedicated_ips(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"GET",
"/v2/email/dedicated-ips",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_deliverability_dashboard_options()
get_deliverability_dashboard_options(params::Dict{String,<:Any})
Retrieve information about the status of the Deliverability dashboard for your account.
When the Deliverability dashboard is enabled, you gain access to reputation,
deliverability, and other metrics for the domains that you use to send email. You also gain
the ability to perform predictive inbox placement tests. When you use the Deliverability
dashboard, you pay a monthly subscription charge, in addition to any other fees that you
accrue by using Amazon SES and other Amazon Web Services services. For more information
about the features and cost of a Deliverability dashboard subscription, see Amazon SES
Pricing.
"""
function get_deliverability_dashboard_options(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"GET",
"/v2/email/deliverability-dashboard";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_deliverability_dashboard_options(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"GET",
"/v2/email/deliverability-dashboard",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_deliverability_test_report(report_id)
get_deliverability_test_report(report_id, params::Dict{String,<:Any})
Retrieve the results of a predictive inbox placement test.
# Arguments
- `report_id`: A unique string that identifies the predictive inbox placement test.
"""
function get_deliverability_test_report(
ReportId; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"GET",
"/v2/email/deliverability-dashboard/test-reports/$(ReportId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_deliverability_test_report(
ReportId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"GET",
"/v2/email/deliverability-dashboard/test-reports/$(ReportId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_domain_deliverability_campaign(campaign_id)
get_domain_deliverability_campaign(campaign_id, params::Dict{String,<:Any})
Retrieve all the deliverability data for a specific campaign. This data is available for a
campaign only if the campaign sent email by using a domain that the Deliverability
dashboard is enabled for.
# Arguments
- `campaign_id`: The unique identifier for the campaign. The Deliverability dashboard
automatically generates and assigns this identifier to a campaign.
"""
function get_domain_deliverability_campaign(
CampaignId; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"GET",
"/v2/email/deliverability-dashboard/campaigns/$(CampaignId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_domain_deliverability_campaign(
CampaignId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"GET",
"/v2/email/deliverability-dashboard/campaigns/$(CampaignId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_domain_statistics_report(domain, end_date, start_date)
get_domain_statistics_report(domain, end_date, start_date, params::Dict{String,<:Any})
Retrieve inbox placement and engagement rates for the domains that you use to send email.
# Arguments
- `domain`: The domain that you want to obtain deliverability metrics for.
- `end_date`: The last day (in Unix time) that you want to obtain domain deliverability
metrics for. The EndDate that you specify has to be less than or equal to 30 days after the
StartDate.
- `start_date`: The first day (in Unix time) that you want to obtain domain deliverability
metrics for.
"""
function get_domain_statistics_report(
Domain, EndDate, StartDate; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"GET",
"/v2/email/deliverability-dashboard/statistics-report/$(Domain)",
Dict{String,Any}("EndDate" => EndDate, "StartDate" => StartDate);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_domain_statistics_report(
Domain,
EndDate,
StartDate,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"GET",
"/v2/email/deliverability-dashboard/statistics-report/$(Domain)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("EndDate" => EndDate, "StartDate" => StartDate),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_email_identity(email_identity)
get_email_identity(email_identity, params::Dict{String,<:Any})
Provides information about a specific identity, including the identity's verification
status, sending authorization policies, its DKIM authentication status, and its custom
Mail-From settings.
# Arguments
- `email_identity`: The email identity.
"""
function get_email_identity(
EmailIdentity; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"GET",
"/v2/email/identities/$(EmailIdentity)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_email_identity(
EmailIdentity,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"GET",
"/v2/email/identities/$(EmailIdentity)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_email_identity_policies(email_identity)
get_email_identity_policies(email_identity, params::Dict{String,<:Any})
Returns the requested sending authorization policies for the given identity (an email
address or a domain). The policies are returned as a map of policy names to policy
contents. You can retrieve a maximum of 20 policies at a time. This API is for the
identity owner only. If you have not verified the identity, this API will return an error.
Sending authorization is a feature that enables an identity owner to authorize other
senders to use its identities. For information about using sending authorization, see the
Amazon SES Developer Guide. You can execute this operation no more than once per second.
# Arguments
- `email_identity`: The email identity.
"""
function get_email_identity_policies(
EmailIdentity; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"GET",
"/v2/email/identities/$(EmailIdentity)/policies";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_email_identity_policies(
EmailIdentity,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"GET",
"/v2/email/identities/$(EmailIdentity)/policies",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_email_template(template_name)
get_email_template(template_name, params::Dict{String,<:Any})
Displays the template object (which includes the subject line, HTML part and text part) for
the template you specify. You can execute this operation no more than once per second.
# Arguments
- `template_name`: The name of the template.
"""
function get_email_template(TemplateName; aws_config::AbstractAWSConfig=global_aws_config())
return sesv2(
"GET",
"/v2/email/templates/$(TemplateName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_email_template(
TemplateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"GET",
"/v2/email/templates/$(TemplateName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_export_job(job_id)
get_export_job(job_id, params::Dict{String,<:Any})
Provides information about an export job.
# Arguments
- `job_id`: The export job ID.
"""
function get_export_job(JobId; aws_config::AbstractAWSConfig=global_aws_config())
return sesv2(
"GET",
"/v2/email/export-jobs/$(JobId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_export_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"GET",
"/v2/email/export-jobs/$(JobId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_import_job(job_id)
get_import_job(job_id, params::Dict{String,<:Any})
Provides information about an import job.
# Arguments
- `job_id`: The ID of the import job.
"""
function get_import_job(JobId; aws_config::AbstractAWSConfig=global_aws_config())
return sesv2(
"GET",
"/v2/email/import-jobs/$(JobId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_import_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"GET",
"/v2/email/import-jobs/$(JobId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_message_insights(message_id)
get_message_insights(message_id, params::Dict{String,<:Any})
Provides information about a specific message, including the from address, the subject, the
recipient address, email tags, as well as events associated with the message. You can
execute this operation no more than once per second.
# Arguments
- `message_id`: A MessageId is a unique identifier for a message, and is returned when
sending emails through Amazon SES.
"""
function get_message_insights(MessageId; aws_config::AbstractAWSConfig=global_aws_config())
return sesv2(
"GET",
"/v2/email/insights/$(MessageId)/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_message_insights(
MessageId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"GET",
"/v2/email/insights/$(MessageId)/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_suppressed_destination(email_address)
get_suppressed_destination(email_address, params::Dict{String,<:Any})
Retrieves information about a specific email address that's on the suppression list for
your account.
# Arguments
- `email_address`: The email address that's on the account suppression list.
"""
function get_suppressed_destination(
EmailAddress; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"GET",
"/v2/email/suppression/addresses/$(EmailAddress)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_suppressed_destination(
EmailAddress,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"GET",
"/v2/email/suppression/addresses/$(EmailAddress)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_configuration_sets()
list_configuration_sets(params::Dict{String,<:Any})
List all of the configuration sets associated with your account in the current region.
Configuration sets are groups of rules that you can apply to the emails you send. You apply
a configuration set to an email by including a reference to the configuration set in the
headers of the email. When you apply a configuration set to an email, all of the rules in
that configuration set are applied to the email.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: A token returned from a previous call to ListConfigurationSets to indicate
the position in the list of configuration sets.
- `"PageSize"`: The number of results to show in a single call to ListConfigurationSets. If
the number of results is larger than the number you specified in this parameter, then the
response includes a NextToken element, which you can use to obtain additional results.
"""
function list_configuration_sets(; aws_config::AbstractAWSConfig=global_aws_config())
return sesv2(
"GET",
"/v2/email/configuration-sets";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_configuration_sets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"GET",
"/v2/email/configuration-sets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_contact_lists()
list_contact_lists(params::Dict{String,<:Any})
Lists all of the contact lists available.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: A string token indicating that there might be additional contact lists
available to be listed. Use the token provided in the Response to use in the subsequent
call to ListContactLists with the same parameters to retrieve the next page of contact
lists.
- `"PageSize"`: Maximum number of contact lists to return at once. Use this parameter to
paginate results. If additional contact lists exist beyond the specified limit, the
NextToken element is sent in the response. Use the NextToken value in subsequent requests
to retrieve additional lists.
"""
function list_contact_lists(; aws_config::AbstractAWSConfig=global_aws_config())
return sesv2(
"GET",
"/v2/email/contact-lists";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_contact_lists(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"GET",
"/v2/email/contact-lists",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_contacts(contact_list_name)
list_contacts(contact_list_name, params::Dict{String,<:Any})
Lists the contacts present in a specific contact list.
# Arguments
- `contact_list_name`: The name of the contact list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: A filter that can be applied to a list of contacts.
- `"NextToken"`: A string token indicating that there might be additional contacts
available to be listed. Use the token provided in the Response to use in the subsequent
call to ListContacts with the same parameters to retrieve the next page of contacts.
- `"PageSize"`: The number of contacts that may be returned at once, which is dependent on
if there are more or less contacts than the value of the PageSize. Use this parameter to
paginate results. If additional contacts exist beyond the specified limit, the NextToken
element is sent in the response. Use the NextToken value in subsequent requests to retrieve
additional contacts.
"""
function list_contacts(ContactListName; aws_config::AbstractAWSConfig=global_aws_config())
return sesv2(
"POST",
"/v2/email/contact-lists/$(ContactListName)/contacts/list";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_contacts(
ContactListName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"POST",
"/v2/email/contact-lists/$(ContactListName)/contacts/list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_custom_verification_email_templates()
list_custom_verification_email_templates(params::Dict{String,<:Any})
Lists the existing custom verification email templates for your account in the current
Amazon Web Services Region. For more information about custom verification email templates,
see Using custom verification email templates in the Amazon SES Developer Guide. You can
execute this operation no more than once per second.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: A token returned from a previous call to
ListCustomVerificationEmailTemplates to indicate the position in the list of custom
verification email templates.
- `"PageSize"`: The number of results to show in a single call to
ListCustomVerificationEmailTemplates. If the number of results is larger than the number
you specified in this parameter, then the response includes a NextToken element, which you
can use to obtain additional results. The value you specify has to be at least 1, and can
be no more than 50.
"""
function list_custom_verification_email_templates(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"GET",
"/v2/email/custom-verification-email-templates";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_custom_verification_email_templates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"GET",
"/v2/email/custom-verification-email-templates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_dedicated_ip_pools()
list_dedicated_ip_pools(params::Dict{String,<:Any})
List all of the dedicated IP pools that exist in your Amazon Web Services account in the
current Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: A token returned from a previous call to ListDedicatedIpPools to indicate
the position in the list of dedicated IP pools.
- `"PageSize"`: The number of results to show in a single call to ListDedicatedIpPools. If
the number of results is larger than the number you specified in this parameter, then the
response includes a NextToken element, which you can use to obtain additional results.
"""
function list_dedicated_ip_pools(; aws_config::AbstractAWSConfig=global_aws_config())
return sesv2(
"GET",
"/v2/email/dedicated-ip-pools";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_dedicated_ip_pools(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"GET",
"/v2/email/dedicated-ip-pools",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_deliverability_test_reports()
list_deliverability_test_reports(params::Dict{String,<:Any})
Show a list of the predictive inbox placement tests that you've performed, regardless of
their statuses. For predictive inbox placement tests that are complete, you can use the
GetDeliverabilityTestReport operation to view the results.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: A token returned from a previous call to ListDeliverabilityTestReports to
indicate the position in the list of predictive inbox placement tests.
- `"PageSize"`: The number of results to show in a single call to
ListDeliverabilityTestReports. If the number of results is larger than the number you
specified in this parameter, then the response includes a NextToken element, which you can
use to obtain additional results. The value you specify has to be at least 0, and can be no
more than 1000.
"""
function list_deliverability_test_reports(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"GET",
"/v2/email/deliverability-dashboard/test-reports";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_deliverability_test_reports(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"GET",
"/v2/email/deliverability-dashboard/test-reports",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_domain_deliverability_campaigns(end_date, start_date, subscribed_domain)
list_domain_deliverability_campaigns(end_date, start_date, subscribed_domain, params::Dict{String,<:Any})
Retrieve deliverability data for all the campaigns that used a specific domain to send
email during a specified time range. This data is available for a domain only if you
enabled the Deliverability dashboard for the domain.
# Arguments
- `end_date`: The last day that you want to obtain deliverability data for. This value has
to be less than or equal to 30 days after the value of the StartDate parameter.
- `start_date`: The first day that you want to obtain deliverability data for.
- `subscribed_domain`: The domain to obtain deliverability data for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: A token that’s returned from a previous call to the
ListDomainDeliverabilityCampaigns operation. This token indicates the position of a
campaign in the list of campaigns.
- `"PageSize"`: The maximum number of results to include in response to a single call to
the ListDomainDeliverabilityCampaigns operation. If the number of results is larger than
the number that you specify in this parameter, the response includes a NextToken element,
which you can use to obtain additional results.
"""
function list_domain_deliverability_campaigns(
EndDate, StartDate, SubscribedDomain; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"GET",
"/v2/email/deliverability-dashboard/domains/$(SubscribedDomain)/campaigns",
Dict{String,Any}("EndDate" => EndDate, "StartDate" => StartDate);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_domain_deliverability_campaigns(
EndDate,
StartDate,
SubscribedDomain,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"GET",
"/v2/email/deliverability-dashboard/domains/$(SubscribedDomain)/campaigns",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("EndDate" => EndDate, "StartDate" => StartDate),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_email_identities()
list_email_identities(params::Dict{String,<:Any})
Returns a list of all of the email identities that are associated with your Amazon Web
Services account. An identity can be either an email address or a domain. This operation
returns identities that are verified as well as those that aren't. This operation returns
identities that are associated with Amazon SES and Amazon Pinpoint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: A token returned from a previous call to ListEmailIdentities to indicate
the position in the list of identities.
- `"PageSize"`: The number of results to show in a single call to ListEmailIdentities. If
the number of results is larger than the number you specified in this parameter, then the
response includes a NextToken element, which you can use to obtain additional results. The
value you specify has to be at least 0, and can be no more than 1000.
"""
function list_email_identities(; aws_config::AbstractAWSConfig=global_aws_config())
return sesv2(
"GET",
"/v2/email/identities";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_email_identities(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"GET",
"/v2/email/identities",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_email_templates()
list_email_templates(params::Dict{String,<:Any})
Lists the email templates present in your Amazon SES account in the current Amazon Web
Services Region. You can execute this operation no more than once per second.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: A token returned from a previous call to ListEmailTemplates to indicate
the position in the list of email templates.
- `"PageSize"`: The number of results to show in a single call to ListEmailTemplates. If
the number of results is larger than the number you specified in this parameter, then the
response includes a NextToken element, which you can use to obtain additional results. The
value you specify has to be at least 1, and can be no more than 100.
"""
function list_email_templates(; aws_config::AbstractAWSConfig=global_aws_config())
return sesv2(
"GET", "/v2/email/templates"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_email_templates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"GET",
"/v2/email/templates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_export_jobs()
list_export_jobs(params::Dict{String,<:Any})
Lists all of the export jobs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExportSourceType"`: A value used to list export jobs that have a certain
ExportSourceType.
- `"JobStatus"`: A value used to list export jobs that have a certain JobStatus.
- `"NextToken"`: The pagination token returned from a previous call to ListExportJobs to
indicate the position in the list of export jobs.
- `"PageSize"`: Maximum number of export jobs to return at once. Use this parameter to
paginate results. If additional export jobs exist beyond the specified limit, the NextToken
element is sent in the response. Use the NextToken value in subsequent calls to
ListExportJobs to retrieve additional export jobs.
"""
function list_export_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return sesv2(
"POST",
"/v2/email/list-export-jobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_export_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"POST",
"/v2/email/list-export-jobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_import_jobs()
list_import_jobs(params::Dict{String,<:Any})
Lists all of the import jobs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ImportDestinationType"`: The destination of the import job, which can be used to list
import jobs that have a certain ImportDestinationType.
- `"NextToken"`: A string token indicating that there might be additional import jobs
available to be listed. Copy this token to a subsequent call to ListImportJobs with the
same parameters to retrieve the next page of import jobs.
- `"PageSize"`: Maximum number of import jobs to return at once. Use this parameter to
paginate results. If additional import jobs exist beyond the specified limit, the NextToken
element is sent in the response. Use the NextToken value in subsequent requests to retrieve
additional addresses.
"""
function list_import_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return sesv2(
"POST",
"/v2/email/import-jobs/list";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_import_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"POST",
"/v2/email/import-jobs/list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_recommendations()
list_recommendations(params::Dict{String,<:Any})
Lists the recommendations present in your Amazon SES account in the current Amazon Web
Services Region. You can execute this operation no more than once per second.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Filters applied when retrieving recommendations. Can eiter be an individual
filter, or combinations of STATUS and IMPACT or STATUS and TYPE
- `"NextToken"`: A token returned from a previous call to ListRecommendations to indicate
the position in the list of recommendations.
- `"PageSize"`: The number of results to show in a single call to ListRecommendations. If
the number of results is larger than the number you specified in this parameter, then the
response includes a NextToken element, which you can use to obtain additional results. The
value you specify has to be at least 1, and can be no more than 100.
"""
function list_recommendations(; aws_config::AbstractAWSConfig=global_aws_config())
return sesv2(
"POST",
"/v2/email/vdm/recommendations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_recommendations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"POST",
"/v2/email/vdm/recommendations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_suppressed_destinations()
list_suppressed_destinations(params::Dict{String,<:Any})
Retrieves a list of email addresses that are on the suppression list for your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EndDate"`: Used to filter the list of suppressed email destinations so that it only
includes addresses that were added to the list before a specific date.
- `"NextToken"`: A token returned from a previous call to ListSuppressedDestinations to
indicate the position in the list of suppressed email addresses.
- `"PageSize"`: The number of results to show in a single call to
ListSuppressedDestinations. If the number of results is larger than the number you
specified in this parameter, then the response includes a NextToken element, which you can
use to obtain additional results.
- `"Reason"`: The factors that caused the email address to be added to .
- `"StartDate"`: Used to filter the list of suppressed email destinations so that it only
includes addresses that were added to the list after a specific date.
"""
function list_suppressed_destinations(; aws_config::AbstractAWSConfig=global_aws_config())
return sesv2(
"GET",
"/v2/email/suppression/addresses";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_suppressed_destinations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"GET",
"/v2/email/suppression/addresses",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Retrieve a list of the tags (keys and values) that are associated with a specified
resource. A tag is a label that you optionally define and associate with a resource. Each
tag consists of a required tag key and an optional associated tag value. A tag key is a
general label that acts as a category for more specific tag values. A tag value acts as a
descriptor within a tag key.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource that you want to retrieve
tag information for.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"GET",
"/v2/email/tags",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"GET",
"/v2/email/tags",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_account_dedicated_ip_warmup_attributes()
put_account_dedicated_ip_warmup_attributes(params::Dict{String,<:Any})
Enable or disable the automatic warm-up feature for dedicated IP addresses.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AutoWarmupEnabled"`: Enables or disables the automatic warm-up feature for dedicated IP
addresses that are associated with your Amazon SES account in the current Amazon Web
Services Region. Set to true to enable the automatic warm-up feature, or set to false to
disable it.
"""
function put_account_dedicated_ip_warmup_attributes(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"PUT",
"/v2/email/account/dedicated-ips/warmup";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_account_dedicated_ip_warmup_attributes(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"PUT",
"/v2/email/account/dedicated-ips/warmup",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_account_details(mail_type, use_case_description, website_url)
put_account_details(mail_type, use_case_description, website_url, params::Dict{String,<:Any})
Update your Amazon SES account details.
# Arguments
- `mail_type`: The type of email your account will send.
- `use_case_description`: A description of the types of email that you plan to send.
- `website_url`: The URL of your website. This information helps us better understand the
type of content that you plan to send.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AdditionalContactEmailAddresses"`: Additional email addresses that you would like to be
notified regarding Amazon SES matters.
- `"ContactLanguage"`: The language you would prefer to be contacted with.
- `"ProductionAccessEnabled"`: Indicates whether or not your account should have production
access in the current Amazon Web Services Region. If the value is false, then your account
is in the sandbox. When your account is in the sandbox, you can only send email to verified
identities. If the value is true, then your account has production access. When your
account has production access, you can send email to any address. The sending quota and
maximum sending rate for your account vary based on your specific use case.
"""
function put_account_details(
MailType,
UseCaseDescription,
WebsiteURL;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"POST",
"/v2/email/account/details",
Dict{String,Any}(
"MailType" => MailType,
"UseCaseDescription" => UseCaseDescription,
"WebsiteURL" => WebsiteURL,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_account_details(
MailType,
UseCaseDescription,
WebsiteURL,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"POST",
"/v2/email/account/details",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MailType" => MailType,
"UseCaseDescription" => UseCaseDescription,
"WebsiteURL" => WebsiteURL,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_account_sending_attributes()
put_account_sending_attributes(params::Dict{String,<:Any})
Enable or disable the ability of your account to send email.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SendingEnabled"`: Enables or disables your account's ability to send email. Set to true
to enable email sending, or set to false to disable email sending. If Amazon Web Services
paused your account's ability to send email, you can't use this operation to resume your
account's ability to send email.
"""
function put_account_sending_attributes(; aws_config::AbstractAWSConfig=global_aws_config())
return sesv2(
"PUT",
"/v2/email/account/sending";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_account_sending_attributes(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"PUT",
"/v2/email/account/sending",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_account_suppression_attributes()
put_account_suppression_attributes(params::Dict{String,<:Any})
Change the settings for the account-level suppression list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SuppressedReasons"`: A list that contains the reasons that email addresses will be
automatically added to the suppression list for your account. This list can contain any or
all of the following: COMPLAINT – Amazon SES adds an email address to the suppression
list for your account when a message sent to that address results in a complaint. BOUNCE
– Amazon SES adds an email address to the suppression list for your account when a
message sent to that address results in a hard bounce.
"""
function put_account_suppression_attributes(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"PUT",
"/v2/email/account/suppression";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_account_suppression_attributes(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"PUT",
"/v2/email/account/suppression",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_account_vdm_attributes(vdm_attributes)
put_account_vdm_attributes(vdm_attributes, params::Dict{String,<:Any})
Update your Amazon SES account VDM attributes. You can execute this operation no more than
once per second.
# Arguments
- `vdm_attributes`: The VDM attributes that you wish to apply to your Amazon SES account.
"""
function put_account_vdm_attributes(
VdmAttributes; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"PUT",
"/v2/email/account/vdm",
Dict{String,Any}("VdmAttributes" => VdmAttributes);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_account_vdm_attributes(
VdmAttributes,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"PUT",
"/v2/email/account/vdm",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("VdmAttributes" => VdmAttributes), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_configuration_set_delivery_options(configuration_set_name)
put_configuration_set_delivery_options(configuration_set_name, params::Dict{String,<:Any})
Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools to
create groups of dedicated IP addresses for sending specific types of email.
# Arguments
- `configuration_set_name`: The name of the configuration set to associate with a dedicated
IP pool.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SendingPoolName"`: The name of the dedicated IP pool to associate with the
configuration set.
- `"TlsPolicy"`: Specifies whether messages that use the configuration set are required to
use Transport Layer Security (TLS). If the value is Require, messages are only delivered if
a TLS connection can be established. If the value is Optional, messages can be delivered in
plain text if a TLS connection can't be established.
"""
function put_configuration_set_delivery_options(
ConfigurationSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"PUT",
"/v2/email/configuration-sets/$(ConfigurationSetName)/delivery-options";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_configuration_set_delivery_options(
ConfigurationSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"PUT",
"/v2/email/configuration-sets/$(ConfigurationSetName)/delivery-options",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_configuration_set_reputation_options(configuration_set_name)
put_configuration_set_reputation_options(configuration_set_name, params::Dict{String,<:Any})
Enable or disable collection of reputation metrics for emails that you send using a
particular configuration set in a specific Amazon Web Services Region.
# Arguments
- `configuration_set_name`: The name of the configuration set.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ReputationMetricsEnabled"`: If true, tracking of reputation metrics is enabled for the
configuration set. If false, tracking of reputation metrics is disabled for the
configuration set.
"""
function put_configuration_set_reputation_options(
ConfigurationSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"PUT",
"/v2/email/configuration-sets/$(ConfigurationSetName)/reputation-options";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_configuration_set_reputation_options(
ConfigurationSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"PUT",
"/v2/email/configuration-sets/$(ConfigurationSetName)/reputation-options",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_configuration_set_sending_options(configuration_set_name)
put_configuration_set_sending_options(configuration_set_name, params::Dict{String,<:Any})
Enable or disable email sending for messages that use a particular configuration set in a
specific Amazon Web Services Region.
# Arguments
- `configuration_set_name`: The name of the configuration set to enable or disable email
sending for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SendingEnabled"`: If true, email sending is enabled for the configuration set. If
false, email sending is disabled for the configuration set.
"""
function put_configuration_set_sending_options(
ConfigurationSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"PUT",
"/v2/email/configuration-sets/$(ConfigurationSetName)/sending";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_configuration_set_sending_options(
ConfigurationSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"PUT",
"/v2/email/configuration-sets/$(ConfigurationSetName)/sending",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_configuration_set_suppression_options(configuration_set_name)
put_configuration_set_suppression_options(configuration_set_name, params::Dict{String,<:Any})
Specify the account suppression list preferences for a configuration set.
# Arguments
- `configuration_set_name`: The name of the configuration set to change the suppression
list preferences for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SuppressedReasons"`: A list that contains the reasons that email addresses are
automatically added to the suppression list for your account. This list can contain any or
all of the following: COMPLAINT – Amazon SES adds an email address to the suppression
list for your account when a message sent to that address results in a complaint. BOUNCE
– Amazon SES adds an email address to the suppression list for your account when a
message sent to that address results in a hard bounce.
"""
function put_configuration_set_suppression_options(
ConfigurationSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"PUT",
"/v2/email/configuration-sets/$(ConfigurationSetName)/suppression-options";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_configuration_set_suppression_options(
ConfigurationSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"PUT",
"/v2/email/configuration-sets/$(ConfigurationSetName)/suppression-options",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_configuration_set_tracking_options(configuration_set_name)
put_configuration_set_tracking_options(configuration_set_name, params::Dict{String,<:Any})
Specify a custom domain to use for open and click tracking elements in email that you send.
# Arguments
- `configuration_set_name`: The name of the configuration set.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CustomRedirectDomain"`: The domain to use to track open and click events.
"""
function put_configuration_set_tracking_options(
ConfigurationSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"PUT",
"/v2/email/configuration-sets/$(ConfigurationSetName)/tracking-options";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_configuration_set_tracking_options(
ConfigurationSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"PUT",
"/v2/email/configuration-sets/$(ConfigurationSetName)/tracking-options",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_configuration_set_vdm_options(configuration_set_name)
put_configuration_set_vdm_options(configuration_set_name, params::Dict{String,<:Any})
Specify VDM preferences for email that you send using the configuration set. You can
execute this operation no more than once per second.
# Arguments
- `configuration_set_name`: The name of the configuration set.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"VdmOptions"`: The VDM options to apply to the configuration set.
"""
function put_configuration_set_vdm_options(
ConfigurationSetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"PUT",
"/v2/email/configuration-sets/$(ConfigurationSetName)/vdm-options";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_configuration_set_vdm_options(
ConfigurationSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"PUT",
"/v2/email/configuration-sets/$(ConfigurationSetName)/vdm-options",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_dedicated_ip_in_pool(destination_pool_name, ip)
put_dedicated_ip_in_pool(destination_pool_name, ip, params::Dict{String,<:Any})
Move a dedicated IP address to an existing dedicated IP pool. The dedicated IP address
that you specify must already exist, and must be associated with your Amazon Web Services
account. The dedicated IP pool you specify must already exist. You can create a new pool
by using the CreateDedicatedIpPool operation.
# Arguments
- `destination_pool_name`: The name of the IP pool that you want to add the dedicated IP
address to. You have to specify an IP pool that already exists.
- `ip`: The IP address that you want to move to the dedicated IP pool. The value you
specify has to be a dedicated IP address that's associated with your Amazon Web Services
account.
"""
function put_dedicated_ip_in_pool(
DestinationPoolName, IP; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"PUT",
"/v2/email/dedicated-ips/$(IP)/pool",
Dict{String,Any}("DestinationPoolName" => DestinationPoolName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_dedicated_ip_in_pool(
DestinationPoolName,
IP,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"PUT",
"/v2/email/dedicated-ips/$(IP)/pool",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DestinationPoolName" => DestinationPoolName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_dedicated_ip_pool_scaling_attributes(pool_name, scaling_mode)
put_dedicated_ip_pool_scaling_attributes(pool_name, scaling_mode, params::Dict{String,<:Any})
Used to convert a dedicated IP pool to a different scaling mode. MANAGED pools cannot be
converted to STANDARD scaling mode.
# Arguments
- `pool_name`: The name of the dedicated IP pool.
- `scaling_mode`: The scaling mode to apply to the dedicated IP pool. Changing the scaling
mode from MANAGED to STANDARD is not supported.
"""
function put_dedicated_ip_pool_scaling_attributes(
PoolName, ScalingMode; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"PUT",
"/v2/email/dedicated-ip-pools/$(PoolName)/scaling",
Dict{String,Any}("ScalingMode" => ScalingMode);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_dedicated_ip_pool_scaling_attributes(
PoolName,
ScalingMode,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"PUT",
"/v2/email/dedicated-ip-pools/$(PoolName)/scaling",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ScalingMode" => ScalingMode), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_dedicated_ip_warmup_attributes(ip, warmup_percentage)
put_dedicated_ip_warmup_attributes(ip, warmup_percentage, params::Dict{String,<:Any})
# Arguments
- `ip`: The dedicated IP address that you want to update the warm-up attributes for.
- `warmup_percentage`: The warm-up percentage that you want to associate with the dedicated
IP address.
"""
function put_dedicated_ip_warmup_attributes(
IP, WarmupPercentage; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"PUT",
"/v2/email/dedicated-ips/$(IP)/warmup",
Dict{String,Any}("WarmupPercentage" => WarmupPercentage);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_dedicated_ip_warmup_attributes(
IP,
WarmupPercentage,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"PUT",
"/v2/email/dedicated-ips/$(IP)/warmup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("WarmupPercentage" => WarmupPercentage), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_deliverability_dashboard_option(dashboard_enabled)
put_deliverability_dashboard_option(dashboard_enabled, params::Dict{String,<:Any})
Enable or disable the Deliverability dashboard. When you enable the Deliverability
dashboard, you gain access to reputation, deliverability, and other metrics for the domains
that you use to send email. You also gain the ability to perform predictive inbox placement
tests. When you use the Deliverability dashboard, you pay a monthly subscription charge, in
addition to any other fees that you accrue by using Amazon SES and other Amazon Web
Services services. For more information about the features and cost of a Deliverability
dashboard subscription, see Amazon SES Pricing.
# Arguments
- `dashboard_enabled`: Specifies whether to enable the Deliverability dashboard. To enable
the dashboard, set this value to true.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SubscribedDomains"`: An array of objects, one for each verified domain that you use to
send email and enabled the Deliverability dashboard for.
"""
function put_deliverability_dashboard_option(
DashboardEnabled; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"PUT",
"/v2/email/deliverability-dashboard",
Dict{String,Any}("DashboardEnabled" => DashboardEnabled);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_deliverability_dashboard_option(
DashboardEnabled,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"PUT",
"/v2/email/deliverability-dashboard",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("DashboardEnabled" => DashboardEnabled), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_email_identity_configuration_set_attributes(email_identity)
put_email_identity_configuration_set_attributes(email_identity, params::Dict{String,<:Any})
Used to associate a configuration set with an email identity.
# Arguments
- `email_identity`: The email address or domain to associate with a configuration set.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConfigurationSetName"`: The configuration set to associate with an email identity.
"""
function put_email_identity_configuration_set_attributes(
EmailIdentity; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"PUT",
"/v2/email/identities/$(EmailIdentity)/configuration-set";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_email_identity_configuration_set_attributes(
EmailIdentity,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"PUT",
"/v2/email/identities/$(EmailIdentity)/configuration-set",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_email_identity_dkim_attributes(email_identity)
put_email_identity_dkim_attributes(email_identity, params::Dict{String,<:Any})
Used to enable or disable DKIM authentication for an email identity.
# Arguments
- `email_identity`: The email identity.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SigningEnabled"`: Sets the DKIM signing configuration for the identity. When you set
this value true, then the messages that are sent from the identity are signed using DKIM.
If you set this value to false, your messages are sent without DKIM signing.
"""
function put_email_identity_dkim_attributes(
EmailIdentity; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"PUT",
"/v2/email/identities/$(EmailIdentity)/dkim";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_email_identity_dkim_attributes(
EmailIdentity,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"PUT",
"/v2/email/identities/$(EmailIdentity)/dkim",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_email_identity_dkim_signing_attributes(email_identity, signing_attributes_origin)
put_email_identity_dkim_signing_attributes(email_identity, signing_attributes_origin, params::Dict{String,<:Any})
Used to configure or change the DKIM authentication settings for an email domain identity.
You can use this operation to do any of the following: Update the signing attributes for
an identity that uses Bring Your Own DKIM (BYODKIM). Update the key length that should be
used for Easy DKIM. Change from using no DKIM authentication to using Easy DKIM. Change
from using no DKIM authentication to using BYODKIM. Change from using Easy DKIM to using
BYODKIM. Change from using BYODKIM to using Easy DKIM.
# Arguments
- `email_identity`: The email identity.
- `signing_attributes_origin`: The method to use to configure DKIM for the identity. There
are the following possible values: AWS_SES – Configure DKIM for the identity by using
Easy DKIM. EXTERNAL – Configure DKIM for the identity by using Bring Your Own DKIM
(BYODKIM).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SigningAttributes"`: An object that contains information about the private key and
selector that you want to use to configure DKIM for the identity for Bring Your Own DKIM
(BYODKIM) for the identity, or, configures the key length to be used for Easy DKIM.
"""
function put_email_identity_dkim_signing_attributes(
EmailIdentity,
SigningAttributesOrigin;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"PUT",
"/v1/email/identities/$(EmailIdentity)/dkim/signing",
Dict{String,Any}("SigningAttributesOrigin" => SigningAttributesOrigin);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_email_identity_dkim_signing_attributes(
EmailIdentity,
SigningAttributesOrigin,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"PUT",
"/v1/email/identities/$(EmailIdentity)/dkim/signing",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("SigningAttributesOrigin" => SigningAttributesOrigin),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_email_identity_feedback_attributes(email_identity)
put_email_identity_feedback_attributes(email_identity, params::Dict{String,<:Any})
Used to enable or disable feedback forwarding for an identity. This setting determines what
happens when an identity is used to send an email that results in a bounce or complaint
event. If the value is true, you receive email notifications when bounce or complaint
events occur. These notifications are sent to the address that you specified in the
Return-Path header of the original email. You're required to have a method of tracking
bounces and complaints. If you haven't set up another mechanism for receiving bounce or
complaint notifications (for example, by setting up an event destination), you receive an
email notification when these events occur (even if this setting is disabled).
# Arguments
- `email_identity`: The email identity.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EmailForwardingEnabled"`: Sets the feedback forwarding configuration for the identity.
If the value is true, you receive email notifications when bounce or complaint events
occur. These notifications are sent to the address that you specified in the Return-Path
header of the original email. You're required to have a method of tracking bounces and
complaints. If you haven't set up another mechanism for receiving bounce or complaint
notifications (for example, by setting up an event destination), you receive an email
notification when these events occur (even if this setting is disabled).
"""
function put_email_identity_feedback_attributes(
EmailIdentity; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"PUT",
"/v2/email/identities/$(EmailIdentity)/feedback";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_email_identity_feedback_attributes(
EmailIdentity,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"PUT",
"/v2/email/identities/$(EmailIdentity)/feedback",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_email_identity_mail_from_attributes(email_identity)
put_email_identity_mail_from_attributes(email_identity, params::Dict{String,<:Any})
Used to enable or disable the custom Mail-From domain configuration for an email identity.
# Arguments
- `email_identity`: The verified email identity.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BehaviorOnMxFailure"`: The action to take if the required MX record isn't found when
you send an email. When you set this value to UseDefaultValue, the mail is sent using
amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, the Amazon
SES API v2 returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the
email. These behaviors are taken when the custom MAIL FROM domain configuration is in the
Pending, Failed, and TemporaryFailure states.
- `"MailFromDomain"`: The custom MAIL FROM domain that you want the verified identity to
use. The MAIL FROM domain must meet the following criteria: It has to be a subdomain of
the verified identity. It can't be used to receive email. It can't be used in a
\"From\" address if the MAIL FROM domain is a destination for feedback forwarding emails.
"""
function put_email_identity_mail_from_attributes(
EmailIdentity; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"PUT",
"/v2/email/identities/$(EmailIdentity)/mail-from";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_email_identity_mail_from_attributes(
EmailIdentity,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"PUT",
"/v2/email/identities/$(EmailIdentity)/mail-from",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_suppressed_destination(email_address, reason)
put_suppressed_destination(email_address, reason, params::Dict{String,<:Any})
Adds an email address to the suppression list for your account.
# Arguments
- `email_address`: The email address that should be added to the suppression list for your
account.
- `reason`: The factors that should cause the email address to be added to the suppression
list for your account.
"""
function put_suppressed_destination(
EmailAddress, Reason; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"PUT",
"/v2/email/suppression/addresses",
Dict{String,Any}("EmailAddress" => EmailAddress, "Reason" => Reason);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_suppressed_destination(
EmailAddress,
Reason,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"PUT",
"/v2/email/suppression/addresses",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("EmailAddress" => EmailAddress, "Reason" => Reason),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_bulk_email(bulk_email_entries, default_content)
send_bulk_email(bulk_email_entries, default_content, params::Dict{String,<:Any})
Composes an email message to multiple destinations.
# Arguments
- `bulk_email_entries`: The list of bulk email entry objects.
- `default_content`: An object that contains the body of the message. You can specify a
template message.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConfigurationSetName"`: The name of the configuration set to use when sending the email.
- `"DefaultEmailTags"`: A list of tags, in the form of name/value pairs, to apply to an
email that you send using the SendEmail operation. Tags correspond to characteristics of
the email that you define, so that you can publish email sending events.
- `"FeedbackForwardingEmailAddress"`: The address that you want bounce and complaint
notifications to be sent to.
- `"FeedbackForwardingEmailAddressIdentityArn"`: This parameter is used only for sending
authorization. It is the ARN of the identity that is associated with the sending
authorization policy that permits you to use the email address specified in the
FeedbackForwardingEmailAddress parameter. For example, if the owner of example.com (which
has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it
that authorizes you to use [email protected], then you would specify the
FeedbackForwardingEmailAddressIdentityArn to be
arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
FeedbackForwardingEmailAddress to be [email protected]. For more information about
sending authorization, see the Amazon SES Developer Guide.
- `"FromEmailAddress"`: The email address to use as the \"From\" address for the email. The
address that you specify has to be verified.
- `"FromEmailAddressIdentityArn"`: This parameter is used only for sending authorization.
It is the ARN of the identity that is associated with the sending authorization policy that
permits you to use the email address specified in the FromEmailAddress parameter. For
example, if the owner of example.com (which has ARN
arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that
authorizes you to use [email protected], then you would specify the
FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com,
and the FromEmailAddress to be [email protected]. For more information about sending
authorization, see the Amazon SES Developer Guide.
- `"ReplyToAddresses"`: The \"Reply-to\" email addresses for the message. When the
recipient replies to the message, each Reply-to address receives the reply.
"""
function send_bulk_email(
BulkEmailEntries, DefaultContent; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"POST",
"/v2/email/outbound-bulk-emails",
Dict{String,Any}(
"BulkEmailEntries" => BulkEmailEntries, "DefaultContent" => DefaultContent
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_bulk_email(
BulkEmailEntries,
DefaultContent,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"POST",
"/v2/email/outbound-bulk-emails",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"BulkEmailEntries" => BulkEmailEntries,
"DefaultContent" => DefaultContent,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_custom_verification_email(email_address, template_name)
send_custom_verification_email(email_address, template_name, params::Dict{String,<:Any})
Adds an email address to the list of identities for your Amazon SES account in the current
Amazon Web Services Region and attempts to verify it. As a result of executing this
operation, a customized verification email is sent to the specified address. To use this
operation, you must first create a custom verification email template. For more information
about creating and using custom verification email templates, see Using custom verification
email templates in the Amazon SES Developer Guide. You can execute this operation no more
than once per second.
# Arguments
- `email_address`: The email address to verify.
- `template_name`: The name of the custom verification email template to use when sending
the verification email.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConfigurationSetName"`: Name of a configuration set to use when sending the
verification email.
"""
function send_custom_verification_email(
EmailAddress, TemplateName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"POST",
"/v2/email/outbound-custom-verification-emails",
Dict{String,Any}("EmailAddress" => EmailAddress, "TemplateName" => TemplateName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_custom_verification_email(
EmailAddress,
TemplateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"POST",
"/v2/email/outbound-custom-verification-emails",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EmailAddress" => EmailAddress, "TemplateName" => TemplateName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_email(content)
send_email(content, params::Dict{String,<:Any})
Sends an email message. You can use the Amazon SES API v2 to send the following types of
messages: Simple – A standard email message. When you create this type of message, you
specify the sender, the recipient, and the message body, and Amazon SES assembles the
message for you. Raw – A raw, MIME-formatted email message. When you send this type of
email, you have to specify all of the message headers, as well as the message body. You can
use this message type to send messages that contain attachments. The message that you
specify has to be a valid MIME message. Templated – A message that contains
personalization tags. When you send this type of email, Amazon SES API v2 automatically
replaces the tags with values that you specify.
# Arguments
- `content`: An object that contains the body of the message. You can send either a Simple
message, Raw message, or a Templated message.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConfigurationSetName"`: The name of the configuration set to use when sending the email.
- `"Destination"`: An object that contains the recipients of the email message.
- `"EmailTags"`: A list of tags, in the form of name/value pairs, to apply to an email that
you send using the SendEmail operation. Tags correspond to characteristics of the email
that you define, so that you can publish email sending events.
- `"FeedbackForwardingEmailAddress"`: The address that you want bounce and complaint
notifications to be sent to.
- `"FeedbackForwardingEmailAddressIdentityArn"`: This parameter is used only for sending
authorization. It is the ARN of the identity that is associated with the sending
authorization policy that permits you to use the email address specified in the
FeedbackForwardingEmailAddress parameter. For example, if the owner of example.com (which
has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it
that authorizes you to use [email protected], then you would specify the
FeedbackForwardingEmailAddressIdentityArn to be
arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
FeedbackForwardingEmailAddress to be [email protected]. For more information about
sending authorization, see the Amazon SES Developer Guide.
- `"FromEmailAddress"`: The email address to use as the \"From\" address for the email. The
address that you specify has to be verified.
- `"FromEmailAddressIdentityArn"`: This parameter is used only for sending authorization.
It is the ARN of the identity that is associated with the sending authorization policy that
permits you to use the email address specified in the FromEmailAddress parameter. For
example, if the owner of example.com (which has ARN
arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that
authorizes you to use [email protected], then you would specify the
FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com,
and the FromEmailAddress to be [email protected]. For more information about sending
authorization, see the Amazon SES Developer Guide. For Raw emails, the
FromEmailAddressIdentityArn value overrides the X-SES-SOURCE-ARN and X-SES-FROM-ARN headers
specified in raw email message content.
- `"ListManagementOptions"`: An object used to specify a list or topic to which an email
belongs, which will be used when a contact chooses to unsubscribe.
- `"ReplyToAddresses"`: The \"Reply-to\" email addresses for the message. When the
recipient replies to the message, each Reply-to address receives the reply.
"""
function send_email(Content; aws_config::AbstractAWSConfig=global_aws_config())
return sesv2(
"POST",
"/v2/email/outbound-emails",
Dict{String,Any}("Content" => Content);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_email(
Content, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"POST",
"/v2/email/outbound-emails",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Content" => Content), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Add one or more tags (keys and values) to a specified resource. A tag is a label that you
optionally define and associate with a resource. Tags can help you categorize and manage
resources in different ways, such as by purpose, owner, environment, or other criteria. A
resource can have as many as 50 tags. Each tag consists of a required tag key and an
associated tag value, both of which you define. A tag key is a general label that acts as
a category for more specific tag values. A tag value acts as a descriptor within a tag key.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource that you want to add one
or more tags to.
- `tags`: A list of the tags that you want to add to the resource. A tag consists of a
required tag key (Key) and an associated tag value (Value). The maximum length of a tag key
is 128 characters. The maximum length of a tag value is 256 characters.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return sesv2(
"POST",
"/v2/email/tags",
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ResourceArn,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"POST",
"/v2/email/tags",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
test_render_email_template(template_data, template_name)
test_render_email_template(template_data, template_name, params::Dict{String,<:Any})
Creates a preview of the MIME content of an email when provided with a template and a set
of replacement data. You can execute this operation no more than once per second.
# Arguments
- `template_data`: A list of replacement values to apply to the template. This parameter is
a JSON object, typically consisting of key-value pairs in which the keys correspond to
replacement tags in the email template.
- `template_name`: The name of the template.
"""
function test_render_email_template(
TemplateData, TemplateName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"POST",
"/v2/email/templates/$(TemplateName)/render",
Dict{String,Any}("TemplateData" => TemplateData);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function test_render_email_template(
TemplateData,
TemplateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"POST",
"/v2/email/templates/$(TemplateName)/render",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TemplateData" => TemplateData), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Remove one or more tags (keys and values) from a specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource that you want to remove
one or more tags from.
- `tag_keys`: The tags (tag keys) that you want to remove from the resource. When you
specify a tag key, the action removes both that key and its associated tag value. To remove
more than one tag from the resource, append the TagKeys parameter and argument for each
additional tag to remove, separated by an ampersand. For example:
/v2/email/tags?ResourceArn=ResourceArn&TagKeys=Key1&TagKeys=Key2
"""
function untag_resource(
ResourceArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"DELETE",
"/v2/email/tags",
Dict{String,Any}("ResourceArn" => ResourceArn, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ResourceArn,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"DELETE",
"/v2/email/tags",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_configuration_set_event_destination(configuration_set_name, event_destination, event_destination_name)
update_configuration_set_event_destination(configuration_set_name, event_destination, event_destination_name, params::Dict{String,<:Any})
Update the configuration of an event destination for a configuration set. Events include
message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are
places that you can send information about these events to. For example, you can send event
data to Amazon EventBridge and associate a rule to send the event to the specified target.
# Arguments
- `configuration_set_name`: The name of the configuration set that contains the event
destination to modify.
- `event_destination`: An object that defines the event destination.
- `event_destination_name`: The name of the event destination.
"""
function update_configuration_set_event_destination(
ConfigurationSetName,
EventDestination,
EventDestinationName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"PUT",
"/v2/email/configuration-sets/$(ConfigurationSetName)/event-destinations/$(EventDestinationName)",
Dict{String,Any}("EventDestination" => EventDestination);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_configuration_set_event_destination(
ConfigurationSetName,
EventDestination,
EventDestinationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"PUT",
"/v2/email/configuration-sets/$(ConfigurationSetName)/event-destinations/$(EventDestinationName)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("EventDestination" => EventDestination), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_contact(contact_list_name, email_address)
update_contact(contact_list_name, email_address, params::Dict{String,<:Any})
Updates a contact's preferences for a list. You must specify all existing topic
preferences in the TopicPreferences object, not just the ones that need updating;
otherwise, all your existing preferences will be removed.
# Arguments
- `contact_list_name`: The name of the contact list.
- `email_address`: The contact's email address.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AttributesData"`: The attribute data attached to a contact.
- `"TopicPreferences"`: The contact's preference for being opted-in to or opted-out of a
topic.
- `"UnsubscribeAll"`: A boolean value status noting if the contact is unsubscribed from all
contact list topics.
"""
function update_contact(
ContactListName, EmailAddress; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"PUT",
"/v2/email/contact-lists/$(ContactListName)/contacts/$(EmailAddress)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_contact(
ContactListName,
EmailAddress,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"PUT",
"/v2/email/contact-lists/$(ContactListName)/contacts/$(EmailAddress)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_contact_list(contact_list_name)
update_contact_list(contact_list_name, params::Dict{String,<:Any})
Updates contact list metadata. This operation does a complete replacement.
# Arguments
- `contact_list_name`: The name of the contact list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of what the contact list is about.
- `"Topics"`: An interest group, theme, or label within a list. A contact list can have
multiple topics.
"""
function update_contact_list(
ContactListName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"PUT",
"/v2/email/contact-lists/$(ContactListName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_contact_list(
ContactListName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"PUT",
"/v2/email/contact-lists/$(ContactListName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_custom_verification_email_template(failure_redirection_url, from_email_address, success_redirection_url, template_content, template_name, template_subject)
update_custom_verification_email_template(failure_redirection_url, from_email_address, success_redirection_url, template_content, template_name, template_subject, params::Dict{String,<:Any})
Updates an existing custom verification email template. For more information about custom
verification email templates, see Using custom verification email templates in the Amazon
SES Developer Guide. You can execute this operation no more than once per second.
# Arguments
- `failure_redirection_url`: The URL that the recipient of the verification email is sent
to if his or her address is not successfully verified.
- `from_email_address`: The email address that the custom verification email is sent from.
- `success_redirection_url`: The URL that the recipient of the verification email is sent
to if his or her address is successfully verified.
- `template_content`: The content of the custom verification email. The total size of the
email must be less than 10 MB. The message body may contain HTML, with some limitations.
For more information, see Custom verification email frequently asked questions in the
Amazon SES Developer Guide.
- `template_name`: The name of the custom verification email template that you want to
update.
- `template_subject`: The subject line of the custom verification email.
"""
function update_custom_verification_email_template(
FailureRedirectionURL,
FromEmailAddress,
SuccessRedirectionURL,
TemplateContent,
TemplateName,
TemplateSubject;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"PUT",
"/v2/email/custom-verification-email-templates/$(TemplateName)",
Dict{String,Any}(
"FailureRedirectionURL" => FailureRedirectionURL,
"FromEmailAddress" => FromEmailAddress,
"SuccessRedirectionURL" => SuccessRedirectionURL,
"TemplateContent" => TemplateContent,
"TemplateSubject" => TemplateSubject,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_custom_verification_email_template(
FailureRedirectionURL,
FromEmailAddress,
SuccessRedirectionURL,
TemplateContent,
TemplateName,
TemplateSubject,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"PUT",
"/v2/email/custom-verification-email-templates/$(TemplateName)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FailureRedirectionURL" => FailureRedirectionURL,
"FromEmailAddress" => FromEmailAddress,
"SuccessRedirectionURL" => SuccessRedirectionURL,
"TemplateContent" => TemplateContent,
"TemplateSubject" => TemplateSubject,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_email_identity_policy(email_identity, policy, policy_name)
update_email_identity_policy(email_identity, policy, policy_name, params::Dict{String,<:Any})
Updates the specified sending authorization policy for the given identity (an email address
or a domain). This API returns successfully even if a policy with the specified name does
not exist. This API is for the identity owner only. If you have not verified the identity,
this API will return an error. Sending authorization is a feature that enables an identity
owner to authorize other senders to use its identities. For information about using sending
authorization, see the Amazon SES Developer Guide. You can execute this operation no more
than once per second.
# Arguments
- `email_identity`: The email identity.
- `policy`: The text of the policy in JSON format. The policy cannot exceed 4 KB. For
information about the syntax of sending authorization policies, see the Amazon SES
Developer Guide.
- `policy_name`: The name of the policy. The policy name cannot exceed 64 characters and
can only include alphanumeric characters, dashes, and underscores.
"""
function update_email_identity_policy(
EmailIdentity, Policy, PolicyName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"PUT",
"/v2/email/identities/$(EmailIdentity)/policies/$(PolicyName)",
Dict{String,Any}("Policy" => Policy);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_email_identity_policy(
EmailIdentity,
Policy,
PolicyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"PUT",
"/v2/email/identities/$(EmailIdentity)/policies/$(PolicyName)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Policy" => Policy), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_email_template(template_content, template_name)
update_email_template(template_content, template_name, params::Dict{String,<:Any})
Updates an email template. Email templates enable you to send personalized email to one or
more destinations in a single API operation. For more information, see the Amazon SES
Developer Guide. You can execute this operation no more than once per second.
# Arguments
- `template_content`: The content of the email template, composed of a subject line, an
HTML part, and a text-only part.
- `template_name`: The name of the template.
"""
function update_email_template(
TemplateContent, TemplateName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sesv2(
"PUT",
"/v2/email/templates/$(TemplateName)",
Dict{String,Any}("TemplateContent" => TemplateContent);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_email_template(
TemplateContent,
TemplateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sesv2(
"PUT",
"/v2/email/templates/$(TemplateName)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("TemplateContent" => TemplateContent), 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 | 81521 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: sfn
using AWS.Compat
using AWS.UUIDs
"""
create_activity(name)
create_activity(name, params::Dict{String,<:Any})
Creates an activity. An activity is a task that you write in any programming language and
host on any machine that has access to Step Functions. Activities must poll Step Functions
using the GetActivityTask API action and respond using SendTask* API actions. This function
lets Step Functions know the existence of your activity and returns an identifier for use
in a state machine and when polling from the activity. This operation is eventually
consistent. The results are best effort and may not reflect very recent updates and
changes. CreateActivity is an idempotent API. Subsequent requests won’t create a
duplicate resource if it was already created. CreateActivity's idempotency check is based
on the activity name. If a following request has different tags values, Step Functions 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
- `name`: The name of the activity to create. This name must be unique for your Amazon Web
Services account and region for 90 days. For more information, see Limits Related to State
Machine Executions in the Step Functions Developer Guide. A name must not contain: white
space brackets < > { } [ ] wildcard characters ? * special characters \" # %
^ | ~ ` & , ; : / control characters (U+0000-001F, U+007F-009F) To enable logging
with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: The list of tags to add to a resource. An array of key-value pairs. For more
information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost
Management User Guide, and Controlling Access Using IAM Tags. Tags may only contain Unicode
letters, digits, white space, or these symbols: _ . : / = + - @.
"""
function create_activity(name; aws_config::AbstractAWSConfig=global_aws_config())
return sfn(
"CreateActivity",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_activity(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sfn(
"CreateActivity",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_state_machine(definition, name, role_arn)
create_state_machine(definition, name, role_arn, params::Dict{String,<:Any})
Creates a state machine. A state machine consists of a collection of states that can do
work (Task states), determine to which states to transition next (Choice states), stop an
execution with an error (Fail states), and so on. State machines are specified using a
JSON-based, structured language. For more information, see Amazon States Language in the
Step Functions User Guide. If you set the publish parameter of this API action to true, it
publishes version 1 as the first revision of the state machine. This operation is
eventually consistent. The results are best effort and may not reflect very recent updates
and changes. CreateStateMachine is an idempotent API. Subsequent requests won’t create
a duplicate resource if it was already created. CreateStateMachine's idempotency check is
based on the state machine name, definition, type, LoggingConfiguration, and
TracingConfiguration. The check is also based on the publish and versionDescription
parameters. If a following request has a different roleArn or tags, Step Functions will
ignore these differences and treat it as an idempotent request of the previous. In this
case, roleArn and tags will not be updated, even if they are different.
# Arguments
- `definition`: The Amazon States Language definition of the state machine. See Amazon
States Language.
- `name`: The name of the state machine. A name must not contain: white space brackets
< > { } [ ] wildcard characters ? * special characters \" # % ^ | ~ ` & ,
; : / control characters (U+0000-001F, U+007F-009F) To enable logging with CloudWatch
Logs, the name should only contain 0-9, A-Z, a-z, - and _.
- `role_arn`: The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"loggingConfiguration"`: Defines what execution history events are logged and where they
are logged. By default, the level is set to OFF. For more information see Log Levels in
the Step Functions User Guide.
- `"publish"`: Set to true to publish the first version of the state machine during
creation. The default is false.
- `"tags"`: Tags to be added when creating a state machine. An array of key-value pairs.
For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and
Cost Management User Guide, and Controlling Access Using IAM Tags. Tags may only contain
Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
- `"tracingConfiguration"`: Selects whether X-Ray tracing is enabled.
- `"type"`: Determines whether a Standard or Express state machine is created. The default
is STANDARD. You cannot update the type of a state machine once it has been created.
- `"versionDescription"`: Sets description about the state machine version. You can only
set the description if the publish parameter is set to true. Otherwise, if you set
versionDescription, but publish to false, this API action throws ValidationException.
"""
function create_state_machine(
definition, name, roleArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sfn(
"CreateStateMachine",
Dict{String,Any}("definition" => definition, "name" => name, "roleArn" => roleArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_state_machine(
definition,
name,
roleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sfn(
"CreateStateMachine",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"definition" => definition, "name" => name, "roleArn" => roleArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_state_machine_alias(name, routing_configuration)
create_state_machine_alias(name, routing_configuration, params::Dict{String,<:Any})
Creates an alias for a state machine that points to one or two versions of the same state
machine. You can set your application to call StartExecution with an alias and update the
version the alias uses without changing the client's code. You can also map an alias to
split StartExecution requests between two versions of a state machine. To do this, add a
second RoutingConfig object in the routingConfiguration parameter. You must also specify
the percentage of execution run requests each version should receive in both RoutingConfig
objects. Step Functions randomly chooses which version runs a given execution based on the
percentage you specify. To create an alias that points to a single version, specify a
single RoutingConfig object with a weight set to 100. You can create up to 100 aliases for
each state machine. You must delete unused aliases using the DeleteStateMachineAlias API
action. CreateStateMachineAlias is an idempotent API. Step Functions bases the idempotency
check on the stateMachineArn, description, name, and routingConfiguration parameters.
Requests that contain the same values for these parameters return a successful idempotent
response without creating a duplicate resource. Related operations:
DescribeStateMachineAlias ListStateMachineAliases UpdateStateMachineAlias
DeleteStateMachineAlias
# Arguments
- `name`: The name of the state machine alias. To avoid conflict with version ARNs, don't
use an integer in the name of the alias.
- `routing_configuration`: The routing configuration of a state machine alias. The routing
configuration shifts execution traffic between two state machine versions.
routingConfiguration contains an array of RoutingConfig objects that specify up to two
state machine versions. Step Functions then randomly choses which version to run an
execution with based on the weight assigned to each RoutingConfig.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A description for the state machine alias.
"""
function create_state_machine_alias(
name, routingConfiguration; aws_config::AbstractAWSConfig=global_aws_config()
)
return sfn(
"CreateStateMachineAlias",
Dict{String,Any}("name" => name, "routingConfiguration" => routingConfiguration);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_state_machine_alias(
name,
routingConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sfn(
"CreateStateMachineAlias",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name, "routingConfiguration" => routingConfiguration
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_activity(activity_arn)
delete_activity(activity_arn, params::Dict{String,<:Any})
Deletes an activity.
# Arguments
- `activity_arn`: The Amazon Resource Name (ARN) of the activity to delete.
"""
function delete_activity(activityArn; aws_config::AbstractAWSConfig=global_aws_config())
return sfn(
"DeleteActivity",
Dict{String,Any}("activityArn" => activityArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_activity(
activityArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sfn(
"DeleteActivity",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("activityArn" => activityArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_state_machine(state_machine_arn)
delete_state_machine(state_machine_arn, params::Dict{String,<:Any})
Deletes a state machine. This is an asynchronous operation. It sets the state machine's
status to DELETING and begins the deletion process. A state machine is deleted only when
all its executions are completed. On the next state transition, the state machine's
executions are terminated. A qualified state machine ARN can either refer to a Distributed
Map state defined within a state machine, a version ARN, or an alias ARN. The following are
some examples of qualified and unqualified state machine ARNs: The following qualified
state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state
machine named myStateMachine.
arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel If you
provide a qualified state machine ARN that refers to a Distributed Map state, the request
fails with ValidationException. The following unqualified state machine ARN refers to a
state machine named myStateMachine.
arn:partition:states:region:account-id:stateMachine:myStateMachine This API action also
deletes all versions and aliases associated with a state machine. For EXPRESS state
machines, the deletion happens eventually (usually in less than a minute). Running
executions may emit logs after DeleteStateMachine API is called.
# Arguments
- `state_machine_arn`: The Amazon Resource Name (ARN) of the state machine to delete.
"""
function delete_state_machine(
stateMachineArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sfn(
"DeleteStateMachine",
Dict{String,Any}("stateMachineArn" => stateMachineArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_state_machine(
stateMachineArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sfn(
"DeleteStateMachine",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("stateMachineArn" => stateMachineArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_state_machine_alias(state_machine_alias_arn)
delete_state_machine_alias(state_machine_alias_arn, params::Dict{String,<:Any})
Deletes a state machine alias. After you delete a state machine alias, you can't use it to
start executions. When you delete a state machine alias, Step Functions doesn't delete the
state machine versions that alias references. Related operations:
CreateStateMachineAlias DescribeStateMachineAlias ListStateMachineAliases
UpdateStateMachineAlias
# Arguments
- `state_machine_alias_arn`: The Amazon Resource Name (ARN) of the state machine alias to
delete.
"""
function delete_state_machine_alias(
stateMachineAliasArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sfn(
"DeleteStateMachineAlias",
Dict{String,Any}("stateMachineAliasArn" => stateMachineAliasArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_state_machine_alias(
stateMachineAliasArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sfn(
"DeleteStateMachineAlias",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("stateMachineAliasArn" => stateMachineAliasArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_state_machine_version(state_machine_version_arn)
delete_state_machine_version(state_machine_version_arn, params::Dict{String,<:Any})
Deletes a state machine version. After you delete a version, you can't call StartExecution
using that version's ARN or use the version with a state machine alias. Deleting a state
machine version won't terminate its in-progress executions. You can't delete a state
machine version currently referenced by one or more aliases. Before you delete a version,
you must either delete the aliases or update them to point to another state machine
version. Related operations: PublishStateMachineVersion ListStateMachineVersions
# Arguments
- `state_machine_version_arn`: The Amazon Resource Name (ARN) of the state machine version
to delete.
"""
function delete_state_machine_version(
stateMachineVersionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sfn(
"DeleteStateMachineVersion",
Dict{String,Any}("stateMachineVersionArn" => stateMachineVersionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_state_machine_version(
stateMachineVersionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sfn(
"DeleteStateMachineVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("stateMachineVersionArn" => stateMachineVersionArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_activity(activity_arn)
describe_activity(activity_arn, params::Dict{String,<:Any})
Describes an activity. This operation is eventually consistent. The results are best
effort and may not reflect very recent updates and changes.
# Arguments
- `activity_arn`: The Amazon Resource Name (ARN) of the activity to describe.
"""
function describe_activity(activityArn; aws_config::AbstractAWSConfig=global_aws_config())
return sfn(
"DescribeActivity",
Dict{String,Any}("activityArn" => activityArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_activity(
activityArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sfn(
"DescribeActivity",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("activityArn" => activityArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_execution(execution_arn)
describe_execution(execution_arn, params::Dict{String,<:Any})
Provides information about a state machine execution, such as the state machine associated
with the execution, the execution input and output, and relevant execution metadata. If
you've redriven an execution, you can use this API action to return information about the
redrives of that execution. In addition, you can use this API action to return the Map Run
Amazon Resource Name (ARN) if the execution was dispatched by a Map Run. If you specify a
version or alias ARN when you call the StartExecution API action, DescribeExecution returns
that ARN. This operation is eventually consistent. The results are best effort and may not
reflect very recent updates and changes. Executions of an EXPRESS state machine aren't
supported by DescribeExecution unless a Map Run dispatched them.
# Arguments
- `execution_arn`: The Amazon Resource Name (ARN) of the execution to describe.
"""
function describe_execution(executionArn; aws_config::AbstractAWSConfig=global_aws_config())
return sfn(
"DescribeExecution",
Dict{String,Any}("executionArn" => executionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_execution(
executionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sfn(
"DescribeExecution",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("executionArn" => executionArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_map_run(map_run_arn)
describe_map_run(map_run_arn, params::Dict{String,<:Any})
Provides information about a Map Run's configuration, progress, and results. If you've
redriven a Map Run, this API action also returns information about the redrives of that Map
Run. For more information, see Examining Map Run in the Step Functions Developer Guide.
# Arguments
- `map_run_arn`: The Amazon Resource Name (ARN) that identifies a Map Run.
"""
function describe_map_run(mapRunArn; aws_config::AbstractAWSConfig=global_aws_config())
return sfn(
"DescribeMapRun",
Dict{String,Any}("mapRunArn" => mapRunArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_map_run(
mapRunArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sfn(
"DescribeMapRun",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("mapRunArn" => mapRunArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_state_machine(state_machine_arn)
describe_state_machine(state_machine_arn, params::Dict{String,<:Any})
Provides information about a state machine's definition, its IAM role Amazon Resource Name
(ARN), and configuration. A qualified state machine ARN can either refer to a Distributed
Map state defined within a state machine, a version ARN, or an alias ARN. The following are
some examples of qualified and unqualified state machine ARNs: The following qualified
state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state
machine named myStateMachine.
arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel If you
provide a qualified state machine ARN that refers to a Distributed Map state, the request
fails with ValidationException. The following qualified state machine ARN refers to an
alias named PROD.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachi
ne:PROD> If you provide a qualified state machine ARN that refers to a version ARN or
an alias ARN, the request starts execution for that version or alias. The following
unqualified state machine ARN refers to a state machine named myStateMachine.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachi
ne> This API action returns the details for a state machine version if the
stateMachineArn you specify is a state machine version ARN. This operation is eventually
consistent. The results are best effort and may not reflect very recent updates and
changes.
# Arguments
- `state_machine_arn`: The Amazon Resource Name (ARN) of the state machine for which you
want the information. If you specify a state machine version ARN, this API returns details
about that version. The version ARN is a combination of state machine ARN and the version
number separated by a colon (:). For example, stateMachineARN:1.
"""
function describe_state_machine(
stateMachineArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sfn(
"DescribeStateMachine",
Dict{String,Any}("stateMachineArn" => stateMachineArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_state_machine(
stateMachineArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sfn(
"DescribeStateMachine",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("stateMachineArn" => stateMachineArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_state_machine_alias(state_machine_alias_arn)
describe_state_machine_alias(state_machine_alias_arn, params::Dict{String,<:Any})
Returns details about a state machine alias. Related operations:
CreateStateMachineAlias ListStateMachineAliases UpdateStateMachineAlias
DeleteStateMachineAlias
# Arguments
- `state_machine_alias_arn`: The Amazon Resource Name (ARN) of the state machine alias.
"""
function describe_state_machine_alias(
stateMachineAliasArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sfn(
"DescribeStateMachineAlias",
Dict{String,Any}("stateMachineAliasArn" => stateMachineAliasArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_state_machine_alias(
stateMachineAliasArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sfn(
"DescribeStateMachineAlias",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("stateMachineAliasArn" => stateMachineAliasArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_state_machine_for_execution(execution_arn)
describe_state_machine_for_execution(execution_arn, params::Dict{String,<:Any})
Provides information about a state machine's definition, its execution role ARN, and
configuration. If a Map Run dispatched the execution, this action returns the Map Run
Amazon Resource Name (ARN) in the response. The state machine returned is the state machine
associated with the Map Run. This operation is eventually consistent. The results are best
effort and may not reflect very recent updates and changes. This API action is not
supported by EXPRESS state machines.
# Arguments
- `execution_arn`: The Amazon Resource Name (ARN) of the execution you want state machine
information for.
"""
function describe_state_machine_for_execution(
executionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sfn(
"DescribeStateMachineForExecution",
Dict{String,Any}("executionArn" => executionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_state_machine_for_execution(
executionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sfn(
"DescribeStateMachineForExecution",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("executionArn" => executionArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_activity_task(activity_arn)
get_activity_task(activity_arn, params::Dict{String,<:Any})
Used by workers to retrieve a task (with the specified activity ARN) which has been
scheduled for execution by a running state machine. This initiates a long poll, where the
service holds the HTTP connection open and responds as soon as a task becomes available
(i.e. an execution of a task of this type is needed.) The maximum time the service holds on
to the request before responding is 60 seconds. If no task is available within 60 seconds,
the poll returns a taskToken with a null string. This API action isn't logged in
CloudTrail. Workers should set their client side socket timeout to at least 65 seconds (5
seconds higher than the maximum time the service may hold the poll request). Polling with
GetActivityTask can cause latency in some implementations. See Avoid Latency When Polling
for Activity Tasks in the Step Functions Developer Guide.
# Arguments
- `activity_arn`: The Amazon Resource Name (ARN) of the activity to retrieve tasks from
(assigned when you create the task using CreateActivity.)
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"workerName"`: You can provide an arbitrary name in order to identify the worker that
the task is assigned to. This name is used when it is logged in the execution history.
"""
function get_activity_task(activityArn; aws_config::AbstractAWSConfig=global_aws_config())
return sfn(
"GetActivityTask",
Dict{String,Any}("activityArn" => activityArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_activity_task(
activityArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sfn(
"GetActivityTask",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("activityArn" => activityArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_execution_history(execution_arn)
get_execution_history(execution_arn, params::Dict{String,<:Any})
Returns the history of the specified execution as a list of events. By default, the results
are returned in ascending order of the timeStamp of the events. Use the reverseOrder
parameter to get the latest events first. 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. This API action is not supported by EXPRESS
state machines.
# Arguments
- `execution_arn`: The Amazon Resource Name (ARN) of the execution.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"includeExecutionData"`: You can select whether execution data (input or output of a
history event) is returned. The default is true.
- `"maxResults"`: The maximum number of results that are returned per call. You can use
nextToken to obtain further pages of results. The default is 100 and the maximum allowed
page size is 1000. A value of 0 uses the default. This is only an upper limit. The actual
number of results returned per call might be fewer than the specified maximum.
- `"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.
- `"reverseOrder"`: Lists events in descending order of their timeStamp.
"""
function get_execution_history(
executionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sfn(
"GetExecutionHistory",
Dict{String,Any}("executionArn" => executionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_execution_history(
executionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sfn(
"GetExecutionHistory",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("executionArn" => executionArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_activities()
list_activities(params::Dict{String,<:Any})
Lists the existing activities. 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. This operation is eventually consistent. The results are
best effort and may not reflect very recent updates and changes.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results that are returned per call. You can use
nextToken to obtain further pages of results. The default is 100 and the maximum allowed
page size is 1000. A value of 0 uses the default. This is only an upper limit. The actual
number of results returned per call might be fewer than the specified maximum.
- `"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_activities(; aws_config::AbstractAWSConfig=global_aws_config())
return sfn("ListActivities"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_activities(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sfn(
"ListActivities", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_executions()
list_executions(params::Dict{String,<:Any})
Lists all executions of a state machine or a Map Run. You can list all executions related
to a state machine by specifying a state machine Amazon Resource Name (ARN), or those
related to a Map Run by specifying a Map Run ARN. Using this API action, you can also list
all redriven executions. You can also provide a state machine alias ARN or version ARN to
list the executions associated with a specific alias or version. Results are sorted by
time, with the most recent execution first. 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. This operation is eventually consistent. The
results are best effort and may not reflect very recent updates and changes. This API
action is not supported by EXPRESS state machines.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"mapRunArn"`: The Amazon Resource Name (ARN) of the Map Run that started the child
workflow executions. If the mapRunArn field is specified, a list of all of the child
workflow executions started by a Map Run is returned. For more information, see Examining
Map Run in the Step Functions Developer Guide. You can specify either a mapRunArn or a
stateMachineArn, but not both.
- `"maxResults"`: The maximum number of results that are returned per call. You can use
nextToken to obtain further pages of results. The default is 100 and the maximum allowed
page size is 1000. A value of 0 uses the default. This is only an upper limit. The actual
number of results returned per call might be fewer than the specified maximum.
- `"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.
- `"redriveFilter"`: Sets a filter to list executions based on whether or not they have
been redriven. For a Distributed Map, redriveFilter sets a filter to list child workflow
executions based on whether or not they have been redriven. If you do not provide a
redriveFilter, Step Functions returns a list of both redriven and non-redriven executions.
If you provide a state machine ARN in redriveFilter, the API returns a validation exception.
- `"stateMachineArn"`: The Amazon Resource Name (ARN) of the state machine whose executions
is listed. You can specify either a mapRunArn or a stateMachineArn, but not both. You can
also return a list of executions associated with a specific alias or version, by specifying
an alias ARN or a version ARN in the stateMachineArn parameter.
- `"statusFilter"`: If specified, only list the executions whose current execution status
matches the given filter.
"""
function list_executions(; aws_config::AbstractAWSConfig=global_aws_config())
return sfn("ListExecutions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_executions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sfn(
"ListExecutions", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_map_runs(execution_arn)
list_map_runs(execution_arn, params::Dict{String,<:Any})
Lists all Map Runs that were started by a given state machine execution. Use this API
action to obtain Map Run ARNs, and then call DescribeMapRun to obtain more information, if
needed.
# Arguments
- `execution_arn`: The Amazon Resource Name (ARN) of the execution for which the Map Runs
must be listed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results that are returned per call. You can use
nextToken to obtain further pages of results. The default is 100 and the maximum allowed
page size is 1000. A value of 0 uses the default. This is only an upper limit. The actual
number of results returned per call might be fewer than the specified maximum.
- `"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_map_runs(executionArn; aws_config::AbstractAWSConfig=global_aws_config())
return sfn(
"ListMapRuns",
Dict{String,Any}("executionArn" => executionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_map_runs(
executionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sfn(
"ListMapRuns",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("executionArn" => executionArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_state_machine_aliases(state_machine_arn)
list_state_machine_aliases(state_machine_arn, params::Dict{String,<:Any})
Lists aliases for a specified state machine ARN. Results are sorted by time, with the most
recently created aliases listed first. To list aliases that reference a state machine
version, you can specify the version ARN in the stateMachineArn parameter. 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. Related
operations: CreateStateMachineAlias DescribeStateMachineAlias
UpdateStateMachineAlias DeleteStateMachineAlias
# Arguments
- `state_machine_arn`: The Amazon Resource Name (ARN) of the state machine for which you
want to list aliases. If you specify a state machine version ARN, this API returns a list
of aliases for that version.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results that are returned per call. You can use
nextToken to obtain further pages of results. The default is 100 and the maximum allowed
page size is 1000. A value of 0 uses the default. This is only an upper limit. The actual
number of results returned per call might be fewer than the specified maximum.
- `"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_state_machine_aliases(
stateMachineArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sfn(
"ListStateMachineAliases",
Dict{String,Any}("stateMachineArn" => stateMachineArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_state_machine_aliases(
stateMachineArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sfn(
"ListStateMachineAliases",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("stateMachineArn" => stateMachineArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_state_machine_versions(state_machine_arn)
list_state_machine_versions(state_machine_arn, params::Dict{String,<:Any})
Lists versions for the specified state machine Amazon Resource Name (ARN). The results are
sorted in descending order of the version creation time. 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. Related operations:
PublishStateMachineVersion DeleteStateMachineVersion
# Arguments
- `state_machine_arn`: The Amazon Resource Name (ARN) of the state machine.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results that are returned per call. You can use
nextToken to obtain further pages of results. The default is 100 and the maximum allowed
page size is 1000. A value of 0 uses the default. This is only an upper limit. The actual
number of results returned per call might be fewer than the specified maximum.
- `"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_state_machine_versions(
stateMachineArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sfn(
"ListStateMachineVersions",
Dict{String,Any}("stateMachineArn" => stateMachineArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_state_machine_versions(
stateMachineArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sfn(
"ListStateMachineVersions",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("stateMachineArn" => stateMachineArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_state_machines()
list_state_machines(params::Dict{String,<:Any})
Lists the existing state machines. 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. This operation is eventually consistent. The
results are best effort and may not reflect very recent updates and changes.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results that are returned per call. You can use
nextToken to obtain further pages of results. The default is 100 and the maximum allowed
page size is 1000. A value of 0 uses the default. This is only an upper limit. The actual
number of results returned per call might be fewer than the specified maximum.
- `"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_state_machines(; aws_config::AbstractAWSConfig=global_aws_config())
return sfn("ListStateMachines"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_state_machines(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sfn(
"ListStateMachines", 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 tags for a given resource. Tags may only contain Unicode letters, digits, white space,
or these symbols: _ . : / = + - @.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) for the Step Functions state machine or
activity.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sfn(
"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 sfn(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
publish_state_machine_version(state_machine_arn)
publish_state_machine_version(state_machine_arn, params::Dict{String,<:Any})
Creates a version from the current revision of a state machine. Use versions to create
immutable snapshots of your state machine. You can start executions from versions either
directly or with an alias. To create an alias, use CreateStateMachineAlias. You can publish
up to 1000 versions for each state machine. You must manually delete unused versions using
the DeleteStateMachineVersion API action. PublishStateMachineVersion is an idempotent API.
It doesn't create a duplicate state machine version if it already exists for the current
revision. Step Functions bases PublishStateMachineVersion's idempotency check on the
stateMachineArn, name, and revisionId parameters. Requests with the same parameters return
a successful idempotent response. If you don't specify a revisionId, Step Functions checks
for a previously published version of the state machine's current revision. Related
operations: DeleteStateMachineVersion ListStateMachineVersions
# Arguments
- `state_machine_arn`: The Amazon Resource Name (ARN) of the state machine.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: An optional description of the state machine version.
- `"revisionId"`: Only publish the state machine version if the current state machine's
revision ID matches the specified ID. Use this option to avoid publishing a version if the
state machine changed since you last updated it. If the specified revision ID doesn't match
the state machine's current revision ID, the API returns ConflictException. To specify an
initial revision ID for a state machine with no revision ID assigned, specify the string
INITIAL for the revisionId parameter. For example, you can specify a revisionID of INITIAL
when you create a state machine using the CreateStateMachine API action.
"""
function publish_state_machine_version(
stateMachineArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sfn(
"PublishStateMachineVersion",
Dict{String,Any}("stateMachineArn" => stateMachineArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function publish_state_machine_version(
stateMachineArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sfn(
"PublishStateMachineVersion",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("stateMachineArn" => stateMachineArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
redrive_execution(execution_arn)
redrive_execution(execution_arn, params::Dict{String,<:Any})
Restarts unsuccessful executions of Standard workflows that didn't complete successfully in
the last 14 days. These include failed, aborted, or timed out executions. When you redrive
an execution, it continues the failed execution from the unsuccessful step and uses the
same input. Step Functions preserves the results and execution history of the successful
steps, and doesn't rerun these steps when you redrive an execution. Redriven executions use
the same state machine definition and execution ARN as the original execution attempt. For
workflows that include an Inline Map or Parallel state, RedriveExecution API action
reschedules and redrives only the iterations and branches that failed or aborted. To
redrive a workflow that includes a Distributed Map state whose Map Run failed, you must
redrive the parent workflow. The parent workflow redrives all the unsuccessful states,
including a failed Map Run. If a Map Run was not started in the original execution attempt,
the redriven parent workflow starts the Map Run. This API action is not supported by
EXPRESS state machines. However, you can restart the unsuccessful executions of Express
child workflows in a Distributed Map by redriving its Map Run. When you redrive a Map Run,
the Express child workflows are rerun using the StartExecution API action. For more
information, see Redriving Map Runs. You can redrive executions if your original execution
meets the following conditions: The execution status isn't SUCCEEDED. Your workflow
execution has not exceeded the redrivable period of 14 days. Redrivable period refers to
the time during which you can redrive a given execution. This period starts from the day a
state machine completes its execution. The workflow execution has not exceeded the
maximum open time of one year. For more information about state machine quotas, see Quotas
related to state machine executions. The execution event history count is less than
24,999. Redriven executions append their event history to the existing event history. Make
sure your workflow execution contains less than 24,999 events to accommodate the
ExecutionRedriven history event and at least one other history event.
# Arguments
- `execution_arn`: The Amazon Resource Name (ARN) of the execution to be redriven.
# 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 you don’t specify a client token, the Amazon Web Services
SDK automatically generates a client token and uses it for the request to ensure
idempotency. The API will return idempotent responses for the last 10 client tokens used to
successfully redrive the execution. These client tokens are valid for up to 15 minutes
after they are first used.
"""
function redrive_execution(executionArn; aws_config::AbstractAWSConfig=global_aws_config())
return sfn(
"RedriveExecution",
Dict{String,Any}("executionArn" => executionArn, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function redrive_execution(
executionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sfn(
"RedriveExecution",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"executionArn" => executionArn, "clientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_task_failure(task_token)
send_task_failure(task_token, params::Dict{String,<:Any})
Used by activity workers, Task states using the callback pattern, and optionally Task
states using the job run pattern to report that the task identified by the taskToken failed.
# Arguments
- `task_token`: The token that represents this task. Task tokens are generated by Step
Functions when tasks are assigned to a worker, or in the context object when a workflow
enters a task state. See GetActivityTaskOutputtaskToken.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cause"`: A more detailed explanation of the cause of the failure.
- `"error"`: The error code of the failure.
"""
function send_task_failure(taskToken; aws_config::AbstractAWSConfig=global_aws_config())
return sfn(
"SendTaskFailure",
Dict{String,Any}("taskToken" => taskToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_task_failure(
taskToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sfn(
"SendTaskFailure",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("taskToken" => taskToken), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_task_heartbeat(task_token)
send_task_heartbeat(task_token, params::Dict{String,<:Any})
Used by activity workers and Task states using the callback pattern, and optionally Task
states using the job run pattern to report to Step Functions that the task represented by
the specified taskToken is still making progress. This action resets the Heartbeat clock.
The Heartbeat threshold is specified in the state machine's Amazon States Language
definition (HeartbeatSeconds). This action does not in itself create an event in the
execution history. However, if the task times out, the execution history contains an
ActivityTimedOut entry for activities, or a TaskTimedOut entry for tasks using the job run
or callback pattern. The Timeout of a task, defined in the state machine's Amazon States
Language definition, is its maximum allowed duration, regardless of the number of
SendTaskHeartbeat requests received. Use HeartbeatSeconds to configure the timeout interval
for heartbeats.
# Arguments
- `task_token`: The token that represents this task. Task tokens are generated by Step
Functions when tasks are assigned to a worker, or in the context object when a workflow
enters a task state. See GetActivityTaskOutputtaskToken.
"""
function send_task_heartbeat(taskToken; aws_config::AbstractAWSConfig=global_aws_config())
return sfn(
"SendTaskHeartbeat",
Dict{String,Any}("taskToken" => taskToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_task_heartbeat(
taskToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sfn(
"SendTaskHeartbeat",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("taskToken" => taskToken), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_task_success(output, task_token)
send_task_success(output, task_token, params::Dict{String,<:Any})
Used by activity workers, Task states using the callback pattern, and optionally Task
states using the job run pattern to report that the task identified by the taskToken
completed successfully.
# Arguments
- `output`: The JSON output of the task. Length constraints apply to the payload size, and
are expressed as bytes in UTF-8 encoding.
- `task_token`: The token that represents this task. Task tokens are generated by Step
Functions when tasks are assigned to a worker, or in the context object when a workflow
enters a task state. See GetActivityTaskOutputtaskToken.
"""
function send_task_success(
output, taskToken; aws_config::AbstractAWSConfig=global_aws_config()
)
return sfn(
"SendTaskSuccess",
Dict{String,Any}("output" => output, "taskToken" => taskToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_task_success(
output,
taskToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sfn(
"SendTaskSuccess",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("output" => output, "taskToken" => taskToken),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_execution(state_machine_arn)
start_execution(state_machine_arn, params::Dict{String,<:Any})
Starts a state machine execution. A qualified state machine ARN can either refer to a
Distributed Map state defined within a state machine, a version ARN, or an alias ARN. The
following are some examples of qualified and unqualified state machine ARNs: The
following qualified state machine ARN refers to a Distributed Map state with a label
mapStateLabel in a state machine named myStateMachine.
arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel If you
provide a qualified state machine ARN that refers to a Distributed Map state, the request
fails with ValidationException. The following qualified state machine ARN refers to an
alias named PROD.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachi
ne:PROD> If you provide a qualified state machine ARN that refers to a version ARN or
an alias ARN, the request starts execution for that version or alias. The following
unqualified state machine ARN refers to a state machine named myStateMachine.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachi
ne> If you start an execution with an unqualified state machine ARN, Step Functions
uses the latest revision of the state machine for the execution. To start executions of a
state machine version, call StartExecution and provide the version ARN or the ARN of an
alias that points to the version. StartExecution is idempotent for STANDARD workflows.
For a STANDARD workflow, if you call StartExecution with the same name and input as a
running execution, the call succeeds and return the same response as the original request.
If the execution is closed or if the input is different, it returns a 400
ExecutionAlreadyExists error. You can reuse names after 90 days. StartExecution isn't
idempotent for EXPRESS workflows.
# Arguments
- `state_machine_arn`: The Amazon Resource Name (ARN) of the state machine to execute. The
stateMachineArn parameter accepts one of the following inputs: An unqualified state
machine ARN – Refers to a state machine ARN that isn't qualified with a version or alias
ARN. The following is an example of an unqualified state machine ARN.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachi
ne> Step Functions doesn't associate state machine executions that you start with an
unqualified ARN with a version. This is true even if that version uses the same revision
that the execution used. A state machine version ARN – Refers to a version ARN, which
is a combination of state machine ARN and the version number separated by a colon (:). The
following is an example of the ARN for version 10.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachi
ne>:10 Step Functions doesn't associate executions that you start with a version ARN
with any aliases that point to that version. A state machine alias ARN – Refers to an
alias ARN, which is a combination of state machine ARN and the alias name separated by a
colon (:). The following is an example of the ARN for an alias named PROD.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachi
ne:PROD> Step Functions associates executions that you start with an alias ARN with
that alias and the state machine version used for that execution.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"input"`: The string that contains the JSON input data for the execution, for example:
\"input\": \"{\"first_name\" : \"test\"}\" If you don't include any JSON input data, you
still must include the two braces, for example: \"input\": \"{}\" Length constraints
apply to the payload size, and are expressed as bytes in UTF-8 encoding.
- `"name"`: Optional name of the execution. This name must be unique for your Amazon Web
Services account, Region, and state machine for 90 days. For more information, see Limits
Related to State Machine Executions in the Step Functions Developer Guide. If you don't
provide a name for the execution, Step Functions automatically generates a universally
unique identifier (UUID) as the execution name. A name must not contain: white space
brackets < > { } [ ] wildcard characters ? * special characters \" # % ^ | ~ `
& , ; : / control characters (U+0000-001F, U+007F-009F) To enable logging with
CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
- `"traceHeader"`: Passes the X-Ray trace header. The trace header can also be passed in
the request payload.
"""
function start_execution(stateMachineArn; aws_config::AbstractAWSConfig=global_aws_config())
return sfn(
"StartExecution",
Dict{String,Any}("stateMachineArn" => stateMachineArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_execution(
stateMachineArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sfn(
"StartExecution",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("stateMachineArn" => stateMachineArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_sync_execution(state_machine_arn)
start_sync_execution(state_machine_arn, params::Dict{String,<:Any})
Starts a Synchronous Express state machine execution. StartSyncExecution is not available
for STANDARD workflows. StartSyncExecution will return a 200 OK response, even if your
execution fails, because the status code in the API response doesn't reflect function
errors. Error codes are reserved for errors that prevent your execution from running, such
as permissions errors, limit errors, or issues with your state machine code and
configuration. This API action isn't logged in CloudTrail.
# Arguments
- `state_machine_arn`: The Amazon Resource Name (ARN) of the state machine to execute.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"input"`: The string that contains the JSON input data for the execution, for example:
\"input\": \"{\"first_name\" : \"test\"}\" If you don't include any JSON input data, you
still must include the two braces, for example: \"input\": \"{}\" Length constraints
apply to the payload size, and are expressed as bytes in UTF-8 encoding.
- `"name"`: The name of the execution.
- `"traceHeader"`: Passes the X-Ray trace header. The trace header can also be passed in
the request payload.
"""
function start_sync_execution(
stateMachineArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sfn(
"StartSyncExecution",
Dict{String,Any}("stateMachineArn" => stateMachineArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_sync_execution(
stateMachineArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sfn(
"StartSyncExecution",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("stateMachineArn" => stateMachineArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_execution(execution_arn)
stop_execution(execution_arn, params::Dict{String,<:Any})
Stops an execution. This API action is not supported by EXPRESS state machines.
# Arguments
- `execution_arn`: The Amazon Resource Name (ARN) of the execution to stop.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cause"`: A more detailed explanation of the cause of the failure.
- `"error"`: The error code of the failure.
"""
function stop_execution(executionArn; aws_config::AbstractAWSConfig=global_aws_config())
return sfn(
"StopExecution",
Dict{String,Any}("executionArn" => executionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_execution(
executionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sfn(
"StopExecution",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("executionArn" => executionArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Add a tag to a Step Functions resource. An array of key-value pairs. For more information,
see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User
Guide, and Controlling Access Using IAM Tags. Tags may only contain Unicode letters,
digits, white space, or these symbols: _ . : / = + - @.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) for the Step Functions state machine or
activity.
- `tags`: The list of tags to add to a resource. Tags may only contain Unicode letters,
digits, white space, or these symbols: _ . : / = + - @.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return sfn(
"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 sfn(
"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_state(definition, role_arn)
test_state(definition, role_arn, params::Dict{String,<:Any})
Accepts the definition of a single state and executes it. You can test a state without
creating a state machine or updating an existing state machine. Using this API, you can
test the following: A state's input and output processing data flow An Amazon Web
Services service integration request and response An HTTP Task request and response You
can call this API on only one state at a time. The states that you can test include the
following: All Task types except Activity Pass Wait Choice Succeed
Fail The TestState API assumes an IAM role which must contain the required IAM
permissions for the resources your state is accessing. For information about the
permissions a state might need, see IAM permissions to test a state. The TestState API can
run for up to five minutes. If the execution of a state exceeds this duration, it fails
with the States.Timeout error. TestState doesn't support Activity tasks, .sync or
.waitForTaskToken service integration patterns, Parallel, or Map states.
# Arguments
- `definition`: The Amazon States Language (ASL) definition of the state.
- `role_arn`: The Amazon Resource Name (ARN) of the execution role with the required IAM
permissions for the state.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"input"`: A string that contains the JSON input data for the state.
- `"inspectionLevel"`: Determines the values to return when a state is tested. You can
specify one of the following types: INFO: Shows the final state output. By default, Step
Functions sets inspectionLevel to INFO if you don't specify a level. DEBUG: Shows the
final state output along with the input and output data processing result. TRACE: Shows
the HTTP request and response for an HTTP Task. This level also shows the final state
output along with the input and output data processing result. Each of these levels also
provide information about the status of the state execution and the next state to
transition to.
- `"revealSecrets"`: Specifies whether or not to include secret information in the test
result. For HTTP Tasks, a secret includes the data that an EventBridge connection adds to
modify the HTTP request headers, query parameters, and body. Step Functions doesn't omit
any information included in the state definition or the HTTP response. If you set
revealSecrets to true, you must make sure that the IAM user that calls the TestState API
has permission for the states:RevealSecrets action. For an example of IAM policy that sets
the states:RevealSecrets permission, see IAM permissions to test a state. Without this
permission, Step Functions throws an access denied error. By default, revealSecrets is set
to false.
"""
function test_state(definition, roleArn; aws_config::AbstractAWSConfig=global_aws_config())
return sfn(
"TestState",
Dict{String,Any}("definition" => definition, "roleArn" => roleArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function test_state(
definition,
roleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sfn(
"TestState",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("definition" => definition, "roleArn" => roleArn),
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 a tag from a Step Functions resource
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) for the Step Functions state machine or
activity.
- `tag_keys`: The list of tags to remove from the resource.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return sfn(
"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 sfn(
"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_map_run(map_run_arn)
update_map_run(map_run_arn, params::Dict{String,<:Any})
Updates an in-progress Map Run's configuration to include changes to the settings that
control maximum concurrency and Map Run failure.
# Arguments
- `map_run_arn`: The Amazon Resource Name (ARN) of a Map Run.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxConcurrency"`: The maximum number of child workflow executions that can be specified
to run in parallel for the Map Run at the same time.
- `"toleratedFailureCount"`: The maximum number of failed items before the Map Run fails.
- `"toleratedFailurePercentage"`: The maximum percentage of failed items before the Map Run
fails.
"""
function update_map_run(mapRunArn; aws_config::AbstractAWSConfig=global_aws_config())
return sfn(
"UpdateMapRun",
Dict{String,Any}("mapRunArn" => mapRunArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_map_run(
mapRunArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sfn(
"UpdateMapRun",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("mapRunArn" => mapRunArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_state_machine(state_machine_arn)
update_state_machine(state_machine_arn, params::Dict{String,<:Any})
Updates an existing state machine by modifying its definition, roleArn, or
loggingConfiguration. Running executions will continue to use the previous definition and
roleArn. You must include at least one of definition or roleArn or you will receive a
MissingRequiredParameter error. A qualified state machine ARN refers to a Distributed Map
state defined within a state machine. For example, the qualified state machine ARN
arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers
to a Distributed Map state with a label mapStateLabel in the state machine named
stateMachineName. A qualified state machine ARN can either refer to a Distributed Map state
defined within a state machine, a version ARN, or an alias ARN. The following are some
examples of qualified and unqualified state machine ARNs: The following qualified state
machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine
named myStateMachine.
arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel If you
provide a qualified state machine ARN that refers to a Distributed Map state, the request
fails with ValidationException. The following qualified state machine ARN refers to an
alias named PROD.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachi
ne:PROD> If you provide a qualified state machine ARN that refers to a version ARN or
an alias ARN, the request starts execution for that version or alias. The following
unqualified state machine ARN refers to a state machine named myStateMachine.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachi
ne> After you update your state machine, you can set the publish parameter to true in
the same action to publish a new version. This way, you can opt-in to strict versioning of
your state machine. Step Functions assigns monotonically increasing integers for state
machine versions, starting at version number 1. All StartExecution calls within a few
seconds use the updated definition and roleArn. Executions started immediately after you
call UpdateStateMachine may use the previous state machine definition and roleArn.
# Arguments
- `state_machine_arn`: The Amazon Resource Name (ARN) of the state machine.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"definition"`: The Amazon States Language definition of the state machine. See Amazon
States Language.
- `"loggingConfiguration"`: Use the LoggingConfiguration data type to set CloudWatch Logs
options.
- `"publish"`: Specifies whether the state machine version is published. The default is
false. To publish a version after updating the state machine, set publish to true.
- `"roleArn"`: The Amazon Resource Name (ARN) of the IAM role of the state machine.
- `"tracingConfiguration"`: Selects whether X-Ray tracing is enabled.
- `"versionDescription"`: An optional description of the state machine version to publish.
You can only specify the versionDescription parameter if you've set publish to true.
"""
function update_state_machine(
stateMachineArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sfn(
"UpdateStateMachine",
Dict{String,Any}("stateMachineArn" => stateMachineArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_state_machine(
stateMachineArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sfn(
"UpdateStateMachine",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("stateMachineArn" => stateMachineArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_state_machine_alias(state_machine_alias_arn)
update_state_machine_alias(state_machine_alias_arn, params::Dict{String,<:Any})
Updates the configuration of an existing state machine alias by modifying its description
or routingConfiguration. You must specify at least one of the description or
routingConfiguration parameters to update a state machine alias. UpdateStateMachineAlias
is an idempotent API. Step Functions bases the idempotency check on the
stateMachineAliasArn, description, and routingConfiguration parameters. Requests with the
same parameters return an idempotent response. This operation is eventually consistent.
All StartExecution requests made within a few seconds use the latest alias configuration.
Executions started immediately after calling UpdateStateMachineAlias may use the previous
routing configuration. Related operations: CreateStateMachineAlias
DescribeStateMachineAlias ListStateMachineAliases DeleteStateMachineAlias
# Arguments
- `state_machine_alias_arn`: The Amazon Resource Name (ARN) of the state machine alias.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A description of the state machine alias.
- `"routingConfiguration"`: The routing configuration of the state machine alias. An array
of RoutingConfig objects that specifies up to two state machine versions that the alias
starts executions for.
"""
function update_state_machine_alias(
stateMachineAliasArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sfn(
"UpdateStateMachineAlias",
Dict{String,Any}("stateMachineAliasArn" => stateMachineAliasArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_state_machine_alias(
stateMachineAliasArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sfn(
"UpdateStateMachineAlias",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("stateMachineAliasArn" => stateMachineAliasArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
validate_state_machine_definition(definition)
validate_state_machine_definition(definition, params::Dict{String,<:Any})
Validates the syntax of a state machine definition. You can validate that a state machine
definition is correct without creating a state machine resource. Step Functions will
implicitly perform the same syntax check when you invoke CreateStateMachine and
UpdateStateMachine. State machine definitions are specified using a JSON-based, structured
language. For more information on Amazon States Language see Amazon States Language (ASL).
Suggested uses for ValidateStateMachineDefinition: Integrate automated checks into your
code review or Continuous Integration (CI) process to validate state machine definitions
before starting deployments. Run the validation from a Git pre-commit hook to check your
state machine definitions before committing them to your source repository. Errors found
in the state machine definition will be returned in the response as a list of diagnostic
elements, rather than raise an exception.
# Arguments
- `definition`: The Amazon States Language definition of the state machine. For more
information, see Amazon States Language (ASL).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"type"`: The target type of state machine for this definition. The default is STANDARD.
"""
function validate_state_machine_definition(
definition; aws_config::AbstractAWSConfig=global_aws_config()
)
return sfn(
"ValidateStateMachineDefinition",
Dict{String,Any}("definition" => definition);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function validate_state_machine_definition(
definition,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sfn(
"ValidateStateMachineDefinition",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("definition" => definition), 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 | 55418 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: shield
using AWS.Compat
using AWS.UUIDs
"""
associate_drtlog_bucket(log_bucket)
associate_drtlog_bucket(log_bucket, params::Dict{String,<:Any})
Authorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket
containing log data such as Application Load Balancer access logs, CloudFront logs, or logs
from third party sources. You can associate up to 10 Amazon S3 buckets with your
subscription. To use the services of the SRT and make an AssociateDRTLogBucket request, you
must be subscribed to the Business Support plan or the Enterprise Support plan.
# Arguments
- `log_bucket`: The Amazon S3 bucket that contains the logs that you want to share.
"""
function associate_drtlog_bucket(
LogBucket; aws_config::AbstractAWSConfig=global_aws_config()
)
return shield(
"AssociateDRTLogBucket",
Dict{String,Any}("LogBucket" => LogBucket);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_drtlog_bucket(
LogBucket,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return shield(
"AssociateDRTLogBucket",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("LogBucket" => LogBucket), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_drtrole(role_arn)
associate_drtrole(role_arn, params::Dict{String,<:Any})
Authorizes the Shield Response Team (SRT) using the specified role, to access your Amazon
Web Services account to assist with DDoS attack mitigation during potential attacks. This
enables the SRT to inspect your WAF configuration and create or update WAF rules and web
ACLs. You can associate only one RoleArn with your subscription. If you submit an
AssociateDRTRole request for an account that already has an associated role, the new
RoleArn will replace the existing RoleArn. Prior to making the AssociateDRTRole request,
you must attach the AWSShieldDRTAccessPolicy managed policy to the role that you'll specify
in the request. You can access this policy in the IAM console at AWSShieldDRTAccessPolicy.
For more information see Adding and removing IAM identity permissions. The role must also
trust the service principal drt.shield.amazonaws.com. For more information, see IAM JSON
policy elements: Principal. The SRT will have access only to your WAF and Shield resources.
By submitting this request, you authorize the SRT to inspect your WAF and Shield
configuration and create and update WAF rules and web ACLs on your behalf. The SRT takes
these actions only if explicitly authorized by you. You must have the iam:PassRole
permission to make an AssociateDRTRole request. For more information, see Granting a user
permissions to pass a role to an Amazon Web Services service. To use the services of the
SRT and make an AssociateDRTRole request, you must be subscribed to the Business Support
plan or the Enterprise Support plan.
# Arguments
- `role_arn`: The Amazon Resource Name (ARN) of the role the SRT will use to access your
Amazon Web Services account. Prior to making the AssociateDRTRole request, you must attach
the AWSShieldDRTAccessPolicy managed policy to this role. For more information see
Attaching and Detaching IAM Policies.
"""
function associate_drtrole(RoleArn; aws_config::AbstractAWSConfig=global_aws_config())
return shield(
"AssociateDRTRole",
Dict{String,Any}("RoleArn" => RoleArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_drtrole(
RoleArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return shield(
"AssociateDRTRole",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("RoleArn" => RoleArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_health_check(health_check_arn, protection_id)
associate_health_check(health_check_arn, protection_id, params::Dict{String,<:Any})
Adds health-based detection to the Shield Advanced protection for a resource. Shield
Advanced health-based detection uses the health of your Amazon Web Services resource to
improve responsiveness and accuracy in attack detection and response. You define the
health check in Route 53 and then associate it with your Shield Advanced protection. For
more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide.
# Arguments
- `health_check_arn`: The Amazon Resource Name (ARN) of the health check to associate with
the protection.
- `protection_id`: The unique identifier (ID) for the Protection object to add the health
check association to.
"""
function associate_health_check(
HealthCheckArn, ProtectionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return shield(
"AssociateHealthCheck",
Dict{String,Any}(
"HealthCheckArn" => HealthCheckArn, "ProtectionId" => ProtectionId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_health_check(
HealthCheckArn,
ProtectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return shield(
"AssociateHealthCheck",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"HealthCheckArn" => HealthCheckArn, "ProtectionId" => ProtectionId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_proactive_engagement_details(emergency_contact_list)
associate_proactive_engagement_details(emergency_contact_list, params::Dict{String,<:Any})
Initializes proactive engagement and sets the list of contacts for the Shield Response Team
(SRT) to use. You must provide at least one phone number in the emergency contact list.
After you have initialized proactive engagement using this call, to disable or enable
proactive engagement, use the calls DisableProactiveEngagement and
EnableProactiveEngagement. This call defines the list of email addresses and phone
numbers that the SRT can use to contact you for escalations to the SRT and to initiate
proactive customer support. The contacts that you provide in the request replace any
contacts that were already defined. If you already have contacts defined and want to use
them, retrieve the list using DescribeEmergencyContactSettings and then provide it to this
call.
# Arguments
- `emergency_contact_list`: A list of email addresses and phone numbers that the Shield
Response Team (SRT) can use to contact you for escalations to the SRT and to initiate
proactive customer support. To enable proactive engagement, the contact list must include
at least one phone number. The contacts that you provide here replace any contacts that
were already defined. If you already have contacts defined and want to use them, retrieve
the list using DescribeEmergencyContactSettings and then provide it here.
"""
function associate_proactive_engagement_details(
EmergencyContactList; aws_config::AbstractAWSConfig=global_aws_config()
)
return shield(
"AssociateProactiveEngagementDetails",
Dict{String,Any}("EmergencyContactList" => EmergencyContactList);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_proactive_engagement_details(
EmergencyContactList,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return shield(
"AssociateProactiveEngagementDetails",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("EmergencyContactList" => EmergencyContactList),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_protection(name, resource_arn)
create_protection(name, resource_arn, params::Dict{String,<:Any})
Enables Shield Advanced for a specific Amazon Web Services resource. The resource can be an
Amazon CloudFront distribution, Amazon Route 53 hosted zone, Global Accelerator standard
accelerator, Elastic IP Address, Application Load Balancer, or a Classic Load Balancer. You
can protect Amazon EC2 instances and Network Load Balancers by association with protected
Amazon EC2 Elastic IP addresses. You can add protection to only a single resource with each
CreateProtection request. You can add protection to multiple resources at once through the
Shield Advanced console at https://console.aws.amazon.com/wafv2/shieldv2#/. For more
information see Getting Started with Shield Advanced and Adding Shield Advanced protection
to Amazon Web Services resources.
# Arguments
- `name`: Friendly name for the Protection you are creating.
- `resource_arn`: The ARN (Amazon Resource Name) of the resource to be protected. The ARN
should be in one of the following formats: For an Application Load Balancer:
arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-bala
ncer-id For an Elastic Load Balancer (Classic Load Balancer):
arn:aws:elasticloadbalancing:region:account-id:loadbalancer/load-balancer-name For an
Amazon CloudFront distribution: arn:aws:cloudfront::account-id:distribution/distribution-id
For an Global Accelerator standard accelerator:
arn:aws:globalaccelerator::account-id:accelerator/accelerator-id For Amazon Route 53:
arn:aws:route53:::hostedzone/hosted-zone-id For an Elastic IP address:
arn:aws:ec2:region:account-id:eip-allocation/allocation-id
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: One or more tag key-value pairs for the Protection object that is created.
"""
function create_protection(
Name, ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return shield(
"CreateProtection",
Dict{String,Any}("Name" => Name, "ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_protection(
Name,
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return shield(
"CreateProtection",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Name" => Name, "ResourceArn" => ResourceArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_protection_group(aggregation, pattern, protection_group_id)
create_protection_group(aggregation, pattern, protection_group_id, params::Dict{String,<:Any})
Creates a grouping of protected resources so they can be handled as a collective. This
resource grouping improves the accuracy of detection and reduces false positives.
# Arguments
- `aggregation`: Defines how Shield combines resource data for the group in order to
detect, mitigate, and report events. Sum - Use the total traffic across the group. This
is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances
that scale manually or automatically. Mean - Use the average of the traffic across the
group. This is a good choice for resources that share traffic uniformly. Examples include
accelerators and load balancers. Max - Use the highest traffic from each resource. This
is useful for resources that don't share traffic and for resources that share that traffic
in a non-uniform way. Examples include Amazon CloudFront and origin resources for
CloudFront distributions.
- `pattern`: The criteria to use to choose the protected resources for inclusion in the
group. You can include all resources that have protections, provide a list of resource
Amazon Resource Names (ARNs), or include all resources of a specified resource type.
- `protection_group_id`: The name of the protection group. You use this to identify the
protection group in lists and to manage the protection group, for example to update,
delete, or describe it.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Members"`: The Amazon Resource Names (ARNs) of the resources to include in the
protection group. You must set this when you set Pattern to ARBITRARY and you must not set
it for any other Pattern setting.
- `"ResourceType"`: The resource type to include in the protection group. All protected
resources of this type are included in the protection group. Newly protected resources of
this type are automatically added to the group. You must set this when you set Pattern to
BY_RESOURCE_TYPE and you must not set it for any other Pattern setting.
- `"Tags"`: One or more tag key-value pairs for the protection group.
"""
function create_protection_group(
Aggregation,
Pattern,
ProtectionGroupId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return shield(
"CreateProtectionGroup",
Dict{String,Any}(
"Aggregation" => Aggregation,
"Pattern" => Pattern,
"ProtectionGroupId" => ProtectionGroupId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_protection_group(
Aggregation,
Pattern,
ProtectionGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return shield(
"CreateProtectionGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Aggregation" => Aggregation,
"Pattern" => Pattern,
"ProtectionGroupId" => ProtectionGroupId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_subscription()
create_subscription(params::Dict{String,<:Any})
Activates Shield Advanced for an account. For accounts that are members of an
Organizations organization, Shield Advanced subscriptions are billed against the
organization's payer account, regardless of whether the payer account itself is subscribed.
When you initially create a subscription, your subscription is set to be automatically
renewed at the end of the existing subscription period. You can change this by submitting
an UpdateSubscription request.
"""
function create_subscription(; aws_config::AbstractAWSConfig=global_aws_config())
return shield(
"CreateSubscription"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function create_subscription(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return shield(
"CreateSubscription", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
delete_protection(protection_id)
delete_protection(protection_id, params::Dict{String,<:Any})
Deletes an Shield Advanced Protection.
# Arguments
- `protection_id`: The unique identifier (ID) for the Protection object to be deleted.
"""
function delete_protection(ProtectionId; aws_config::AbstractAWSConfig=global_aws_config())
return shield(
"DeleteProtection",
Dict{String,Any}("ProtectionId" => ProtectionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_protection(
ProtectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return shield(
"DeleteProtection",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ProtectionId" => ProtectionId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_protection_group(protection_group_id)
delete_protection_group(protection_group_id, params::Dict{String,<:Any})
Removes the specified protection group.
# Arguments
- `protection_group_id`: The name of the protection group. You use this to identify the
protection group in lists and to manage the protection group, for example to update,
delete, or describe it.
"""
function delete_protection_group(
ProtectionGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return shield(
"DeleteProtectionGroup",
Dict{String,Any}("ProtectionGroupId" => ProtectionGroupId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_protection_group(
ProtectionGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return shield(
"DeleteProtectionGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ProtectionGroupId" => ProtectionGroupId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_subscription()
delete_subscription(params::Dict{String,<:Any})
Removes Shield Advanced from an account. Shield Advanced requires a 1-year subscription
commitment. You cannot delete a subscription prior to the completion of that commitment.
"""
function delete_subscription(; aws_config::AbstractAWSConfig=global_aws_config())
return shield(
"DeleteSubscription"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_subscription(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return shield(
"DeleteSubscription", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_attack(attack_id)
describe_attack(attack_id, params::Dict{String,<:Any})
Describes the details of a DDoS attack.
# Arguments
- `attack_id`: The unique identifier (ID) for the attack.
"""
function describe_attack(AttackId; aws_config::AbstractAWSConfig=global_aws_config())
return shield(
"DescribeAttack",
Dict{String,Any}("AttackId" => AttackId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_attack(
AttackId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return shield(
"DescribeAttack",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AttackId" => AttackId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_attack_statistics()
describe_attack_statistics(params::Dict{String,<:Any})
Provides information about the number and type of attacks Shield has detected in the last
year for all resources that belong to your account, regardless of whether you've defined
Shield protections for them. This operation is available to Shield customers as well as to
Shield Advanced customers. The operation returns data for the time range of midnight UTC,
one year ago, to midnight UTC, today. For example, if the current time is 2020-10-26
15:39:32 PDT, equal to 2020-10-26 22:39:32 UTC, then the time range for the attack data
returned is from 2019-10-26 00:00:00 UTC to 2020-10-26 00:00:00 UTC. The time range
indicates the period covered by the attack statistics data items.
"""
function describe_attack_statistics(; aws_config::AbstractAWSConfig=global_aws_config())
return shield(
"DescribeAttackStatistics"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_attack_statistics(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return shield(
"DescribeAttackStatistics",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_drtaccess()
describe_drtaccess(params::Dict{String,<:Any})
Returns the current role and list of Amazon S3 log buckets used by the Shield Response Team
(SRT) to access your Amazon Web Services account while assisting with attack mitigation.
"""
function describe_drtaccess(; aws_config::AbstractAWSConfig=global_aws_config())
return shield(
"DescribeDRTAccess"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_drtaccess(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return shield(
"DescribeDRTAccess", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_emergency_contact_settings()
describe_emergency_contact_settings(params::Dict{String,<:Any})
A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to
contact you if you have proactive engagement enabled, for escalations to the SRT and to
initiate proactive customer support.
"""
function describe_emergency_contact_settings(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return shield(
"DescribeEmergencyContactSettings";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_emergency_contact_settings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return shield(
"DescribeEmergencyContactSettings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_protection()
describe_protection(params::Dict{String,<:Any})
Lists the details of a Protection object.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ProtectionId"`: The unique identifier (ID) for the Protection object to describe. You
must provide either the ResourceArn of the protected resource or the ProtectionID of the
protection, but not both.
- `"ResourceArn"`: The ARN (Amazon Resource Name) of the protected Amazon Web Services
resource. You must provide either the ResourceArn of the protected resource or the
ProtectionID of the protection, but not both.
"""
function describe_protection(; aws_config::AbstractAWSConfig=global_aws_config())
return shield(
"DescribeProtection"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_protection(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return shield(
"DescribeProtection", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_protection_group(protection_group_id)
describe_protection_group(protection_group_id, params::Dict{String,<:Any})
Returns the specification for the specified protection group.
# Arguments
- `protection_group_id`: The name of the protection group. You use this to identify the
protection group in lists and to manage the protection group, for example to update,
delete, or describe it.
"""
function describe_protection_group(
ProtectionGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return shield(
"DescribeProtectionGroup",
Dict{String,Any}("ProtectionGroupId" => ProtectionGroupId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_protection_group(
ProtectionGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return shield(
"DescribeProtectionGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ProtectionGroupId" => ProtectionGroupId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_subscription()
describe_subscription(params::Dict{String,<:Any})
Provides details about the Shield Advanced subscription for an account.
"""
function describe_subscription(; aws_config::AbstractAWSConfig=global_aws_config())
return shield(
"DescribeSubscription"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_subscription(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return shield(
"DescribeSubscription",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_application_layer_automatic_response(resource_arn)
disable_application_layer_automatic_response(resource_arn, params::Dict{String,<:Any})
Disable the Shield Advanced automatic application layer DDoS mitigation feature for the
protected resource. This stops Shield Advanced from creating, verifying, and applying WAF
rules for attacks that it detects for the resource.
# Arguments
- `resource_arn`: The ARN (Amazon Resource Name) of the protected resource.
"""
function disable_application_layer_automatic_response(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return shield(
"DisableApplicationLayerAutomaticResponse",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_application_layer_automatic_response(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return shield(
"DisableApplicationLayerAutomaticResponse",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_proactive_engagement()
disable_proactive_engagement(params::Dict{String,<:Any})
Removes authorization from the Shield Response Team (SRT) to notify contacts about
escalations to the SRT and to initiate proactive customer support.
"""
function disable_proactive_engagement(; aws_config::AbstractAWSConfig=global_aws_config())
return shield(
"DisableProactiveEngagement"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function disable_proactive_engagement(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return shield(
"DisableProactiveEngagement",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_drtlog_bucket(log_bucket)
disassociate_drtlog_bucket(log_bucket, params::Dict{String,<:Any})
Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket
containing the logs that you shared previously.
# Arguments
- `log_bucket`: The Amazon S3 bucket that contains the logs that you want to share.
"""
function disassociate_drtlog_bucket(
LogBucket; aws_config::AbstractAWSConfig=global_aws_config()
)
return shield(
"DisassociateDRTLogBucket",
Dict{String,Any}("LogBucket" => LogBucket);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_drtlog_bucket(
LogBucket,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return shield(
"DisassociateDRTLogBucket",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("LogBucket" => LogBucket), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_drtrole()
disassociate_drtrole(params::Dict{String,<:Any})
Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.
"""
function disassociate_drtrole(; aws_config::AbstractAWSConfig=global_aws_config())
return shield(
"DisassociateDRTRole"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function disassociate_drtrole(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return shield(
"DisassociateDRTRole",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_health_check(health_check_arn, protection_id)
disassociate_health_check(health_check_arn, protection_id, params::Dict{String,<:Any})
Removes health-based detection from the Shield Advanced protection for a resource. Shield
Advanced health-based detection uses the health of your Amazon Web Services resource to
improve responsiveness and accuracy in attack detection and response. You define the
health check in Route 53 and then associate or disassociate it with your Shield Advanced
protection. For more information, see Shield Advanced Health-Based Detection in the WAF
Developer Guide.
# Arguments
- `health_check_arn`: The Amazon Resource Name (ARN) of the health check that is associated
with the protection.
- `protection_id`: The unique identifier (ID) for the Protection object to remove the
health check association from.
"""
function disassociate_health_check(
HealthCheckArn, ProtectionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return shield(
"DisassociateHealthCheck",
Dict{String,Any}(
"HealthCheckArn" => HealthCheckArn, "ProtectionId" => ProtectionId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_health_check(
HealthCheckArn,
ProtectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return shield(
"DisassociateHealthCheck",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"HealthCheckArn" => HealthCheckArn, "ProtectionId" => ProtectionId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_application_layer_automatic_response(action, resource_arn)
enable_application_layer_automatic_response(action, resource_arn, params::Dict{String,<:Any})
Enable the Shield Advanced automatic application layer DDoS mitigation for the protected
resource. This feature is available for Amazon CloudFront distributions and Application
Load Balancers only. This causes Shield Advanced to create, verify, and apply WAF rules
for DDoS attacks that it detects for the resource. Shield Advanced applies the rules in a
Shield rule group inside the web ACL that you've associated with the resource. For
information about how automatic mitigation works and the requirements for using it, see
Shield Advanced automatic application layer DDoS mitigation. Don't use this action to make
changes to automatic mitigation settings when it's already enabled for a resource. Instead,
use UpdateApplicationLayerAutomaticResponse. To use this feature, you must associate a web
ACL with the protected resource. The web ACL must be created using the latest version of
WAF (v2). You can associate the web ACL through the Shield Advanced console at
https://console.aws.amazon.com/wafv2/shieldv2#/. For more information, see Getting Started
with Shield Advanced. You can also associate the web ACL to the resource through the WAF
console or the WAF API, but you must manage Shield Advanced automatic mitigation through
Shield Advanced. For information about WAF, see WAF Developer Guide.
# Arguments
- `action`: Specifies the action setting that Shield Advanced should use in the WAF rules
that it creates on behalf of the protected resource in response to DDoS attacks. You
specify this as part of the configuration for the automatic application layer DDoS
mitigation feature, when you enable or update automatic mitigation. Shield Advanced creates
the WAF rules in a Shield Advanced-managed rule group, inside the web ACL that you have
associated with the resource.
- `resource_arn`: The ARN (Amazon Resource Name) of the protected resource.
"""
function enable_application_layer_automatic_response(
Action, ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return shield(
"EnableApplicationLayerAutomaticResponse",
Dict{String,Any}("Action" => Action, "ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_application_layer_automatic_response(
Action,
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return shield(
"EnableApplicationLayerAutomaticResponse",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Action" => Action, "ResourceArn" => ResourceArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_proactive_engagement()
enable_proactive_engagement(params::Dict{String,<:Any})
Authorizes the Shield Response Team (SRT) to use email and phone to notify contacts about
escalations to the SRT and to initiate proactive customer support.
"""
function enable_proactive_engagement(; aws_config::AbstractAWSConfig=global_aws_config())
return shield(
"EnableProactiveEngagement"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function enable_proactive_engagement(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return shield(
"EnableProactiveEngagement",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_subscription_state()
get_subscription_state(params::Dict{String,<:Any})
Returns the SubscriptionState, either Active or Inactive.
"""
function get_subscription_state(; aws_config::AbstractAWSConfig=global_aws_config())
return shield(
"GetSubscriptionState"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_subscription_state(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return shield(
"GetSubscriptionState",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_attacks()
list_attacks(params::Dict{String,<:Any})
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EndTime"`: The end of the time period for the attacks. This is a timestamp type. The
request syntax listing for this call indicates a number type, but you can provide the time
in any valid timestamp format setting.
- `"MaxResults"`: The greatest number of objects that you want Shield Advanced to return to
the list request. Shield Advanced might return fewer objects than you indicate in this
setting, even if more objects are available. If there are more objects remaining, Shield
Advanced will always also return a NextToken value in the response. The default setting is
20.
- `"NextToken"`: When you request a list of objects from Shield Advanced, if the response
does not include all of the remaining available objects, Shield Advanced includes a
NextToken value in the response. You can retrieve the next batch of objects by requesting
the list again and providing the token that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for
a single call with the MaxResults setting. Shield Advanced will not return more than
MaxResults objects, but may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response
will include a NextToken value. On your first call to a list operation, leave this setting
empty.
- `"ResourceArns"`: The ARNs (Amazon Resource Names) of the resources that were attacked.
If you leave this blank, all applicable resources for this account will be included.
- `"StartTime"`: The start of the time period for the attacks. This is a timestamp type.
The request syntax listing for this call indicates a number type, but you can provide the
time in any valid timestamp format setting.
"""
function list_attacks(; aws_config::AbstractAWSConfig=global_aws_config())
return shield("ListAttacks"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_attacks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return shield(
"ListAttacks", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_protection_groups()
list_protection_groups(params::Dict{String,<:Any})
Retrieves ProtectionGroup objects for the account. You can retrieve all protection groups
or you can provide filtering criteria and retrieve just the subset of protection groups
that match the criteria.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InclusionFilters"`: Narrows the set of protection groups that the call retrieves. You
can retrieve a single protection group by its name and you can retrieve all protection
groups that are configured with specific pattern or aggregation settings. You can provide
up to one criteria per filter type. Shield Advanced returns the protection groups that
exactly match all of the search criteria that you provide.
- `"MaxResults"`: The greatest number of objects that you want Shield Advanced to return to
the list request. Shield Advanced might return fewer objects than you indicate in this
setting, even if more objects are available. If there are more objects remaining, Shield
Advanced will always also return a NextToken value in the response. The default setting is
20.
- `"NextToken"`: When you request a list of objects from Shield Advanced, if the response
does not include all of the remaining available objects, Shield Advanced includes a
NextToken value in the response. You can retrieve the next batch of objects by requesting
the list again and providing the token that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for
a single call with the MaxResults setting. Shield Advanced will not return more than
MaxResults objects, but may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response
will include a NextToken value. On your first call to a list operation, leave this setting
empty.
"""
function list_protection_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return shield(
"ListProtectionGroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_protection_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return shield(
"ListProtectionGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_protections()
list_protections(params::Dict{String,<:Any})
Retrieves Protection objects for the account. You can retrieve all protections or you can
provide filtering criteria and retrieve just the subset of protections that match the
criteria.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InclusionFilters"`: Narrows the set of protections that the call retrieves. You can
retrieve a single protection by providing its name or the ARN (Amazon Resource Name) of its
protected resource. You can also retrieve all protections for a specific resource type. You
can provide up to one criteria per filter type. Shield Advanced returns protections that
exactly match all of the filter criteria that you provide.
- `"MaxResults"`: The greatest number of objects that you want Shield Advanced to return to
the list request. Shield Advanced might return fewer objects than you indicate in this
setting, even if more objects are available. If there are more objects remaining, Shield
Advanced will always also return a NextToken value in the response. The default setting is
20.
- `"NextToken"`: When you request a list of objects from Shield Advanced, if the response
does not include all of the remaining available objects, Shield Advanced includes a
NextToken value in the response. You can retrieve the next batch of objects by requesting
the list again and providing the token that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for
a single call with the MaxResults setting. Shield Advanced will not return more than
MaxResults objects, but may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response
will include a NextToken value. On your first call to a list operation, leave this setting
empty.
"""
function list_protections(; aws_config::AbstractAWSConfig=global_aws_config())
return shield("ListProtections"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_protections(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return shield(
"ListProtections", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_resources_in_protection_group(protection_group_id)
list_resources_in_protection_group(protection_group_id, params::Dict{String,<:Any})
Retrieves the resources that are included in the protection group.
# Arguments
- `protection_group_id`: The name of the protection group. You use this to identify the
protection group in lists and to manage the protection group, for example to update,
delete, or describe it.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The greatest number of objects that you want Shield Advanced to return to
the list request. Shield Advanced might return fewer objects than you indicate in this
setting, even if more objects are available. If there are more objects remaining, Shield
Advanced will always also return a NextToken value in the response. The default setting is
20.
- `"NextToken"`: When you request a list of objects from Shield Advanced, if the response
does not include all of the remaining available objects, Shield Advanced includes a
NextToken value in the response. You can retrieve the next batch of objects by requesting
the list again and providing the token that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for
a single call with the MaxResults setting. Shield Advanced will not return more than
MaxResults objects, but may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response
will include a NextToken value. On your first call to a list operation, leave this setting
empty.
"""
function list_resources_in_protection_group(
ProtectionGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return shield(
"ListResourcesInProtectionGroup",
Dict{String,Any}("ProtectionGroupId" => ProtectionGroupId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_resources_in_protection_group(
ProtectionGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return shield(
"ListResourcesInProtectionGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ProtectionGroupId" => ProtectionGroupId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN)
in Shield.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource to get tags for.
"""
function list_tags_for_resource(
ResourceARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return shield(
"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 shield(
"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 or updates tags for a resource in Shield.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource that you want to add or
update tags for.
- `tags`: The tags that you want to modify or add to the resource.
"""
function tag_resource(ResourceARN, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return shield(
"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 shield(
"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 in Shield.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource that you want to remove
tags from.
- `tag_keys`: The tag key for each tag that you want to remove from the resource.
"""
function untag_resource(
ResourceARN, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return shield(
"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 shield(
"UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceARN" => ResourceARN, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_application_layer_automatic_response(action, resource_arn)
update_application_layer_automatic_response(action, resource_arn, params::Dict{String,<:Any})
Updates an existing Shield Advanced automatic application layer DDoS mitigation
configuration for the specified resource.
# Arguments
- `action`: Specifies the action setting that Shield Advanced should use in the WAF rules
that it creates on behalf of the protected resource in response to DDoS attacks. You
specify this as part of the configuration for the automatic application layer DDoS
mitigation feature, when you enable or update automatic mitigation. Shield Advanced creates
the WAF rules in a Shield Advanced-managed rule group, inside the web ACL that you have
associated with the resource.
- `resource_arn`: The ARN (Amazon Resource Name) of the resource.
"""
function update_application_layer_automatic_response(
Action, ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return shield(
"UpdateApplicationLayerAutomaticResponse",
Dict{String,Any}("Action" => Action, "ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_application_layer_automatic_response(
Action,
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return shield(
"UpdateApplicationLayerAutomaticResponse",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Action" => Action, "ResourceArn" => ResourceArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_emergency_contact_settings()
update_emergency_contact_settings(params::Dict{String,<:Any})
Updates the details of the list of email addresses and phone numbers that the Shield
Response Team (SRT) can use to contact you if you have proactive engagement enabled, for
escalations to the SRT and to initiate proactive customer support.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EmergencyContactList"`: A list of email addresses and phone numbers that the Shield
Response Team (SRT) can use to contact you if you have proactive engagement enabled, for
escalations to the SRT and to initiate proactive customer support. If you have proactive
engagement enabled, the contact list must include at least one phone number.
"""
function update_emergency_contact_settings(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return shield(
"UpdateEmergencyContactSettings";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_emergency_contact_settings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return shield(
"UpdateEmergencyContactSettings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_protection_group(aggregation, pattern, protection_group_id)
update_protection_group(aggregation, pattern, protection_group_id, params::Dict{String,<:Any})
Updates an existing protection group. A protection group is a grouping of protected
resources so they can be handled as a collective. This resource grouping improves the
accuracy of detection and reduces false positives.
# Arguments
- `aggregation`: Defines how Shield combines resource data for the group in order to
detect, mitigate, and report events. Sum - Use the total traffic across the group. This
is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances
that scale manually or automatically. Mean - Use the average of the traffic across the
group. This is a good choice for resources that share traffic uniformly. Examples include
accelerators and load balancers. Max - Use the highest traffic from each resource. This
is useful for resources that don't share traffic and for resources that share that traffic
in a non-uniform way. Examples include Amazon CloudFront distributions and origin resources
for CloudFront distributions.
- `pattern`: The criteria to use to choose the protected resources for inclusion in the
group. You can include all resources that have protections, provide a list of resource
Amazon Resource Names (ARNs), or include all resources of a specified resource type.
- `protection_group_id`: The name of the protection group. You use this to identify the
protection group in lists and to manage the protection group, for example to update,
delete, or describe it.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Members"`: The Amazon Resource Names (ARNs) of the resources to include in the
protection group. You must set this when you set Pattern to ARBITRARY and you must not set
it for any other Pattern setting.
- `"ResourceType"`: The resource type to include in the protection group. All protected
resources of this type are included in the protection group. You must set this when you set
Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern setting.
"""
function update_protection_group(
Aggregation,
Pattern,
ProtectionGroupId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return shield(
"UpdateProtectionGroup",
Dict{String,Any}(
"Aggregation" => Aggregation,
"Pattern" => Pattern,
"ProtectionGroupId" => ProtectionGroupId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_protection_group(
Aggregation,
Pattern,
ProtectionGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return shield(
"UpdateProtectionGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Aggregation" => Aggregation,
"Pattern" => Pattern,
"ProtectionGroupId" => ProtectionGroupId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_subscription()
update_subscription(params::Dict{String,<:Any})
Updates the details of an existing subscription. Only enter values for parameters you want
to change. Empty parameters are not updated. For accounts that are members of an
Organizations organization, Shield Advanced subscriptions are billed against the
organization's payer account, regardless of whether the payer account itself is subscribed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AutoRenew"`: When you initally create a subscription, AutoRenew is set to ENABLED. If
ENABLED, the subscription will be automatically renewed at the end of the existing
subscription period. You can change this by submitting an UpdateSubscription request. If
the UpdateSubscription request does not included a value for AutoRenew, the existing value
for AutoRenew remains unchanged.
"""
function update_subscription(; aws_config::AbstractAWSConfig=global_aws_config())
return shield(
"UpdateSubscription"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function update_subscription(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return shield(
"UpdateSubscription", 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 | 30531 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: signer
using AWS.Compat
using AWS.UUIDs
"""
add_profile_permission(action, principal, profile_name, statement_id)
add_profile_permission(action, principal, profile_name, statement_id, params::Dict{String,<:Any})
Adds cross-account permissions to a signing profile.
# Arguments
- `action`: For cross-account signing. Grant a designated account permission to perform one
or more of the following actions. Each action is associated with a specific API's
operations. For more information about cross-account signing, see Using cross-account
signing with signing profiles in the AWS Signer Developer Guide. You can designate the
following actions to an account. signer:StartSigningJob. This action isn't supported for
container image workflows. For details, see StartSigningJob. signer:SignPayload. This
action isn't supported for AWS Lambda workflows. For details, see SignPayload
signer:GetSigningProfile. For details, see GetSigningProfile. signer:RevokeSignature.
For details, see RevokeSignature.
- `principal`: The AWS principal receiving cross-account permissions. This may be an IAM
role or another AWS account ID.
- `profile_name`: The human-readable name of the signing profile.
- `statement_id`: A unique identifier for the cross-account permission statement.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"profileVersion"`: The version of the signing profile.
- `"revisionId"`: A unique identifier for the current profile revision.
"""
function add_profile_permission(
action,
principal,
profileName,
statementId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return signer(
"POST",
"/signing-profiles/$(profileName)/permissions",
Dict{String,Any}(
"action" => action, "principal" => principal, "statementId" => statementId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_profile_permission(
action,
principal,
profileName,
statementId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return signer(
"POST",
"/signing-profiles/$(profileName)/permissions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"action" => action,
"principal" => principal,
"statementId" => statementId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_signing_profile(profile_name)
cancel_signing_profile(profile_name, params::Dict{String,<:Any})
Changes the state of an ACTIVE signing profile to CANCELED. A canceled profile is still
viewable with the ListSigningProfiles operation, but it cannot perform new signing jobs,
and is deleted two years after cancelation.
# Arguments
- `profile_name`: The name of the signing profile to be canceled.
"""
function cancel_signing_profile(
profileName; aws_config::AbstractAWSConfig=global_aws_config()
)
return signer(
"DELETE",
"/signing-profiles/$(profileName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_signing_profile(
profileName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return signer(
"DELETE",
"/signing-profiles/$(profileName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_signing_job(job_id)
describe_signing_job(job_id, params::Dict{String,<:Any})
Returns information about a specific code signing job. You specify the job by using the
jobId value that is returned by the StartSigningJob operation.
# Arguments
- `job_id`: The ID of the signing job on input.
"""
function describe_signing_job(jobId; aws_config::AbstractAWSConfig=global_aws_config())
return signer(
"GET",
"/signing-jobs/$(jobId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_signing_job(
jobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return signer(
"GET",
"/signing-jobs/$(jobId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_revocation_status(certificate_hashes, job_arn, platform_id, profile_version_arn, signature_timestamp)
get_revocation_status(certificate_hashes, job_arn, platform_id, profile_version_arn, signature_timestamp, params::Dict{String,<:Any})
Retrieves the revocation status of one or more of the signing profile, signing job, and
signing certificate.
# Arguments
- `certificate_hashes`: A list of composite signed hashes that identify certificates. A
certificate identifier consists of a subject certificate TBS hash (signed by the parent CA)
combined with a parent CA TBS hash (signed by the parent CA’s CA). Root certificates are
defined as their own CA. The following example shows how to calculate a hash for this
parameter using OpenSSL commands: openssl asn1parse -in childCert.pem -strparse 4 -out
childCert.tbs openssl sha384 < childCert.tbs -binary > childCertTbsHash openssl
asn1parse -in parentCert.pem -strparse 4 -out parentCert.tbs openssl sha384 <
parentCert.tbs -binary > parentCertTbsHash xxd -p childCertTbsHash >
certificateHash.hex xxd -p parentCertTbsHash >> certificateHash.hex cat
certificateHash.hex | tr -d 'n'
- `job_arn`: The ARN of a signing job.
- `platform_id`: The ID of a signing platform.
- `profile_version_arn`: The version of a signing profile.
- `signature_timestamp`: The timestamp of the signature that validates the profile or job.
"""
function get_revocation_status(
certificateHashes,
jobArn,
platformId,
profileVersionArn,
signatureTimestamp;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return signer(
"GET",
"/revocations",
Dict{String,Any}(
"certificateHashes" => certificateHashes,
"jobArn" => jobArn,
"platformId" => platformId,
"profileVersionArn" => profileVersionArn,
"signatureTimestamp" => signatureTimestamp,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_revocation_status(
certificateHashes,
jobArn,
platformId,
profileVersionArn,
signatureTimestamp,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return signer(
"GET",
"/revocations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"certificateHashes" => certificateHashes,
"jobArn" => jobArn,
"platformId" => platformId,
"profileVersionArn" => profileVersionArn,
"signatureTimestamp" => signatureTimestamp,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_signing_platform(platform_id)
get_signing_platform(platform_id, params::Dict{String,<:Any})
Returns information on a specific signing platform.
# Arguments
- `platform_id`: The ID of the target signing platform.
"""
function get_signing_platform(platformId; aws_config::AbstractAWSConfig=global_aws_config())
return signer(
"GET",
"/signing-platforms/$(platformId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_signing_platform(
platformId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return signer(
"GET",
"/signing-platforms/$(platformId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_signing_profile(profile_name)
get_signing_profile(profile_name, params::Dict{String,<:Any})
Returns information on a specific signing profile.
# Arguments
- `profile_name`: The name of the target signing profile.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"profileOwner"`: The AWS account ID of the profile owner.
"""
function get_signing_profile(profileName; aws_config::AbstractAWSConfig=global_aws_config())
return signer(
"GET",
"/signing-profiles/$(profileName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_signing_profile(
profileName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return signer(
"GET",
"/signing-profiles/$(profileName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_profile_permissions(profile_name)
list_profile_permissions(profile_name, params::Dict{String,<:Any})
Lists the cross-account permissions associated with a signing profile.
# Arguments
- `profile_name`: Name of the signing profile containing the cross-account permissions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: String for specifying the next set of paginated results.
"""
function list_profile_permissions(
profileName; aws_config::AbstractAWSConfig=global_aws_config()
)
return signer(
"GET",
"/signing-profiles/$(profileName)/permissions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_profile_permissions(
profileName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return signer(
"GET",
"/signing-profiles/$(profileName)/permissions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_signing_jobs()
list_signing_jobs(params::Dict{String,<:Any})
Lists all your signing jobs. You can use the maxResults parameter to limit the number of
signing jobs that are returned in the response. If additional jobs remain to be listed, AWS
Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to
fetch the remaining values. You can continue calling ListSigningJobs with your maxResults
parameter and with new values that Signer returns in the nextToken parameter until all of
your signing jobs have been returned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"isRevoked"`: Filters results to return only signing jobs with revoked signatures.
- `"jobInvoker"`: Filters results to return only signing jobs initiated by a specified IAM
entity.
- `"maxResults"`: Specifies the maximum number of items to return in the response. Use this
parameter when paginating results. If additional items exist beyond the number you specify,
the nextToken element is set in the response. Use the nextToken value in a subsequent
request to retrieve additional items.
- `"nextToken"`: String for specifying the next set of paginated results to return. After
you receive a response with truncated results, use this parameter in a subsequent request.
Set it to the value of nextToken from the response that you just received.
- `"platformId"`: The ID of microcontroller platform that you specified for the
distribution of your code image.
- `"requestedBy"`: The IAM principal that requested the signing job.
- `"signatureExpiresAfter"`: Filters results to return only signing jobs with signatures
expiring after a specified timestamp.
- `"signatureExpiresBefore"`: Filters results to return only signing jobs with signatures
expiring before a specified timestamp.
- `"status"`: A status value with which to filter your results.
"""
function list_signing_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return signer(
"GET", "/signing-jobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_signing_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return signer(
"GET",
"/signing-jobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_signing_platforms()
list_signing_platforms(params::Dict{String,<:Any})
Lists all signing platforms available in AWS Signer that match the request parameters. If
additional jobs remain to be listed, Signer returns a nextToken value. Use this value in
subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling
ListSigningJobs with your maxResults parameter and with new values that Signer returns in
the nextToken parameter until all of your signing jobs have been returned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"category"`: The category type of a signing platform.
- `"maxResults"`: The maximum number of results to be returned by this operation.
- `"nextToken"`: Value for specifying the next set of paginated results to return. After
you receive a response with truncated results, use this parameter in a subsequent request.
Set it to the value of nextToken from the response that you just received.
- `"partner"`: Any partner entities connected to a signing platform.
- `"target"`: The validation template that is used by the target signing platform.
"""
function list_signing_platforms(; aws_config::AbstractAWSConfig=global_aws_config())
return signer(
"GET", "/signing-platforms"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_signing_platforms(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return signer(
"GET",
"/signing-platforms",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_signing_profiles()
list_signing_profiles(params::Dict{String,<:Any})
Lists all available signing profiles in your AWS account. Returns only profiles with an
ACTIVE status unless the includeCanceled request field is set to true. If additional jobs
remain to be listed, AWS Signer returns a nextToken value. Use this value in subsequent
calls to ListSigningJobs to fetch the remaining values. You can continue calling
ListSigningJobs with your maxResults parameter and with new values that Signer returns in
the nextToken parameter until all of your signing jobs have been returned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"includeCanceled"`: Designates whether to include profiles with the status of CANCELED.
- `"maxResults"`: The maximum number of profiles to be returned.
- `"nextToken"`: Value for specifying the next set of paginated results to return. After
you receive a response with truncated results, use this parameter in a subsequent request.
Set it to the value of nextToken from the response that you just received.
- `"platformId"`: Filters results to return only signing jobs initiated for a specified
signing platform.
- `"statuses"`: Filters results to return only signing jobs with statuses in the specified
list.
"""
function list_signing_profiles(; aws_config::AbstractAWSConfig=global_aws_config())
return signer(
"GET", "/signing-profiles"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_signing_profiles(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return signer(
"GET",
"/signing-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})
Returns a list of the tags associated with a signing profile resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) for the signing profile.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return signer(
"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 signer(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_signing_profile(platform_id, profile_name)
put_signing_profile(platform_id, profile_name, params::Dict{String,<:Any})
Creates a signing profile. A signing profile is a code-signing template that can be used to
carry out a pre-defined signing job.
# Arguments
- `platform_id`: The ID of the signing platform to be created.
- `profile_name`: The name of the signing profile to be created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"overrides"`: A subfield of platform. This specifies any different configuration options
that you want to apply to the chosen platform (such as a different hash-algorithm or
signing-algorithm).
- `"signatureValidityPeriod"`: The default validity period override for any signature
generated using this signing profile. If unspecified, the default is 135 months.
- `"signingMaterial"`: The AWS Certificate Manager certificate that will be used to sign
code with the new signing profile.
- `"signingParameters"`: Map of key-value pairs for signing. These can include any
information that you want to use during signing.
- `"tags"`: Tags to be associated with the signing profile that is being created.
"""
function put_signing_profile(
platformId, profileName; aws_config::AbstractAWSConfig=global_aws_config()
)
return signer(
"PUT",
"/signing-profiles/$(profileName)",
Dict{String,Any}("platformId" => platformId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_signing_profile(
platformId,
profileName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return signer(
"PUT",
"/signing-profiles/$(profileName)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("platformId" => platformId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_profile_permission(profile_name, revision_id, statement_id)
remove_profile_permission(profile_name, revision_id, statement_id, params::Dict{String,<:Any})
Removes cross-account permissions from a signing profile.
# Arguments
- `profile_name`: A human-readable name for the signing profile with permissions to be
removed.
- `revision_id`: An identifier for the current revision of the signing profile permissions.
- `statement_id`: A unique identifier for the cross-account permissions statement.
"""
function remove_profile_permission(
profileName, revisionId, statementId; aws_config::AbstractAWSConfig=global_aws_config()
)
return signer(
"DELETE",
"/signing-profiles/$(profileName)/permissions/$(statementId)",
Dict{String,Any}("revisionId" => revisionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_profile_permission(
profileName,
revisionId,
statementId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return signer(
"DELETE",
"/signing-profiles/$(profileName)/permissions/$(statementId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("revisionId" => revisionId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
revoke_signature(job_id, reason)
revoke_signature(job_id, reason, params::Dict{String,<:Any})
Changes the state of a signing job to REVOKED. This indicates that the signature is no
longer valid.
# Arguments
- `job_id`: ID of the signing job to be revoked.
- `reason`: The reason for revoking the signing job.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"jobOwner"`: AWS account ID of the job owner.
"""
function revoke_signature(jobId, reason; aws_config::AbstractAWSConfig=global_aws_config())
return signer(
"PUT",
"/signing-jobs/$(jobId)/revoke",
Dict{String,Any}("reason" => reason);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function revoke_signature(
jobId,
reason,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return signer(
"PUT",
"/signing-jobs/$(jobId)/revoke",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("reason" => reason), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
revoke_signing_profile(effective_time, profile_name, profile_version, reason)
revoke_signing_profile(effective_time, profile_name, profile_version, reason, params::Dict{String,<:Any})
Changes the state of a signing profile to REVOKED. This indicates that signatures generated
using the signing profile after an effective start date are no longer valid.
# Arguments
- `effective_time`: A timestamp for when revocation of a Signing Profile should become
effective. Signatures generated using the signing profile after this timestamp are not
trusted.
- `profile_name`: The name of the signing profile to be revoked.
- `profile_version`: The version of the signing profile to be revoked.
- `reason`: The reason for revoking a signing profile.
"""
function revoke_signing_profile(
effectiveTime,
profileName,
profileVersion,
reason;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return signer(
"PUT",
"/signing-profiles/$(profileName)/revoke",
Dict{String,Any}(
"effectiveTime" => effectiveTime,
"profileVersion" => profileVersion,
"reason" => reason,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function revoke_signing_profile(
effectiveTime,
profileName,
profileVersion,
reason,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return signer(
"PUT",
"/signing-profiles/$(profileName)/revoke",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"effectiveTime" => effectiveTime,
"profileVersion" => profileVersion,
"reason" => reason,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
sign_payload(payload, payload_format, profile_name)
sign_payload(payload, payload_format, profile_name, params::Dict{String,<:Any})
Signs a binary payload and returns a signature envelope.
# Arguments
- `payload`: Specifies the object digest (hash) to sign.
- `payload_format`: Payload content type. The single valid type is
application/vnd.cncf.notary.payload.v1+json.
- `profile_name`: The name of the signing profile.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"profileOwner"`: The AWS account ID of the profile owner.
"""
function sign_payload(
payload, payloadFormat, profileName; aws_config::AbstractAWSConfig=global_aws_config()
)
return signer(
"POST",
"/signing-jobs/with-payload",
Dict{String,Any}(
"payload" => payload,
"payloadFormat" => payloadFormat,
"profileName" => profileName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function sign_payload(
payload,
payloadFormat,
profileName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return signer(
"POST",
"/signing-jobs/with-payload",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"payload" => payload,
"payloadFormat" => payloadFormat,
"profileName" => profileName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_signing_job(client_request_token, destination, profile_name, source)
start_signing_job(client_request_token, destination, profile_name, source, params::Dict{String,<:Any})
Initiates a signing job to be performed on the code provided. Signing jobs are viewable by
the ListSigningJobs operation for two years after they are performed. Note the following
requirements: You must create an Amazon S3 source bucket. For more information, see
Creating a Bucket in the Amazon S3 Getting Started Guide. Your S3 source bucket must be
version enabled. You must create an S3 destination bucket. AWS Signer uses your S3
destination bucket to write your signed code. You specify the name of the source and
destination buckets when calling the StartSigningJob operation. You must ensure the S3
buckets are from the same Region as the signing profile. Cross-Region signing isn't
supported. You must also specify a request token that identifies your request to Signer.
You can call the DescribeSigningJob and the ListSigningJobs actions after you call
StartSigningJob. For a Java example that shows how to use this action, see StartSigningJob.
# Arguments
- `client_request_token`: String that identifies the signing request. All calls after the
first that use this token return the same response as the first call.
- `destination`: The S3 bucket in which to save your signed object. The destination
contains the name of your bucket and an optional prefix.
- `profile_name`: The name of the signing profile.
- `source`: The S3 bucket that contains the object to sign or a BLOB that contains your raw
code.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"profileOwner"`: The AWS account ID of the signing profile owner.
"""
function start_signing_job(
clientRequestToken,
destination,
profileName,
source;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return signer(
"POST",
"/signing-jobs",
Dict{String,Any}(
"clientRequestToken" => clientRequestToken,
"destination" => destination,
"profileName" => profileName,
"source" => source,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_signing_job(
clientRequestToken,
destination,
profileName,
source,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return signer(
"POST",
"/signing-jobs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientRequestToken" => clientRequestToken,
"destination" => destination,
"profileName" => profileName,
"source" => source,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds one or more tags to a signing profile. Tags are labels that you can use to identify
and organize your AWS resources. Each tag consists of a key and an optional value. To
specify the signing profile, use its Amazon Resource Name (ARN). To specify the tag, use a
key-value pair.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) for the signing profile.
- `tags`: One or more tags to be associated with the signing profile.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return signer(
"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 signer(
"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 a signing profile. To remove the tags, specify a list of tag
keys.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) for the signing profile.
- `tag_keys`: A list of tag keys to be removed from the signing profile.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return signer(
"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 signer(
"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 | 21023 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: simpledb
using AWS.Compat
using AWS.UUIDs
"""
batch_delete_attributes(domain_name, item)
batch_delete_attributes(domain_name, item, params::Dict{String,<:Any})
Performs multiple DeleteAttributes operations in a single call, which reduces round trips
and latencies. This enables Amazon SimpleDB to optimize requests, which generally yields
better throughput. If you specify BatchDeleteAttributes without attributes or values,
all the attributes for the item are deleted. BatchDeleteAttributes is an idempotent
operation; running it multiple times on the same item or attribute doesn't result in an
error. The BatchDeleteAttributes operation succeeds or fails in its entirety. There are
no partial deletes. You can execute multiple BatchDeleteAttributes operations and other
operations in parallel. However, large numbers of concurrent BatchDeleteAttributes calls
can result in Service Unavailable (503) responses. This operation is vulnerable to
exceeding the maximum URL size when making a REST request using the HTTP GET method. This
operation does not support conditions using Expected.X.Name, Expected.X.Value, or
Expected.X.Exists. The following limitations are enforced for this operation: 1 MB
request size 25 item limit per BatchDeleteAttributes operation
# Arguments
- `domain_name`: The name of the domain in which the attributes are being deleted.
- `item`: A list of items on which to perform the operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Items"`: A list of items on which to perform the operation.
"""
function batch_delete_attributes(
DomainName, Item; aws_config::AbstractAWSConfig=global_aws_config()
)
return simpledb(
"BatchDeleteAttributes",
Dict{String,Any}("DomainName" => DomainName, "Item" => Item);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_delete_attributes(
DomainName,
Item,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return simpledb(
"BatchDeleteAttributes",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("DomainName" => DomainName, "Item" => Item), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_put_attributes(domain_name, item)
batch_put_attributes(domain_name, item, params::Dict{String,<:Any})
The BatchPutAttributes operation creates or replaces attributes within one or more items.
By using this operation, the client can perform multiple PutAttribute operation with a
single call. This helps yield savings in round trips and latencies, enabling Amazon
SimpleDB to optimize requests and generally produce better throughput. The client may
specify the item name with the Item.X.ItemName parameter. The client may specify new
attributes using a combination of the Item.X.Attribute.Y.Name and Item.X.Attribute.Y.Value
parameters. The client may specify the first attribute for the first item using the
parameters Item.0.Attribute.0.Name and Item.0.Attribute.0.Value, and for the second
attribute for the first item by the parameters Item.0.Attribute.1.Name and
Item.0.Attribute.1.Value, and so on. Attributes are uniquely identified within an item by
their name/value combination. For example, a single item can have the attributes {
\"first_name\", \"first_value\" } and { \"first_name\", \"second_value\" }. However, it
cannot have two attribute instances where both the Item.X.Attribute.Y.Name and
Item.X.Attribute.Y.Value are the same. Optionally, the requester can supply the Replace
parameter for each individual value. Setting this value to true will cause the new
attribute values to replace the existing attribute values. For example, if an item I has
the attributes { 'a', '1' }, { 'b', '2'} and { 'b', '3' } and the requester does a
BatchPutAttributes of {'I', 'b', '4' } with the Replace parameter set to true, the final
attributes of the item will be { 'a', '1' } and { 'b', '4' }, replacing the previous values
of the 'b' attribute with the new value. You cannot specify an empty string as an item or
as an attribute name. The BatchPutAttributes operation succeeds or fails in its entirety.
There are no partial puts. This operation is vulnerable to exceeding the maximum URL size
when making a REST request using the HTTP GET method. This operation does not support
conditions using Expected.X.Name, Expected.X.Value, or Expected.X.Exists. You can execute
multiple BatchPutAttributes operations and other operations in parallel. However, large
numbers of concurrent BatchPutAttributes calls can result in Service Unavailable (503)
responses. The following limitations are enforced for this operation: 256 attribute
name-value pairs per item 1 MB request size 1 billion attributes per domain 10 GB of total
user data storage per domain 25 item limit per BatchPutAttributes operation
# Arguments
- `domain_name`: The name of the domain in which the attributes are being stored.
- `item`: A list of items on which to perform the operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Items"`: A list of items on which to perform the operation.
"""
function batch_put_attributes(
DomainName, Item; aws_config::AbstractAWSConfig=global_aws_config()
)
return simpledb(
"BatchPutAttributes",
Dict{String,Any}("DomainName" => DomainName, "Item" => Item);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_put_attributes(
DomainName,
Item,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return simpledb(
"BatchPutAttributes",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("DomainName" => DomainName, "Item" => Item), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_domain(domain_name)
create_domain(domain_name, params::Dict{String,<:Any})
The CreateDomain operation creates a new domain. The domain name should be unique among
the domains associated with the Access Key ID provided in the request. The CreateDomain
operation may take 10 or more seconds to complete. CreateDomain is an idempotent
operation; running it multiple times using the same domain name will not result in an error
response. The client can create up to 100 domains per account. If the client requires
additional domains, go to http://aws.amazon.com/contact-us/simpledb-limit-request/.
# Arguments
- `domain_name`: The name of the domain to create. The name can range between 3 and 255
characters and can contain the following characters: a-z, A-Z, 0-9, '_', '-', and '.'.
"""
function create_domain(DomainName; aws_config::AbstractAWSConfig=global_aws_config())
return simpledb(
"CreateDomain",
Dict{String,Any}("DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_domain(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return simpledb(
"CreateDomain",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_attributes(domain_name, item_name)
delete_attributes(domain_name, item_name, params::Dict{String,<:Any})
Deletes one or more attributes associated with an item. If all attributes of the item are
deleted, the item is deleted. If DeleteAttributes is called without being passed any
attributes or values specified, all the attributes for the item are deleted.
DeleteAttributes is an idempotent operation; running it multiple times on the same item or
attribute does not result in an error response. Because Amazon SimpleDB makes multiple
copies of item data and uses an eventual consistency update model, performing a
GetAttributes or Select operation (read) immediately after a DeleteAttributes or
PutAttributes operation (write) might not return updated item data.
# Arguments
- `domain_name`: The name of the domain in which to perform the operation.
- `item_name`: The name of the item. Similar to rows on a spreadsheet, items represent
individual objects that contain one or more value-attribute pairs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Attributes"`: A list of Attributes. Similar to columns on a spreadsheet, attributes
represent categories of data that can be assigned to items.
- `"Expected"`: The update condition which, if specified, determines whether the specified
attributes will be deleted or not. The update condition must be satisfied in order for this
request to be processed and the attributes to be deleted.
"""
function delete_attributes(
DomainName, ItemName; aws_config::AbstractAWSConfig=global_aws_config()
)
return simpledb(
"DeleteAttributes",
Dict{String,Any}("DomainName" => DomainName, "ItemName" => ItemName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_attributes(
DomainName,
ItemName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return simpledb(
"DeleteAttributes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DomainName" => DomainName, "ItemName" => ItemName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_domain(domain_name)
delete_domain(domain_name, params::Dict{String,<:Any})
The DeleteDomain operation deletes a domain. Any items (and their attributes) in the
domain are deleted as well. The DeleteDomain operation might take 10 or more seconds to
complete. Running DeleteDomain on a domain that does not exist or running the function
multiple times using the same domain name will not result in an error response.
# Arguments
- `domain_name`: The name of the domain to delete.
"""
function delete_domain(DomainName; aws_config::AbstractAWSConfig=global_aws_config())
return simpledb(
"DeleteDomain",
Dict{String,Any}("DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_domain(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return simpledb(
"DeleteDomain",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
domain_metadata(domain_name)
domain_metadata(domain_name, params::Dict{String,<:Any})
Returns information about the domain, including when the domain was created, the number of
items and attributes in the domain, and the size of the attribute names and values.
# Arguments
- `domain_name`: The name of the domain for which to display the metadata of.
"""
function domain_metadata(DomainName; aws_config::AbstractAWSConfig=global_aws_config())
return simpledb(
"DomainMetadata",
Dict{String,Any}("DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function domain_metadata(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return simpledb(
"DomainMetadata",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_attributes(domain_name, item_name)
get_attributes(domain_name, item_name, params::Dict{String,<:Any})
Returns all of the attributes associated with the specified item. Optionally, the
attributes returned can be limited to one or more attributes by specifying an attribute
name parameter. If the item does not exist on the replica that was accessed for this
operation, an empty set is returned. The system does not return an error as it cannot
guarantee the item does not exist on other replicas. If GetAttributes is called without
being passed any attribute names, all the attributes for the item are returned.
# Arguments
- `domain_name`: The name of the domain in which to perform the operation.
- `item_name`: The name of the item.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AttributeNames"`: The names of the attributes.
- `"ConsistentRead"`: Determines whether or not strong consistency should be enforced when
data is read from SimpleDB. If true, any data previously written to SimpleDB will be
returned. Otherwise, results will be consistent eventually, and the client may not see data
that was written immediately before your read.
"""
function get_attributes(
DomainName, ItemName; aws_config::AbstractAWSConfig=global_aws_config()
)
return simpledb(
"GetAttributes",
Dict{String,Any}("DomainName" => DomainName, "ItemName" => ItemName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_attributes(
DomainName,
ItemName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return simpledb(
"GetAttributes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DomainName" => DomainName, "ItemName" => ItemName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_domains()
list_domains(params::Dict{String,<:Any})
The ListDomains operation lists all domains associated with the Access Key ID. It returns
domain names up to the limit set by MaxNumberOfDomains. A NextToken is returned if there
are more than MaxNumberOfDomains domains. Calling ListDomains successive times with the
NextToken provided by the operation returns up to MaxNumberOfDomains more domain names with
each successive operation call.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxNumberOfDomains"`: The maximum number of domain names you want returned. The range
is 1 to 100. The default setting is 100.
- `"NextToken"`: A string informing Amazon SimpleDB where to start the next list of domain
names.
"""
function list_domains(; aws_config::AbstractAWSConfig=global_aws_config())
return simpledb("ListDomains"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_domains(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return simpledb(
"ListDomains", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
put_attributes(attribute, domain_name, item_name)
put_attributes(attribute, domain_name, item_name, params::Dict{String,<:Any})
The PutAttributes operation creates or replaces attributes in an item. The client may
specify new attributes using a combination of the Attribute.X.Name and Attribute.X.Value
parameters. The client specifies the first attribute by the parameters Attribute.0.Name and
Attribute.0.Value, the second attribute by the parameters Attribute.1.Name and
Attribute.1.Value, and so on. Attributes are uniquely identified in an item by their
name/value combination. For example, a single item can have the attributes {
\"first_name\", \"first_value\" } and { \"first_name\", second_value\" }. However, it
cannot have two attribute instances where both the Attribute.X.Name and Attribute.X.Value
are the same. Optionally, the requestor can supply the Replace parameter for each
individual attribute. Setting this value to true causes the new attribute value to replace
the existing attribute value(s). For example, if an item has the attributes { 'a', '1' }, {
'b', '2'} and { 'b', '3' } and the requestor calls PutAttributes using the attributes {
'b', '4' } with the Replace parameter set to true, the final attributes of the item are
changed to { 'a', '1' } and { 'b', '4' }, which replaces the previous values of the 'b'
attribute with the new value. Using PutAttributes to replace attribute values that do not
exist will not result in an error response. You cannot specify an empty string as an
attribute name. Because Amazon SimpleDB makes multiple copies of client data and uses an
eventual consistency update model, an immediate GetAttributes or Select operation (read)
immediately after a PutAttributes or DeleteAttributes operation (write) might not return
the updated data. The following limitations are enforced for this operation: 256 total
attribute name-value pairs per item One billion attributes per domain 10 GB of total user
data storage per domain
# Arguments
- `attribute`: The list of attributes.
- `domain_name`: The name of the domain in which to perform the operation.
- `item_name`: The name of the item.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Attributes"`: The list of attributes.
- `"Expected"`: The update condition which, if specified, determines whether the specified
attributes will be updated or not. The update condition must be satisfied in order for this
request to be processed and the attributes to be updated.
"""
function put_attributes(
Attribute, DomainName, ItemName; aws_config::AbstractAWSConfig=global_aws_config()
)
return simpledb(
"PutAttributes",
Dict{String,Any}(
"Attribute" => Attribute, "DomainName" => DomainName, "ItemName" => ItemName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_attributes(
Attribute,
DomainName,
ItemName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return simpledb(
"PutAttributes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Attribute" => Attribute,
"DomainName" => DomainName,
"ItemName" => ItemName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
select(select_expression)
select(select_expression, params::Dict{String,<:Any})
The Select operation returns a set of attributes for ItemNames that match the select
expression. Select is similar to the standard SQL SELECT statement. The total size of the
response cannot exceed 1 MB in total size. Amazon SimpleDB automatically adjusts the number
of items returned per page to enforce this limit. For example, if the client asks to
retrieve 2500 items, but each individual item is 10 kB in size, the system returns 100
items and an appropriate NextToken so the client can access the next page of results. For
information on how to construct select expressions, see Using Select to Create Amazon
SimpleDB Queries in the Developer Guide.
# Arguments
- `select_expression`: The expression used to query the domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConsistentRead"`: Determines whether or not strong consistency should be enforced when
data is read from SimpleDB. If true, any data previously written to SimpleDB will be
returned. Otherwise, results will be consistent eventually, and the client may not see data
that was written immediately before your read.
- `"NextToken"`: A string informing Amazon SimpleDB where to start the next list of
ItemNames.
"""
function select(SelectExpression; aws_config::AbstractAWSConfig=global_aws_config())
return simpledb(
"Select",
Dict{String,Any}("SelectExpression" => SelectExpression);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function select(
SelectExpression,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return simpledb(
"Select",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("SelectExpression" => SelectExpression), 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 | 22661 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: simspaceweaver
using AWS.Compat
using AWS.UUIDs
"""
create_snapshot(destination, simulation)
create_snapshot(destination, simulation, params::Dict{String,<:Any})
Creates a snapshot of the specified simulation. A snapshot is a file that contains
simulation state data at a specific time. The state data saved in a snapshot includes
entity data from the State Fabric, the simulation configuration specified in the schema,
and the clock tick number. You can use the snapshot to initialize a new simulation. For
more information about snapshots, see Snapshots in the SimSpace Weaver User Guide. You
specify a Destination when you create a snapshot. The Destination is the name of an Amazon
S3 bucket and an optional ObjectKeyPrefix. The ObjectKeyPrefix is usually the name of a
folder in the bucket. SimSpace Weaver creates a snapshot folder inside the Destination and
places the snapshot file there. The snapshot file is an Amazon S3 object. It has an object
key with the form: object-key-prefix/snapshot/simulation-name-YYMMdd-HHmm-ss.zip, where:
YY is the 2-digit year MM is the 2-digit month dd is the 2-digit day of the
month HH is the 2-digit hour (24-hour clock) mm is the 2-digit minutes ss is
the 2-digit seconds
# Arguments
- `destination`: The Amazon S3 bucket and optional folder (object key prefix) where
SimSpace Weaver creates the snapshot file. The Amazon S3 bucket must be in the same Amazon
Web Services Region as the simulation.
- `simulation`: The name of the simulation.
"""
function create_snapshot(
Destination, Simulation; aws_config::AbstractAWSConfig=global_aws_config()
)
return simspaceweaver(
"POST",
"/createsnapshot",
Dict{String,Any}("Destination" => Destination, "Simulation" => Simulation);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_snapshot(
Destination,
Simulation,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return simspaceweaver(
"POST",
"/createsnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Destination" => Destination, "Simulation" => Simulation),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_app(app, domain, simulation)
delete_app(app, domain, simulation, params::Dict{String,<:Any})
Deletes the instance of the given custom app.
# Arguments
- `app`: The name of the app.
- `domain`: The name of the domain of the app.
- `simulation`: The name of the simulation of the app.
"""
function delete_app(
app, domain, simulation; aws_config::AbstractAWSConfig=global_aws_config()
)
return simspaceweaver(
"DELETE",
"/deleteapp",
Dict{String,Any}("app" => app, "domain" => domain, "simulation" => simulation);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_app(
app,
domain,
simulation,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return simspaceweaver(
"DELETE",
"/deleteapp",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"app" => app, "domain" => domain, "simulation" => simulation
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_simulation(simulation)
delete_simulation(simulation, params::Dict{String,<:Any})
Deletes all SimSpace Weaver resources assigned to the given simulation. Your simulation
uses resources in other Amazon Web Services. This API operation doesn't delete resources in
other Amazon Web Services.
# Arguments
- `simulation`: The name of the simulation.
"""
function delete_simulation(simulation; aws_config::AbstractAWSConfig=global_aws_config())
return simspaceweaver(
"DELETE",
"/deletesimulation",
Dict{String,Any}("simulation" => simulation);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_simulation(
simulation,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return simspaceweaver(
"DELETE",
"/deletesimulation",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("simulation" => simulation), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_app(app, domain, simulation)
describe_app(app, domain, simulation, params::Dict{String,<:Any})
Returns the state of the given custom app.
# Arguments
- `app`: The name of the app.
- `domain`: The name of the domain of the app.
- `simulation`: The name of the simulation of the app.
"""
function describe_app(
app, domain, simulation; aws_config::AbstractAWSConfig=global_aws_config()
)
return simspaceweaver(
"GET",
"/describeapp",
Dict{String,Any}("app" => app, "domain" => domain, "simulation" => simulation);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_app(
app,
domain,
simulation,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return simspaceweaver(
"GET",
"/describeapp",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"app" => app, "domain" => domain, "simulation" => simulation
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_simulation(simulation)
describe_simulation(simulation, params::Dict{String,<:Any})
Returns the current state of the given simulation.
# Arguments
- `simulation`: The name of the simulation.
"""
function describe_simulation(simulation; aws_config::AbstractAWSConfig=global_aws_config())
return simspaceweaver(
"GET",
"/describesimulation",
Dict{String,Any}("simulation" => simulation);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_simulation(
simulation,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return simspaceweaver(
"GET",
"/describesimulation",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("simulation" => simulation), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_apps(simulation)
list_apps(simulation, params::Dict{String,<:Any})
Lists all custom apps or service apps for the given simulation and domain.
# Arguments
- `simulation`: The name of the simulation that you want to list apps for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"domain"`: The name of the domain that you want to list apps for.
- `"maxResults"`: The maximum number of apps to list.
- `"nextToken"`: If SimSpace Weaver returns nextToken, then there are more results
available. The value of nextToken is a unique pagination token for each page. To retrieve
the next page, call the operation again using the returned token. Keep all other arguments
unchanged. If no results remain, then nextToken is set to null. Each pagination token
expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP
400 ValidationException error.
"""
function list_apps(simulation; aws_config::AbstractAWSConfig=global_aws_config())
return simspaceweaver(
"GET",
"/listapps",
Dict{String,Any}("simulation" => simulation);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_apps(
simulation,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return simspaceweaver(
"GET",
"/listapps",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("simulation" => simulation), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_simulations()
list_simulations(params::Dict{String,<:Any})
Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the
API call.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of simulations to list.
- `"nextToken"`: If SimSpace Weaver returns nextToken, then there are more results
available. The value of nextToken is a unique pagination token for each page. To retrieve
the next page, call the operation again using the returned token. Keep all other arguments
unchanged. If no results remain, then nextToken is set to null. Each pagination token
expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP
400 ValidationException error.
"""
function list_simulations(; aws_config::AbstractAWSConfig=global_aws_config())
return simspaceweaver(
"GET", "/listsimulations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_simulations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return simspaceweaver(
"GET",
"/listsimulations",
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 SimSpace Weaver resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource. For more information
about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return simspaceweaver(
"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 simspaceweaver(
"GET",
"/tags/$(ResourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_app(domain, name, simulation)
start_app(domain, name, simulation, params::Dict{String,<:Any})
Starts a custom app with the configuration specified in the simulation schema.
# Arguments
- `domain`: The name of the domain of the app.
- `name`: The name of the app.
- `simulation`: The name of the simulation of the app.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: A value that you provide to ensure that repeated calls to this API
operation using the same parameters complete only once. A ClientToken is also known as an
idempotency token. A ClientToken expires after 24 hours.
- `"Description"`: The description of the app.
- `"LaunchOverrides"`:
"""
function start_app(
Domain, Name, Simulation; aws_config::AbstractAWSConfig=global_aws_config()
)
return simspaceweaver(
"POST",
"/startapp",
Dict{String,Any}(
"Domain" => Domain,
"Name" => Name,
"Simulation" => Simulation,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_app(
Domain,
Name,
Simulation,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return simspaceweaver(
"POST",
"/startapp",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Domain" => Domain,
"Name" => Name,
"Simulation" => Simulation,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_clock(simulation)
start_clock(simulation, params::Dict{String,<:Any})
Starts the simulation clock.
# Arguments
- `simulation`: The name of the simulation.
"""
function start_clock(Simulation; aws_config::AbstractAWSConfig=global_aws_config())
return simspaceweaver(
"POST",
"/startclock",
Dict{String,Any}("Simulation" => Simulation);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_clock(
Simulation,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return simspaceweaver(
"POST",
"/startclock",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Simulation" => Simulation), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_simulation(name, role_arn)
start_simulation(name, role_arn, params::Dict{String,<:Any})
Starts a simulation with the given name. You must choose to start your simulation from a
schema or from a snapshot. For more information about the schema, see the schema reference
in the SimSpace Weaver User Guide. For more information about snapshots, see Snapshots in
the SimSpace Weaver User Guide.
# Arguments
- `name`: The name of the simulation.
- `role_arn`: The Amazon Resource Name (ARN) of the Identity and Access Management (IAM)
role that the simulation assumes to perform actions. For more information about ARNs, see
Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. For more
information about IAM roles, see IAM roles in the Identity and Access Management User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: A value that you provide to ensure that repeated calls to this API
operation using the same parameters complete only once. A ClientToken is also known as an
idempotency token. A ClientToken expires after 24 hours.
- `"Description"`: The description of the simulation.
- `"MaximumDuration"`: The maximum running time of the simulation, specified as a number of
minutes (m or M), hours (h or H), or days (d or D). The simulation stops when it reaches
this limit. The maximum value is 14D, or its equivalent in the other units. The default
value is 14D. A value equivalent to 0 makes the simulation immediately transition to
Stopping as soon as it reaches Started.
- `"SchemaS3Location"`: The location of the simulation schema in Amazon Simple Storage
Service (Amazon S3). For more information about Amazon S3, see the Amazon Simple Storage
Service User Guide . Provide a SchemaS3Location to start your simulation from a schema. If
you provide a SchemaS3Location then you can't provide a SnapshotS3Location.
- `"SnapshotS3Location"`: The location of the snapshot .zip file in Amazon Simple Storage
Service (Amazon S3). For more information about Amazon S3, see the Amazon Simple Storage
Service User Guide . Provide a SnapshotS3Location to start your simulation from a snapshot.
The Amazon S3 bucket must be in the same Amazon Web Services Region as the simulation. If
you provide a SnapshotS3Location then you can't provide a SchemaS3Location.
- `"Tags"`: A list of tags for the simulation. For more information about tags, see Tagging
Amazon Web Services resources in the Amazon Web Services General Reference.
"""
function start_simulation(Name, RoleArn; aws_config::AbstractAWSConfig=global_aws_config())
return simspaceweaver(
"POST",
"/startsimulation",
Dict{String,Any}(
"Name" => Name, "RoleArn" => RoleArn, "ClientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_simulation(
Name,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return simspaceweaver(
"POST",
"/startsimulation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Name" => Name, "RoleArn" => RoleArn, "ClientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_app(app, domain, simulation)
stop_app(app, domain, simulation, params::Dict{String,<:Any})
Stops the given custom app and shuts down all of its allocated compute resources.
# Arguments
- `app`: The name of the app.
- `domain`: The name of the domain of the app.
- `simulation`: The name of the simulation of the app.
"""
function stop_app(
App, Domain, Simulation; aws_config::AbstractAWSConfig=global_aws_config()
)
return simspaceweaver(
"POST",
"/stopapp",
Dict{String,Any}("App" => App, "Domain" => Domain, "Simulation" => Simulation);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_app(
App,
Domain,
Simulation,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return simspaceweaver(
"POST",
"/stopapp",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"App" => App, "Domain" => Domain, "Simulation" => Simulation
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_clock(simulation)
stop_clock(simulation, params::Dict{String,<:Any})
Stops the simulation clock.
# Arguments
- `simulation`: The name of the simulation.
"""
function stop_clock(Simulation; aws_config::AbstractAWSConfig=global_aws_config())
return simspaceweaver(
"POST",
"/stopclock",
Dict{String,Any}("Simulation" => Simulation);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_clock(
Simulation,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return simspaceweaver(
"POST",
"/stopclock",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Simulation" => Simulation), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_simulation(simulation)
stop_simulation(simulation, params::Dict{String,<:Any})
Stops the given simulation. You can't restart a simulation after you stop it. If you want
to restart a simulation, then you must stop it, delete it, and start a new instance of it.
# Arguments
- `simulation`: The name of the simulation.
"""
function stop_simulation(Simulation; aws_config::AbstractAWSConfig=global_aws_config())
return simspaceweaver(
"POST",
"/stopsimulation",
Dict{String,Any}("Simulation" => Simulation);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_simulation(
Simulation,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return simspaceweaver(
"POST",
"/stopsimulation",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Simulation" => Simulation), 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 SimSpace Weaver resource. For more information about tags, see Tagging
Amazon Web Services resources in the Amazon Web Services General Reference.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource that you want to add tags
to. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web
Services General Reference.
- `tags`: A list of tags to apply to the resource.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return simspaceweaver(
"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 simspaceweaver(
"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 SimSpace Weaver resource. For more information about tags, see Tagging
Amazon Web Services resources in the Amazon Web Services General Reference.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource that you want to remove
tags from. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon
Web Services General Reference.
- `tag_keys`: A list of tag keys to remove from the resource.
"""
function untag_resource(
ResourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return simspaceweaver(
"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 simspaceweaver(
"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 | 35825 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: sms
using AWS.Compat
using AWS.UUIDs
"""
create_app()
create_app(params::Dict{String,<:Any})
Creates an application. An application consists of one or more server groups. Each server
group contain one or more servers.
# 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 application creation.
- `"description"`: The description of the new application
- `"name"`: The name of the new application.
- `"roleName"`: The name of the service role in the customer's account to be used by Server
Migration Service.
- `"serverGroups"`: The server groups to include in the application.
- `"tags"`: The tags to be associated with the application.
"""
function create_app(; aws_config::AbstractAWSConfig=global_aws_config())
return sms("CreateApp"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function create_app(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms("CreateApp", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
"""
create_replication_job(seed_replication_time, server_id)
create_replication_job(seed_replication_time, server_id, params::Dict{String,<:Any})
Creates a replication job. The replication job schedules periodic replication runs to
replicate your server to Amazon Web Services. Each replication run creates an Amazon
Machine Image (AMI).
# Arguments
- `seed_replication_time`: The seed replication time.
- `server_id`: The ID of the server.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the replication job.
- `"encrypted"`: Indicates whether the replication job produces encrypted AMIs.
- `"frequency"`: The time between consecutive replication runs, in hours.
- `"kmsKeyId"`: The ID of the KMS key for replication jobs that produce encrypted AMIs.
This value can be any of the following: KMS key ID KMS key alias ARN referring to the
KMS key ID ARN referring to the KMS key alias If encrypted is true but a KMS key ID is
not specified, the customer's default KMS key for Amazon EBS is used.
- `"licenseType"`: The license type to be used for the AMI created by a successful
replication run.
- `"numberOfRecentAmisToKeep"`: The maximum number of SMS-created AMIs to retain. The
oldest is deleted after the maximum number is reached and a new AMI is created.
- `"roleName"`: The name of the IAM role to be used by the Server Migration Service.
- `"runOnce"`: Indicates whether to run the replication job one time.
"""
function create_replication_job(
seedReplicationTime, serverId; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"CreateReplicationJob",
Dict{String,Any}(
"seedReplicationTime" => seedReplicationTime, "serverId" => serverId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_replication_job(
seedReplicationTime,
serverId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sms(
"CreateReplicationJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"seedReplicationTime" => seedReplicationTime, "serverId" => serverId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_app()
delete_app(params::Dict{String,<:Any})
Deletes the specified application. Optionally deletes the launched stack associated with
the application and all Server Migration Service replication jobs for servers in the
application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"appId"`: The ID of the application.
- `"forceStopAppReplication"`: Indicates whether to stop all replication jobs corresponding
to the servers in the application while deleting the application.
- `"forceTerminateApp"`: Indicates whether to terminate the stack corresponding to the
application while deleting the application.
"""
function delete_app(; aws_config::AbstractAWSConfig=global_aws_config())
return sms("DeleteApp"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function delete_app(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms("DeleteApp", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
"""
delete_app_launch_configuration()
delete_app_launch_configuration(params::Dict{String,<:Any})
Deletes the launch configuration for the specified application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"appId"`: The ID of the application.
"""
function delete_app_launch_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"DeleteAppLaunchConfiguration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_app_launch_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"DeleteAppLaunchConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_app_replication_configuration()
delete_app_replication_configuration(params::Dict{String,<:Any})
Deletes the replication configuration for the specified application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"appId"`: The ID of the application.
"""
function delete_app_replication_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"DeleteAppReplicationConfiguration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_app_replication_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"DeleteAppReplicationConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_app_validation_configuration(app_id)
delete_app_validation_configuration(app_id, params::Dict{String,<:Any})
Deletes the validation configuration for the specified application.
# Arguments
- `app_id`: The ID of the application.
"""
function delete_app_validation_configuration(
appId; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"DeleteAppValidationConfiguration",
Dict{String,Any}("appId" => appId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_app_validation_configuration(
appId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"DeleteAppValidationConfiguration",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("appId" => appId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_replication_job(replication_job_id)
delete_replication_job(replication_job_id, params::Dict{String,<:Any})
Deletes the specified replication job. After you delete a replication job, there are no
further replication runs. Amazon Web Services deletes the contents of the Amazon S3 bucket
used to store Server Migration Service artifacts. The AMIs created by the replication runs
are not deleted.
# Arguments
- `replication_job_id`: The ID of the replication job.
"""
function delete_replication_job(
replicationJobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"DeleteReplicationJob",
Dict{String,Any}("replicationJobId" => replicationJobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_replication_job(
replicationJobId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sms(
"DeleteReplicationJob",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("replicationJobId" => replicationJobId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_server_catalog()
delete_server_catalog(params::Dict{String,<:Any})
Deletes all servers from your server catalog.
"""
function delete_server_catalog(; aws_config::AbstractAWSConfig=global_aws_config())
return sms(
"DeleteServerCatalog"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_server_catalog(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"DeleteServerCatalog",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_connector(connector_id)
disassociate_connector(connector_id, params::Dict{String,<:Any})
Disassociates the specified connector from Server Migration Service. After you disassociate
a connector, it is no longer available to support replication jobs.
# Arguments
- `connector_id`: The ID of the connector.
"""
function disassociate_connector(
connectorId; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"DisassociateConnector",
Dict{String,Any}("connectorId" => connectorId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_connector(
connectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sms(
"DisassociateConnector",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("connectorId" => connectorId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
generate_change_set()
generate_change_set(params::Dict{String,<:Any})
Generates a target change set for a currently launched stack and writes it to an Amazon S3
object in the customer’s Amazon S3 bucket.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"appId"`: The ID of the application associated with the change set.
- `"changesetFormat"`: The format for the change set.
"""
function generate_change_set(; aws_config::AbstractAWSConfig=global_aws_config())
return sms("GenerateChangeSet"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function generate_change_set(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"GenerateChangeSet", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
generate_template()
generate_template(params::Dict{String,<:Any})
Generates an CloudFormation template based on the current launch configuration and writes
it to an Amazon S3 object in the customer’s Amazon S3 bucket.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"appId"`: The ID of the application associated with the CloudFormation template.
- `"templateFormat"`: The format for generating the CloudFormation template.
"""
function generate_template(; aws_config::AbstractAWSConfig=global_aws_config())
return sms("GenerateTemplate"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function generate_template(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"GenerateTemplate", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_app()
get_app(params::Dict{String,<:Any})
Retrieve information about the specified application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"appId"`: The ID of the application.
"""
function get_app(; aws_config::AbstractAWSConfig=global_aws_config())
return sms("GetApp"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_app(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms("GetApp", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
"""
get_app_launch_configuration()
get_app_launch_configuration(params::Dict{String,<:Any})
Retrieves the application launch configuration associated with the specified application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"appId"`: The ID of the application.
"""
function get_app_launch_configuration(; aws_config::AbstractAWSConfig=global_aws_config())
return sms(
"GetAppLaunchConfiguration"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_app_launch_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"GetAppLaunchConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_app_replication_configuration()
get_app_replication_configuration(params::Dict{String,<:Any})
Retrieves the application replication configuration associated with the specified
application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"appId"`: The ID of the application.
"""
function get_app_replication_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"GetAppReplicationConfiguration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_app_replication_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"GetAppReplicationConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_app_validation_configuration(app_id)
get_app_validation_configuration(app_id, params::Dict{String,<:Any})
Retrieves information about a configuration for validating an application.
# Arguments
- `app_id`: The ID of the application.
"""
function get_app_validation_configuration(
appId; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"GetAppValidationConfiguration",
Dict{String,Any}("appId" => appId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_app_validation_configuration(
appId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"GetAppValidationConfiguration",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("appId" => appId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_app_validation_output(app_id)
get_app_validation_output(app_id, params::Dict{String,<:Any})
Retrieves output from validating an application.
# Arguments
- `app_id`: The ID of the application.
"""
function get_app_validation_output(appId; aws_config::AbstractAWSConfig=global_aws_config())
return sms(
"GetAppValidationOutput",
Dict{String,Any}("appId" => appId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_app_validation_output(
appId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"GetAppValidationOutput",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("appId" => appId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_connectors()
get_connectors(params::Dict{String,<:Any})
Describes the connectors registered with the Server Migration Service.
# 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. The default
value is 50. To retrieve the remaining results, make another call with the returned
NextToken value.
- `"nextToken"`: The token for the next set of results.
"""
function get_connectors(; aws_config::AbstractAWSConfig=global_aws_config())
return sms("GetConnectors"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_connectors(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"GetConnectors", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_replication_jobs()
get_replication_jobs(params::Dict{String,<:Any})
Describes the specified replication job or all of your replication jobs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return in a single call. The default
value is 50. To retrieve the remaining results, make another call with the returned
NextToken value.
- `"nextToken"`: The token for the next set of results.
- `"replicationJobId"`: The ID of the replication job.
"""
function get_replication_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return sms("GetReplicationJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_replication_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"GetReplicationJobs", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_replication_runs(replication_job_id)
get_replication_runs(replication_job_id, params::Dict{String,<:Any})
Describes the replication runs for the specified replication job.
# Arguments
- `replication_job_id`: The ID of the replication 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 a single call. The default
value is 50. To retrieve the remaining results, make another call with the returned
NextToken value.
- `"nextToken"`: The token for the next set of results.
"""
function get_replication_runs(
replicationJobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"GetReplicationRuns",
Dict{String,Any}("replicationJobId" => replicationJobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_replication_runs(
replicationJobId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sms(
"GetReplicationRuns",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("replicationJobId" => replicationJobId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_servers()
get_servers(params::Dict{String,<:Any})
Describes the servers in your server catalog. Before you can describe your servers, you
must import them using ImportServerCatalog.
# 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. The default
value is 50. To retrieve the remaining results, make another call with the returned
NextToken value.
- `"nextToken"`: The token for the next set of results.
- `"vmServerAddressList"`: The server addresses.
"""
function get_servers(; aws_config::AbstractAWSConfig=global_aws_config())
return sms("GetServers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_servers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms("GetServers", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
"""
import_app_catalog()
import_app_catalog(params::Dict{String,<:Any})
Allows application import from Migration Hub.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"roleName"`: The name of the service role. If you omit this parameter, we create a
service-linked role for Migration Hub in your account. Otherwise, the role that you provide
must have the policy and trust policy described in the Migration Hub User Guide.
"""
function import_app_catalog(; aws_config::AbstractAWSConfig=global_aws_config())
return sms("ImportAppCatalog"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function import_app_catalog(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"ImportAppCatalog", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
import_server_catalog()
import_server_catalog(params::Dict{String,<:Any})
Gathers a complete list of on-premises servers. Connectors must be installed and monitoring
all servers to import. This call returns immediately, but might take additional time to
retrieve all the servers.
"""
function import_server_catalog(; aws_config::AbstractAWSConfig=global_aws_config())
return sms(
"ImportServerCatalog"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function import_server_catalog(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"ImportServerCatalog",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
launch_app()
launch_app(params::Dict{String,<:Any})
Launches the specified application as a stack in CloudFormation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"appId"`: The ID of the application.
"""
function launch_app(; aws_config::AbstractAWSConfig=global_aws_config())
return sms("LaunchApp"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function launch_app(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms("LaunchApp", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
"""
list_apps()
list_apps(params::Dict{String,<:Any})
Retrieves summaries for all applications.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"appIds"`: The unique application IDs.
- `"maxResults"`: The maximum number of results to return in a single call. 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.
"""
function list_apps(; aws_config::AbstractAWSConfig=global_aws_config())
return sms("ListApps"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_apps(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms("ListApps", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
"""
notify_app_validation_output(app_id)
notify_app_validation_output(app_id, params::Dict{String,<:Any})
Provides information to Server Migration Service about whether application validation is
successful.
# Arguments
- `app_id`: The ID of the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"notificationContext"`: The notification information.
"""
function notify_app_validation_output(
appId; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"NotifyAppValidationOutput",
Dict{String,Any}("appId" => appId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function notify_app_validation_output(
appId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"NotifyAppValidationOutput",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("appId" => appId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_app_launch_configuration()
put_app_launch_configuration(params::Dict{String,<:Any})
Creates or updates the launch configuration for the specified application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"appId"`: The ID of the application.
- `"autoLaunch"`: Indicates whether the application is configured to launch automatically
after replication is complete.
- `"roleName"`: The name of service role in the customer's account that CloudFormation uses
to launch the application.
- `"serverGroupLaunchConfigurations"`: Information about the launch configurations for
server groups in the application.
"""
function put_app_launch_configuration(; aws_config::AbstractAWSConfig=global_aws_config())
return sms(
"PutAppLaunchConfiguration"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function put_app_launch_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"PutAppLaunchConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_app_replication_configuration()
put_app_replication_configuration(params::Dict{String,<:Any})
Creates or updates the replication configuration for the specified application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"appId"`: The ID of the application.
- `"serverGroupReplicationConfigurations"`: Information about the replication
configurations for server groups in the application.
"""
function put_app_replication_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"PutAppReplicationConfiguration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_app_replication_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"PutAppReplicationConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_app_validation_configuration(app_id)
put_app_validation_configuration(app_id, params::Dict{String,<:Any})
Creates or updates a validation configuration for the specified application.
# Arguments
- `app_id`: The ID of the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"appValidationConfigurations"`: The configuration for application validation.
- `"serverGroupValidationConfigurations"`: The configuration for instance validation.
"""
function put_app_validation_configuration(
appId; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"PutAppValidationConfiguration",
Dict{String,Any}("appId" => appId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_app_validation_configuration(
appId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"PutAppValidationConfiguration",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("appId" => appId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_app_replication()
start_app_replication(params::Dict{String,<:Any})
Starts replicating the specified application by creating replication jobs for each server
in the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"appId"`: The ID of the application.
"""
function start_app_replication(; aws_config::AbstractAWSConfig=global_aws_config())
return sms(
"StartAppReplication"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function start_app_replication(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"StartAppReplication",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_on_demand_app_replication(app_id)
start_on_demand_app_replication(app_id, params::Dict{String,<:Any})
Starts an on-demand replication run for the specified application.
# Arguments
- `app_id`: The ID of the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the replication run.
"""
function start_on_demand_app_replication(
appId; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"StartOnDemandAppReplication",
Dict{String,Any}("appId" => appId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_on_demand_app_replication(
appId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"StartOnDemandAppReplication",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("appId" => appId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_on_demand_replication_run(replication_job_id)
start_on_demand_replication_run(replication_job_id, params::Dict{String,<:Any})
Starts an on-demand replication run for the specified replication job. This replication run
starts immediately. This replication run is in addition to the ones already scheduled.
There is a limit on the number of on-demand replications runs that you can request in a
24-hour period.
# Arguments
- `replication_job_id`: The ID of the replication job.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the replication run.
"""
function start_on_demand_replication_run(
replicationJobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"StartOnDemandReplicationRun",
Dict{String,Any}("replicationJobId" => replicationJobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_on_demand_replication_run(
replicationJobId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sms(
"StartOnDemandReplicationRun",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("replicationJobId" => replicationJobId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_app_replication()
stop_app_replication(params::Dict{String,<:Any})
Stops replicating the specified application by deleting the replication job for each server
in the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"appId"`: The ID of the application.
"""
function stop_app_replication(; aws_config::AbstractAWSConfig=global_aws_config())
return sms("StopAppReplication"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function stop_app_replication(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"StopAppReplication", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
terminate_app()
terminate_app(params::Dict{String,<:Any})
Terminates the stack for the specified application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"appId"`: The ID of the application.
"""
function terminate_app(; aws_config::AbstractAWSConfig=global_aws_config())
return sms("TerminateApp"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function terminate_app(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"TerminateApp", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
update_app()
update_app(params::Dict{String,<:Any})
Updates the specified application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"appId"`: The ID of the application.
- `"description"`: The new description of the application.
- `"name"`: The new name of the application.
- `"roleName"`: The name of the service role in the customer's account used by Server
Migration Service.
- `"serverGroups"`: The server groups in the application to update.
- `"tags"`: The tags to associate with the application.
"""
function update_app(; aws_config::AbstractAWSConfig=global_aws_config())
return sms("UpdateApp"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function update_app(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms("UpdateApp", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
"""
update_replication_job(replication_job_id)
update_replication_job(replication_job_id, params::Dict{String,<:Any})
Updates the specified settings for the specified replication job.
# Arguments
- `replication_job_id`: The ID of the replication job.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the replication job.
- `"encrypted"`: When true, the replication job produces encrypted AMIs. For more
information, KmsKeyId.
- `"frequency"`: The time between consecutive replication runs, in hours.
- `"kmsKeyId"`: The ID of the KMS key for replication jobs that produce encrypted AMIs.
This value can be any of the following: KMS key ID KMS key alias ARN referring to the
KMS key ID ARN referring to the KMS key alias If encrypted is enabled but a KMS key ID
is not specified, the customer's default KMS key for Amazon EBS is used.
- `"licenseType"`: The license type to be used for the AMI created by a successful
replication run.
- `"nextReplicationRunStartTime"`: The start time of the next replication run.
- `"numberOfRecentAmisToKeep"`: The maximum number of SMS-created AMIs to retain. The
oldest is deleted after the maximum number is reached and a new AMI is created.
- `"roleName"`: The name of the IAM role to be used by Server Migration Service.
"""
function update_replication_job(
replicationJobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return sms(
"UpdateReplicationJob",
Dict{String,Any}("replicationJobId" => replicationJobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_replication_job(
replicationJobId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sms(
"UpdateReplicationJob",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("replicationJobId" => replicationJobId), 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 | 14526 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: snow_device_management
using AWS.Compat
using AWS.UUIDs
"""
cancel_task(task_id)
cancel_task(task_id, params::Dict{String,<:Any})
Sends a cancel request for a specified task. You can cancel a task only if it's still in a
QUEUED state. Tasks that are already running can't be cancelled. A task might still run if
it's processed from the queue before the CancelTask operation changes the task's state.
# Arguments
- `task_id`: The ID of the task that you are attempting to cancel. You can retrieve a task
ID by using the ListTasks operation.
"""
function cancel_task(taskId; aws_config::AbstractAWSConfig=global_aws_config())
return snow_device_management(
"POST",
"/task/$(taskId)/cancel";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_task(
taskId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return snow_device_management(
"POST",
"/task/$(taskId)/cancel",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_task(command, targets)
create_task(command, targets, params::Dict{String,<:Any})
Instructs one or more devices to start a task, such as unlocking or rebooting.
# Arguments
- `command`: The task to be performed. Only one task is executed on a device at a time.
- `targets`: A list of managed device IDs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token ensuring that the action is called only once with the specified
details.
- `"description"`: A description of the task and its targets.
- `"tags"`: Optional metadata that you assign to a resource. You can use tags to categorize
a resource in different ways, such as by purpose, owner, or environment.
"""
function create_task(command, targets; aws_config::AbstractAWSConfig=global_aws_config())
return snow_device_management(
"POST",
"/task",
Dict{String,Any}(
"command" => command, "targets" => targets, "clientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_task(
command,
targets,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return snow_device_management(
"POST",
"/task",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"command" => command,
"targets" => targets,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_device(managed_device_id)
describe_device(managed_device_id, params::Dict{String,<:Any})
Checks device-specific information, such as the device type, software version, IP
addresses, and lock status.
# Arguments
- `managed_device_id`: The ID of the device that you are checking the information of.
"""
function describe_device(managedDeviceId; aws_config::AbstractAWSConfig=global_aws_config())
return snow_device_management(
"POST",
"/managed-device/$(managedDeviceId)/describe";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_device(
managedDeviceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return snow_device_management(
"POST",
"/managed-device/$(managedDeviceId)/describe",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_device_ec2_instances(instance_ids, managed_device_id)
describe_device_ec2_instances(instance_ids, managed_device_id, params::Dict{String,<:Any})
Checks the current state of the Amazon EC2 instances. The output is similar to
describeDevice, but the results are sourced from the device cache in the Amazon Web
Services Cloud and include a subset of the available fields.
# Arguments
- `instance_ids`: A list of instance IDs associated with the managed device.
- `managed_device_id`: The ID of the managed device.
"""
function describe_device_ec2_instances(
instanceIds, managedDeviceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return snow_device_management(
"POST",
"/managed-device/$(managedDeviceId)/resources/ec2/describe",
Dict{String,Any}("instanceIds" => instanceIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_device_ec2_instances(
instanceIds,
managedDeviceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return snow_device_management(
"POST",
"/managed-device/$(managedDeviceId)/resources/ec2/describe",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("instanceIds" => instanceIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_execution(managed_device_id, task_id)
describe_execution(managed_device_id, task_id, params::Dict{String,<:Any})
Checks the status of a remote task running on one or more target devices.
# Arguments
- `managed_device_id`: The ID of the managed device.
- `task_id`: The ID of the task that the action is describing.
"""
function describe_execution(
managedDeviceId, taskId; aws_config::AbstractAWSConfig=global_aws_config()
)
return snow_device_management(
"POST",
"/task/$(taskId)/execution/$(managedDeviceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_execution(
managedDeviceId,
taskId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return snow_device_management(
"POST",
"/task/$(taskId)/execution/$(managedDeviceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_task(task_id)
describe_task(task_id, params::Dict{String,<:Any})
Checks the metadata for a given task on a device.
# Arguments
- `task_id`: The ID of the task to be described.
"""
function describe_task(taskId; aws_config::AbstractAWSConfig=global_aws_config())
return snow_device_management(
"POST", "/task/$(taskId)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_task(
taskId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return snow_device_management(
"POST",
"/task/$(taskId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_device_resources(managed_device_id)
list_device_resources(managed_device_id, params::Dict{String,<:Any})
Returns a list of the Amazon Web Services resources available for a device. Currently,
Amazon EC2 instances are the only supported resource type.
# Arguments
- `managed_device_id`: The ID of the managed device that you are listing the resources of.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of resources per page.
- `"nextToken"`: A pagination token to continue to the next page of results.
- `"type"`: A structure used to filter the results by type of resource.
"""
function list_device_resources(
managedDeviceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return snow_device_management(
"GET",
"/managed-device/$(managedDeviceId)/resources";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_device_resources(
managedDeviceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return snow_device_management(
"GET",
"/managed-device/$(managedDeviceId)/resources",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_devices()
list_devices(params::Dict{String,<:Any})
Returns a list of all devices on your Amazon Web Services account that have Amazon Web
Services Snow Device Management enabled in the Amazon Web Services Region where the command
is run.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"jobId"`: The ID of the job used to order the device.
- `"maxResults"`: The maximum number of devices to list per page.
- `"nextToken"`: A pagination token to continue to the next page of results.
"""
function list_devices(; aws_config::AbstractAWSConfig=global_aws_config())
return snow_device_management(
"GET", "/managed-devices"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_devices(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return snow_device_management(
"GET",
"/managed-devices",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_executions(task_id)
list_executions(task_id, params::Dict{String,<:Any})
Returns the status of tasks for one or more target devices.
# Arguments
- `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 tasks to list per page.
- `"nextToken"`: A pagination token to continue to the next page of tasks.
- `"state"`: A structure used to filter the tasks by their current state.
"""
function list_executions(taskId; aws_config::AbstractAWSConfig=global_aws_config())
return snow_device_management(
"GET",
"/executions",
Dict{String,Any}("taskId" => taskId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_executions(
taskId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return snow_device_management(
"GET",
"/executions",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("taskId" => taskId), 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 managed device or task.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the device or task.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return snow_device_management(
"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 snow_device_management(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tasks()
list_tasks(params::Dict{String,<:Any})
Returns a list of tasks that can be filtered by state.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of tasks per page.
- `"nextToken"`: A pagination token to continue to the next page of tasks.
- `"state"`: A structure used to filter the list of tasks.
"""
function list_tasks(; aws_config::AbstractAWSConfig=global_aws_config())
return snow_device_management(
"GET", "/tasks"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_tasks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return snow_device_management(
"GET", "/tasks", 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 replaces tags on a device or task.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the device or task.
- `tags`: Optional metadata that you assign to a resource. You can use tags to categorize a
resource in different ways, such as by purpose, owner, or environment.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return snow_device_management(
"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 snow_device_management(
"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 device or task.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the device or task.
- `tag_keys`: Optional metadata that you assign to a resource. You can use tags to
categorize a resource in different ways, such as by purpose, owner, or environment.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return snow_device_management(
"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 snow_device_management(
"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 | 48063 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: snowball
using AWS.Compat
using AWS.UUIDs
"""
cancel_cluster(cluster_id)
cancel_cluster(cluster_id, params::Dict{String,<:Any})
Cancels a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum
status. You'll have at least an hour after creating a cluster job to cancel it.
# Arguments
- `cluster_id`: The 39-character ID for the cluster that you want to cancel, for example
CID123e4567-e89b-12d3-a456-426655440000.
"""
function cancel_cluster(ClusterId; aws_config::AbstractAWSConfig=global_aws_config())
return snowball(
"CancelCluster",
Dict{String,Any}("ClusterId" => ClusterId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_cluster(
ClusterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return snowball(
"CancelCluster",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClusterId" => ClusterId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_job(job_id)
cancel_job(job_id, params::Dict{String,<:Any})
Cancels the specified job. You can only cancel a job before its JobState value changes to
PreparingAppliance. Requesting the ListJobs or DescribeJob action returns a job's JobState
as part of the response element data returned.
# Arguments
- `job_id`: The 39-character job ID for the job that you want to cancel, for example
JID123e4567-e89b-12d3-a456-426655440000.
"""
function cancel_job(JobId; aws_config::AbstractAWSConfig=global_aws_config())
return snowball(
"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 snowball(
"CancelJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_address(address)
create_address(address, params::Dict{String,<:Any})
Creates an address for a Snow device to be shipped to. In most regions, addresses are
validated at the time of creation. The address you provide must be located within the
serviceable area of your region. If the address is invalid or unsupported, then an
exception is thrown. If providing an address as a JSON file through the cli-input-json
option, include the full file path. For example, --cli-input-json
file://create-address.json.
# Arguments
- `address`: The address that you want the Snow device shipped to.
"""
function create_address(Address; aws_config::AbstractAWSConfig=global_aws_config())
return snowball(
"CreateAddress",
Dict{String,Any}("Address" => Address);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_address(
Address, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return snowball(
"CreateAddress",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Address" => Address), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_cluster(address_id, job_type, shipping_option, snowball_type)
create_cluster(address_id, job_type, shipping_option, snowball_type, params::Dict{String,<:Any})
Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action
separately to create the jobs for each of these nodes. The cluster does not ship until
these five node jobs have been created.
# Arguments
- `address_id`: The ID for the address that you want the cluster shipped to.
- `job_type`: The type of job for this cluster. Currently, the only job type supported for
clusters is LOCAL_USE. For more information, see
\"https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html\" (Snow
Family Devices and Capacity) in the Snowcone User Guide or
\"https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html\"
(Snow Family Devices and Capacity) in the Snowcone User Guide.
- `shipping_option`: The shipping speed for each node in this cluster. This speed doesn't
dictate how soon you'll get each Snowball Edge device, rather it represents how quickly
each device moves to its destination while in transit. Regional shipping speeds are as
follows: In Australia, you have access to express shipping. Typically, Snow devices
shipped express are delivered in about a day. In the European Union (EU), you have access
to express shipping. Typically, Snow devices shipped express are delivered in about a day.
In addition, most countries in the EU have access to standard shipping, which typically
takes less than a week, one way. In India, Snow devices are delivered in one to seven
days. In the United States of America (US), you have access to one-day shipping and
two-day shipping. In Australia, you have access to express shipping. Typically, devices
shipped express are delivered in about a day. In the European Union (EU), you have access
to express shipping. Typically, Snow devices shipped express are delivered in about a day.
In addition, most countries in the EU have access to standard shipping, which typically
takes less than a week, one way. In India, Snow devices are delivered in one to seven
days. In the US, you have access to one-day shipping and two-day shipping.
- `snowball_type`: The type of Snow Family devices to use for this cluster. For cluster
jobs, Amazon Web Services Snow Family currently supports only the EDGE device type. For
more information, see
\"https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html\" (Snow
Family Devices and Capacity) in the Snowcone User Guide or
\"https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html\"
(Snow Family Devices and Capacity) in the Snowcone User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: An optional description of this specific cluster, for example
Environmental Data Cluster-01.
- `"ForceCreateJobs"`: Force to create cluster when user attempts to overprovision or
underprovision a cluster. A cluster is overprovisioned or underprovisioned if the initial
size of the cluster is more (overprovisioned) or less (underprovisioned) than what needed
to meet capacity requirement specified with OnDeviceServiceConfiguration.
- `"ForwardingAddressId"`: The forwarding address ID for a cluster. This field is not
supported in most regions.
- `"InitialClusterSize"`: If provided, each job will be automatically created and
associated with the new cluster. If not provided, will be treated as 0.
- `"KmsKeyARN"`: The KmsKeyARN value that you want to associate with this cluster.
KmsKeyARN values are created by using the CreateKey API action in Key Management Service
(KMS).
- `"LongTermPricingIds"`: Lists long-term pricing id that will be used to associate with
jobs automatically created for the new cluster.
- `"Notification"`: The Amazon Simple Notification Service (Amazon SNS) notification
settings for this cluster.
- `"OnDeviceServiceConfiguration"`: Specifies the service or services on the Snow Family
device that your transferred data will be exported from or imported into. Amazon Web
Services Snow Family device clusters support Amazon S3 and NFS (Network File System).
- `"RemoteManagement"`: Allows you to securely operate and manage Snow devices in a cluster
remotely from outside of your internal network. When set to INSTALLED_AUTOSTART, remote
management will automatically be available when the device arrives at your location.
Otherwise, you need to use the Snowball Client to manage the device.
- `"Resources"`: The resources associated with the cluster job. These resources include
Amazon S3 buckets and optional Lambda functions written in the Python language.
- `"RoleARN"`: The RoleARN that you want to associate with this cluster. RoleArn values are
created by using the CreateRole API action in Identity and Access Management (IAM).
- `"SnowballCapacityPreference"`: If your job is being created in one of the US regions,
you have the option of specifying what size Snow device you'd like for this job. In all
other regions, Snowballs come with 80 TB in storage capacity. For more information, see
\"https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html\" (Snow
Family Devices and Capacity) in the Snowcone User Guide or
\"https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html\"
(Snow Family Devices and Capacity) in the Snowcone User Guide.
- `"TaxDocuments"`: The tax documents required in your Amazon Web Services Region.
"""
function create_cluster(
AddressId,
JobType,
ShippingOption,
SnowballType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return snowball(
"CreateCluster",
Dict{String,Any}(
"AddressId" => AddressId,
"JobType" => JobType,
"ShippingOption" => ShippingOption,
"SnowballType" => SnowballType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_cluster(
AddressId,
JobType,
ShippingOption,
SnowballType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return snowball(
"CreateCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AddressId" => AddressId,
"JobType" => JobType,
"ShippingOption" => ShippingOption,
"SnowballType" => SnowballType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_job()
create_job(params::Dict{String,<:Any})
Creates a job to import or export data between Amazon S3 and your on-premises data center.
Your Amazon Web Services account must have the right trust policies and permissions in
place to create a job for a Snow device. If you're creating a job for a node in a cluster,
you only need to provide the clusterId value; the other job attributes are inherited from
the cluster. Only the Snowball; Edge device type is supported when ordering clustered
jobs. The device capacity is optional. Availability of device types differ by Amazon Web
Services Region. For more information about Region availability, see Amazon Web Services
Regional Services. Snow Family devices and their capacities. Device type: SNC1_SSD
Capacity: T14 Description: Snowcone Device type: SNC1_HDD Capacity: T8
Description: Snowcone Device type: EDGE_S Capacity: T98 Description: Snowball
Edge Storage Optimized for data transfer only Device type: EDGE_CG Capacity: T42
Description: Snowball Edge Compute Optimized with GPU Device type: EDGE_C Capacity:
T42 Description: Snowball Edge Compute Optimized without GPU Device type: EDGE
Capacity: T100 Description: Snowball Edge Storage Optimized with EC2 Compute This
device is replaced with T98. Device type: STANDARD Capacity: T50 Description:
Original Snowball device This device is only available in the Ningxia, Beijing, and
Singapore Amazon Web Services Region Device type: STANDARD Capacity: T80
Description: Original Snowball device This device is only available in the Ningxia,
Beijing, and Singapore Amazon Web Services Region. Snow Family device type:
RACK_5U_C Capacity: T13 Description: Snowblade. Device type: V3_5S Capacity:
T240 Description: Snowball Edge Storage Optimized 210TB
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AddressId"`: The ID for the address that you want the Snow device shipped to.
- `"ClusterId"`: The ID of a cluster. If you're creating a job for a node in a cluster, you
need to provide only this clusterId value. The other job attributes are inherited from the
cluster.
- `"Description"`: Defines an optional description of this specific job, for example
Important Photos 2016-08-11.
- `"DeviceConfiguration"`: Defines the device configuration for an Snowcone job. For more
information, see
\"https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html\" (Snow
Family Devices and Capacity) in the Snowcone User Guide or
\"https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html\"
(Snow Family Devices and Capacity) in the Snowcone User Guide.
- `"ForwardingAddressId"`: The forwarding address ID for a job. This field is not supported
in most Regions.
- `"ImpactLevel"`: The highest impact level of data that will be stored or processed on the
device, provided at job creation.
- `"JobType"`: Defines the type of job that you're creating.
- `"KmsKeyARN"`: The KmsKeyARN that you want to associate with this job. KmsKeyARNs are
created using the CreateKey Key Management Service (KMS) API action.
- `"LongTermPricingId"`: The ID of the long-term pricing type for the device.
- `"Notification"`: Defines the Amazon Simple Notification Service (Amazon SNS)
notification settings for this job.
- `"OnDeviceServiceConfiguration"`: Specifies the service or services on the Snow Family
device that your transferred data will be exported from or imported into. Amazon Web
Services Snow Family supports Amazon S3 and NFS (Network File System) and the Amazon Web
Services Storage Gateway service Tape Gateway type.
- `"PickupDetails"`: Information identifying the person picking up the device.
- `"RemoteManagement"`: Allows you to securely operate and manage Snowcone devices remotely
from outside of your internal network. When set to INSTALLED_AUTOSTART, remote management
will automatically be available when the device arrives at your location. Otherwise, you
need to use the Snowball Edge client to manage the device. When set to NOT_INSTALLED,
remote management will not be available on the device.
- `"Resources"`: Defines the Amazon S3 buckets associated with this job. With IMPORT jobs,
you specify the bucket or buckets that your transferred data will be imported into. With
EXPORT jobs, you specify the bucket or buckets that your transferred data will be exported
from. Optionally, you can also specify a KeyRange value. If you choose to export a range,
you define the length of the range by providing either an inclusive BeginMarker value, an
inclusive EndMarker value, or both. Ranges are UTF-8 binary sorted.
- `"RoleARN"`: The RoleARN that you want to associate with this job. RoleArns are created
using the CreateRole Identity and Access Management (IAM) API action.
- `"ShippingOption"`: The shipping speed for this job. This speed doesn't dictate how soon
you'll get the Snow device, rather it represents how quickly the Snow device moves to its
destination while in transit. Regional shipping speeds are as follows: In Australia, you
have access to express shipping. Typically, Snow devices shipped express are delivered in
about a day. In the European Union (EU), you have access to express shipping. Typically,
Snow devices shipped express are delivered in about a day. In addition, most countries in
the EU have access to standard shipping, which typically takes less than a week, one way.
In India, Snow devices are delivered in one to seven days. In the US, you have access to
one-day shipping and two-day shipping.
- `"SnowballCapacityPreference"`: If your job is being created in one of the US regions,
you have the option of specifying what size Snow device you'd like for this job. In all
other regions, Snowballs come with 80 TB in storage capacity. For more information, see
\"https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html\" (Snow
Family Devices and Capacity) in the Snowcone User Guide or
\"https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html\"
(Snow Family Devices and Capacity) in the Snowcone User Guide.
- `"SnowballType"`: The type of Snow Family devices to use for this job. For cluster
jobs, Amazon Web Services Snow Family currently supports only the EDGE device type. The
type of Amazon Web Services Snow device to use for this job. Currently, the only supported
device type for cluster jobs is EDGE. For more information, see Snowball Edge Device
Options in the Snowball Edge Developer Guide. For more information, see
\"https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html\" (Snow
Family Devices and Capacity) in the Snowcone User Guide or
\"https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html\"
(Snow Family Devices and Capacity) in the Snowcone User Guide.
- `"TaxDocuments"`: The tax documents required in your Amazon Web Services Region.
"""
function create_job(; aws_config::AbstractAWSConfig=global_aws_config())
return snowball("CreateJob"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function create_job(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return snowball(
"CreateJob", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
create_long_term_pricing(long_term_pricing_type, snowball_type)
create_long_term_pricing(long_term_pricing_type, snowball_type, params::Dict{String,<:Any})
Creates a job with the long-term usage option for a device. The long-term usage is a 1-year
or 3-year long-term pricing type for the device. You are billed upfront, and Amazon Web
Services provides discounts for long-term pricing.
# Arguments
- `long_term_pricing_type`: The type of long-term pricing option you want for the device,
either 1-year or 3-year long-term pricing.
- `snowball_type`: The type of Snow Family devices to use for the long-term pricing job.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IsLongTermPricingAutoRenew"`: Specifies whether the current long-term pricing type for
the device should be renewed.
"""
function create_long_term_pricing(
LongTermPricingType, SnowballType; aws_config::AbstractAWSConfig=global_aws_config()
)
return snowball(
"CreateLongTermPricing",
Dict{String,Any}(
"LongTermPricingType" => LongTermPricingType, "SnowballType" => SnowballType
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_long_term_pricing(
LongTermPricingType,
SnowballType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return snowball(
"CreateLongTermPricing",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LongTermPricingType" => LongTermPricingType,
"SnowballType" => SnowballType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_return_shipping_label(job_id)
create_return_shipping_label(job_id, params::Dict{String,<:Any})
Creates a shipping label that will be used to return the Snow device to Amazon Web Services.
# Arguments
- `job_id`: The ID for a job that you want to create the return shipping label for; for
example, JID123e4567-e89b-12d3-a456-426655440000.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ShippingOption"`: The shipping speed for a particular job. This speed doesn't dictate
how soon the device is returned to Amazon Web Services. This speed represents how quickly
it moves to its destination while in transit. Regional shipping speeds are as follows:
"""
function create_return_shipping_label(
JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return snowball(
"CreateReturnShippingLabel",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_return_shipping_label(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return snowball(
"CreateReturnShippingLabel",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_address(address_id)
describe_address(address_id, params::Dict{String,<:Any})
Takes an AddressId and returns specific details about that address in the form of an
Address object.
# Arguments
- `address_id`: The automatically generated ID for a specific address.
"""
function describe_address(AddressId; aws_config::AbstractAWSConfig=global_aws_config())
return snowball(
"DescribeAddress",
Dict{String,Any}("AddressId" => AddressId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_address(
AddressId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return snowball(
"DescribeAddress",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AddressId" => AddressId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_addresses()
describe_addresses(params::Dict{String,<:Any})
Returns a specified number of ADDRESS objects. Calling this API in one of the US regions
will return addresses from the list of all addresses associated with this account in all US
regions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The number of ADDRESS objects to return.
- `"NextToken"`: HTTP requests are stateless. To identify what object comes \"next\" in the
list of ADDRESS objects, you have the option of specifying a value for NextToken as the
starting point for your list of returned addresses.
"""
function describe_addresses(; aws_config::AbstractAWSConfig=global_aws_config())
return snowball(
"DescribeAddresses"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_addresses(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return snowball(
"DescribeAddresses", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_cluster(cluster_id)
describe_cluster(cluster_id, params::Dict{String,<:Any})
Returns information about a specific cluster including shipping information, cluster
status, and other important metadata.
# Arguments
- `cluster_id`: The automatically generated ID for a cluster.
"""
function describe_cluster(ClusterId; aws_config::AbstractAWSConfig=global_aws_config())
return snowball(
"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 snowball(
"DescribeCluster",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClusterId" => ClusterId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_job(job_id)
describe_job(job_id, params::Dict{String,<:Any})
Returns information about a specific job including shipping information, job status, and
other important metadata.
# Arguments
- `job_id`: The automatically generated ID for a job, for example
JID123e4567-e89b-12d3-a456-426655440000.
"""
function describe_job(JobId; aws_config::AbstractAWSConfig=global_aws_config())
return snowball(
"DescribeJob",
Dict{String,Any}("JobId" => 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 snowball(
"DescribeJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_return_shipping_label(job_id)
describe_return_shipping_label(job_id, params::Dict{String,<:Any})
Information on the shipping label of a Snow device that is being returned to Amazon Web
Services.
# Arguments
- `job_id`: The automatically generated ID for a job, for example
JID123e4567-e89b-12d3-a456-426655440000.
"""
function describe_return_shipping_label(
JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return snowball(
"DescribeReturnShippingLabel",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_return_shipping_label(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return snowball(
"DescribeReturnShippingLabel",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_job_manifest(job_id)
get_job_manifest(job_id, params::Dict{String,<:Any})
Returns a link to an Amazon S3 presigned URL for the manifest file associated with the
specified JobId value. You can access the manifest file for up to 60 minutes after this
request has been made. To access the manifest file after 60 minutes have passed, you'll
have to make another call to the GetJobManifest action. The manifest is an encrypted file
that you can download after your job enters the WithCustomer status. This is the only valid
status for calling this API as the manifest and UnlockCode code value are used for securing
your device and should only be used when you have the device. The manifest is decrypted by
using the UnlockCode code value, when you pass both values to the Snow device through the
Snowball client when the client is started for the first time. As a best practice, we
recommend that you don't save a copy of an UnlockCode value in the same location as the
manifest file for that job. Saving these separately helps prevent unauthorized parties from
gaining access to the Snow device associated with that job. The credentials of a given job,
including its manifest file and unlock code, expire 360 days after the job is created.
# Arguments
- `job_id`: The ID for a job that you want to get the manifest file for, for example
JID123e4567-e89b-12d3-a456-426655440000.
"""
function get_job_manifest(JobId; aws_config::AbstractAWSConfig=global_aws_config())
return snowball(
"GetJobManifest",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_job_manifest(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return snowball(
"GetJobManifest",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_job_unlock_code(job_id)
get_job_unlock_code(job_id, params::Dict{String,<:Any})
Returns the UnlockCode code value for the specified job. A particular UnlockCode value can
be accessed for up to 360 days after the associated job has been created. The UnlockCode
value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code is
used to decrypt the manifest file when it is passed along with the manifest to the Snow
device through the Snowball client when the client is started for the first time. The only
valid status for calling this API is WithCustomer as the manifest and Unlock code values
are used for securing your device and should only be used when you have the device. As a
best practice, we recommend that you don't save a copy of the UnlockCode in the same
location as the manifest file for that job. Saving these separately helps prevent
unauthorized parties from gaining access to the Snow device associated with that job.
# Arguments
- `job_id`: The ID for the job that you want to get the UnlockCode value for, for example
JID123e4567-e89b-12d3-a456-426655440000.
"""
function get_job_unlock_code(JobId; aws_config::AbstractAWSConfig=global_aws_config())
return snowball(
"GetJobUnlockCode",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_job_unlock_code(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return snowball(
"GetJobUnlockCode",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_snowball_usage()
get_snowball_usage(params::Dict{String,<:Any})
Returns information about the Snow Family service limit for your account, and also the
number of Snow devices your account has in use. The default service limit for the number of
Snow devices that you can have at one time is 1. If you want to increase your service
limit, contact Amazon Web Services Support.
"""
function get_snowball_usage(; aws_config::AbstractAWSConfig=global_aws_config())
return snowball(
"GetSnowballUsage"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_snowball_usage(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return snowball(
"GetSnowballUsage", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_software_updates(job_id)
get_software_updates(job_id, params::Dict{String,<:Any})
Returns an Amazon S3 presigned URL for an update file associated with a specified JobId.
# Arguments
- `job_id`: The ID for a job that you want to get the software update file for, for example
JID123e4567-e89b-12d3-a456-426655440000.
"""
function get_software_updates(JobId; aws_config::AbstractAWSConfig=global_aws_config())
return snowball(
"GetSoftwareUpdates",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_software_updates(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return snowball(
"GetSoftwareUpdates",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_cluster_jobs(cluster_id)
list_cluster_jobs(cluster_id, params::Dict{String,<:Any})
Returns an array of JobListEntry objects of the specified length. Each JobListEntry object
is for a job in the specified cluster and contains a job's state, a job's ID, and other
information.
# Arguments
- `cluster_id`: The 39-character ID for the cluster that you want to list, for example
CID123e4567-e89b-12d3-a456-426655440000.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The number of JobListEntry objects to return.
- `"NextToken"`: HTTP requests are stateless. To identify what object comes \"next\" in the
list of JobListEntry objects, you have the option of specifying NextToken as the starting
point for your returned list.
"""
function list_cluster_jobs(ClusterId; aws_config::AbstractAWSConfig=global_aws_config())
return snowball(
"ListClusterJobs",
Dict{String,Any}("ClusterId" => ClusterId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_cluster_jobs(
ClusterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return snowball(
"ListClusterJobs",
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})
Returns an array of ClusterListEntry objects of the specified length. Each ClusterListEntry
object contains a cluster's state, a cluster's ID, and other important status information.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The number of ClusterListEntry objects to return.
- `"NextToken"`: HTTP requests are stateless. To identify what object comes \"next\" in the
list of ClusterListEntry objects, you have the option of specifying NextToken as the
starting point for your returned list.
"""
function list_clusters(; aws_config::AbstractAWSConfig=global_aws_config())
return snowball("ListClusters"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_clusters(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return snowball(
"ListClusters", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_compatible_images()
list_compatible_images(params::Dict{String,<:Any})
This action returns a list of the different Amazon EC2-compatible Amazon Machine Images
(AMIs) that are owned by your Amazon Web Services accountthat would be supported for use on
a Snow device. Currently, supported AMIs are based on the Amazon Linux-2, Ubuntu 20.04 LTS
- Focal, or Ubuntu 22.04 LTS - Jammy images, available on the Amazon Web Services
Marketplace. Ubuntu 16.04 LTS - Xenial (HVM) images are no longer supported in the Market,
but still supported for use on devices through Amazon EC2 VM Import/Export and running
locally in AMIs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results for the list of compatible images.
Currently, a Snowball Edge device can store 10 AMIs.
- `"NextToken"`: HTTP requests are stateless. To identify what object comes \"next\" in the
list of compatible images, you can specify a value for NextToken as the starting point for
your list of returned images.
"""
function list_compatible_images(; aws_config::AbstractAWSConfig=global_aws_config())
return snowball(
"ListCompatibleImages"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_compatible_images(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return snowball(
"ListCompatibleImages",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_jobs()
list_jobs(params::Dict{String,<:Any})
Returns an array of JobListEntry objects of the specified length. Each JobListEntry object
contains a job's state, a job's ID, and a value that indicates whether the job is a job
part, in the case of export jobs. Calling this API action in one of the US regions will
return jobs from the list of all jobs associated with this account in all US regions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The number of JobListEntry objects to return.
- `"NextToken"`: HTTP requests are stateless. To identify what object comes \"next\" in the
list of JobListEntry objects, you have the option of specifying NextToken as the starting
point for your returned list.
"""
function list_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return snowball("ListJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return snowball(
"ListJobs", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_long_term_pricing()
list_long_term_pricing(params::Dict{String,<:Any})
Lists all long-term pricing types.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of ListLongTermPricing objects to return.
- `"NextToken"`: Because HTTP requests are stateless, this is the starting point for your
next list of ListLongTermPricing to return.
"""
function list_long_term_pricing(; aws_config::AbstractAWSConfig=global_aws_config())
return snowball(
"ListLongTermPricing"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_long_term_pricing(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return snowball(
"ListLongTermPricing",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_pickup_locations()
list_pickup_locations(params::Dict{String,<:Any})
A list of locations from which the customer can choose to pickup a device.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of locations to list per page.
- `"NextToken"`: HTTP requests are stateless. To identify what object comes \"next\" in the
list of ListPickupLocationsRequest objects, you have the option of specifying NextToken as
the starting point for your returned list.
"""
function list_pickup_locations(; aws_config::AbstractAWSConfig=global_aws_config())
return snowball(
"ListPickupLocations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_pickup_locations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return snowball(
"ListPickupLocations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_service_versions(service_name)
list_service_versions(service_name, params::Dict{String,<:Any})
Lists all supported versions for Snow on-device services. Returns an array of
ServiceVersion object containing the supported versions for a particular service.
# Arguments
- `service_name`: The name of the service for which you're requesting supported versions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DependentServices"`: A list of names and versions of dependant services of the
requested service.
- `"MaxResults"`: The maximum number of ListServiceVersions objects to return.
- `"NextToken"`: Because HTTP requests are stateless, this is the starting point for the
next list of returned ListServiceVersionsRequest versions.
"""
function list_service_versions(
ServiceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return snowball(
"ListServiceVersions",
Dict{String,Any}("ServiceName" => ServiceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_service_versions(
ServiceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return snowball(
"ListServiceVersions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ServiceName" => ServiceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_cluster(cluster_id)
update_cluster(cluster_id, params::Dict{String,<:Any})
While a cluster's ClusterState value is in the AwaitingQuorum state, you can update some of
the information associated with a cluster. Once the cluster changes to a different job
state, usually 60 minutes after the cluster being created, this action is no longer
available.
# Arguments
- `cluster_id`: The cluster ID of the cluster that you want to update, for example
CID123e4567-e89b-12d3-a456-426655440000.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AddressId"`: The ID of the updated Address object.
- `"Description"`: The updated description of this cluster.
- `"ForwardingAddressId"`: The updated ID for the forwarding address for a cluster. This
field is not supported in most regions.
- `"Notification"`: The new or updated Notification object.
- `"OnDeviceServiceConfiguration"`: Specifies the service or services on the Snow Family
device that your transferred data will be exported from or imported into. Amazon Web
Services Snow Family device clusters support Amazon S3 and NFS (Network File System).
- `"Resources"`: The updated arrays of JobResource objects that can include updated
S3Resource objects or LambdaResource objects.
- `"RoleARN"`: The new role Amazon Resource Name (ARN) that you want to associate with this
cluster. To create a role ARN, use the CreateRole API action in Identity and Access
Management (IAM).
- `"ShippingOption"`: The updated shipping option value of this cluster's ShippingDetails
object.
"""
function update_cluster(ClusterId; aws_config::AbstractAWSConfig=global_aws_config())
return snowball(
"UpdateCluster",
Dict{String,Any}("ClusterId" => ClusterId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_cluster(
ClusterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return snowball(
"UpdateCluster",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClusterId" => ClusterId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_job(job_id)
update_job(job_id, params::Dict{String,<:Any})
While a job's JobState value is New, you can update some of the information associated with
a job. Once the job changes to a different job state, usually within 60 minutes of the job
being created, this action is no longer available.
# Arguments
- `job_id`: The job ID of the job that you want to update, for example
JID123e4567-e89b-12d3-a456-426655440000.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AddressId"`: The ID of the updated Address object.
- `"Description"`: The updated description of this job's JobMetadata object.
- `"ForwardingAddressId"`: The updated ID for the forwarding address for a job. This field
is not supported in most regions.
- `"Notification"`: The new or updated Notification object.
- `"OnDeviceServiceConfiguration"`: Specifies the service or services on the Snow Family
device that your transferred data will be exported from or imported into. Amazon Web
Services Snow Family supports Amazon S3 and NFS (Network File System) and the Amazon Web
Services Storage Gateway service Tape Gateway type.
- `"PickupDetails"`:
- `"Resources"`: The updated JobResource object, or the updated JobResource object.
- `"RoleARN"`: The new role Amazon Resource Name (ARN) that you want to associate with this
job. To create a role ARN, use the CreateRoleIdentity and Access Management (IAM) API
action.
- `"ShippingOption"`: The updated shipping option value of this job's ShippingDetails
object.
- `"SnowballCapacityPreference"`: The updated SnowballCapacityPreference of this job's
JobMetadata object. The 50 TB Snowballs are only available in the US regions. For more
information, see
\"https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html\" (Snow
Family Devices and Capacity) in the Snowcone User Guide or
\"https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html\"
(Snow Family Devices and Capacity) in the Snowcone User Guide.
"""
function update_job(JobId; aws_config::AbstractAWSConfig=global_aws_config())
return snowball(
"UpdateJob",
Dict{String,Any}("JobId" => 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 snowball(
"UpdateJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_job_shipment_state(job_id, shipment_state)
update_job_shipment_state(job_id, shipment_state, params::Dict{String,<:Any})
Updates the state when a shipment state changes to a different state.
# Arguments
- `job_id`: The job ID of the job whose shipment date you want to update, for example
JID123e4567-e89b-12d3-a456-426655440000.
- `shipment_state`: The state of a device when it is being shipped. Set to RECEIVED when
the device arrives at your location. Set to RETURNED when you have returned the device to
Amazon Web Services.
"""
function update_job_shipment_state(
JobId, ShipmentState; aws_config::AbstractAWSConfig=global_aws_config()
)
return snowball(
"UpdateJobShipmentState",
Dict{String,Any}("JobId" => JobId, "ShipmentState" => ShipmentState);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_job_shipment_state(
JobId,
ShipmentState,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return snowball(
"UpdateJobShipmentState",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("JobId" => JobId, "ShipmentState" => ShipmentState),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_long_term_pricing(long_term_pricing_id)
update_long_term_pricing(long_term_pricing_id, params::Dict{String,<:Any})
Updates the long-term pricing type.
# Arguments
- `long_term_pricing_id`: The ID of the long-term pricing type for the device.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IsLongTermPricingAutoRenew"`: If set to true, specifies that the current long-term
pricing type for the device should be automatically renewed before the long-term pricing
contract expires.
- `"ReplacementJob"`: Specifies that a device that is ordered with long-term pricing should
be replaced with a new device.
"""
function update_long_term_pricing(
LongTermPricingId; aws_config::AbstractAWSConfig=global_aws_config()
)
return snowball(
"UpdateLongTermPricing",
Dict{String,Any}("LongTermPricingId" => LongTermPricingId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_long_term_pricing(
LongTermPricingId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return snowball(
"UpdateLongTermPricing",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("LongTermPricingId" => LongTermPricingId), 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 | 89551 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: sns
using AWS.Compat
using AWS.UUIDs
"""
add_permission(awsaccount_id, action_name, label, topic_arn)
add_permission(awsaccount_id, action_name, label, topic_arn, params::Dict{String,<:Any})
Adds a statement to a topic's access control policy, granting access for the specified
Amazon Web Services accounts to the specified actions. To remove the ability to change
topic permissions, you must deny permissions to the AddPermission, RemovePermission, and
SetTopicAttributes actions in your IAM policy.
# Arguments
- `awsaccount_id`: The Amazon Web Services account IDs of the users (principals) who will
be given access to the specified actions. The users must have Amazon Web Services account,
but do not need to be signed up for this service.
- `action_name`: The action you want to allow for the specified principal(s). Valid values:
Any Amazon SNS action name, for example Publish.
- `label`: A unique identifier for the new policy statement.
- `topic_arn`: The ARN of the topic whose access control policy you wish to modify.
"""
function add_permission(
AWSAccountId,
ActionName,
Label,
TopicArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sns(
"AddPermission",
Dict{String,Any}(
"AWSAccountId" => AWSAccountId,
"ActionName" => ActionName,
"Label" => Label,
"TopicArn" => TopicArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_permission(
AWSAccountId,
ActionName,
Label,
TopicArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sns(
"AddPermission",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AWSAccountId" => AWSAccountId,
"ActionName" => ActionName,
"Label" => Label,
"TopicArn" => TopicArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
check_if_phone_number_is_opted_out(phone_number)
check_if_phone_number_is_opted_out(phone_number, params::Dict{String,<:Any})
Accepts a phone number and indicates whether the phone holder has opted out of receiving
SMS messages from your Amazon Web Services account. You cannot send SMS messages to a
number that is opted out. To resume sending messages, you can opt in the number by using
the OptInPhoneNumber action.
# Arguments
- `phone_number`: The phone number for which you want to check the opt out status.
"""
function check_if_phone_number_is_opted_out(
phoneNumber; aws_config::AbstractAWSConfig=global_aws_config()
)
return sns(
"CheckIfPhoneNumberIsOptedOut",
Dict{String,Any}("phoneNumber" => phoneNumber);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function check_if_phone_number_is_opted_out(
phoneNumber,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sns(
"CheckIfPhoneNumberIsOptedOut",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("phoneNumber" => phoneNumber), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
confirm_subscription(token, topic_arn)
confirm_subscription(token, topic_arn, params::Dict{String,<:Any})
Verifies an endpoint owner's intent to receive messages by validating the token sent to the
endpoint by an earlier Subscribe action. If the token is valid, the action creates a new
subscription and returns its Amazon Resource Name (ARN). This call requires an AWS
signature only when the AuthenticateOnUnsubscribe flag is set to \"true\".
# Arguments
- `token`: Short-lived token sent to an endpoint during the Subscribe action.
- `topic_arn`: The ARN of the topic for which you wish to confirm a subscription.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AuthenticateOnUnsubscribe"`: Disallows unauthenticated unsubscribes of the
subscription. If the value of this parameter is true and the request has an Amazon Web
Services signature, then only the topic owner and the subscription owner can unsubscribe
the endpoint. The unsubscribe action requires Amazon Web Services authentication.
"""
function confirm_subscription(
Token, TopicArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sns(
"ConfirmSubscription",
Dict{String,Any}("Token" => Token, "TopicArn" => TopicArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function confirm_subscription(
Token,
TopicArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sns(
"ConfirmSubscription",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Token" => Token, "TopicArn" => TopicArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_platform_application(attributes, name, platform)
create_platform_application(attributes, name, platform, params::Dict{String,<:Any})
Creates a platform application object for one of the supported push notification services,
such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may
register. You must specify PlatformPrincipal and PlatformCredential attributes when using
the CreatePlatformApplication action. PlatformPrincipal and PlatformCredential are
received from the notification service. For ADM, PlatformPrincipal is client id and
PlatformCredential is client secret. For APNS and APNS_SANDBOX using certificate
credentials, PlatformPrincipal is SSL certificate and PlatformCredential is private key.
For APNS and APNS_SANDBOX using token credentials, PlatformPrincipal is signing key ID and
PlatformCredential is signing key. For Baidu, PlatformPrincipal is API key and
PlatformCredential is secret key. For GCM (Firebase Cloud Messaging) using key
credentials, there is no PlatformPrincipal. The PlatformCredential is API key. For GCM
(Firebase Cloud Messaging) using token credentials, there is no PlatformPrincipal. The
PlatformCredential is a JSON formatted private key file. When using the Amazon Web Services
CLI, the file must be in string format and special characters must be ignored. To format
the file correctly, Amazon SNS recommends using the following command: SERVICE_JSON=`jq
@json <<< cat service.json`. For MPNS, PlatformPrincipal is TLS certificate and
PlatformCredential is private key. For WNS, PlatformPrincipal is Package Security
Identifier and PlatformCredential is secret key. You can use the returned
PlatformApplicationArn as an attribute for the CreatePlatformEndpoint action.
# Arguments
- `attributes`: For a list of attributes, see SetPlatformApplicationAttributes .
- `name`: Application names must be made up of only uppercase and lowercase ASCII letters,
numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.
- `platform`: The following platforms are supported: ADM (Amazon Device Messaging), APNS
(Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging).
"""
function create_platform_application(
Attributes, Name, Platform; aws_config::AbstractAWSConfig=global_aws_config()
)
return sns(
"CreatePlatformApplication",
Dict{String,Any}(
"Attributes" => Attributes, "Name" => Name, "Platform" => Platform
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_platform_application(
Attributes,
Name,
Platform,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sns(
"CreatePlatformApplication",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Attributes" => Attributes, "Name" => Name, "Platform" => Platform
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_platform_endpoint(platform_application_arn, token)
create_platform_endpoint(platform_application_arn, token, params::Dict{String,<:Any})
Creates an endpoint for a device and mobile app on one of the supported push notification
services, such as GCM (Firebase Cloud Messaging) and APNS. CreatePlatformEndpoint requires
the PlatformApplicationArn that is returned from CreatePlatformApplication. You can use the
returned EndpointArn to send a message to a mobile app or by the Subscribe action for
subscription to a topic. The CreatePlatformEndpoint action is idempotent, so if the
requester already owns an endpoint with the same device token and attributes, that
endpoint's ARN is returned without creating a new endpoint. For more information, see Using
Amazon SNS Mobile Push Notifications. When using CreatePlatformEndpoint with Baidu, two
attributes must be provided: ChannelId and UserId. The token field must also contain the
ChannelId. For more information, see Creating an Amazon SNS Endpoint for Baidu.
# Arguments
- `platform_application_arn`: PlatformApplicationArn returned from
CreatePlatformApplication is used to create a an endpoint.
- `token`: Unique identifier created by the notification service for an app on a device.
The specific name for Token will vary, depending on which notification service is being
used. For example, when using APNS as the notification service, you need the device token.
Alternatively, when using GCM (Firebase Cloud Messaging) or ADM, the device token
equivalent is called the registration ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Attributes"`: For a list of attributes, see SetEndpointAttributes .
- `"CustomUserData"`: Arbitrary user data to associate with the endpoint. Amazon SNS does
not use this data. The data must be in UTF-8 format and less than 2KB.
"""
function create_platform_endpoint(
PlatformApplicationArn, Token; aws_config::AbstractAWSConfig=global_aws_config()
)
return sns(
"CreatePlatformEndpoint",
Dict{String,Any}(
"PlatformApplicationArn" => PlatformApplicationArn, "Token" => Token
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_platform_endpoint(
PlatformApplicationArn,
Token,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sns(
"CreatePlatformEndpoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PlatformApplicationArn" => PlatformApplicationArn, "Token" => Token
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_smssandbox_phone_number(phone_number)
create_smssandbox_phone_number(phone_number, params::Dict{String,<:Any})
Adds a destination phone number to an Amazon Web Services account in the SMS sandbox and
sends a one-time password (OTP) to that phone number. When you start using Amazon SNS to
send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox
provides a safe environment for you to try Amazon SNS features without risking your
reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox,
you can use all of the features of Amazon SNS. However, you can send SMS messages only to
verified destination phone numbers. For more information, including how to move out of the
sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer
Guide.
# Arguments
- `phone_number`: The destination phone number to verify. On verification, Amazon SNS adds
this phone number to the list of verified phone numbers that you can send SMS messages to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LanguageCode"`: The language to use for sending the OTP. The default value is en-US.
"""
function create_smssandbox_phone_number(
PhoneNumber; aws_config::AbstractAWSConfig=global_aws_config()
)
return sns(
"CreateSMSSandboxPhoneNumber",
Dict{String,Any}("PhoneNumber" => PhoneNumber);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_smssandbox_phone_number(
PhoneNumber,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sns(
"CreateSMSSandboxPhoneNumber",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PhoneNumber" => PhoneNumber), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_topic(name)
create_topic(name, params::Dict{String,<:Any})
Creates a topic to which notifications can be published. Users can create at most 100,000
standard topics (at most 1,000 FIFO topics). For more information, see Creating an Amazon
SNS topic in the Amazon SNS Developer Guide. This action is idempotent, so if the requester
already owns a topic with the specified name, that topic's ARN is returned without creating
a new topic.
# Arguments
- `name`: The name of the topic you want to create. Constraints: Topic names must be made
up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and
must be between 1 and 256 characters long. For a FIFO (first-in-first-out) topic, the name
must end with the .fifo suffix.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Attributes"`: A map of attributes with their corresponding values. The following lists
names, descriptions, and values of the special request parameters that the CreateTopic
action uses: DeliveryPolicy – The policy that defines how Amazon SNS retries failed
deliveries to HTTP/S endpoints. DisplayName – The display name to use for a topic with
SMS subscriptions. FifoTopic – Set to true to create a FIFO topic. Policy – The
policy that defines who can access your topic. By default, only the topic owner can publish
or subscribe to the topic. SignatureVersion – The signature version corresponds to the
hashing algorithm used while creating the signature of the notifications, subscription
confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default,
SignatureVersion is set to 1. TracingConfig – Tracing mode of an Amazon SNS topic. By
default TracingConfig is set to PassThrough, and the topic passes through the tracing
header it receives from an Amazon SNS publisher to its subscriptions. If set to Active,
Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the
tracing header is true. This is only supported on standard topics. The following
attribute applies only to server-side encryption: KmsMasterKeyId – The ID of an Amazon
Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more
information, see Key Terms. For more examples, see KeyId in the Key Management Service API
Reference. The following attributes apply only to FIFO topics: ArchivePolicy – Adds
or updates an inline policy document to archive messages stored in the specified Amazon SNS
topic. BeginningArchiveTime – The earliest starting point at which a message in the
topic’s archive can be replayed from. This point in time is based on the configured
message retention period set by the topic’s message archiving policy.
ContentBasedDeduplication – Enables content-based deduplication for FIFO topics. By
default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this
attribute is false, you must specify a value for the MessageDeduplicationId parameter for
the Publish action. When you set ContentBasedDeduplication to true, Amazon SNS uses a
SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not
the attributes of the message). (Optional) To override the generated value, you can specify
a value for the MessageDeduplicationId parameter for the Publish action.
- `"DataProtectionPolicy"`: The body of the policy document you want to use for this topic.
You can only add one policy per topic. The policy must be in JSON string format. Length
Constraints: Maximum length of 30,720.
- `"Tags"`: The list of tags to add to a new topic. To be able to tag a topic on creation,
you must have the sns:CreateTopic and sns:TagResource permissions.
"""
function create_topic(Name; aws_config::AbstractAWSConfig=global_aws_config())
return sns(
"CreateTopic",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_topic(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sns(
"CreateTopic",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), 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 endpoint for a device and mobile app from Amazon SNS. This action is
idempotent. For more information, see Using Amazon SNS Mobile Push Notifications. When you
delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the
endpoint from the topic.
# Arguments
- `endpoint_arn`: EndpointArn of endpoint to delete.
"""
function delete_endpoint(EndpointArn; aws_config::AbstractAWSConfig=global_aws_config())
return sns(
"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 sns(
"DeleteEndpoint",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EndpointArn" => EndpointArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_platform_application(platform_application_arn)
delete_platform_application(platform_application_arn, params::Dict{String,<:Any})
Deletes a platform application object for one of the supported push notification services,
such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS
Mobile Push Notifications.
# Arguments
- `platform_application_arn`: PlatformApplicationArn of platform application object to
delete.
"""
function delete_platform_application(
PlatformApplicationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sns(
"DeletePlatformApplication",
Dict{String,Any}("PlatformApplicationArn" => PlatformApplicationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_platform_application(
PlatformApplicationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sns(
"DeletePlatformApplication",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("PlatformApplicationArn" => PlatformApplicationArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_smssandbox_phone_number(phone_number)
delete_smssandbox_phone_number(phone_number, params::Dict{String,<:Any})
Deletes an Amazon Web Services account's verified or pending phone number from the SMS
sandbox. When you start using Amazon SNS to send SMS messages, your Amazon Web Services
account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try
Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web
Services account is in the SMS sandbox, you can use all of the features of Amazon SNS.
However, you can send SMS messages only to verified destination phone numbers. For more
information, including how to move out of the sandbox to send messages without
restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
# Arguments
- `phone_number`: The destination phone number to delete.
"""
function delete_smssandbox_phone_number(
PhoneNumber; aws_config::AbstractAWSConfig=global_aws_config()
)
return sns(
"DeleteSMSSandboxPhoneNumber",
Dict{String,Any}("PhoneNumber" => PhoneNumber);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_smssandbox_phone_number(
PhoneNumber,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sns(
"DeleteSMSSandboxPhoneNumber",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PhoneNumber" => PhoneNumber), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_topic(topic_arn)
delete_topic(topic_arn, params::Dict{String,<:Any})
Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages
previously sent to the topic from being delivered to subscribers. This action is
idempotent, so deleting a topic that does not exist does not result in an error.
# Arguments
- `topic_arn`: The ARN of the topic you want to delete.
"""
function delete_topic(TopicArn; aws_config::AbstractAWSConfig=global_aws_config())
return sns(
"DeleteTopic",
Dict{String,Any}("TopicArn" => TopicArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_topic(
TopicArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sns(
"DeleteTopic",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TopicArn" => TopicArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_data_protection_policy(resource_arn)
get_data_protection_policy(resource_arn, params::Dict{String,<:Any})
Retrieves the specified inline DataProtectionPolicy document that is stored in the
specified Amazon SNS topic.
# Arguments
- `resource_arn`: The ARN of the topic whose DataProtectionPolicy you want to get. For more
information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General
Reference.
"""
function get_data_protection_policy(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sns(
"GetDataProtectionPolicy",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_data_protection_policy(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sns(
"GetDataProtectionPolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_endpoint_attributes(endpoint_arn)
get_endpoint_attributes(endpoint_arn, params::Dict{String,<:Any})
Retrieves the endpoint attributes for a device on one of the supported push notification
services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see Using
Amazon SNS Mobile Push Notifications.
# Arguments
- `endpoint_arn`: EndpointArn for GetEndpointAttributes input.
"""
function get_endpoint_attributes(
EndpointArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sns(
"GetEndpointAttributes",
Dict{String,Any}("EndpointArn" => EndpointArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_endpoint_attributes(
EndpointArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sns(
"GetEndpointAttributes",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EndpointArn" => EndpointArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_platform_application_attributes(platform_application_arn)
get_platform_application_attributes(platform_application_arn, params::Dict{String,<:Any})
Retrieves the attributes of the platform application object for the supported push
notification services, such as APNS and GCM (Firebase Cloud Messaging). For more
information, see Using Amazon SNS Mobile Push Notifications.
# Arguments
- `platform_application_arn`: PlatformApplicationArn for
GetPlatformApplicationAttributesInput.
"""
function get_platform_application_attributes(
PlatformApplicationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sns(
"GetPlatformApplicationAttributes",
Dict{String,Any}("PlatformApplicationArn" => PlatformApplicationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_platform_application_attributes(
PlatformApplicationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sns(
"GetPlatformApplicationAttributes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("PlatformApplicationArn" => PlatformApplicationArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_smsattributes()
get_smsattributes(params::Dict{String,<:Any})
Returns the settings for sending SMS messages from your Amazon Web Services account. These
settings are set with the SetSMSAttributes action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"attributes"`: A list of the individual attribute names, such as MonthlySpendLimit, for
which you want values. For all attribute names, see SetSMSAttributes. If you don't use this
parameter, Amazon SNS returns all SMS attributes.
"""
function get_smsattributes(; aws_config::AbstractAWSConfig=global_aws_config())
return sns("GetSMSAttributes"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_smsattributes(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sns(
"GetSMSAttributes", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_smssandbox_account_status()
get_smssandbox_account_status(params::Dict{String,<:Any})
Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target
Amazon Web Services Region. When you start using Amazon SNS to send SMS messages, your
Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe
environment for you to try Amazon SNS features without risking your reputation as an SMS
sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of
the features of Amazon SNS. However, you can send SMS messages only to verified destination
phone numbers. For more information, including how to move out of the sandbox to send
messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
"""
function get_smssandbox_account_status(; aws_config::AbstractAWSConfig=global_aws_config())
return sns(
"GetSMSSandboxAccountStatus"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_smssandbox_account_status(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sns(
"GetSMSSandboxAccountStatus",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_subscription_attributes(subscription_arn)
get_subscription_attributes(subscription_arn, params::Dict{String,<:Any})
Returns all of the properties of a subscription.
# Arguments
- `subscription_arn`: The ARN of the subscription whose properties you want to get.
"""
function get_subscription_attributes(
SubscriptionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sns(
"GetSubscriptionAttributes",
Dict{String,Any}("SubscriptionArn" => SubscriptionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_subscription_attributes(
SubscriptionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sns(
"GetSubscriptionAttributes",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("SubscriptionArn" => SubscriptionArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_topic_attributes(topic_arn)
get_topic_attributes(topic_arn, params::Dict{String,<:Any})
Returns all of the properties of a topic. Topic properties returned might differ based on
the authorization of the user.
# Arguments
- `topic_arn`: The ARN of the topic whose properties you want to get.
"""
function get_topic_attributes(TopicArn; aws_config::AbstractAWSConfig=global_aws_config())
return sns(
"GetTopicAttributes",
Dict{String,Any}("TopicArn" => TopicArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_topic_attributes(
TopicArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sns(
"GetTopicAttributes",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TopicArn" => TopicArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_endpoints_by_platform_application(platform_application_arn)
list_endpoints_by_platform_application(platform_application_arn, params::Dict{String,<:Any})
Lists the endpoints and endpoint attributes for devices in a supported push notification
service, such as GCM (Firebase Cloud Messaging) and APNS. The results for
ListEndpointsByPlatformApplication are paginated and return a limited list of endpoints, up
to 100. If additional records are available after the first page results, then a NextToken
string will be returned. To receive the next page, you call
ListEndpointsByPlatformApplication again using the NextToken string received from the
previous call. When there are no more records to return, NextToken will be null. For more
information, see Using Amazon SNS Mobile Push Notifications. This action is throttled at
30 transactions per second (TPS).
# Arguments
- `platform_application_arn`: PlatformApplicationArn for
ListEndpointsByPlatformApplicationInput action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: NextToken string is used when calling ListEndpointsByPlatformApplication
action to retrieve additional records that are available after the first page results.
"""
function list_endpoints_by_platform_application(
PlatformApplicationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sns(
"ListEndpointsByPlatformApplication",
Dict{String,Any}("PlatformApplicationArn" => PlatformApplicationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_endpoints_by_platform_application(
PlatformApplicationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sns(
"ListEndpointsByPlatformApplication",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("PlatformApplicationArn" => PlatformApplicationArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_origination_numbers()
list_origination_numbers(params::Dict{String,<:Any})
Lists the calling Amazon Web Services account's dedicated origination numbers and their
metadata. For more information about origination numbers, see Origination numbers in the
Amazon SNS Developer Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of origination numbers to return.
- `"NextToken"`: Token that the previous ListOriginationNumbers request returns.
"""
function list_origination_numbers(; aws_config::AbstractAWSConfig=global_aws_config())
return sns(
"ListOriginationNumbers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_origination_numbers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sns(
"ListOriginationNumbers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_phone_numbers_opted_out()
list_phone_numbers_opted_out(params::Dict{String,<:Any})
Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to
them. The results for ListPhoneNumbersOptedOut are paginated, and each page returns up to
100 phone numbers. If additional phone numbers are available after the first page of
results, then a NextToken string will be returned. To receive the next page, you call
ListPhoneNumbersOptedOut again using the NextToken string received from the previous call.
When there are no more records to return, NextToken will be null.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: A NextToken string is used when you call the ListPhoneNumbersOptedOut
action to retrieve additional records that are available after the first page of results.
"""
function list_phone_numbers_opted_out(; aws_config::AbstractAWSConfig=global_aws_config())
return sns(
"ListPhoneNumbersOptedOut"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_phone_numbers_opted_out(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sns(
"ListPhoneNumbersOptedOut",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_platform_applications()
list_platform_applications(params::Dict{String,<:Any})
Lists the platform application objects for the supported push notification services, such
as APNS and GCM (Firebase Cloud Messaging). The results for ListPlatformApplications are
paginated and return a limited list of applications, up to 100. If additional records are
available after the first page results, then a NextToken string will be returned. To
receive the next page, you call ListPlatformApplications using the NextToken string
received from the previous call. When there are no more records to return, NextToken will
be null. For more information, see Using Amazon SNS Mobile Push Notifications. This action
is throttled at 15 transactions per second (TPS).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: NextToken string is used when calling ListPlatformApplications action to
retrieve additional records that are available after the first page results.
"""
function list_platform_applications(; aws_config::AbstractAWSConfig=global_aws_config())
return sns(
"ListPlatformApplications"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_platform_applications(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sns(
"ListPlatformApplications",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_smssandbox_phone_numbers()
list_smssandbox_phone_numbers(params::Dict{String,<:Any})
Lists the calling Amazon Web Services account's current verified and pending destination
phone numbers in the SMS sandbox. When you start using Amazon SNS to send SMS messages,
your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe
environment for you to try Amazon SNS features without risking your reputation as an SMS
sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of
the features of Amazon SNS. However, you can send SMS messages only to verified destination
phone numbers. For more information, including how to move out of the sandbox to send
messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of phone numbers to return.
- `"NextToken"`: Token that the previous ListSMSSandboxPhoneNumbersInput request returns.
"""
function list_smssandbox_phone_numbers(; aws_config::AbstractAWSConfig=global_aws_config())
return sns(
"ListSMSSandboxPhoneNumbers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_smssandbox_phone_numbers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sns(
"ListSMSSandboxPhoneNumbers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_subscriptions()
list_subscriptions(params::Dict{String,<:Any})
Returns a list of the requester's subscriptions. Each call returns a limited list of
subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned.
Use the NextToken parameter in a new ListSubscriptions call to get further results. This
action is throttled at 30 transactions per second (TPS).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: Token returned by the previous ListSubscriptions request.
"""
function list_subscriptions(; aws_config::AbstractAWSConfig=global_aws_config())
return sns("ListSubscriptions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_subscriptions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sns(
"ListSubscriptions", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_subscriptions_by_topic(topic_arn)
list_subscriptions_by_topic(topic_arn, params::Dict{String,<:Any})
Returns a list of the subscriptions to a specific topic. Each call returns a limited list
of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned.
Use the NextToken parameter in a new ListSubscriptionsByTopic call to get further results.
This action is throttled at 30 transactions per second (TPS).
# Arguments
- `topic_arn`: The ARN of the topic for which you wish to find subscriptions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: Token returned by the previous ListSubscriptionsByTopic request.
"""
function list_subscriptions_by_topic(
TopicArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sns(
"ListSubscriptionsByTopic",
Dict{String,Any}("TopicArn" => TopicArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_subscriptions_by_topic(
TopicArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sns(
"ListSubscriptionsByTopic",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TopicArn" => TopicArn), 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 added to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags
in the Amazon Simple Notification Service Developer Guide.
# Arguments
- `resource_arn`: The ARN of the topic for which to list tags.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sns(
"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 sns(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_topics()
list_topics(params::Dict{String,<:Any})
Returns a list of the requester's topics. Each call returns a limited list of topics, up to
100. If there are more topics, a NextToken is also returned. Use the NextToken parameter in
a new ListTopics call to get further results. This action is throttled at 30 transactions
per second (TPS).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: Token returned by the previous ListTopics request.
"""
function list_topics(; aws_config::AbstractAWSConfig=global_aws_config())
return sns("ListTopics"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_topics(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sns("ListTopics", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
"""
opt_in_phone_number(phone_number)
opt_in_phone_number(phone_number, params::Dict{String,<:Any})
Use this request to opt in a phone number that is opted out, which enables you to resume
sending SMS messages to the number. You can opt in a phone number only once every 30 days.
# Arguments
- `phone_number`: The phone number to opt in. Use E.164 format.
"""
function opt_in_phone_number(phoneNumber; aws_config::AbstractAWSConfig=global_aws_config())
return sns(
"OptInPhoneNumber",
Dict{String,Any}("phoneNumber" => phoneNumber);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function opt_in_phone_number(
phoneNumber,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sns(
"OptInPhoneNumber",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("phoneNumber" => phoneNumber), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
publish(message)
publish(message, params::Dict{String,<:Any})
Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone
number, or a message to a mobile platform endpoint (when you specify the TargetArn). If you
send a message to a topic, Amazon SNS delivers the message to each endpoint that is
subscribed to the topic. The format of the message depends on the notification protocol for
each subscribed endpoint. When a messageId is returned, the message is saved and Amazon SNS
immediately delivers it to subscribers. To use the Publish action for publishing a message
to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify
the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call
with the CreatePlatformEndpoint action. For more information about formatting messages,
see Send Custom Platform-Specific Payloads in Messages to Mobile Devices. You can publish
messages only to topics and endpoints in the same Amazon Web Services Region.
# Arguments
- `message`: The message you want to send. If you are publishing to a topic and you want to
send the same message to all transport protocols, include the text of the message as a
String value. If you want to send different messages for each transport protocol, set the
value of the MessageStructure parameter to json and use a JSON object for the Message
parameter. Constraints: With the exception of SMS, messages must be UTF-8 encoded
strings and at most 256 KB in size (262,144 bytes, not 262,144 characters). For SMS, each
message can contain up to 140 characters. This character limit depends on the encoding
schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters,
or 70 UCS-2 characters. If you publish a message that exceeds this size limit, Amazon SNS
sends the message as multiple messages, each fitting within the size limit. Messages aren't
truncated mid-word but are cut off at whole-word boundaries. The total size limit for a
single SMS Publish action is 1,600 characters. JSON-specific constraints: Keys in the
JSON object that correspond to supported transport protocols must have simple JSON string
values. The values will be parsed (unescaped) before they are used in outgoing messages.
Outbound notifications are JSON encoded (meaning that the characters will be reescaped for
sending). Values have a minimum length of 0 (the empty string, \"\", is allowed).
Values have a maximum length bounded by the overall message size (so, including multiple
protocols may limit message sizes). Non-string values will cause the key to be ignored.
Keys that do not correspond to supported transport protocols are ignored. Duplicate keys
are not allowed. Failure to parse or validate any key or value in the message will cause
the Publish call to return an error (no partial delivery).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MessageAttributes"`: Message attributes for Publish action.
- `"MessageDeduplicationId"`: This parameter applies only to FIFO (first-in-first-out)
topics. The MessageDeduplicationId can contain up to 128 alphanumeric characters (a-z, A-Z,
0-9) and punctuation (!\"#%&'()*+,-./:;<=>?@[]^_`{|}~). Every message must have a
unique MessageDeduplicationId, which is a token used for deduplication of sent messages. If
a message with a particular MessageDeduplicationId is sent successfully, any message sent
with the same MessageDeduplicationId during the 5-minute deduplication interval is treated
as a duplicate. If the topic has ContentBasedDeduplication set, the system generates a
MessageDeduplicationId based on the contents of the message. Your MessageDeduplicationId
overrides the generated one.
- `"MessageGroupId"`: This parameter applies only to FIFO (first-in-first-out) topics. The
MessageGroupId can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and
punctuation (!\"#%&'()*+,-./:;<=>?@[]^_`{|}~). The MessageGroupId is a tag that
specifies that a message belongs to a specific message group. Messages that belong to the
same message group are processed in a FIFO manner (however, messages in different message
groups might be processed out of order). Every message must include a MessageGroupId.
- `"MessageStructure"`: Set MessageStructure to json if you want to send a different
message for each protocol. For example, using one publish action, you can send a short
message to your SMS subscribers and a longer message to your email subscribers. If you set
MessageStructure to json, the value of the Message parameter must: be a syntactically
valid JSON object; and contain at least a top-level JSON key of \"default\" with a value
that is a string. You can define other top-level keys that define the message you want to
send to a specific transport protocol (e.g., \"http\"). Valid value: json
- `"PhoneNumber"`: The phone number to which you want to deliver an SMS message. Use E.164
format. If you don't specify a value for the PhoneNumber parameter, you must specify a
value for the TargetArn or TopicArn parameters.
- `"Subject"`: Optional parameter to be used as the \"Subject\" line when the message is
delivered to email endpoints. This field will also be included, if present, in the standard
JSON messages delivered to other endpoints. Constraints: Subjects must be UTF-8 text with
no line breaks or control characters, and less than 100 characters long.
- `"TargetArn"`: If you don't specify a value for the TargetArn parameter, you must specify
a value for the PhoneNumber or TopicArn parameters.
- `"TopicArn"`: The topic you want to publish to. If you don't specify a value for the
TopicArn parameter, you must specify a value for the PhoneNumber or TargetArn parameters.
"""
function publish(Message; aws_config::AbstractAWSConfig=global_aws_config())
return sns(
"Publish",
Dict{String,Any}("Message" => Message);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function publish(
Message, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sns(
"Publish",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Message" => Message), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
publish_batch(publish_batch_request_entries, topic_arn)
publish_batch(publish_batch_request_entries, topic_arn, params::Dict{String,<:Any})
Publishes up to ten messages to the specified topic. This is a batch version of Publish.
For FIFO topics, multiple messages within a single batch are published in the order they
are sent, and messages are deduplicated within the batch and across batches for 5 minutes.
The result of publishing each message 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. The
maximum allowed individual message size and the maximum total payload size (the sum of the
individual lengths of all of the batched messages) are both 256 KB (262,144 bytes). Some
actions take lists of parameters. These lists are specified using the param.n notation.
Values of n are integers starting from 1. For example, a parameter list with two elements
looks like this: &AttributeName.1=first &AttributeName.2=second If you send a
batch message to a topic, Amazon SNS publishes the batch message to each endpoint that is
subscribed to the topic. The format of the batch message depends on the notification
protocol for each subscribed endpoint. When a messageId is returned, the batch message is
saved and Amazon SNS immediately delivers the message to subscribers.
# Arguments
- `publish_batch_request_entries`: A list of PublishBatch request entries to be sent to the
SNS topic.
- `topic_arn`: The Amazon resource name (ARN) of the topic you want to batch publish to.
"""
function publish_batch(
PublishBatchRequestEntries, TopicArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sns(
"PublishBatch",
Dict{String,Any}(
"PublishBatchRequestEntries" => PublishBatchRequestEntries,
"TopicArn" => TopicArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function publish_batch(
PublishBatchRequestEntries,
TopicArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sns(
"PublishBatch",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PublishBatchRequestEntries" => PublishBatchRequestEntries,
"TopicArn" => TopicArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_data_protection_policy(data_protection_policy, resource_arn)
put_data_protection_policy(data_protection_policy, resource_arn, params::Dict{String,<:Any})
Adds or updates an inline policy document that is stored in the specified Amazon SNS topic.
# Arguments
- `data_protection_policy`: The JSON serialization of the topic's DataProtectionPolicy. The
DataProtectionPolicy must be in JSON string format. Length Constraints: Maximum length of
30,720.
- `resource_arn`: The ARN of the topic whose DataProtectionPolicy you want to add or
update. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web
Services General Reference.
"""
function put_data_protection_policy(
DataProtectionPolicy, ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sns(
"PutDataProtectionPolicy",
Dict{String,Any}(
"DataProtectionPolicy" => DataProtectionPolicy, "ResourceArn" => ResourceArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_data_protection_policy(
DataProtectionPolicy,
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sns(
"PutDataProtectionPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DataProtectionPolicy" => DataProtectionPolicy,
"ResourceArn" => ResourceArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_permission(label, topic_arn)
remove_permission(label, topic_arn, params::Dict{String,<:Any})
Removes a statement from a topic's access control policy. To remove the ability to change
topic permissions, you must deny permissions to the AddPermission, RemovePermission, and
SetTopicAttributes actions in your IAM policy.
# Arguments
- `label`: The unique label of the statement you want to remove.
- `topic_arn`: The ARN of the topic whose access control policy you wish to modify.
"""
function remove_permission(
Label, TopicArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sns(
"RemovePermission",
Dict{String,Any}("Label" => Label, "TopicArn" => TopicArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_permission(
Label,
TopicArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sns(
"RemovePermission",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Label" => Label, "TopicArn" => TopicArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_endpoint_attributes(attributes, endpoint_arn)
set_endpoint_attributes(attributes, endpoint_arn, params::Dict{String,<:Any})
Sets the attributes for an endpoint for a device on one of the supported push notification
services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see Using
Amazon SNS Mobile Push Notifications.
# Arguments
- `attributes`: A map of the endpoint attributes. Attributes in this map include the
following: CustomUserData – arbitrary user data to associate with the endpoint. Amazon
SNS does not use this data. The data must be in UTF-8 format and less than 2KB. Enabled
– flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false
when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can
set it back to true, typically after updating Token. Token – device token, also
referred to as a registration id, for an app and mobile device. This is returned from the
notification service when an app and mobile device are registered with the notification
service.
- `endpoint_arn`: EndpointArn used for SetEndpointAttributes action.
"""
function set_endpoint_attributes(
Attributes, EndpointArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sns(
"SetEndpointAttributes",
Dict{String,Any}("Attributes" => Attributes, "EndpointArn" => EndpointArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_endpoint_attributes(
Attributes,
EndpointArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sns(
"SetEndpointAttributes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Attributes" => Attributes, "EndpointArn" => EndpointArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_platform_application_attributes(attributes, platform_application_arn)
set_platform_application_attributes(attributes, platform_application_arn, params::Dict{String,<:Any})
Sets the attributes of the platform application object for the supported push notification
services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using
Amazon SNS Mobile Push Notifications. For information on configuring attributes for message
delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status.
# Arguments
- `attributes`: A map of the platform application attributes. Attributes in this map
include the following: PlatformCredential – The credential received from the
notification service. For ADM, PlatformCredentialis client secret. For Apple Services
using certificate credentials, PlatformCredential is private key. For Apple Services
using token credentials, PlatformCredential is signing key. For GCM (Firebase Cloud
Messaging) using key credentials, there is no PlatformPrincipal. The PlatformCredential is
API key. For GCM (Firebase Cloud Messaging) using token credentials, there is no
PlatformPrincipal. The PlatformCredential is a JSON formatted private key file. When using
the Amazon Web Services CLI, the file must be in string format and special characters must
be ignored. To format the file correctly, Amazon SNS recommends using the following
command: SERVICE_JSON=`jq @json <<< cat service.json`. PlatformPrincipal
– The principal received from the notification service. For ADM, PlatformPrincipalis
client id. For Apple Services using certificate credentials, PlatformPrincipal is SSL
certificate. For Apple Services using token credentials, PlatformPrincipal is signing key
ID. For GCM (Firebase Cloud Messaging), there is no PlatformPrincipal.
EventEndpointCreated – Topic ARN to which EndpointCreated event notifications are sent.
EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications are sent.
EventEndpointUpdated – Topic ARN to which EndpointUpdate event notifications are sent.
EventDeliveryFailure – Topic ARN to which DeliveryFailure event notifications are sent
upon Direct Publish delivery failure (permanent) to one of the application's endpoints.
SuccessFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use
CloudWatch Logs on your behalf. FailureFeedbackRoleArn – IAM role ARN used to give
Amazon SNS write access to use CloudWatch Logs on your behalf. SuccessFeedbackSampleRate
– Sample rate percentage (0-100) of successfully delivered messages. The following
attributes only apply to APNs token-based authentication: ApplePlatformTeamID – The
identifier that's assigned to your Apple developer account team. ApplePlatformBundleID
– The bundle identifier that's assigned to your iOS app.
- `platform_application_arn`: PlatformApplicationArn for SetPlatformApplicationAttributes
action.
"""
function set_platform_application_attributes(
Attributes, PlatformApplicationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sns(
"SetPlatformApplicationAttributes",
Dict{String,Any}(
"Attributes" => Attributes, "PlatformApplicationArn" => PlatformApplicationArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_platform_application_attributes(
Attributes,
PlatformApplicationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sns(
"SetPlatformApplicationAttributes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Attributes" => Attributes,
"PlatformApplicationArn" => PlatformApplicationArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_smsattributes(attributes)
set_smsattributes(attributes, params::Dict{String,<:Any})
Use this request to set the default settings for sending SMS messages and receiving daily
SMS usage reports. You can override some of these settings for a single message when you
use the Publish action with the MessageAttributes.entry.N parameter. For more information,
see Publishing to a mobile phone in the Amazon SNS Developer Guide. To use this operation,
you must grant the Amazon SNS service principal (sns.amazonaws.com) permission to perform
the s3:ListBucket action.
# Arguments
- `attributes`: The default settings for sending SMS messages from your Amazon Web Services
account. You can set values for the following attribute names: MonthlySpendLimit – The
maximum amount in USD that you are willing to spend each month to send SMS messages. When
Amazon SNS determines that sending an SMS message would incur a cost that exceeds this
limit, it stops sending SMS messages within minutes. Amazon SNS stops sending SMS messages
within minutes of the limit being crossed. During that interval, if you continue to send
SMS messages, you will incur costs that exceed your limit. By default, the spend limit is
set to the maximum allowed by Amazon SNS. If you want to raise the limit, submit an SNS
Limit Increase case. For New limit value, enter your desired monthly spend limit. In the
Use Case Description field, explain that you are requesting an SMS monthly spend limit
increase. DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to
write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send,
Amazon SNS writes a log that includes the message price, the success or failure status, the
reason for failure (if the message failed), the message dwell time, and other information.
DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which
Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100.
For example, to write logs only for failed deliveries, set this value to 0. To write logs
for 10% of your successful deliveries, set it to 10. DefaultSenderID – A string, such as
your business brand, that is displayed as the sender on the receiving device. Support for
sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it
must contain at least one letter. DefaultSMSType – The type of SMS message that you will
send by default. You can assign the following values: Promotional – (Default)
Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery
to incur the lowest cost. Transactional – Critical messages that support customer
transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS
optimizes the message delivery to achieve the highest reliability. UsageReportS3Bucket
– The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS.
Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report
includes the following information for each SMS message that was successfully delivered by
your Amazon Web Services account: Time that the message was published (in UTC) Message
ID Destination phone number Message type Delivery status Message price (in USD)
Part number (a message is split into multiple parts if it is too long for a single message)
Total number of parts To receive the report, the bucket must have a policy that allows
the Amazon SNS service principal to perform the s3:PutObject and s3:GetBucketLocation
actions. For an example bucket policy and usage report, see Monitoring SMS Activity in the
Amazon SNS Developer Guide.
"""
function set_smsattributes(attributes; aws_config::AbstractAWSConfig=global_aws_config())
return sns(
"SetSMSAttributes",
Dict{String,Any}("attributes" => attributes);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_smsattributes(
attributes,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sns(
"SetSMSAttributes",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("attributes" => attributes), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_subscription_attributes(attribute_name, subscription_arn)
set_subscription_attributes(attribute_name, subscription_arn, params::Dict{String,<:Any})
Allows a subscription owner to set an attribute of the subscription to a new value.
# Arguments
- `attribute_name`: A map of attributes with their corresponding values. The following
lists the names, descriptions, and values of the special request parameters that this
action uses: DeliveryPolicy – The policy that defines how Amazon SNS retries failed
deliveries to HTTP/S endpoints. FilterPolicy – The simple JSON object that lets your
subscriber receive only a subset of messages, rather than receiving every message published
to the topic. FilterPolicyScope – This attribute lets you choose the filtering scope
by using one of the following string value types: MessageAttributes (default) – The
filter is applied on the message attributes. MessageBody – The filter is applied on
the message body. RawMessageDelivery – When set to true, enables raw message
delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to
process JSON formatting, which is otherwise created for Amazon SNS metadata.
RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS
dead-letter queue. Messages that can't be delivered due to client errors (for example, when
the subscribed endpoint is unreachable) or server errors (for example, when the service
that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue
for further analysis or reprocessing. The following attribute applies only to Amazon Data
Firehose delivery stream subscriptions: SubscriptionRoleArn – The ARN of the IAM role
that has the following: Permission to write to the Firehose delivery stream Amazon SNS
listed as a trusted entity Specifying a valid ARN for this attribute is required for
Firehose delivery stream subscriptions. For more information, see Fanout to Firehose
delivery streams in the Amazon SNS Developer Guide.
- `subscription_arn`: The ARN of the subscription to modify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AttributeValue"`: The new value for the attribute in JSON format.
"""
function set_subscription_attributes(
AttributeName, SubscriptionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sns(
"SetSubscriptionAttributes",
Dict{String,Any}(
"AttributeName" => AttributeName, "SubscriptionArn" => SubscriptionArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_subscription_attributes(
AttributeName,
SubscriptionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sns(
"SetSubscriptionAttributes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AttributeName" => AttributeName, "SubscriptionArn" => SubscriptionArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_topic_attributes(attribute_name, topic_arn)
set_topic_attributes(attribute_name, topic_arn, params::Dict{String,<:Any})
Allows a topic owner to set an attribute of the topic to a new value. To remove the
ability to change topic permissions, you must deny permissions to the AddPermission,
RemovePermission, and SetTopicAttributes actions in your IAM policy.
# Arguments
- `attribute_name`: A map of attributes with their corresponding values. The following
lists the names, descriptions, and values of the special request parameters that the
SetTopicAttributes action uses: ApplicationSuccessFeedbackRoleArn – Indicates failed
message delivery status for an Amazon SNS topic that is subscribed to a platform
application endpoint. DeliveryPolicy – The policy that defines how Amazon SNS retries
failed deliveries to HTTP/S endpoints. DisplayName – The display name to use for a
topic with SMS subscriptions. Policy – The policy that defines who can access your
topic. By default, only the topic owner can publish or subscribe to the topic.
TracingConfig – Tracing mode of an Amazon SNS topic. By default TracingConfig is set to
PassThrough, and the topic passes through the tracing header it receives from an Amazon SNS
publisher to its subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data
to topic owner account if the sampled flag in the tracing header is true. This is only
supported on standard topics. HTTP HTTPSuccessFeedbackRoleArn – Indicates successful
message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.
HTTPSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for
an Amazon SNS topic that is subscribed to an HTTP endpoint. HTTPFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic that is subscribed to
an HTTP endpoint. Amazon Kinesis Data Firehose FirehoseSuccessFeedbackRoleArn –
Indicates successful message delivery status for an Amazon SNS topic that is subscribed to
an Amazon Kinesis Data Firehose endpoint. FirehoseSuccessFeedbackSampleRate –
Indicates percentage of successful messages to sample for an Amazon SNS topic that is
subscribed to an Amazon Kinesis Data Firehose endpoint. FirehoseFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic that is subscribed to
an Amazon Kinesis Data Firehose endpoint. Lambda LambdaSuccessFeedbackRoleArn –
Indicates successful message delivery status for an Amazon SNS topic that is subscribed to
an Lambda endpoint. LambdaSuccessFeedbackSampleRate – Indicates percentage of
successful messages to sample for an Amazon SNS topic that is subscribed to an Lambda
endpoint. LambdaFailureFeedbackRoleArn – Indicates failed message delivery status for
an Amazon SNS topic that is subscribed to an Lambda endpoint. Platform application
endpoint ApplicationSuccessFeedbackRoleArn – Indicates successful message delivery
status for an Amazon SNS topic that is subscribed to an Amazon Web Services application
endpoint. ApplicationSuccessFeedbackSampleRate – Indicates percentage of successful
messages to sample for an Amazon SNS topic that is subscribed to an Amazon Web Services
application endpoint. ApplicationFailureFeedbackRoleArn – Indicates failed message
delivery status for an Amazon SNS topic that is subscribed to an Amazon Web Services
application endpoint. In addition to being able to configure topic attributes for
message delivery status of notification messages sent to Amazon SNS application endpoints,
you can also configure application attributes for the delivery status of push notification
messages sent to push notification services. For example, For more information, see Using
Amazon SNS Application Attributes for Message Delivery Status. Amazon SQS
SQSSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon
SNS topic that is subscribed to an Amazon SQS endpoint. SQSSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an Amazon SNS topic that is
subscribed to an Amazon SQS endpoint. SQSFailureFeedbackRoleArn – Indicates failed
message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS
endpoint. The <ENDPOINT>SuccessFeedbackRoleArn and
<ENDPOINT>FailureFeedbackRoleArn attributes are used to give Amazon SNS write access
to use CloudWatch Logs on your behalf. The <ENDPOINT>SuccessFeedbackSampleRate
attribute is for specifying the sample rate percentage (0-100) of successfully delivered
messages. After you configure the <ENDPOINT>FailureFeedbackRoleArn attribute, then
all failed message deliveries generate CloudWatch Logs. The following attribute applies
only to server-side-encryption: KmsMasterKeyId – The ID of an Amazon Web Services
managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see
Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
SignatureVersion – The signature version corresponds to the hashing algorithm used while
creating the signature of the notifications, subscription confirmations, or unsubscribe
confirmation messages sent by Amazon SNS. By default, SignatureVersion is set to 1. The
following attribute applies only to FIFO topics: ContentBasedDeduplication – Enables
content-based deduplication for FIFO topics. By default, ContentBasedDeduplication is set
to false. If you create a FIFO topic and this attribute is false, you must specify a value
for the MessageDeduplicationId parameter for the Publish action. When you set
ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the
MessageDeduplicationId using the body of the message (but not the attributes of the
message). (Optional) To override the generated value, you can specify a value for the
MessageDeduplicationId parameter for the Publish action.
- `topic_arn`: The ARN of the topic to modify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AttributeValue"`: The new value for the attribute.
"""
function set_topic_attributes(
AttributeName, TopicArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sns(
"SetTopicAttributes",
Dict{String,Any}("AttributeName" => AttributeName, "TopicArn" => TopicArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_topic_attributes(
AttributeName,
TopicArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sns(
"SetTopicAttributes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AttributeName" => AttributeName, "TopicArn" => TopicArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
subscribe(protocol, topic_arn)
subscribe(protocol, topic_arn, params::Dict{String,<:Any})
Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or email, or
if the endpoint and the topic are not in the same Amazon Web Services account, the endpoint
owner must run the ConfirmSubscription action to confirm the subscription. You call the
ConfirmSubscription action with the token from the subscription response. Confirmation
tokens are valid for two days. This action is throttled at 100 transactions per second
(TPS).
# Arguments
- `protocol`: The protocol that you want to use. Supported protocols include: http –
delivery of JSON-encoded message via HTTP POST https – delivery of JSON-encoded
message via HTTPS POST email – delivery of message via SMTP email-json – delivery
of JSON-encoded message via SMTP sms – delivery of message via SMS sqs – delivery
of JSON-encoded message to an Amazon SQS queue application – delivery of JSON-encoded
message to an EndpointArn for a mobile app and device lambda – delivery of
JSON-encoded message to an Lambda function firehose – delivery of JSON-encoded message
to an Amazon Kinesis Data Firehose delivery stream.
- `topic_arn`: The ARN of the topic you want to subscribe to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Attributes"`: A map of attributes with their corresponding values. The following lists
the names, descriptions, and values of the special request parameters that the Subscribe
action uses: DeliveryPolicy – The policy that defines how Amazon SNS retries failed
deliveries to HTTP/S endpoints. FilterPolicy – The simple JSON object that lets your
subscriber receive only a subset of messages, rather than receiving every message published
to the topic. FilterPolicyScope – This attribute lets you choose the filtering scope
by using one of the following string value types: MessageAttributes (default) – The
filter is applied on the message attributes. MessageBody – The filter is applied on
the message body. RawMessageDelivery – When set to true, enables raw message
delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to
process JSON formatting, which is otherwise created for Amazon SNS metadata.
RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS
dead-letter queue. Messages that can't be delivered due to client errors (for example, when
the subscribed endpoint is unreachable) or server errors (for example, when the service
that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue
for further analysis or reprocessing. The following attribute applies only to Amazon Data
Firehose delivery stream subscriptions: SubscriptionRoleArn – The ARN of the IAM role
that has the following: Permission to write to the Firehose delivery stream Amazon SNS
listed as a trusted entity Specifying a valid ARN for this attribute is required for
Firehose delivery stream subscriptions. For more information, see Fanout to Firehose
delivery streams in the Amazon SNS Developer Guide. The following attributes apply only
to FIFO topics: ReplayPolicy – Adds or updates an inline policy document for a
subscription to replay messages stored in the specified Amazon SNS topic. ReplayStatus
– Retrieves the status of the subscription message replay, which can be one of the
following: Completed – The replay has successfully redelivered all messages, and is
now delivering newly published messages. If an ending point was specified in the
ReplayPolicy then the subscription will no longer receive newly published messages. In
progress – The replay is currently replaying the selected messages. Failed – The
replay was unable to complete. Pending – The default state while the replay initiates.
- `"Endpoint"`: The endpoint that you want to receive notifications. Endpoints vary by
protocol: For the http protocol, the (public) endpoint is a URL beginning with http://.
For the https protocol, the (public) endpoint is a URL beginning with https://. For the
email protocol, the endpoint is an email address. For the email-json protocol, the
endpoint is an email address. For the sms protocol, the endpoint is a phone number of an
SMS-enabled device. For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue.
For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
For the lambda protocol, the endpoint is the ARN of an Lambda function. For the
firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery
stream.
- `"ReturnSubscriptionArn"`: Sets whether the response from the Subscribe request includes
the subscription ARN, even if the subscription is not yet confirmed. If you set this
parameter to true, the response includes the ARN in all cases, even if the subscription is
not yet confirmed. In addition to the ARN for confirmed subscriptions, the response also
includes the pending subscription ARN value for subscriptions that aren't yet confirmed. A
subscription becomes confirmed when the subscriber calls the ConfirmSubscription action
with a confirmation token. The default value is false.
"""
function subscribe(Protocol, TopicArn; aws_config::AbstractAWSConfig=global_aws_config())
return sns(
"Subscribe",
Dict{String,Any}("Protocol" => Protocol, "TopicArn" => TopicArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function subscribe(
Protocol,
TopicArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sns(
"Subscribe",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Protocol" => Protocol, "TopicArn" => TopicArn),
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 the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the
Amazon SNS Developer Guide. When you use topic tags, keep the following guidelines in mind:
Adding more than 50 tags to a topic isn't recommended. Tags don't have any semantic
meaning. Amazon SNS interprets tags as character strings. Tags are case-sensitive. A
new tag with a key identical to that of an existing tag overwrites the existing tag.
Tagging actions are limited to 10 TPS per Amazon Web Services account, per Amazon Web
Services Region. If your application requires a higher throughput, file a technical support
request.
# Arguments
- `resource_arn`: The ARN of the topic to which to add tags.
- `tags`: The tags to be added to the specified topic. A tag consists of a required key and
an optional value.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return sns(
"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 sns(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
unsubscribe(subscription_arn)
unsubscribe(subscription_arn, params::Dict{String,<:Any})
Deletes a subscription. If the subscription requires authentication for deletion, only the
owner of the subscription or the topic's owner can unsubscribe, and an Amazon Web Services
signature is required. If the Unsubscribe call does not require authentication and the
requester is not the subscription owner, a final cancellation message is delivered to the
endpoint, so that the endpoint owner can easily resubscribe to the topic if the Unsubscribe
request was unintended. Amazon SQS queue subscriptions require authentication for
deletion. Only the owner of the subscription, or the owner of the topic can unsubscribe
using the required Amazon Web Services signature. This action is throttled at 100
transactions per second (TPS).
# Arguments
- `subscription_arn`: The ARN of the subscription to be deleted.
"""
function unsubscribe(SubscriptionArn; aws_config::AbstractAWSConfig=global_aws_config())
return sns(
"Unsubscribe",
Dict{String,Any}("SubscriptionArn" => SubscriptionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function unsubscribe(
SubscriptionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sns(
"Unsubscribe",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("SubscriptionArn" => SubscriptionArn), 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 the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in
the Amazon SNS Developer Guide.
# Arguments
- `resource_arn`: The ARN of the topic from which to remove tags.
- `tag_keys`: The list of tag keys to remove from the specified topic.
"""
function untag_resource(
ResourceArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return sns(
"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 sns(
"UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
verify_smssandbox_phone_number(one_time_password, phone_number)
verify_smssandbox_phone_number(one_time_password, phone_number, params::Dict{String,<:Any})
Verifies a destination phone number with a one-time password (OTP) for the calling Amazon
Web Services account. When you start using Amazon SNS to send SMS messages, your Amazon Web
Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you
to try Amazon SNS features without risking your reputation as an SMS sender. While your
Amazon Web Services account is in the SMS sandbox, you can use all of the features of
Amazon SNS. However, you can send SMS messages only to verified destination phone numbers.
For more information, including how to move out of the sandbox to send messages without
restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
# Arguments
- `one_time_password`: The OTP sent to the destination number from the
CreateSMSSandBoxPhoneNumber call.
- `phone_number`: The destination phone number to verify.
"""
function verify_smssandbox_phone_number(
OneTimePassword, PhoneNumber; aws_config::AbstractAWSConfig=global_aws_config()
)
return sns(
"VerifySMSSandboxPhoneNumber",
Dict{String,Any}(
"OneTimePassword" => OneTimePassword, "PhoneNumber" => PhoneNumber
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function verify_smssandbox_phone_number(
OneTimePassword,
PhoneNumber,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sns(
"VerifySMSSandboxPhoneNumber",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"OneTimePassword" => OneTimePassword, "PhoneNumber" => PhoneNumber
),
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 | 82301 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: sqs
using AWS.Compat
using AWS.UUIDs
"""
add_permission(awsaccount_ids, actions, label, queue_url)
add_permission(awsaccount_ids, actions, label, queue_url, params::Dict{String,<:Any})
Adds a permission to a queue for a specific principal. This allows sharing access to the
queue. When you create a queue, you have full control access rights for the queue. Only
you, the owner of the queue, can grant or deny permissions to the queue. For more
information about these permissions, see Allow Developers to Write Messages to a Shared
Queue in the Amazon SQS Developer Guide. AddPermission generates a policy for you. You
can use SetQueueAttributes to upload your policy. For more information, see Using Custom
Policies with the Amazon SQS Access Policy Language in the Amazon SQS Developer Guide. An
Amazon SQS policy can have a maximum of seven actions per statement. To remove the
ability to change queue permissions, you must deny permission to the AddPermission,
RemovePermission, and SetQueueAttributes actions in your IAM policy. Amazon SQS
AddPermission does not support adding a non-account principal. Cross-account
permissions don't apply to this action. For more information, see Grant cross-account
permissions to a role and a username in the Amazon SQS Developer Guide.
# Arguments
- `awsaccount_ids`: The Amazon Web Services account numbers of the principals who are to
receive permission. For information about locating the Amazon Web Services account
identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer Guide.
- `actions`: The action the client wants to allow for the specified principal. Valid
values: the name of any action or *. For more information about these actions, see Overview
of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the Amazon
SQS Developer Guide. Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for
ActionName.n also grants permissions for the corresponding batch versions of those actions:
SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.
- `label`: The unique identification of the permission you're setting (for example,
AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric
characters, hyphens (-), and underscores (_).
- `queue_url`: The URL of the Amazon SQS queue to which permissions are added. Queue URLs
and names are case-sensitive.
"""
function add_permission(
AWSAccountIds,
Actions,
Label,
QueueUrl;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sqs(
"AddPermission",
Dict{String,Any}(
"AWSAccountIds" => AWSAccountIds,
"Actions" => Actions,
"Label" => Label,
"QueueUrl" => QueueUrl,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_permission(
AWSAccountIds,
Actions,
Label,
QueueUrl,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sqs(
"AddPermission",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AWSAccountIds" => AWSAccountIds,
"Actions" => Actions,
"Label" => Label,
"QueueUrl" => QueueUrl,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_message_move_task(task_handle)
cancel_message_move_task(task_handle, params::Dict{String,<:Any})
Cancels a specified message movement task. A message movement can only be cancelled when
the current status is RUNNING. Cancelling a message movement task does not revert the
messages that have already been moved. It can only stop the messages that have not been
moved yet. This action is currently limited to supporting message redrive from
dead-letter queues (DLQs) only. In this context, the source queue is the dead-letter queue
(DLQ), while the destination queue can be the original source queue (from which the
messages were driven to the dead-letter-queue), or a custom destination queue. Only one
active message movement task is supported per queue at any given time.
# Arguments
- `task_handle`: An identifier associated with a message movement task.
"""
function cancel_message_move_task(
TaskHandle; aws_config::AbstractAWSConfig=global_aws_config()
)
return sqs(
"CancelMessageMoveTask",
Dict{String,Any}("TaskHandle" => TaskHandle);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_message_move_task(
TaskHandle,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sqs(
"CancelMessageMoveTask",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TaskHandle" => TaskHandle), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
change_message_visibility(queue_url, receipt_handle, visibility_timeout)
change_message_visibility(queue_url, receipt_handle, visibility_timeout, params::Dict{String,<:Any})
Changes the visibility timeout of a specified message in a queue to a new value. The
default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The
maximum is 12 hours. For more information, see Visibility Timeout in the Amazon SQS
Developer Guide. For example, if the default timeout for a queue is 60 seconds, 15 seconds
have elapsed since you received the message, and you send a ChangeMessageVisibility call
with VisibilityTimeout set to 10 seconds, the 10 seconds begin to count from the time that
you make the ChangeMessageVisibility call. Thus, any attempt to change the visibility
timeout or to delete that message 10 seconds after you initially change the visibility
timeout (a total of 25 seconds) might result in an error. An Amazon SQS message has three
basic states: Sent to a queue by a producer. Received from the queue by a consumer.
Deleted from the queue. A message is considered to be stored after it is sent to a queue
by a producer, but not yet received from the queue by a consumer (that is, between states 1
and 2). There is no limit to the number of stored messages. A message is considered to be
in flight after it is received from a queue by a consumer, but not yet deleted from the
queue (that is, between states 2 and 3). There is a limit to the number of in flight
messages. Limits that apply to in flight messages are unrelated to the unlimited number of
stored messages. For most standard queues (depending on queue traffic and message backlog),
there can be a maximum of approximately 120,000 in flight messages (received from a queue
by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS
returns the OverLimit error message. To avoid reaching the limit, you should delete
messages from the queue after they're processed. You can also increase the number of queues
you use to process your messages. To request a limit increase, file a support request. For
FIFO queues, there can be a maximum of 20,000 in flight messages (received from a queue by
a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS
returns no error messages. If you attempt to set the VisibilityTimeout to a value greater
than the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically
recalculate and increase the timeout to the maximum remaining time. Unlike with a queue,
when you change the visibility timeout for a specific message the timeout value is applied
immediately but isn't saved in memory for that message. If you don't delete a message after
it is received, the visibility timeout for the message reverts to the original timeout
value (not to the value you set using the ChangeMessageVisibility action) the next time the
message is received.
# Arguments
- `queue_url`: The URL of the Amazon SQS queue whose message's visibility is changed. Queue
URLs and names are case-sensitive.
- `receipt_handle`: The receipt handle associated with the message, whose visibility
timeout is changed. This parameter is returned by the ReceiveMessage action.
- `visibility_timeout`: The new value for the message's visibility timeout (in seconds).
Values range: 0 to 43200. Maximum: 12 hours.
"""
function change_message_visibility(
QueueUrl,
ReceiptHandle,
VisibilityTimeout;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sqs(
"ChangeMessageVisibility",
Dict{String,Any}(
"QueueUrl" => QueueUrl,
"ReceiptHandle" => ReceiptHandle,
"VisibilityTimeout" => VisibilityTimeout,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function change_message_visibility(
QueueUrl,
ReceiptHandle,
VisibilityTimeout,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sqs(
"ChangeMessageVisibility",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"QueueUrl" => QueueUrl,
"ReceiptHandle" => ReceiptHandle,
"VisibilityTimeout" => VisibilityTimeout,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
change_message_visibility_batch(entries, queue_url)
change_message_visibility_batch(entries, queue_url, params::Dict{String,<:Any})
Changes the visibility timeout of multiple messages. This is a batch version of
ChangeMessageVisibility. The result of the action on each message is reported individually
in the response. You can send up to 10 ChangeMessageVisibility requests with each
ChangeMessageVisibilityBatch action. 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.
# Arguments
- `entries`: Lists the receipt handles of the messages for which the visibility timeout
must be changed.
- `queue_url`: The URL of the Amazon SQS queue whose messages' visibility is changed. Queue
URLs and names are case-sensitive.
"""
function change_message_visibility_batch(
Entries, QueueUrl; aws_config::AbstractAWSConfig=global_aws_config()
)
return sqs(
"ChangeMessageVisibilityBatch",
Dict{String,Any}("Entries" => Entries, "QueueUrl" => QueueUrl);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function change_message_visibility_batch(
Entries,
QueueUrl,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sqs(
"ChangeMessageVisibilityBatch",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Entries" => Entries, "QueueUrl" => QueueUrl),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_queue(queue_name)
create_queue(queue_name, params::Dict{String,<:Any})
Creates a new standard or FIFO queue. You can pass one or more attributes in the request.
Keep the following in mind: If you don't specify the FifoQueue attribute, Amazon SQS
creates a standard queue. You can't change the queue type after you create it and you
can't convert an existing standard queue into a FIFO queue. You must either create a new
FIFO queue for your application or delete your existing standard queue and recreate it as a
FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the
Amazon SQS Developer Guide. If you don't provide a value for an attribute, the queue is
created with the default value for the attribute. If you delete a queue, you must wait at
least 60 seconds before creating a queue with the same name. To successfully create a new
queue, you must provide a queue name that adheres to the limits related to queues and is
unique within the scope of your queues. After you create a queue, you must wait at least
one second after the queue is created to be able to use the queue. To get the queue URL,
use the GetQueueUrl action. GetQueueUrl requires only the QueueName parameter. be aware
of existing queue names: If you provide the name of an existing queue along with the
exact names and values of all the queue's attributes, CreateQueue returns the queue URL for
the existing queue. If the queue name, attribute names, or attribute values don't match
an existing queue, CreateQueue returns an error. Cross-account permissions don't apply
to this action. For more information, see Grant cross-account permissions to a role and a
username in the Amazon SQS Developer Guide.
# Arguments
- `queue_name`: The name of the new queue. The following limits apply to this name: A
queue name can have up to 80 characters. Valid values: alphanumeric characters, hyphens
(-), and underscores (_). A FIFO queue name must end with the .fifo suffix. Queue URLs
and names are case-sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Attributes"`: A map of attributes with their corresponding values. The following lists
the names, descriptions, and values of the special request parameters that the CreateQueue
action uses: DelaySeconds – The length of time, in seconds, for which the delivery of
all messages in the queue is delayed. Valid values: An integer from 0 to 900 seconds (15
minutes). Default: 0. MaximumMessageSize – The limit of how many bytes a message can
contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) to
262,144 bytes (256 KiB). Default: 262,144 (256 KiB). MessageRetentionPeriod – The
length of time, in seconds, for which Amazon SQS retains a message. Valid values: An
integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4
days). When you change a queue's attributes, the change can take up to 60 seconds for most
of the attributes to propagate throughout the Amazon SQS system. Changes made to the
MessageRetentionPeriod attribute can take up to 15 minutes and will impact existing
messages in the queue potentially causing them to be expired and deleted if the
MessageRetentionPeriod is reduced below the age of existing messages. Policy – The
queue's policy. A valid Amazon Web Services policy. For more information about policy
structure, see Overview of Amazon Web Services IAM Policies in the IAM User Guide.
ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a
ReceiveMessage action waits for a message to arrive. Valid values: An integer from 0 to 20
(seconds). Default: 0. VisibilityTimeout – The visibility timeout for the queue, in
seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more
information about the visibility timeout, see Visibility Timeout in the Amazon SQS
Developer Guide. The following attributes apply only to dead-letter queues:
RedrivePolicy – The string that includes the parameters for the dead-letter queue
functionality of the source queue as a JSON object. The parameters are as follows:
deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which
Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
maxReceiveCount – The number of times a message is delivered to the source queue before
being moved to the dead-letter queue. Default: 10. When the ReceiveCount for a message
exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the
dead-letter-queue. RedriveAllowPolicy – The string that includes the parameters for
the permissions for the dead-letter queue redrive permission and which source queues can
specify dead-letter queues as a JSON object. The parameters are as follows:
redrivePermission – The permission type that defines which source queues can specify the
current queue as the dead-letter queue. Valid values are: allowAll – (Default) Any
source queues in this Amazon Web Services account in the same Region can specify this queue
as the dead-letter queue. denyAll – No source queues can specify this queue as the
dead-letter queue. byQueue – Only queues specified by the sourceQueueArns parameter
can specify this queue as the dead-letter queue. sourceQueueArns – The Amazon
Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter
queue and redrive messages. You can specify this parameter only when the redrivePermission
parameter is set to byQueue. You can specify up to 10 source queue ARNs. To allow more than
10 source queues to specify dead-letter queues, set the redrivePermission parameter to
allowAll. The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly,
the dead-letter queue of a standard queue must also be a standard queue. The following
attributes apply only to server-side-encryption: KmsMasterKeyId – The ID of an Amazon
Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more
information, see Key Terms. While the alias of the Amazon Web Services managed CMK for
Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be
alias/MyAlias . For more examples, see KeyId in the Key Management Service API Reference.
KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can
reuse a data key to encrypt or decrypt messages before calling KMS again. An integer
representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default:
300 (5 minutes). A shorter time period provides better security but results in more calls
to KMS which might incur charges after Free Tier. For more information, see How Does the
Data Key Reuse Period Work? SqsManagedSseEnabled – Enables server-side queue
encryption using SQS owned encryption keys. Only one server-side encryption option is
supported per queue (for example, SSE-KMS or SSE-SQS). The following attributes apply
only to FIFO (first-in-first-out) queues: FifoQueue – Designates a queue as FIFO.
Valid values are true and false. If you don't specify the FifoQueue attribute, Amazon SQS
creates a standard queue. You can provide this attribute only during queue creation. You
can't change it for an existing queue. When you set this attribute, you must also provide
the MessageGroupId for your messages explicitly. For more information, see FIFO queue logic
in the Amazon SQS Developer Guide. ContentBasedDeduplication – Enables content-based
deduplication. Valid values are true and false. For more information, see Exactly-once
processing in the Amazon SQS Developer Guide. Note the following: Every message must
have a unique MessageDeduplicationId. You may provide a MessageDeduplicationId
explicitly. If you aren't able to provide a MessageDeduplicationId and you enable
ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the
MessageDeduplicationId using the body of the message (but not the attributes of the
message). If you don't provide a MessageDeduplicationId and the queue doesn't have
ContentBasedDeduplication set, the action fails with an error. If the queue has
ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
When ContentBasedDeduplication is in effect, messages with identical content sent within
the deduplication interval are treated as duplicates and only one copy of the message is
delivered. If you send one message with ContentBasedDeduplication enabled and then
another message with a MessageDeduplicationId that is the same as the one generated for the
first MessageDeduplicationId, the two messages are treated as duplicates and only one copy
of the message is delivered. The following attributes apply only to high throughput
for FIFO queues: DeduplicationScope – Specifies whether message deduplication occurs
at the message group or queue level. Valid values are messageGroup and queue.
FifoThroughputLimit – Specifies whether the FIFO queue throughput quota applies to the
entire queue or per message group. Valid values are perQueue and perMessageGroupId. The
perMessageGroupId value is allowed only when the value for DeduplicationScope is
messageGroup. To enable high throughput for FIFO queues, do the following: Set
DeduplicationScope to messageGroup. Set FifoThroughputLimit to perMessageGroupId. If
you set these attributes to anything other than the values shown for enabling high
throughput, normal throughput is in effect and deduplication occurs as specified. For
information on throughput quotas, see Quotas related to messages in the Amazon SQS
Developer Guide.
- `"tags"`: Add cost allocation tags to the specified Amazon SQS queue. For an overview,
see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide. When you use queue
tags, keep the following guidelines in mind: Adding more than 50 tags to a queue isn't
recommended. Tags don't have any semantic meaning. Amazon SQS interprets tags as
character strings. Tags are case-sensitive. A new tag with a key identical to that of
an existing tag overwrites the existing tag. For a full list of tag restrictions, see
Quotas related to queues in the Amazon SQS Developer Guide. To be able to tag a queue on
creation, you must have the sqs:CreateQueue and sqs:TagQueue permissions. Cross-account
permissions don't apply to this action. For more information, see Grant cross-account
permissions to a role and a username in the Amazon SQS Developer Guide.
"""
function create_queue(QueueName; aws_config::AbstractAWSConfig=global_aws_config())
return sqs(
"CreateQueue",
Dict{String,Any}("QueueName" => QueueName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_queue(
QueueName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sqs(
"CreateQueue",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("QueueName" => QueueName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_message(queue_url, receipt_handle)
delete_message(queue_url, receipt_handle, params::Dict{String,<:Any})
Deletes the specified message from the specified queue. To select the message to delete,
use the ReceiptHandle of the message (not the MessageId which you receive when you send the
message). Amazon SQS can delete a message from a queue even if a visibility timeout setting
causes the message to be locked by another consumer. Amazon SQS automatically deletes
messages left in a queue longer than the retention period configured for the queue. The
ReceiptHandle is associated with a specific instance of receiving a message. If you receive
a message more than once, the ReceiptHandle is different each time you receive a message.
When you use the DeleteMessage action, you must provide the most recently received
ReceiptHandle for the message (otherwise, the request succeeds, but the message will not be
deleted). For standard queues, it is possible to receive a message even after you delete
it. This might happen on rare occasions if one of the servers which stores a copy of the
message is unavailable when you send the request to delete the message. The copy remains on
the server and might be returned to you during a subsequent receive request. You should
ensure that your application is idempotent, so that receiving a message more than once does
not cause issues.
# Arguments
- `queue_url`: The URL of the Amazon SQS queue from which messages are deleted. Queue URLs
and names are case-sensitive.
- `receipt_handle`: The receipt handle associated with the message to delete.
"""
function delete_message(
QueueUrl, ReceiptHandle; aws_config::AbstractAWSConfig=global_aws_config()
)
return sqs(
"DeleteMessage",
Dict{String,Any}("QueueUrl" => QueueUrl, "ReceiptHandle" => ReceiptHandle);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_message(
QueueUrl,
ReceiptHandle,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sqs(
"DeleteMessage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("QueueUrl" => QueueUrl, "ReceiptHandle" => ReceiptHandle),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_message_batch(entries, queue_url)
delete_message_batch(entries, queue_url, params::Dict{String,<:Any})
Deletes up to ten messages from the specified queue. This is a batch version of
DeleteMessage. The result of the action on each message 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.
# Arguments
- `entries`: Lists the receipt handles for the messages to be deleted.
- `queue_url`: The URL of the Amazon SQS queue from which messages are deleted. Queue URLs
and names are case-sensitive.
"""
function delete_message_batch(
Entries, QueueUrl; aws_config::AbstractAWSConfig=global_aws_config()
)
return sqs(
"DeleteMessageBatch",
Dict{String,Any}("Entries" => Entries, "QueueUrl" => QueueUrl);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_message_batch(
Entries,
QueueUrl,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sqs(
"DeleteMessageBatch",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Entries" => Entries, "QueueUrl" => QueueUrl),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_queue(queue_url)
delete_queue(queue_url, params::Dict{String,<:Any})
Deletes the queue specified by the QueueUrl, regardless of the queue's contents. Be
careful with the DeleteQueue action: When you delete a queue, any messages in the queue are
no longer available. When you delete a queue, the deletion process takes up to 60
seconds. Requests you send involving that queue during the 60 seconds might succeed. For
example, a SendMessage request might succeed, but after 60 seconds the queue and the
message you sent no longer exist. When you delete a queue, you must wait at least 60
seconds before creating a queue with the same name. Cross-account permissions don't apply
to this action. For more information, see Grant cross-account permissions to a role and a
username in the Amazon SQS Developer Guide. The delete operation uses the HTTP GET verb.
# Arguments
- `queue_url`: The URL of the Amazon SQS queue to delete. Queue URLs and names are
case-sensitive.
"""
function delete_queue(QueueUrl; aws_config::AbstractAWSConfig=global_aws_config())
return sqs(
"DeleteQueue",
Dict{String,Any}("QueueUrl" => QueueUrl);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_queue(
QueueUrl,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sqs(
"DeleteQueue",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("QueueUrl" => QueueUrl), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_queue_attributes(queue_url)
get_queue_attributes(queue_url, params::Dict{String,<:Any})
Gets attributes for the specified queue. To determine whether a queue is FIFO, you can
check whether QueueName ends with the .fifo suffix.
# Arguments
- `queue_url`: The URL of the Amazon SQS queue whose attribute information is retrieved.
Queue URLs and names are case-sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AttributeNames"`: A list of attributes for which to retrieve information. The
AttributeNames parameter is optional, but if you don't specify values for this parameter,
the request returns empty results. In the future, new attributes might be added. If you
write code that calls this action, we recommend that you structure your code so that it can
handle new attributes gracefully. The following attributes are supported: The
ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, and
ApproximateNumberOfMessages metrics may not achieve consistency until at least 1 minute
after the producers stop sending messages. This period is required for the queue metadata
to reach eventual consistency. All – Returns all values.
ApproximateNumberOfMessages – Returns the approximate number of messages available for
retrieval from the queue. ApproximateNumberOfMessagesDelayed – Returns the approximate
number of messages in the queue that are delayed and not available for reading immediately.
This can happen when the queue is configured as a delay queue or when a message has been
sent with a delay parameter. ApproximateNumberOfMessagesNotVisible – Returns the
approximate number of messages that are in flight. Messages are considered to be in flight
if they have been sent to a client but have not yet been deleted or have not yet reached
the end of their visibility window. CreatedTimestamp – Returns the time when the
queue was created in seconds (epoch time). DelaySeconds – Returns the default delay on
the queue in seconds. LastModifiedTimestamp – Returns the time when the queue was last
changed in seconds (epoch time). MaximumMessageSize – Returns the limit of how many
bytes a message can contain before Amazon SQS rejects it. MessageRetentionPeriod –
Returns the length of time, in seconds, for which Amazon SQS retains a message. When you
change a queue's attributes, the change can take up to 60 seconds for most of the
attributes to propagate throughout the Amazon SQS system. Changes made to the
MessageRetentionPeriod attribute can take up to 15 minutes and will impact existing
messages in the queue potentially causing them to be expired and deleted if the
MessageRetentionPeriod is reduced below the age of existing messages. Policy – Returns
the policy of the queue. QueueArn – Returns the Amazon resource name (ARN) of the
queue. ReceiveMessageWaitTimeSeconds – Returns the length of time, in seconds, for
which the ReceiveMessage action waits for a message to arrive. VisibilityTimeout –
Returns the visibility timeout for the queue. For more information about the visibility
timeout, see Visibility Timeout in the Amazon SQS Developer Guide. The following
attributes apply only to dead-letter queues: RedrivePolicy – The string that includes
the parameters for the dead-letter queue functionality of the source queue as a JSON
object. The parameters are as follows: deadLetterTargetArn – The Amazon Resource Name
(ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of
maxReceiveCount is exceeded. maxReceiveCount – The number of times a message is
delivered to the source queue before being moved to the dead-letter queue. Default: 10.
When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS
moves the message to the dead-letter-queue. RedriveAllowPolicy – The string that
includes the parameters for the permissions for the dead-letter queue redrive permission
and which source queues can specify dead-letter queues as a JSON object. The parameters are
as follows: redrivePermission – The permission type that defines which source queues
can specify the current queue as the dead-letter queue. Valid values are: allowAll –
(Default) Any source queues in this Amazon Web Services account in the same Region can
specify this queue as the dead-letter queue. denyAll – No source queues can specify
this queue as the dead-letter queue. byQueue – Only queues specified by the
sourceQueueArns parameter can specify this queue as the dead-letter queue.
sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify
this queue as the dead-letter queue and redrive messages. You can specify this parameter
only when the redrivePermission parameter is set to byQueue. You can specify up to 10
source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set
the redrivePermission parameter to allowAll. The dead-letter queue of a FIFO queue
must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also
be a standard queue. The following attributes apply only to server-side-encryption:
KmsMasterKeyId – Returns the ID of an Amazon Web Services managed customer master key
(CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
KmsDataKeyReusePeriodSeconds – Returns the length of time, in seconds, for which Amazon
SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. For more
information, see How Does the Data Key Reuse Period Work?. SqsManagedSseEnabled –
Returns information about whether the queue is using SSE-SQS encryption using SQS owned
encryption keys. Only one server-side encryption option is supported per queue (for
example, SSE-KMS or SSE-SQS). The following attributes apply only to FIFO
(first-in-first-out) queues: FifoQueue – Returns information about whether the queue
is FIFO. For more information, see FIFO queue logic in the Amazon SQS Developer Guide. To
determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo
suffix. ContentBasedDeduplication – Returns whether content-based deduplication is
enabled for the queue. For more information, see Exactly-once processing in the Amazon SQS
Developer Guide. The following attributes apply only to high throughput for FIFO queues:
DeduplicationScope – Specifies whether message deduplication occurs at the message
group or queue level. Valid values are messageGroup and queue. FifoThroughputLimit –
Specifies whether the FIFO queue throughput quota applies to the entire queue or per
message group. Valid values are perQueue and perMessageGroupId. The perMessageGroupId value
is allowed only when the value for DeduplicationScope is messageGroup. To enable high
throughput for FIFO queues, do the following: Set DeduplicationScope to messageGroup.
Set FifoThroughputLimit to perMessageGroupId. If you set these attributes to anything
other than the values shown for enabling high throughput, normal throughput is in effect
and deduplication occurs as specified. For information on throughput quotas, see Quotas
related to messages in the Amazon SQS Developer Guide.
"""
function get_queue_attributes(QueueUrl; aws_config::AbstractAWSConfig=global_aws_config())
return sqs(
"GetQueueAttributes",
Dict{String,Any}("QueueUrl" => QueueUrl);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_queue_attributes(
QueueUrl,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sqs(
"GetQueueAttributes",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("QueueUrl" => QueueUrl), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_queue_url(queue_name)
get_queue_url(queue_name, params::Dict{String,<:Any})
Returns the URL of an existing Amazon SQS queue. To access a queue that belongs to another
AWS account, use the QueueOwnerAWSAccountId parameter to specify the account ID of the
queue's owner. The queue's owner must grant you permission to access the queue. For more
information about shared queue access, see AddPermission or see Allow Developers to Write
Messages to a Shared Queue in the Amazon SQS Developer Guide.
# Arguments
- `queue_name`: The name of the queue whose URL must be fetched. Maximum 80 characters.
Valid values: alphanumeric characters, hyphens (-), and underscores (_). Queue URLs and
names are case-sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"QueueOwnerAWSAccountId"`: The Amazon Web Services account ID of the account that
created the queue.
"""
function get_queue_url(QueueName; aws_config::AbstractAWSConfig=global_aws_config())
return sqs(
"GetQueueUrl",
Dict{String,Any}("QueueName" => QueueName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_queue_url(
QueueName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sqs(
"GetQueueUrl",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("QueueName" => QueueName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_dead_letter_source_queues(queue_url)
list_dead_letter_source_queues(queue_url, params::Dict{String,<:Any})
Returns a list of your queues that have the RedrivePolicy queue attribute configured with a
dead-letter queue. The ListDeadLetterSourceQueues methods supports pagination. Set
parameter MaxResults in the request to specify the maximum number of results to be returned
in the response. If you do not set MaxResults, the response includes a maximum of 1,000
results. If you set MaxResults and there are additional results to display, the response
includes a value for NextToken. Use NextToken as a parameter in your next request to
ListDeadLetterSourceQueues to receive the next page of results. For more information about
using dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon SQS
Developer Guide.
# Arguments
- `queue_url`: The URL of a dead-letter queue. Queue URLs and names are case-sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Maximum number of results to include in the response. Value range is 1 to
1000. You must set MaxResults to receive a value for NextToken in the response.
- `"NextToken"`: Pagination token to request the next set of results.
"""
function list_dead_letter_source_queues(
QueueUrl; aws_config::AbstractAWSConfig=global_aws_config()
)
return sqs(
"ListDeadLetterSourceQueues",
Dict{String,Any}("QueueUrl" => QueueUrl);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_dead_letter_source_queues(
QueueUrl,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sqs(
"ListDeadLetterSourceQueues",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("QueueUrl" => QueueUrl), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_message_move_tasks(source_arn)
list_message_move_tasks(source_arn, params::Dict{String,<:Any})
Gets the most recent message movement tasks (up to 10) under a specific source queue.
This action is currently limited to supporting message redrive from dead-letter queues
(DLQs) only. In this context, the source queue is the dead-letter queue (DLQ), while the
destination queue can be the original source queue (from which the messages were driven to
the dead-letter-queue), or a custom destination queue. Only one active message movement
task is supported per queue at any given time.
# Arguments
- `source_arn`: The ARN of the queue whose message movement tasks are 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 include in the response. The default is
1, which provides the most recent message movement task. The upper limit is 10.
"""
function list_message_move_tasks(
SourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sqs(
"ListMessageMoveTasks",
Dict{String,Any}("SourceArn" => SourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_message_move_tasks(
SourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sqs(
"ListMessageMoveTasks",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SourceArn" => SourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_queue_tags(queue_url)
list_queue_tags(queue_url, params::Dict{String,<:Any})
List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see
Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide. Cross-account
permissions don't apply to this action. For more information, see Grant cross-account
permissions to a role and a username in the Amazon SQS Developer Guide.
# Arguments
- `queue_url`: The URL of the queue.
"""
function list_queue_tags(QueueUrl; aws_config::AbstractAWSConfig=global_aws_config())
return sqs(
"ListQueueTags",
Dict{String,Any}("QueueUrl" => QueueUrl);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_queue_tags(
QueueUrl,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sqs(
"ListQueueTags",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("QueueUrl" => QueueUrl), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_queues()
list_queues(params::Dict{String,<:Any})
Returns a list of your queues in the current region. The response includes a maximum of
1,000 results. If you specify a value for the optional QueueNamePrefix parameter, only
queues with a name that begins with the specified value are returned. The listQueues
methods supports pagination. Set parameter MaxResults in the request to specify the maximum
number of results to be returned in the response. If you do not set MaxResults, the
response includes a maximum of 1,000 results. If you set MaxResults and there are
additional results to display, the response includes a value for NextToken. Use NextToken
as a parameter in your next request to listQueues to receive the next page of results.
Cross-account permissions don't apply to this action. For more information, see Grant
cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Maximum number of results to include in the response. Value range is 1 to
1000. You must set MaxResults to receive a value for NextToken in the response.
- `"NextToken"`: Pagination token to request the next set of results.
- `"QueueNamePrefix"`: A string to use for filtering the list results. Only those queues
whose name begins with the specified string are returned. Queue URLs and names are
case-sensitive.
"""
function list_queues(; aws_config::AbstractAWSConfig=global_aws_config())
return sqs("ListQueues"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_queues(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sqs("ListQueues", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
"""
purge_queue(queue_url)
purge_queue(queue_url, params::Dict{String,<:Any})
Deletes available messages in a queue (including in-flight messages) specified by the
QueueURL parameter. When you use the PurgeQueue action, you can't retrieve any messages
deleted from a queue. The message deletion process takes up to 60 seconds. We recommend
waiting for 60 seconds regardless of your queue's size. Messages sent to the queue before
you call PurgeQueue might be received but are deleted within the next minute. Messages sent
to the queue after you call PurgeQueue might be deleted while the queue is being purged.
# Arguments
- `queue_url`: The URL of the queue from which the PurgeQueue action deletes messages.
Queue URLs and names are case-sensitive.
"""
function purge_queue(QueueUrl; aws_config::AbstractAWSConfig=global_aws_config())
return sqs(
"PurgeQueue",
Dict{String,Any}("QueueUrl" => QueueUrl);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function purge_queue(
QueueUrl,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sqs(
"PurgeQueue",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("QueueUrl" => QueueUrl), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
receive_message(queue_url)
receive_message(queue_url, params::Dict{String,<:Any})
Retrieves one or more messages (up to 10), from the specified queue. Using the
WaitTimeSeconds parameter enables long-poll support. For more information, see Amazon SQS
Long Polling in the Amazon SQS Developer Guide. Short poll is the default behavior where a
weighted random set of machines is sampled on a ReceiveMessage call. Thus, only the
messages on the sampled machines are returned. If the number of messages in the queue is
small (fewer than 1,000), you most likely get fewer messages than you requested per
ReceiveMessage call. If the number of messages in the queue is extremely small, you might
not receive any messages in a particular ReceiveMessage response. If this happens, repeat
the request. For each message returned, the response includes the following: The message
body. An MD5 digest of the message body. For information about MD5, see RFC1321. The
MessageId you received when you sent the message to the queue. The receipt handle. The
message attributes. An MD5 digest of the message attributes. The receipt handle is the
identifier you must provide when deleting the message. For more information, see Queue and
Message Identifiers in the Amazon SQS Developer Guide. You can provide the
VisibilityTimeout parameter in your request. The parameter is applied to the messages that
Amazon SQS returns in the response. If you don't include the parameter, the overall
visibility timeout for the queue is used for the returned messages. For more information,
see Visibility Timeout in the Amazon SQS Developer Guide. A message that isn't deleted or a
message whose visibility isn't extended before the visibility timeout expires counts as a
failed receive. Depending on the configuration of the queue, the message might be sent to
the dead-letter queue. In the future, new attributes might be added. If you write code
that calls this action, we recommend that you structure your code so that it can handle new
attributes gracefully.
# Arguments
- `queue_url`: The URL of the Amazon SQS queue from which messages are received. Queue URLs
and names are case-sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AttributeNames"`: This parameter has been deprecated but will be supported for
backward compatibility. To provide attribute names, you are encouraged to use
MessageSystemAttributeNames. A list of attributes that need to be returned along with
each message. These attributes include: All – Returns all values.
ApproximateFirstReceiveTimestamp – Returns the time the message was first received from
the queue (epoch time in milliseconds). ApproximateReceiveCount – Returns the number
of times a message has been received across all queues but not deleted. AWSTraceHeader
– Returns the X-Ray trace header string. SenderId For a user, returns the user ID,
for example ABCDEFGHI1JKLMNOPQ23R. For an IAM role, returns the IAM role ID, for example
ABCDE1F2GH3I4JK5LMNOP:i-a123b456. SentTimestamp – Returns the time the message was
sent to the queue (epoch time in milliseconds). SqsManagedSseEnabled – Enables
server-side queue encryption using SQS owned encryption keys. Only one server-side
encryption option is supported per queue (for example, SSE-KMS or SSE-SQS).
MessageDeduplicationId – Returns the value provided by the producer that calls the
SendMessage action. MessageGroupId – Returns the value provided by the producer that
calls the SendMessage action. Messages with the same MessageGroupId are returned in
sequence. SequenceNumber – Returns the value provided by Amazon SQS.
- `"MaxNumberOfMessages"`: The maximum number of messages to return. Amazon SQS never
returns more messages than this value (however, fewer messages might be returned). Valid
values: 1 to 10. Default: 1.
- `"MessageAttributeNames"`: The name of the message attribute, where N is the index. The
name can contain alphanumeric characters and the underscore (_), hyphen (-), and period
(.). The name is case-sensitive and must be unique among all attribute names for the
message. The name must not start with AWS-reserved prefixes such as AWS. or Amazon. (or
any casing variants). The name must not start or end with a period (.), and it should not
have periods in succession (..). The name can be up to 256 characters long. When using
ReceiveMessage, you can send a list of attribute names to receive, or you can return all of
the attributes by specifying All or .* in your request. You can also use all message
attributes starting with a prefix, for example bar.*.
- `"MessageSystemAttributeNames"`: A list of attributes that need to be returned along with
each message. These attributes include: All – Returns all values.
ApproximateFirstReceiveTimestamp – Returns the time the message was first received from
the queue (epoch time in milliseconds). ApproximateReceiveCount – Returns the number
of times a message has been received across all queues but not deleted. AWSTraceHeader
– Returns the X-Ray trace header string. SenderId For a user, returns the user ID,
for example ABCDEFGHI1JKLMNOPQ23R. For an IAM role, returns the IAM role ID, for example
ABCDE1F2GH3I4JK5LMNOP:i-a123b456. SentTimestamp – Returns the time the message was
sent to the queue (epoch time in milliseconds). SqsManagedSseEnabled – Enables
server-side queue encryption using SQS owned encryption keys. Only one server-side
encryption option is supported per queue (for example, SSE-KMS or SSE-SQS).
MessageDeduplicationId – Returns the value provided by the producer that calls the
SendMessage action. MessageGroupId – Returns the value provided by the producer that
calls the SendMessage action. Messages with the same MessageGroupId are returned in
sequence. SequenceNumber – Returns the value provided by Amazon SQS.
- `"ReceiveRequestAttemptId"`: This parameter applies only to FIFO (first-in-first-out)
queues. The token used for deduplication of ReceiveMessage calls. If a networking issue
occurs after a ReceiveMessage action, and instead of a response you receive a generic
error, it is possible to retry the same action with an identical ReceiveRequestAttemptId to
retrieve the same set of messages, even if their visibility timeout has not yet expired.
You can use ReceiveRequestAttemptId only for 5 minutes after a ReceiveMessage action.
When you set FifoQueue, a caller of the ReceiveMessage action can provide a
ReceiveRequestAttemptId explicitly. It is possible to retry the ReceiveMessage action
with the same ReceiveRequestAttemptId if none of the messages have been modified (deleted
or had their visibility changes). During a visibility timeout, subsequent calls with the
same ReceiveRequestAttemptId return the same messages and receipt handles. If a retry
occurs within the deduplication interval, it resets the visibility timeout. For more
information, see Visibility Timeout in the Amazon SQS Developer Guide. If a caller of the
ReceiveMessage action still processes messages when the visibility timeout expires and
messages become visible, another worker consuming from the same queue can receive the same
messages and therefore process duplicates. Also, if a consumer whose message processing
time is longer than the visibility timeout tries to delete the processed messages, the
action fails with an error. To mitigate this effect, ensure that your application observes
a safe threshold before the visibility timeout expires and extend the visibility timeout as
necessary. While messages with a particular MessageGroupId are invisible, no more
messages belonging to the same MessageGroupId are returned until the visibility timeout
expires. You can still receive messages with another MessageGroupId as long as it is also
visible. If a caller of ReceiveMessage can't track the ReceiveRequestAttemptId, no
retries work until the original visibility timeout expires. As a result, delays might occur
but the messages in the queue remain in a strict order. The maximum length of
ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId can contain alphanumeric
characters (a-z, A-Z, 0-9) and punctuation (!\"#%&'()*+,-./:;<=>?@[]^_`{|}~). For
best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId
Request Parameter in the Amazon SQS Developer Guide.
- `"VisibilityTimeout"`: The duration (in seconds) that the received messages are hidden
from subsequent retrieve requests after being retrieved by a ReceiveMessage request.
- `"WaitTimeSeconds"`: The duration (in seconds) for which the call waits for a message to
arrive in the queue before returning. If a message is available, the call returns sooner
than WaitTimeSeconds. If no messages are available and the wait time expires, the call does
not return a message list. To avoid HTTP errors, ensure that the HTTP response timeout for
ReceiveMessage requests is longer than the WaitTimeSeconds parameter. For example, with the
Java SDK, you can set HTTP transport settings using the NettyNioAsyncHttpClient for
asynchronous clients, or the ApacheHttpClient for synchronous clients.
"""
function receive_message(QueueUrl; aws_config::AbstractAWSConfig=global_aws_config())
return sqs(
"ReceiveMessage",
Dict{String,Any}("QueueUrl" => QueueUrl);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function receive_message(
QueueUrl,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sqs(
"ReceiveMessage",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("QueueUrl" => QueueUrl), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_permission(label, queue_url)
remove_permission(label, queue_url, params::Dict{String,<:Any})
Revokes any permissions in the queue policy that matches the specified Label parameter.
Only the owner of a queue can remove permissions from it. Cross-account permissions don't
apply to this action. For more information, see Grant cross-account permissions to a role
and a username in the Amazon SQS Developer Guide. To remove the ability to change queue
permissions, you must deny permission to the AddPermission, RemovePermission, and
SetQueueAttributes actions in your IAM policy.
# Arguments
- `label`: The identification of the permission to remove. This is the label added using
the AddPermission action.
- `queue_url`: The URL of the Amazon SQS queue from which permissions are removed. Queue
URLs and names are case-sensitive.
"""
function remove_permission(
Label, QueueUrl; aws_config::AbstractAWSConfig=global_aws_config()
)
return sqs(
"RemovePermission",
Dict{String,Any}("Label" => Label, "QueueUrl" => QueueUrl);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_permission(
Label,
QueueUrl,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sqs(
"RemovePermission",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Label" => Label, "QueueUrl" => QueueUrl), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_message(message_body, queue_url)
send_message(message_body, queue_url, params::Dict{String,<:Any})
Delivers a message to the specified queue. A message can include only XML, JSON, and
unformatted text. The following Unicode characters are allowed. For more information, see
the W3C specification for characters. #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD
| #x10000 to #x10FFFF Amazon SQS does not throw an exception or completely reject the
message if it contains invalid characters. Instead, it replaces those invalid characters
with U+FFFD before storing the message in the queue, as long as the message body contains
at least one valid character.
# Arguments
- `message_body`: The message to send. The minimum size is one character. The maximum size
is 256 KiB. A message can include only XML, JSON, and unformatted text. The following
Unicode characters are allowed. For more information, see the W3C specification for
characters. #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF
Amazon SQS does not throw an exception or completely reject the message if it contains
invalid characters. Instead, it replaces those invalid characters with U+FFFD before
storing the message in the queue, as long as the message body contains at least one valid
character.
- `queue_url`: The URL of the Amazon SQS queue to which a message is sent. Queue URLs and
names are case-sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DelaySeconds"`: The length of time, in seconds, for which to delay a specific message.
Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value
become available for processing after the delay period is finished. If you don't specify a
value, the default value for the queue applies. When you set FifoQueue, you can't set
DelaySeconds per message. You can set this parameter only on a queue level.
- `"MessageAttributes"`: Each message attribute consists of a Name, Type, and Value. For
more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.
- `"MessageDeduplicationId"`: This parameter applies only to FIFO (first-in-first-out)
queues. The token used for deduplication of sent messages. If a message with a particular
MessageDeduplicationId is sent successfully, any messages sent with the same
MessageDeduplicationId are accepted successfully but aren't delivered during the 5-minute
deduplication interval. For more information, see Exactly-once processing in the Amazon
SQS Developer Guide. Every message must have a unique MessageDeduplicationId, You may
provide a MessageDeduplicationId explicitly. If you aren't able to provide a
MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS
uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message
(but not the attributes of the message). If you don't provide a MessageDeduplicationId
and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.
If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the
generated one. When ContentBasedDeduplication is in effect, messages with identical
content sent within the deduplication interval are treated as duplicates and only one copy
of the message is delivered. If you send one message with ContentBasedDeduplication
enabled and then another message with a MessageDeduplicationId that is the same as the one
generated for the first MessageDeduplicationId, the two messages are treated as duplicates
and only one copy of the message is delivered. The MessageDeduplicationId is available
to the consumer of the message (this can be useful for troubleshooting delivery issues). If
a message is sent successfully but the acknowledgement is lost and the message is resent
with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't
detect duplicate messages. Amazon SQS continues to keep track of the message deduplication
ID even after the message is received and deleted. The maximum length of
MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric
characters (a-z, A-Z, 0-9) and punctuation (!\"#%&'()*+,-./:;<=>?@[]^_`{|}~). For
best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId
Property in the Amazon SQS Developer Guide.
- `"MessageGroupId"`: This parameter applies only to FIFO (first-in-first-out) queues. The
tag that specifies that a message belongs to a specific message group. Messages that belong
to the same message group are processed in a FIFO manner (however, messages in different
message groups might be processed out of order). To interleave multiple ordered streams
within a single queue, use MessageGroupId values (for example, session data for multiple
users). In this scenario, multiple consumers can process the queue, but the session data of
each user is processed in a FIFO fashion. You must associate a non-empty MessageGroupId
with a message. If you don't provide a MessageGroupId, the action fails. ReceiveMessage
might return messages with multiple MessageGroupId values. For each MessageGroupId, the
messages are sorted by time sent. The caller can't specify a MessageGroupId. The maximum
length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and
punctuation (!\"#%&'()*+,-./:;<=>?@[]^_`{|}~). For best practices of using
MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer Guide.
MessageGroupId is required for FIFO queues. You can't use it for Standard queues.
- `"MessageSystemAttributes"`: The message system attribute to send. Each message system
attribute consists of a Name, Type, and Value. Currently, the only supported message
system attribute is AWSTraceHeader. Its type must be String and its value must be a
correctly formatted X-Ray trace header string. The size of a message system attribute
doesn't count towards the total size of a message.
"""
function send_message(
MessageBody, QueueUrl; aws_config::AbstractAWSConfig=global_aws_config()
)
return sqs(
"SendMessage",
Dict{String,Any}("MessageBody" => MessageBody, "QueueUrl" => QueueUrl);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_message(
MessageBody,
QueueUrl,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sqs(
"SendMessage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("MessageBody" => MessageBody, "QueueUrl" => QueueUrl),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_message_batch(entries, queue_url)
send_message_batch(entries, queue_url, params::Dict{String,<:Any})
You can use SendMessageBatch to send up to 10 messages to the specified queue by assigning
either identical or different values to each message (or by not assigning values at all).
This is a batch version of SendMessage. For a FIFO queue, multiple messages within a
single batch are enqueued in the order they are sent. The result of sending each message 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. The maximum allowed individual message
size and the maximum total payload size (the sum of the individual lengths of all of the
batched messages) are both 256 KiB (262,144 bytes). A message can include only XML, JSON,
and unformatted text. The following Unicode characters are allowed. For more information,
see the W3C specification for characters. #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to
#xFFFD | #x10000 to #x10FFFF Amazon SQS does not throw an exception or completely reject
the message if it contains invalid characters. Instead, it replaces those invalid
characters with U+FFFD before storing the message in the queue, as long as the message body
contains at least one valid character. If you don't specify the DelaySeconds parameter for
an entry, Amazon SQS uses the default value for the queue.
# Arguments
- `entries`: A list of SendMessageBatchRequestEntry items.
- `queue_url`: The URL of the Amazon SQS queue to which batched messages are sent. Queue
URLs and names are case-sensitive.
"""
function send_message_batch(
Entries, QueueUrl; aws_config::AbstractAWSConfig=global_aws_config()
)
return sqs(
"SendMessageBatch",
Dict{String,Any}("Entries" => Entries, "QueueUrl" => QueueUrl);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_message_batch(
Entries,
QueueUrl,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sqs(
"SendMessageBatch",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Entries" => Entries, "QueueUrl" => QueueUrl),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_queue_attributes(attributes, queue_url)
set_queue_attributes(attributes, queue_url, params::Dict{String,<:Any})
Sets the value of one or more queue attributes, like a policy. When you change a queue's
attributes, the change can take up to 60 seconds for most of the attributes to propagate
throughout the Amazon SQS system. Changes made to the MessageRetentionPeriod attribute can
take up to 15 minutes and will impact existing messages in the queue potentially causing
them to be expired and deleted if the MessageRetentionPeriod is reduced below the age of
existing messages. In the future, new attributes might be added. If you write code that
calls this action, we recommend that you structure your code so that it can handle new
attributes gracefully. Cross-account permissions don't apply to this action. For more
information, see Grant cross-account permissions to a role and a username in the Amazon SQS
Developer Guide. To remove the ability to change queue permissions, you must deny
permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your
IAM policy.
# Arguments
- `attributes`: A map of attributes to set. The following lists the names, descriptions,
and values of the special request parameters that the SetQueueAttributes action uses:
DelaySeconds – The length of time, in seconds, for which the delivery of all messages in
the queue is delayed. Valid values: An integer from 0 to 900 (15 minutes). Default: 0.
MaximumMessageSize – The limit of how many bytes a message can contain before Amazon SQS
rejects it. Valid values: An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256
KiB). Default: 262,144 (256 KiB). MessageRetentionPeriod – The length of time, in
seconds, for which Amazon SQS retains a message. Valid values: An integer representing
seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days). When you
change a queue's attributes, the change can take up to 60 seconds for most of the
attributes to propagate throughout the Amazon SQS system. Changes made to the
MessageRetentionPeriod attribute can take up to 15 minutes and will impact existing
messages in the queue potentially causing them to be expired and deleted if the
MessageRetentionPeriod is reduced below the age of existing messages. Policy – The
queue's policy. A valid Amazon Web Services policy. For more information about policy
structure, see Overview of Amazon Web Services IAM Policies in the Identity and Access
Management User Guide. ReceiveMessageWaitTimeSeconds – The length of time, in
seconds, for which a ReceiveMessage action waits for a message to arrive. Valid values:
An integer from 0 to 20 (seconds). Default: 0. VisibilityTimeout – The visibility
timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours).
Default: 30. For more information about the visibility timeout, see Visibility Timeout in
the Amazon SQS Developer Guide. The following attributes apply only to dead-letter
queues: RedrivePolicy – The string that includes the parameters for the dead-letter
queue functionality of the source queue as a JSON object. The parameters are as follows:
deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which
Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
maxReceiveCount – The number of times a message is delivered to the source queue before
being moved to the dead-letter queue. Default: 10. When the ReceiveCount for a message
exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the
dead-letter-queue. RedriveAllowPolicy – The string that includes the parameters for
the permissions for the dead-letter queue redrive permission and which source queues can
specify dead-letter queues as a JSON object. The parameters are as follows:
redrivePermission – The permission type that defines which source queues can specify the
current queue as the dead-letter queue. Valid values are: allowAll – (Default) Any
source queues in this Amazon Web Services account in the same Region can specify this queue
as the dead-letter queue. denyAll – No source queues can specify this queue as the
dead-letter queue. byQueue – Only queues specified by the sourceQueueArns parameter
can specify this queue as the dead-letter queue. sourceQueueArns – The Amazon
Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter
queue and redrive messages. You can specify this parameter only when the redrivePermission
parameter is set to byQueue. You can specify up to 10 source queue ARNs. To allow more than
10 source queues to specify dead-letter queues, set the redrivePermission parameter to
allowAll. The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly,
the dead-letter queue of a standard queue must also be a standard queue. The following
attributes apply only to server-side-encryption: KmsMasterKeyId – The ID of an Amazon
Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more
information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always
alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias . For more
examples, see KeyId in the Key Management Service API Reference.
KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can
reuse a data key to encrypt or decrypt messages before calling KMS again. An integer
representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default:
300 (5 minutes). A shorter time period provides better security but results in more calls
to KMS which might incur charges after Free Tier. For more information, see How Does the
Data Key Reuse Period Work?. SqsManagedSseEnabled – Enables server-side queue
encryption using SQS owned encryption keys. Only one server-side encryption option is
supported per queue (for example, SSE-KMS or SSE-SQS). The following attribute applies
only to FIFO (first-in-first-out) queues: ContentBasedDeduplication – Enables
content-based deduplication. For more information, see Exactly-once processing in the
Amazon SQS Developer Guide. Note the following: Every message must have a unique
MessageDeduplicationId. You may provide a MessageDeduplicationId explicitly. If you
aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication
for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using
the body of the message (but not the attributes of the message). If you don't provide a
MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action
fails with an error. If the queue has ContentBasedDeduplication set, your
MessageDeduplicationId overrides the generated one. When ContentBasedDeduplication is
in effect, messages with identical content sent within the deduplication interval are
treated as duplicates and only one copy of the message is delivered. If you send one
message with ContentBasedDeduplication enabled and then another message with a
MessageDeduplicationId that is the same as the one generated for the first
MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the
message is delivered. The following attributes apply only to high throughput for FIFO
queues: DeduplicationScope – Specifies whether message deduplication occurs at the
message group or queue level. Valid values are messageGroup and queue.
FifoThroughputLimit – Specifies whether the FIFO queue throughput quota applies to the
entire queue or per message group. Valid values are perQueue and perMessageGroupId. The
perMessageGroupId value is allowed only when the value for DeduplicationScope is
messageGroup. To enable high throughput for FIFO queues, do the following: Set
DeduplicationScope to messageGroup. Set FifoThroughputLimit to perMessageGroupId. If
you set these attributes to anything other than the values shown for enabling high
throughput, normal throughput is in effect and deduplication occurs as specified. For
information on throughput quotas, see Quotas related to messages in the Amazon SQS
Developer Guide.
- `queue_url`: The URL of the Amazon SQS queue whose attributes are set. Queue URLs and
names are case-sensitive.
"""
function set_queue_attributes(
Attributes, QueueUrl; aws_config::AbstractAWSConfig=global_aws_config()
)
return sqs(
"SetQueueAttributes",
Dict{String,Any}("Attributes" => Attributes, "QueueUrl" => QueueUrl);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_queue_attributes(
Attributes,
QueueUrl,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sqs(
"SetQueueAttributes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Attributes" => Attributes, "QueueUrl" => QueueUrl),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_message_move_task(source_arn)
start_message_move_task(source_arn, params::Dict{String,<:Any})
Starts an asynchronous task to move messages from a specified source queue to a specified
destination queue. This action is currently limited to supporting message redrive from
queues that are configured as dead-letter queues (DLQs) of other Amazon SQS queues only.
Non-SQS queue sources of dead-letter queues, such as Lambda or Amazon SNS topics, are
currently not supported. In dead-letter queues redrive context, the StartMessageMoveTask
the source queue is the DLQ, while the destination queue can be the original source queue
(from which the messages were driven to the dead-letter-queue), or a custom destination
queue. Only one active message movement task is supported per queue at any given time.
# Arguments
- `source_arn`: The ARN of the queue that contains the messages to be moved to another
queue. Currently, only ARNs of dead-letter queues (DLQs) whose sources are other Amazon SQS
queues are accepted. DLQs whose sources are non-SQS queues, such as Lambda or Amazon SNS
topics, are not currently supported.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DestinationArn"`: The ARN of the queue that receives the moved messages. You can use
this field to specify the destination queue where you would like to redrive messages. If
this field is left blank, the messages will be redriven back to their respective original
source queues.
- `"MaxNumberOfMessagesPerSecond"`: The number of messages to be moved per second (the
message movement rate). You can use this field to define a fixed message movement rate. The
maximum value for messages per second is 500. If this field is left blank, the system will
optimize the rate based on the queue message backlog size, which may vary throughout the
duration of the message movement task.
"""
function start_message_move_task(
SourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sqs(
"StartMessageMoveTask",
Dict{String,Any}("SourceArn" => SourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_message_move_task(
SourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sqs(
"StartMessageMoveTask",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SourceArn" => SourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_queue(queue_url, tags)
tag_queue(queue_url, tags, params::Dict{String,<:Any})
Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging
Your Amazon SQS Queues in the Amazon SQS Developer Guide. When you use queue tags, keep the
following guidelines in mind: Adding more than 50 tags to a queue isn't recommended.
Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
Tags are case-sensitive. A new tag with a key identical to that of an existing tag
overwrites the existing tag. For a full list of tag restrictions, see Quotas related to
queues in the Amazon SQS Developer Guide. Cross-account permissions don't apply to this
action. For more information, see Grant cross-account permissions to a role and a username
in the Amazon SQS Developer Guide.
# Arguments
- `queue_url`: The URL of the queue.
- `tags`: The list of tags to be added to the specified queue.
"""
function tag_queue(QueueUrl, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return sqs(
"TagQueue",
Dict{String,Any}("QueueUrl" => QueueUrl, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_queue(
QueueUrl,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sqs(
"TagQueue",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("QueueUrl" => QueueUrl, "Tags" => Tags), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_queue(queue_url, tag_keys)
untag_queue(queue_url, tag_keys, params::Dict{String,<:Any})
Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see
Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide. Cross-account
permissions don't apply to this action. For more information, see Grant cross-account
permissions to a role and a username in the Amazon SQS Developer Guide.
# Arguments
- `queue_url`: The URL of the queue.
- `tag_keys`: The list of tags to be removed from the specified queue.
"""
function untag_queue(QueueUrl, TagKeys; aws_config::AbstractAWSConfig=global_aws_config())
return sqs(
"UntagQueue",
Dict{String,Any}("QueueUrl" => QueueUrl, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_queue(
QueueUrl,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sqs(
"UntagQueue",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("QueueUrl" => QueueUrl, "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 | 307123 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: ssm
using AWS.Compat
using AWS.UUIDs
"""
add_tags_to_resource(resource_id, resource_type, tags)
add_tags_to_resource(resource_id, resource_type, tags, params::Dict{String,<:Any})
Adds or overwrites one or more tags for the specified resource. Tags are metadata that you
can assign to your automations, documents, managed nodes, maintenance windows, Parameter
Store parameters, and patch baselines. Tags enable you to categorize your resources in
different ways, for example, by purpose, owner, or environment. Each tag consists of a key
and an optional value, both of which you define. For example, you could define a set of
tags for your account's managed nodes that helps you track each node's owner and stack
level. For example: Key=Owner,Value=DbAdmin Key=Owner,Value=SysAdmin
Key=Owner,Value=Dev Key=Stack,Value=Production Key=Stack,Value=Pre-Production
Key=Stack,Value=Test Most resources can have a maximum of 50 tags. Automations can have
a maximum of 5 tags. We recommend that you devise a set of tag keys that meets your needs
for each resource type. Using a consistent set of tag keys makes it easier for you to
manage your resources. You can search and filter the resources based on the tags you add.
Tags don't have any semantic meaning to and are interpreted strictly as a string of
characters. For more information about using tags with Amazon Elastic Compute Cloud (Amazon
EC2) instances, see Tag your Amazon EC2 resources in the Amazon EC2 User Guide.
# Arguments
- `resource_id`: The resource ID you want to tag. Use the ID of the resource. Here are some
examples: MaintenanceWindow: mw-012345abcde PatchBaseline: pb-012345abcde Automation:
example-c160-4567-8519-012345abcde OpsMetadata object: ResourceID for tagging is created
from the Amazon Resource Name (ARN) for the object. Specifically, ResourceID is created
from the strings that come after the word opsmetadata in the ARN. For example, an
OpsMetadata object with an ARN of
arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a ResourceID of
either aws/ssm/MyGroup/appmanager or /aws/ssm/MyGroup/appmanager. For the Document and
Parameter values, use the name of the resource. If you're tagging a shared document, you
must use the full ARN of the document. ManagedInstance: mi-012345abcde The
ManagedInstance type for this API operation is only for on-premises managed nodes. You must
specify the name of the managed node in the following format: mi-ID_number . For example,
mi-1a2b3c4d5e6f.
- `resource_type`: Specifies the type of resource you are tagging. The ManagedInstance
type for this API operation is for on-premises managed nodes. You must specify the name of
the managed node in the following format: mi-ID_number . For example, mi-1a2b3c4d5e6f.
- `tags`: One or more tags. The value parameter is required. Don't enter personally
identifiable information in this field.
"""
function add_tags_to_resource(
ResourceId, ResourceType, Tags; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"AddTagsToResource",
Dict{String,Any}(
"ResourceId" => ResourceId, "ResourceType" => ResourceType, "Tags" => Tags
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_tags_to_resource(
ResourceId,
ResourceType,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"AddTagsToResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ResourceId" => ResourceId,
"ResourceType" => ResourceType,
"Tags" => Tags,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_ops_item_related_item(association_type, ops_item_id, resource_type, resource_uri)
associate_ops_item_related_item(association_type, ops_item_id, resource_type, resource_uri, params::Dict{String,<:Any})
Associates a related item to a Systems Manager OpsCenter OpsItem. For example, you can
associate an Incident Manager incident or analysis with an OpsItem. Incident Manager and
OpsCenter are capabilities of Amazon Web Services Systems Manager.
# Arguments
- `association_type`: The type of association that you want to create between an OpsItem
and a resource. OpsCenter supports IsParentOf and RelatesTo association types.
- `ops_item_id`: The ID of the OpsItem to which you want to associate a resource as a
related item.
- `resource_type`: The type of resource that you want to associate with an OpsItem.
OpsCenter supports the following types: AWS::SSMIncidents::IncidentRecord: an Incident
Manager incident. AWS::SSM::Document: a Systems Manager (SSM) document.
- `resource_uri`: The Amazon Resource Name (ARN) of the Amazon Web Services resource that
you want to associate with the OpsItem.
"""
function associate_ops_item_related_item(
AssociationType,
OpsItemId,
ResourceType,
ResourceUri;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"AssociateOpsItemRelatedItem",
Dict{String,Any}(
"AssociationType" => AssociationType,
"OpsItemId" => OpsItemId,
"ResourceType" => ResourceType,
"ResourceUri" => ResourceUri,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_ops_item_related_item(
AssociationType,
OpsItemId,
ResourceType,
ResourceUri,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"AssociateOpsItemRelatedItem",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AssociationType" => AssociationType,
"OpsItemId" => OpsItemId,
"ResourceType" => ResourceType,
"ResourceUri" => ResourceUri,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_command(command_id)
cancel_command(command_id, params::Dict{String,<:Any})
Attempts to cancel the command specified by the Command ID. There is no guarantee that the
command will be terminated and the underlying process stopped.
# Arguments
- `command_id`: The ID of the command you want to cancel.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InstanceIds"`: (Optional) A list of managed node IDs on which you want to cancel the
command. If not provided, the command is canceled on every node on which it was requested.
"""
function cancel_command(CommandId; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"CancelCommand",
Dict{String,Any}("CommandId" => CommandId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_command(
CommandId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"CancelCommand",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("CommandId" => CommandId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_maintenance_window_execution(window_execution_id)
cancel_maintenance_window_execution(window_execution_id, params::Dict{String,<:Any})
Stops a maintenance window execution that is already in progress and cancels any tasks in
the window that haven't already starting running. Tasks already in progress will continue
to completion.
# Arguments
- `window_execution_id`: The ID of the maintenance window execution to stop.
"""
function cancel_maintenance_window_execution(
WindowExecutionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"CancelMaintenanceWindowExecution",
Dict{String,Any}("WindowExecutionId" => WindowExecutionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_maintenance_window_execution(
WindowExecutionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"CancelMaintenanceWindowExecution",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("WindowExecutionId" => WindowExecutionId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_activation(iam_role)
create_activation(iam_role, params::Dict{String,<:Any})
Generates an activation code and activation ID you can use to register your on-premises
servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager.
Registering these machines with Systems Manager makes it possible to manage them using
Systems Manager capabilities. You use the activation code and ID when installing SSM Agent
on machines in your hybrid environment. For more information about requirements for
managing on-premises machines using Systems Manager, see Setting up Amazon Web Services
Systems Manager for hybrid and multicloud environments in the Amazon Web Services Systems
Manager User Guide. Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices,
and on-premises servers and VMs that are configured for Systems Manager are all called
managed nodes.
# Arguments
- `iam_role`: The name of the Identity and Access Management (IAM) role that you want to
assign to the managed node. This IAM role must provide AssumeRole permissions for the
Amazon Web Services Systems Manager service principal ssm.amazonaws.com. For more
information, see Create an IAM service role for a hybrid and multicloud environment in the
Amazon Web Services Systems Manager User Guide. You can't specify an IAM service-linked
role for this parameter. You must create a unique role.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DefaultInstanceName"`: The name of the registered, managed node as it will appear in
the Amazon Web Services Systems Manager console or when you use the Amazon Web Services
command line tools to list Systems Manager resources. Don't enter personally identifiable
information in this field.
- `"Description"`: A user-defined description of the resource that you want to register
with Systems Manager. Don't enter personally identifiable information in this field.
- `"ExpirationDate"`: The date by which this activation request should expire, in timestamp
format, such as \"2021-07-07T00:00:00\". You can specify a date up to 30 days in advance.
If you don't provide an expiration date, the activation code expires in 24 hours.
- `"RegistrationLimit"`: Specify the maximum number of managed nodes you want to register.
The default value is 1.
- `"RegistrationMetadata"`: Reserved for internal use.
- `"Tags"`: Optional metadata that you assign to a resource. Tags enable you to categorize
a resource in different ways, such as by purpose, owner, or environment. For example, you
might want to tag an activation to identify which servers or virtual machines (VMs) in your
on-premises environment you intend to activate. In this case, you could specify the
following key-value pairs: Key=OS,Value=Windows Key=Environment,Value=Production
When you install SSM Agent on your on-premises servers and VMs, you specify an activation
ID and code. When you specify the activation ID and code, tags assigned to the activation
are automatically applied to the on-premises servers or VMs. You can't add tags to or
delete tags from an existing activation. You can tag your on-premises servers, edge
devices, and VMs after they connect to Systems Manager for the first time and are assigned
a managed node ID. This means they are listed in the Amazon Web Services Systems Manager
console with an ID that is prefixed with \"mi-\". For information about how to add tags to
your managed nodes, see AddTagsToResource. For information about how to remove tags from
your managed nodes, see RemoveTagsFromResource.
"""
function create_activation(IamRole; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"CreateActivation",
Dict{String,Any}("IamRole" => IamRole);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_activation(
IamRole, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"CreateActivation",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("IamRole" => IamRole), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_association(name)
create_association(name, params::Dict{String,<:Any})
A State Manager association defines the state that you want to maintain on your managed
nodes. For example, an association can specify that anti-virus software must be installed
and running on your managed nodes, or that certain ports must be closed. For static
targets, the association specifies a schedule for when the configuration is reapplied. For
dynamic targets, such as an Amazon Web Services resource group or an Amazon Web Services
autoscaling group, State Manager, a capability of Amazon Web Services Systems Manager
applies the configuration when new managed nodes are added to the group. The association
also specifies actions to take when applying the configuration. For example, an association
for anti-virus software might run once a day. If the software isn't installed, then State
Manager installs it. If the software is installed, but the service isn't running, then the
association might instruct State Manager to start the service.
# Arguments
- `name`: The name of the SSM Command document or Automation runbook that contains the
configuration information for the managed node. You can specify Amazon Web
Services-predefined documents, documents you created, or a document that is shared with you
from another Amazon Web Services account. For Systems Manager documents (SSM documents)
that are shared with you from other Amazon Web Services accounts, you must specify the
complete SSM document ARN, in the following format:
arn:partition:ssm:region:account-id:document/document-name For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document For Amazon Web
Services-predefined documents and SSM documents you created in your account, you only need
to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AlarmConfiguration"`:
- `"ApplyOnlyAtCronInterval"`: By default, when you create a new association, the system
runs it immediately after it is created and then according to the schedule you specified.
Specify this option if you don't want an association to run immediately after you create
it. This parameter isn't supported for rate expressions.
- `"AssociationName"`: Specify a descriptive name for the association.
- `"AutomationTargetParameterName"`: Choose the parameter that will define how your
automation will branch out. This target is required for associations that use an Automation
runbook and target resources by using rate controls. Automation is a capability of Amazon
Web Services Systems Manager.
- `"CalendarNames"`: The names or Amazon Resource Names (ARNs) of the Change Calendar type
documents you want to gate your associations under. The associations only run when that
change calendar is open. For more information, see Amazon Web Services Systems Manager
Change Calendar.
- `"ComplianceSeverity"`: The severity level to assign to the association.
- `"DocumentVersion"`: The document version you want to associate with the targets. Can be
a specific version or the default version. State Manager doesn't support running
associations that use a new version of a document if that document is shared from another
account. State Manager always runs the default version of a document if shared from another
account, even though the Systems Manager console shows that a new version was processed. If
you want to run an association using a new version of a document shared form another
account, you must set the document version to default.
- `"Duration"`: The number of hours the association can run before it is canceled. Duration
applies to associations that are currently running, and any pending and in progress
commands on all targets. If a target was taken offline for the association to run, it is
made available again immediately, without a reboot. The Duration parameter applies only
when both these conditions are true: The association for which you specify a duration is
cancelable according to the parameters of the SSM command document or Automation runbook
associated with this execution. The command specifies the ApplyOnlyAtCronInterval
parameter, which means that the association doesn't run immediately after it is created,
but only according to the specified schedule.
- `"InstanceId"`: The managed node ID. InstanceId has been deprecated. To specify a
managed node ID for an association, use the Targets parameter. Requests that include the
parameter InstanceID with Systems Manager documents (SSM documents) that use schema version
2.0 or later will fail. In addition, if you use the parameter InstanceId, you can't use the
parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or
ScheduleExpression. To use these parameters, you must use the Targets parameter.
- `"MaxConcurrency"`: The maximum number of targets allowed to run the association at the
same time. You can specify a number, for example 10, or a percentage of the target set, for
example 10%. The default value is 100%, which means all targets run the association at the
same time. If a new managed node starts and attempts to run an association while Systems
Manager is running MaxConcurrency associations, the association is allowed to run. During
the next association interval, the new managed node will process its association within the
limit specified for MaxConcurrency.
- `"MaxErrors"`: The number of errors that are allowed before the system stops sending
requests to run the association on additional targets. You can specify either an absolute
number of errors, for example 10, or a percentage of the target set, for example 10%. If
you specify 3, for example, the system stops sending requests when the fourth error is
received. If you specify 0, then the system stops sending requests after the first error is
returned. If you run an association on 50 managed nodes and set MaxError to 10%, then the
system stops sending the request when the sixth error is received. Executions that are
already running an association when MaxErrors is reached are allowed to complete, but some
of these executions may fail as well. If you need to ensure that there won't be more than
max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a
time.
- `"OutputLocation"`: An Amazon Simple Storage Service (Amazon S3) bucket where you want to
store the output details of the request.
- `"Parameters"`: The parameters for the runtime configuration of the document.
- `"ScheduleExpression"`: A cron expression when the association will be applied to the
targets.
- `"ScheduleOffset"`: Number of days to wait after the scheduled day to run an association.
For example, if you specified a cron schedule of cron(0 0 ? * THU#2 *), you could specify
an offset of 3 to run the association each Sunday after the second Thursday of the month.
For more information about cron schedules for associations, see Reference: Cron and rate
expressions for Systems Manager in the Amazon Web Services Systems Manager User Guide. To
use offsets, you must specify the ApplyOnlyAtCronInterval parameter. This option tells the
system not to run an association immediately after you create it.
- `"SyncCompliance"`: The mode for generating association compliance. You can specify AUTO
or MANUAL. In AUTO mode, the system uses the status of the association execution to
determine the compliance status. If the association execution runs successfully, then the
association is COMPLIANT. If the association execution doesn't run successfully, the
association is NON-COMPLIANT. In MANUAL mode, you must specify the AssociationId as a
parameter for the PutComplianceItems API operation. In this case, compliance data isn't
managed by State Manager. It is managed by your direct call to the PutComplianceItems API
operation. By default, all associations use AUTO mode.
- `"Tags"`: Adds or overwrites one or more tags for a State Manager association. Tags are
metadata that you can assign to your Amazon Web Services resources. Tags enable you to
categorize your resources in different ways, for example, by purpose, owner, or
environment. Each tag consists of a key and an optional value, both of which you define.
- `"TargetLocations"`: A location is a combination of Amazon Web Services Regions and
Amazon Web Services accounts where you want to run the association. Use this action to
create an association in multiple Regions and multiple accounts.
- `"TargetMaps"`: A key-value mapping of document parameters to target resources. Both
Targets and TargetMaps can't be specified together.
- `"Targets"`: The targets for the association. You can target managed nodes by using tags,
Amazon Web Services resource groups, all managed nodes in an Amazon Web Services account,
or individual managed node IDs. You can target all managed nodes in an Amazon Web Services
account by specifying the InstanceIds key with a value of *. For more information about
choosing targets for an association, see About targets and rate controls in State Manager
associations in the Amazon Web Services Systems Manager User Guide.
"""
function create_association(Name; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"CreateAssociation",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_association(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"CreateAssociation",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_association_batch(entries)
create_association_batch(entries, params::Dict{String,<:Any})
Associates the specified Amazon Web Services Systems Manager document (SSM document) with
the specified managed nodes or targets. When you associate a document with one or more
managed nodes using IDs or tags, Amazon Web Services Systems Manager Agent (SSM Agent)
running on the managed node processes the document and configures the node as specified. If
you associate a document with a managed node that already has an associated document, the
system returns the AssociationAlreadyExists exception.
# Arguments
- `entries`: One or more associations.
"""
function create_association_batch(
Entries; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"CreateAssociationBatch",
Dict{String,Any}("Entries" => Entries);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_association_batch(
Entries, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"CreateAssociationBatch",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Entries" => Entries), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_document(content, name)
create_document(content, name, params::Dict{String,<:Any})
Creates a Amazon Web Services Systems Manager (SSM document). An SSM document defines the
actions that Systems Manager performs on your managed nodes. For more information about SSM
documents, including information about supported schemas, features, and syntax, see Amazon
Web Services Systems Manager Documents in the Amazon Web Services Systems Manager User
Guide.
# Arguments
- `content`: The content for the new SSM document in JSON or YAML format. The content of
the document must not exceed 64KB. This quota also includes the content specified for input
parameters at runtime. We recommend storing the contents for your new document in an
external JSON or YAML file and referencing the file in a command. For examples, see the
following topics in the Amazon Web Services Systems Manager User Guide. Create an SSM
document (console) Create an SSM document (command line) Create an SSM document
(API)
- `name`: A name for the SSM document. You can't use the following strings as document
name prefixes. These are reserved by Amazon Web Services for use as document name prefixes:
aws amazon amzn AWSEC2 AWSConfigRemediation AWSSupport
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Attachments"`: A list of key-value pairs that describe attachments to a version of a
document.
- `"DisplayName"`: An optional field where you can specify a friendly name for the SSM
document. This value can differ for each version of the document. You can update this value
at a later time using the UpdateDocument operation.
- `"DocumentFormat"`: Specify the document format for the request. The document format can
be JSON, YAML, or TEXT. JSON is the default format.
- `"DocumentType"`: The type of document to create. The DeploymentStrategy document type
is an internal-use-only document type reserved for AppConfig.
- `"Requires"`: A list of SSM documents required by a document. This parameter is used
exclusively by AppConfig. When a user creates an AppConfig configuration in an SSM
document, the user must also specify a required document for validation purposes. In this
case, an ApplicationConfiguration document requires an ApplicationConfigurationSchema
document for validation purposes. For more information, see What is AppConfig? in the
AppConfig User Guide.
- `"Tags"`: Optional metadata that you assign to a resource. Tags enable you to categorize
a resource in different ways, such as by purpose, owner, or environment. For example, you
might want to tag an SSM document to identify the types of targets or the environment where
it will run. In this case, you could specify the following key-value pairs:
Key=OS,Value=Windows Key=Environment,Value=Production To add tags to an existing
SSM document, use the AddTagsToResource operation.
- `"TargetType"`: Specify a target type to define the kinds of resources the document can
run on. For example, to run a document on EC2 instances, specify the following value:
/AWS::EC2::Instance. If you specify a value of '/' the document can run on all types of
resources. If you don't specify a value, the document can't run on any resources. For a
list of valid resource types, see Amazon Web Services resource and property types reference
in the CloudFormation User Guide.
- `"VersionName"`: An optional field specifying the version of the artifact you are
creating with the document. For example, Release12.1. This value is unique across all
versions of a document, and can't be changed.
"""
function create_document(Content, Name; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"CreateDocument",
Dict{String,Any}("Content" => Content, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_document(
Content,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"CreateDocument",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Content" => Content, "Name" => Name), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_maintenance_window(allow_unassociated_targets, cutoff, duration, name, schedule)
create_maintenance_window(allow_unassociated_targets, cutoff, duration, name, schedule, params::Dict{String,<:Any})
Creates a new maintenance window. The value you specify for Duration determines the
specific end time for the maintenance window based on the time it begins. No maintenance
window tasks are permitted to start after the resulting endtime minus the number of hours
you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the duration
is three hours, and the value you specify for Cutoff is one hour, no maintenance window
tasks can start after 5 PM.
# Arguments
- `allow_unassociated_targets`: Enables a maintenance window task to run on managed nodes,
even if you haven't registered those nodes as targets. If enabled, then you must specify
the unregistered managed nodes (by node ID) when you register a task with the maintenance
window. If you don't enable this option, then you must specify previously-registered
targets when you register a task with the maintenance window.
- `cutoff`: The number of hours before the end of the maintenance window that Amazon Web
Services Systems Manager stops scheduling new tasks for execution.
- `duration`: The duration of the maintenance window in hours.
- `name`: The name of the maintenance window.
- `schedule`: The schedule of the maintenance window in the form of a cron or rate
expression.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: User-provided idempotency token.
- `"Description"`: An optional description for the maintenance window. We recommend
specifying a description to help you organize your maintenance windows.
- `"EndDate"`: The date and time, in ISO-8601 Extended format, for when you want the
maintenance window to become inactive. EndDate allows you to set a date and time in the
future when the maintenance window will no longer run.
- `"ScheduleOffset"`: The number of days to wait after the date and time specified by a
cron expression before running the maintenance window. For example, the following cron
expression schedules a maintenance window to run on the third Tuesday of every month at
11:30 PM. cron(30 23 ? * TUE#3 *) If the schedule offset is 2, the maintenance window
won't run until two days later.
- `"ScheduleTimezone"`: The time zone that the scheduled maintenance window executions are
based on, in Internet Assigned Numbers Authority (IANA) format. For example:
\"America/Los_Angeles\", \"UTC\", or \"Asia/Seoul\". For more information, see the Time
Zone Database on the IANA website.
- `"StartDate"`: The date and time, in ISO-8601 Extended format, for when you want the
maintenance window to become active. StartDate allows you to delay activation of the
maintenance window until the specified future date. When using a rate schedule, if you
provide a start date that occurs in the past, the current date and time are used as the
start date.
- `"Tags"`: Optional metadata that you assign to a resource. Tags enable you to categorize
a resource in different ways, such as by purpose, owner, or environment. For example, you
might want to tag a maintenance window to identify the type of tasks it will run, the types
of targets, and the environment it will run in. In this case, you could specify the
following key-value pairs: Key=TaskType,Value=AgentUpdate Key=OS,Value=Windows
Key=Environment,Value=Production To add tags to an existing maintenance window, use the
AddTagsToResource operation.
"""
function create_maintenance_window(
AllowUnassociatedTargets,
Cutoff,
Duration,
Name,
Schedule;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"CreateMaintenanceWindow",
Dict{String,Any}(
"AllowUnassociatedTargets" => AllowUnassociatedTargets,
"Cutoff" => Cutoff,
"Duration" => Duration,
"Name" => Name,
"Schedule" => Schedule,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_maintenance_window(
AllowUnassociatedTargets,
Cutoff,
Duration,
Name,
Schedule,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"CreateMaintenanceWindow",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AllowUnassociatedTargets" => AllowUnassociatedTargets,
"Cutoff" => Cutoff,
"Duration" => Duration,
"Name" => Name,
"Schedule" => Schedule,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_ops_item(description, source, title)
create_ops_item(description, source, title, params::Dict{String,<:Any})
Creates a new OpsItem. You must have permission in Identity and Access Management (IAM) to
create a new OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services
Systems Manager User Guide. Operations engineers and IT professionals use Amazon Web
Services Systems Manager OpsCenter to view, investigate, and remediate operational issues
impacting the performance and health of their Amazon Web Services resources. For more
information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services
Systems Manager User Guide.
# Arguments
- `description`: User-defined text that contains information about the OpsItem, in Markdown
format. Provide enough information so that users viewing this OpsItem for the first time
understand the issue.
- `source`: The origin of the OpsItem, such as Amazon EC2 or Systems Manager. The source
name can't contain the following strings: aws, amazon, and amzn.
- `title`: A short heading that describes the nature of the OpsItem and the impacted
resource.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccountId"`: The target Amazon Web Services account where you want to create an
OpsItem. To make this call, your account must be configured to work with OpsItems across
accounts. For more information, see Set up OpsCenter in the Amazon Web Services Systems
Manager User Guide.
- `"ActualEndTime"`: The time a runbook workflow ended. Currently reported only for the
OpsItem type /aws/changerequest.
- `"ActualStartTime"`: The time a runbook workflow started. Currently reported only for the
OpsItem type /aws/changerequest.
- `"Category"`: Specify a category to assign to an OpsItem.
- `"Notifications"`: The Amazon Resource Name (ARN) of an SNS topic where notifications are
sent when this OpsItem is edited or changed.
- `"OperationalData"`: Operational data is custom data that provides useful reference
details about the OpsItem. For example, you can specify log files, error strings, license
keys, troubleshooting tips, or other relevant data. You enter operational data as key-value
pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20
KB. Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon,
/aws, /amzn, /ssm. You can choose to make the data searchable by other users in the
account or you can restrict search access. Searchable data means that all users with access
to the OpsItem Overview page (as provided by the DescribeOpsItems API operation) can view
and search on the specified data. Operational data that isn't searchable is only viewable
by users who have access to the OpsItem (as provided by the GetOpsItem API operation). Use
the /aws/resources key in OperationalData to specify a related resource in the request. Use
the /aws/automations key in OperationalData to associate an Automation runbook with the
OpsItem. To view Amazon Web Services CLI example commands that use these keys, see Create
OpsItems manually in the Amazon Web Services Systems Manager User Guide.
- `"OpsItemType"`: The type of OpsItem to create. Systems Manager supports the following
types of OpsItems: /aws/issue This type of OpsItem is used for default OpsItems created
by OpsCenter. /aws/changerequest This type of OpsItem is used by Change Manager for
reviewing and approving or rejecting change requests. /aws/insight This type of
OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.
- `"PlannedEndTime"`: The time specified in a change request for a runbook workflow to end.
Currently supported only for the OpsItem type /aws/changerequest.
- `"PlannedStartTime"`: The time specified in a change request for a runbook workflow to
start. Currently supported only for the OpsItem type /aws/changerequest.
- `"Priority"`: The importance of this OpsItem in relation to other OpsItems in the system.
- `"RelatedOpsItems"`: One or more OpsItems that share something in common with the current
OpsItems. For example, related OpsItems can include OpsItems with similar error messages,
impacted resources, or statuses for the impacted resource.
- `"Severity"`: Specify a severity to assign to an OpsItem.
- `"Tags"`: Optional metadata that you assign to a resource. Tags use a key-value pair. For
example: Key=Department,Value=Finance To add tags to a new OpsItem, a user must have IAM
permissions for both the ssm:CreateOpsItems operation and the ssm:AddTagsToResource
operation. To add tags to an existing OpsItem, use the AddTagsToResource operation.
"""
function create_ops_item(
Description, Source, Title; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"CreateOpsItem",
Dict{String,Any}(
"Description" => Description, "Source" => Source, "Title" => Title
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_ops_item(
Description,
Source,
Title,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"CreateOpsItem",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Description" => Description, "Source" => Source, "Title" => Title
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_ops_metadata(resource_id)
create_ops_metadata(resource_id, params::Dict{String,<:Any})
If you create a new application in Application Manager, Amazon Web Services Systems Manager
calls this API operation to specify information about the new application, including the
application type.
# Arguments
- `resource_id`: A resource ID for a new Application Manager application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Metadata"`: Metadata for a new Application Manager application.
- `"Tags"`: Optional metadata that you assign to a resource. You can specify a maximum of
five tags for an OpsMetadata object. Tags enable you to categorize a resource in different
ways, such as by purpose, owner, or environment. For example, you might want to tag an
OpsMetadata object to identify an environment or target Amazon Web Services Region. In this
case, you could specify the following key-value pairs: Key=Environment,Value=Production
Key=Region,Value=us-east-2
"""
function create_ops_metadata(ResourceId; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"CreateOpsMetadata",
Dict{String,Any}("ResourceId" => ResourceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_ops_metadata(
ResourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"CreateOpsMetadata",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceId" => ResourceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_patch_baseline(name)
create_patch_baseline(name, params::Dict{String,<:Any})
Creates a patch baseline. For information about valid key-value pairs in PatchFilters for
each supported operating system type, see PatchFilter.
# Arguments
- `name`: The name of the patch baseline.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ApprovalRules"`: A set of rules used to include patches in the baseline.
- `"ApprovedPatches"`: A list of explicitly approved patches for the baseline. For
information about accepted formats for lists of approved patches and rejected patches, see
About package name formats for approved and rejected patch lists in the Amazon Web Services
Systems Manager User Guide.
- `"ApprovedPatchesComplianceLevel"`: Defines the compliance level for approved patches.
When an approved patch is reported as missing, this value describes the severity of the
compliance violation. The default value is UNSPECIFIED.
- `"ApprovedPatchesEnableNonSecurity"`: Indicates whether the list of approved patches
includes non-security updates that should be applied to the managed nodes. The default
value is false. Applies to Linux managed nodes only.
- `"ClientToken"`: User-provided idempotency token.
- `"Description"`: A description of the patch baseline.
- `"GlobalFilters"`: A set of global filters used to include patches in the baseline.
- `"OperatingSystem"`: Defines the operating system the patch baseline applies to. The
default value is WINDOWS.
- `"RejectedPatches"`: A list of explicitly rejected patches for the baseline. For
information about accepted formats for lists of approved patches and rejected patches, see
About package name formats for approved and rejected patch lists in the Amazon Web Services
Systems Manager User Guide.
- `"RejectedPatchesAction"`: The action for Patch Manager to take on patches included in
the RejectedPackages list. ALLOW_AS_DEPENDENCY : A package in the Rejected patches list
is installed only if it is a dependency of another package. It is considered compliant with
the patch baseline, and its status is reported as InstalledOther. This is the default
action if no option is specified. BLOCK: Packages in the Rejected patches list, and
packages that include them as dependencies, aren't installed by Patch Manager under any
circumstances. If a package was installed before it was added to the Rejected patches list,
or is installed outside of Patch Manager afterward, it's considered noncompliant with the
patch baseline and its status is reported as InstalledRejected.
- `"Sources"`: Information about the patches to use to update the managed nodes, including
target operating systems and source repositories. Applies to Linux managed nodes only.
- `"Tags"`: Optional metadata that you assign to a resource. Tags enable you to categorize
a resource in different ways, such as by purpose, owner, or environment. For example, you
might want to tag a patch baseline to identify the severity level of patches it specifies
and the operating system family it applies to. In this case, you could specify the
following key-value pairs: Key=PatchSeverity,Value=Critical Key=OS,Value=Windows
To add tags to an existing patch baseline, use the AddTagsToResource operation.
"""
function create_patch_baseline(Name; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"CreatePatchBaseline",
Dict{String,Any}("Name" => Name, "ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_patch_baseline(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"CreatePatchBaseline",
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_resource_data_sync(sync_name)
create_resource_data_sync(sync_name, params::Dict{String,<:Any})
A resource data sync helps you view data from multiple sources in a single location. Amazon
Web Services Systems Manager offers two types of resource data sync: SyncToDestination and
SyncFromSource. You can configure Systems Manager Inventory to use the SyncToDestination
type to synchronize Inventory data from multiple Amazon Web Services Regions to a single
Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Configuring
resource data sync for Inventory in the Amazon Web Services Systems Manager User Guide. You
can configure Systems Manager Explorer to use the SyncFromSource type to synchronize
operational work items (OpsItems) and operational data (OpsData) from multiple Amazon Web
Services Regions to a single Amazon S3 bucket. This type can synchronize OpsItems and
OpsData from multiple Amazon Web Services accounts and Amazon Web Services Regions or
EntireOrganization by using Organizations. For more information, see Setting up Systems
Manager Explorer to display data from multiple accounts and Regions in the Amazon Web
Services Systems Manager User Guide. A resource data sync is an asynchronous operation that
returns immediately. After a successful initial sync is completed, the system continuously
syncs data. To check the status of a sync, use the ListResourceDataSync. By default, data
isn't encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3
to ensure secure data storage. We also recommend that you secure access to the Amazon S3
bucket by creating a restrictive bucket policy.
# Arguments
- `sync_name`: A name for the configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"S3Destination"`: Amazon S3 configuration details for the sync. This parameter is
required if the SyncType value is SyncToDestination.
- `"SyncSource"`: Specify information about the data sources to synchronize. This parameter
is required if the SyncType value is SyncFromSource.
- `"SyncType"`: Specify SyncToDestination to create a resource data sync that synchronizes
data to an S3 bucket for Inventory. If you specify SyncToDestination, you must provide a
value for S3Destination. Specify SyncFromSource to synchronize data from a single account
and multiple Regions, or multiple Amazon Web Services accounts and Amazon Web Services
Regions, as listed in Organizations for Explorer. If you specify SyncFromSource, you must
provide a value for SyncSource. The default value is SyncToDestination.
"""
function create_resource_data_sync(
SyncName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"CreateResourceDataSync",
Dict{String,Any}("SyncName" => SyncName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_resource_data_sync(
SyncName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"CreateResourceDataSync",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SyncName" => SyncName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_activation(activation_id)
delete_activation(activation_id, params::Dict{String,<:Any})
Deletes an activation. You aren't required to delete an activation. If you delete an
activation, you can no longer use it to register additional managed nodes. Deleting an
activation doesn't de-register managed nodes. You must manually de-register managed nodes.
# Arguments
- `activation_id`: The ID of the activation that you want to delete.
"""
function delete_activation(ActivationId; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"DeleteActivation",
Dict{String,Any}("ActivationId" => ActivationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_activation(
ActivationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"DeleteActivation",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ActivationId" => ActivationId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_association()
delete_association(params::Dict{String,<:Any})
Disassociates the specified Amazon Web Services Systems Manager document (SSM document)
from the specified managed node. If you created the association by using the Targets
parameter, then you must delete the association by using the association ID. When you
disassociate a document from a managed node, it doesn't change the configuration of the
node. To change the configuration state of a managed node after you disassociate a
document, you must create a new document with the desired configuration and associate it
with the node.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AssociationId"`: The association ID that you want to delete.
- `"InstanceId"`: The managed node ID. InstanceId has been deprecated. To specify a
managed node ID for an association, use the Targets parameter. Requests that include the
parameter InstanceID with Systems Manager documents (SSM documents) that use schema version
2.0 or later will fail. In addition, if you use the parameter InstanceId, you can't use the
parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or
ScheduleExpression. To use these parameters, you must use the Targets parameter.
- `"Name"`: The name of the SSM document.
"""
function delete_association(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm("DeleteAssociation"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function delete_association(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DeleteAssociation", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
delete_document(name)
delete_document(name, params::Dict{String,<:Any})
Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed
node associations to the document. Before you delete the document, we recommend that you
use DeleteAssociation to disassociate all managed nodes that are associated with the
document.
# Arguments
- `name`: The name of the document.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DocumentVersion"`: The version of the document that you want to delete. If not
provided, all versions of the document are deleted.
- `"Force"`: Some SSM document types require that you specify a Force flag before you can
delete the document. For example, you must specify a Force flag to delete a document of
type ApplicationConfigurationSchema. You can restrict access to the Force flag in an
Identity and Access Management (IAM) policy.
- `"VersionName"`: The version name of the document that you want to delete. If not
provided, all versions of the document are deleted.
"""
function delete_document(Name; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"DeleteDocument",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_document(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DeleteDocument",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_inventory(type_name)
delete_inventory(type_name, params::Dict{String,<:Any})
Delete a custom inventory type or the data associated with a custom Inventory type.
Deleting a custom inventory type is also referred to as deleting a custom inventory schema.
# Arguments
- `type_name`: The name of the custom inventory type for which you want to delete either
all previously collected data or the inventory type itself.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: User-provided idempotency token.
- `"DryRun"`: Use this option to view a summary of the deletion request without deleting
any data or the data type. This option is useful when you only want to understand what will
be deleted. Once you validate that the data to be deleted is what you intend to delete, you
can run the same command without specifying the DryRun option.
- `"SchemaDeleteOption"`: Use the SchemaDeleteOption to delete a custom inventory type
(schema). If you don't choose this option, the system only deletes existing inventory data
associated with the custom inventory type. Choose one of the following options:
DisableSchema: If you choose this option, the system ignores all inventory data for the
specified version, and any earlier versions. To enable this schema again, you must call the
PutInventory operation for a version greater than the disabled version. DeleteSchema: This
option deletes the specified custom type from the Inventory service. You can recreate the
schema later, if you want.
"""
function delete_inventory(TypeName; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"DeleteInventory",
Dict{String,Any}("TypeName" => TypeName, "ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_inventory(
TypeName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"DeleteInventory",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("TypeName" => TypeName, "ClientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_maintenance_window(window_id)
delete_maintenance_window(window_id, params::Dict{String,<:Any})
Deletes a maintenance window.
# Arguments
- `window_id`: The ID of the maintenance window to delete.
"""
function delete_maintenance_window(
WindowId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DeleteMaintenanceWindow",
Dict{String,Any}("WindowId" => WindowId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_maintenance_window(
WindowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"DeleteMaintenanceWindow",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("WindowId" => WindowId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_ops_item(ops_item_id)
delete_ops_item(ops_item_id, params::Dict{String,<:Any})
Delete an OpsItem. You must have permission in Identity and Access Management (IAM) to
delete an OpsItem. Note the following important information about this operation.
Deleting an OpsItem is irreversible. You can't restore a deleted OpsItem. This operation
uses an eventual consistency model, which means the system can take a few minutes to
complete this operation. If you delete an OpsItem and immediately call, for example,
GetOpsItem, the deleted OpsItem might still appear in the response. This operation is
idempotent. The system doesn't throw an exception if you repeatedly call this operation for
the same OpsItem. If the first call is successful, all additional calls return the same
successful response as the first call. This operation doesn't support cross-account
calls. A delegated administrator or management account can't delete OpsItems in other
accounts, even if OpsCenter has been set up for cross-account administration. For more
information about cross-account administration, see Setting up OpsCenter to centrally
manage OpsItems across accounts in the Systems Manager User Guide.
# Arguments
- `ops_item_id`: The ID of the OpsItem that you want to delete.
"""
function delete_ops_item(OpsItemId; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"DeleteOpsItem",
Dict{String,Any}("OpsItemId" => OpsItemId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_ops_item(
OpsItemId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"DeleteOpsItem",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("OpsItemId" => OpsItemId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_ops_metadata(ops_metadata_arn)
delete_ops_metadata(ops_metadata_arn, params::Dict{String,<:Any})
Delete OpsMetadata related to an application.
# Arguments
- `ops_metadata_arn`: The Amazon Resource Name (ARN) of an OpsMetadata Object to delete.
"""
function delete_ops_metadata(
OpsMetadataArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DeleteOpsMetadata",
Dict{String,Any}("OpsMetadataArn" => OpsMetadataArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_ops_metadata(
OpsMetadataArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"DeleteOpsMetadata",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("OpsMetadataArn" => OpsMetadataArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_parameter(name)
delete_parameter(name, params::Dict{String,<:Any})
Delete a parameter from the system. After deleting a parameter, wait for at least 30
seconds to create a parameter with the same name.
# Arguments
- `name`: The name of the parameter to delete. You can't enter the Amazon Resource Name
(ARN) for a parameter, only the parameter name itself.
"""
function delete_parameter(Name; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"DeleteParameter",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_parameter(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DeleteParameter",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_parameters(names)
delete_parameters(names, params::Dict{String,<:Any})
Delete a list of parameters. After deleting a parameter, wait for at least 30 seconds to
create a parameter with the same name.
# Arguments
- `names`: The names of the parameters to delete. After deleting a parameter, wait for at
least 30 seconds to create a parameter with the same name. You can't enter the Amazon
Resource Name (ARN) for a parameter, only the parameter name itself.
"""
function delete_parameters(Names; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"DeleteParameters",
Dict{String,Any}("Names" => Names);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_parameters(
Names, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DeleteParameters",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Names" => Names), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_patch_baseline(baseline_id)
delete_patch_baseline(baseline_id, params::Dict{String,<:Any})
Deletes a patch baseline.
# Arguments
- `baseline_id`: The ID of the patch baseline to delete.
"""
function delete_patch_baseline(
BaselineId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DeletePatchBaseline",
Dict{String,Any}("BaselineId" => BaselineId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_patch_baseline(
BaselineId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"DeletePatchBaseline",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("BaselineId" => BaselineId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_resource_data_sync(sync_name)
delete_resource_data_sync(sync_name, params::Dict{String,<:Any})
Deletes a resource data sync configuration. After the configuration is deleted, changes to
data on managed nodes are no longer synced to or from the target. Deleting a sync
configuration doesn't delete data.
# Arguments
- `sync_name`: The name of the configuration to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SyncType"`: Specify the type of resource data sync to delete.
"""
function delete_resource_data_sync(
SyncName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DeleteResourceDataSync",
Dict{String,Any}("SyncName" => SyncName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_resource_data_sync(
SyncName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"DeleteResourceDataSync",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SyncName" => SyncName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_resource_policy(policy_hash, policy_id, resource_arn)
delete_resource_policy(policy_hash, policy_id, resource_arn, params::Dict{String,<:Any})
Deletes a Systems Manager resource policy. A resource policy helps you to define the IAM
entity (for example, an Amazon Web Services account) that can manage your Systems Manager
resources. The following resources support Systems Manager resource policies.
OpsItemGroup - The resource policy for OpsItemGroup enables Amazon Web Services accounts to
view and interact with OpsCenter operational work items (OpsItems). Parameter - The
resource policy is used to share a parameter with other accounts using Resource Access
Manager (RAM). For more information about cross-account sharing of parameters, see Working
with shared parameters in the Amazon Web Services Systems Manager User Guide.
# Arguments
- `policy_hash`: ID of the current policy version. The hash helps to prevent multiple calls
from attempting to overwrite a policy.
- `policy_id`: The policy ID.
- `resource_arn`: Amazon Resource Name (ARN) of the resource to which the policies are
attached.
"""
function delete_resource_policy(
PolicyHash, PolicyId, ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DeleteResourcePolicy",
Dict{String,Any}(
"PolicyHash" => PolicyHash, "PolicyId" => PolicyId, "ResourceArn" => ResourceArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_resource_policy(
PolicyHash,
PolicyId,
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"DeleteResourcePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PolicyHash" => PolicyHash,
"PolicyId" => PolicyId,
"ResourceArn" => ResourceArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_managed_instance(instance_id)
deregister_managed_instance(instance_id, params::Dict{String,<:Any})
Removes the server or virtual machine from the list of registered servers. You can
reregister the node again at any time. If you don't plan to use Run Command on the server,
we suggest uninstalling SSM Agent first.
# Arguments
- `instance_id`: The ID assigned to the managed node when you registered it using the
activation process.
"""
function deregister_managed_instance(
InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DeregisterManagedInstance",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_managed_instance(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"DeregisterManagedInstance",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_patch_baseline_for_patch_group(baseline_id, patch_group)
deregister_patch_baseline_for_patch_group(baseline_id, patch_group, params::Dict{String,<:Any})
Removes a patch group from a patch baseline.
# Arguments
- `baseline_id`: The ID of the patch baseline to deregister the patch group from.
- `patch_group`: The name of the patch group that should be deregistered from the patch
baseline.
"""
function deregister_patch_baseline_for_patch_group(
BaselineId, PatchGroup; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DeregisterPatchBaselineForPatchGroup",
Dict{String,Any}("BaselineId" => BaselineId, "PatchGroup" => PatchGroup);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_patch_baseline_for_patch_group(
BaselineId,
PatchGroup,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"DeregisterPatchBaselineForPatchGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("BaselineId" => BaselineId, "PatchGroup" => PatchGroup),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_target_from_maintenance_window(window_id, window_target_id)
deregister_target_from_maintenance_window(window_id, window_target_id, params::Dict{String,<:Any})
Removes a target from a maintenance window.
# Arguments
- `window_id`: The ID of the maintenance window the target should be removed from.
- `window_target_id`: The ID of the target definition to remove.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Safe"`: The system checks if the target is being referenced by a task. If the target is
being referenced, the system returns an error and doesn't deregister the target from the
maintenance window.
"""
function deregister_target_from_maintenance_window(
WindowId, WindowTargetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DeregisterTargetFromMaintenanceWindow",
Dict{String,Any}("WindowId" => WindowId, "WindowTargetId" => WindowTargetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_target_from_maintenance_window(
WindowId,
WindowTargetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"DeregisterTargetFromMaintenanceWindow",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"WindowId" => WindowId, "WindowTargetId" => WindowTargetId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_task_from_maintenance_window(window_id, window_task_id)
deregister_task_from_maintenance_window(window_id, window_task_id, params::Dict{String,<:Any})
Removes a task from a maintenance window.
# Arguments
- `window_id`: The ID of the maintenance window the task should be removed from.
- `window_task_id`: The ID of the task to remove from the maintenance window.
"""
function deregister_task_from_maintenance_window(
WindowId, WindowTaskId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DeregisterTaskFromMaintenanceWindow",
Dict{String,Any}("WindowId" => WindowId, "WindowTaskId" => WindowTaskId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_task_from_maintenance_window(
WindowId,
WindowTaskId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"DeregisterTaskFromMaintenanceWindow",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("WindowId" => WindowId, "WindowTaskId" => WindowTaskId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_activations()
describe_activations(params::Dict{String,<:Any})
Describes details about the activation, such as the date and time the activation was
created, its expiration date, the Identity and Access Management (IAM) role assigned to the
managed nodes in the activation, and the number of nodes registered by using this
activation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: A filter to view information about your activations.
- `"MaxResults"`: The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: A token to start the list. Use this token to get the next set of results.
"""
function describe_activations(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"DescribeActivations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_activations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DescribeActivations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_association()
describe_association(params::Dict{String,<:Any})
Describes the association for the specified target or managed node. If you created the
association by using the Targets parameter, then you must retrieve the association by using
the association ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AssociationId"`: The association ID for which you want information.
- `"AssociationVersion"`: Specify the association version to retrieve. To view the latest
version, either specify LATEST for this parameter, or omit this parameter. To view a list
of all associations for a managed node, use ListAssociations. To get a list of versions for
a specific association, use ListAssociationVersions.
- `"InstanceId"`: The managed node ID.
- `"Name"`: The name of the SSM document.
"""
function describe_association(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"DescribeAssociation"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_association(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DescribeAssociation",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_association_execution_targets(association_id, execution_id)
describe_association_execution_targets(association_id, execution_id, params::Dict{String,<:Any})
Views information about a specific execution of a specific association.
# Arguments
- `association_id`: The association ID that includes the execution for which you want to
view details.
- `execution_id`: The execution ID for which you want to view details.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters for the request. You can specify the following filters and values.
Status (EQUAL) ResourceId (EQUAL) ResourceType (EQUAL)
- `"MaxResults"`: The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: A token to start the list. Use this token to get the next set of results.
"""
function describe_association_execution_targets(
AssociationId, ExecutionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DescribeAssociationExecutionTargets",
Dict{String,Any}("AssociationId" => AssociationId, "ExecutionId" => ExecutionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_association_execution_targets(
AssociationId,
ExecutionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"DescribeAssociationExecutionTargets",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AssociationId" => AssociationId, "ExecutionId" => ExecutionId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_association_executions(association_id)
describe_association_executions(association_id, params::Dict{String,<:Any})
Views all executions for a specific association ID.
# Arguments
- `association_id`: The association ID for which you want to view execution history details.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters for the request. You can specify the following filters and values.
ExecutionId (EQUAL) Status (EQUAL) CreatedTime (EQUAL, GREATER_THAN, LESS_THAN)
- `"MaxResults"`: The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: A token to start the list. Use this token to get the next set of results.
"""
function describe_association_executions(
AssociationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DescribeAssociationExecutions",
Dict{String,Any}("AssociationId" => AssociationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_association_executions(
AssociationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"DescribeAssociationExecutions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AssociationId" => AssociationId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_automation_executions()
describe_automation_executions(params::Dict{String,<:Any})
Provides details about all active and terminated Automation executions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters used to limit the scope of executions that are requested.
- `"MaxResults"`: The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a previous call.)
"""
function describe_automation_executions(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"DescribeAutomationExecutions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_automation_executions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DescribeAutomationExecutions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_automation_step_executions(automation_execution_id)
describe_automation_step_executions(automation_execution_id, params::Dict{String,<:Any})
Information about all active and terminated step executions in an Automation workflow.
# Arguments
- `automation_execution_id`: The Automation execution ID for which you want step execution
descriptions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: One or more filters to limit the number of step executions returned by the
request.
- `"MaxResults"`: The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a previous call.)
- `"ReverseOrder"`: Indicates whether to list step executions in reverse order by start
time. The default value is 'false'.
"""
function describe_automation_step_executions(
AutomationExecutionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DescribeAutomationStepExecutions",
Dict{String,Any}("AutomationExecutionId" => AutomationExecutionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_automation_step_executions(
AutomationExecutionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"DescribeAutomationStepExecutions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AutomationExecutionId" => AutomationExecutionId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_available_patches()
describe_available_patches(params::Dict{String,<:Any})
Lists all patches eligible to be included in a patch baseline. Currently,
DescribeAvailablePatches supports only the Amazon Linux 1, Amazon Linux 2, and Windows
Server operating systems.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Each element in the array is a structure containing a key-value pair.
Windows Server Supported keys for Windows Server managed node patches include the
following: PATCH_SET Sample values: OS | APPLICATION PRODUCT Sample values:
WindowsServer2012 | Office 2010 | MicrosoftDefenderAntivirus PRODUCT_FAMILY Sample
values: Windows | Office MSRC_SEVERITY Sample values: ServicePacks | Important |
Moderate CLASSIFICATION Sample values: ServicePacks | SecurityUpdates |
DefinitionUpdates PATCH_ID Sample values: KB123456 | KB4516046 Linux When
specifying filters for Linux patches, you must specify a key-pair for PRODUCT. For example,
using the Command Line Interface (CLI), the following command fails: aws ssm
describe-available-patches --filters Key=CVE_ID,Values=CVE-2018-3615 However, the
following command succeeds: aws ssm describe-available-patches --filters
Key=PRODUCT,Values=AmazonLinux2018.03 Key=CVE_ID,Values=CVE-2018-3615 Supported keys for
Linux managed node patches include the following: PRODUCT Sample values:
AmazonLinux2018.03 | AmazonLinux2.0 NAME Sample values: kernel-headers |
samba-python | php SEVERITY Sample values: Critical | Important | Medium | Low
EPOCH Sample values: 0 | 1 VERSION Sample values: 78.6.1 | 4.10.16 RELEASE
Sample values: 9.56.amzn1 | 1.amzn2 ARCH Sample values: i686 | x86_64
REPOSITORY Sample values: Core | Updates ADVISORY_ID Sample values: ALAS-2018-1058
| ALAS2-2021-1594 CVE_ID Sample values: CVE-2018-3615 | CVE-2020-1472
BUGZILLA_ID Sample values: 1463241
- `"MaxResults"`: The maximum number of patches to return (per page).
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a previous call.)
"""
function describe_available_patches(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"DescribeAvailablePatches"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_available_patches(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DescribeAvailablePatches",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_document(name)
describe_document(name, params::Dict{String,<:Any})
Describes the specified Amazon Web Services Systems Manager document (SSM document).
# Arguments
- `name`: The name of the SSM document.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DocumentVersion"`: The document version for which you want information. Can be a
specific version or the default version.
- `"VersionName"`: An optional field specifying the version of the artifact associated with
the document. For example, 12.6. This value is unique across all versions of a document,
and can't be changed.
"""
function describe_document(Name; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"DescribeDocument",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_document(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DescribeDocument",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_document_permission(name, permission_type)
describe_document_permission(name, permission_type, params::Dict{String,<:Any})
Describes the permissions for a Amazon Web Services Systems Manager document (SSM
document). If you created the document, you are the owner. If a document is shared, it can
either be shared privately (by specifying a user's Amazon Web Services account ID) or
publicly (All).
# Arguments
- `name`: The name of the document for which you are the owner.
- `permission_type`: The permission type for the document. The permission type can be Share.
# 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 call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a previous call.)
"""
function describe_document_permission(
Name, PermissionType; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DescribeDocumentPermission",
Dict{String,Any}("Name" => Name, "PermissionType" => PermissionType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_document_permission(
Name,
PermissionType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"DescribeDocumentPermission",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Name" => Name, "PermissionType" => PermissionType),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_effective_instance_associations(instance_id)
describe_effective_instance_associations(instance_id, params::Dict{String,<:Any})
All associations for the managed nodes.
# Arguments
- `instance_id`: The managed node ID for which you want to view all associations.
# 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 call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a previous call.)
"""
function describe_effective_instance_associations(
InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DescribeEffectiveInstanceAssociations",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_effective_instance_associations(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"DescribeEffectiveInstanceAssociations",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_effective_patches_for_patch_baseline(baseline_id)
describe_effective_patches_for_patch_baseline(baseline_id, params::Dict{String,<:Any})
Retrieves the current effective patches (the patch and the approval state) for the
specified patch baseline. Applies to patch baselines for Windows only.
# Arguments
- `baseline_id`: The ID of the patch baseline to retrieve the effective patches for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of patches to return (per page).
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a previous call.)
"""
function describe_effective_patches_for_patch_baseline(
BaselineId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DescribeEffectivePatchesForPatchBaseline",
Dict{String,Any}("BaselineId" => BaselineId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_effective_patches_for_patch_baseline(
BaselineId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"DescribeEffectivePatchesForPatchBaseline",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("BaselineId" => BaselineId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_instance_associations_status(instance_id)
describe_instance_associations_status(instance_id, params::Dict{String,<:Any})
The status of the associations for the managed nodes.
# Arguments
- `instance_id`: The managed node IDs for which you want association status information.
# 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 call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a previous call.)
"""
function describe_instance_associations_status(
InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DescribeInstanceAssociationsStatus",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_instance_associations_status(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"DescribeInstanceAssociationsStatus",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_instance_information()
describe_instance_information(params::Dict{String,<:Any})
Provides information about one or more of your managed nodes, including the operating
system platform, SSM Agent version, association status, and IP address. This operation does
not return information for nodes that are either Stopped or Terminated. If you specify one
or more node IDs, the operation returns information for those managed nodes. If you don't
specify node IDs, it returns information for all your managed nodes. If you specify a node
ID that isn't valid or a node that you don't own, you receive an error. The IamRole field
returned for this API operation is the Identity and Access Management (IAM) role assigned
to on-premises managed nodes. This operation does not return the IAM role for EC2
instances.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: One or more filters. Use a filter to return a more specific list of managed
nodes. You can filter based on tags applied to your managed nodes. Tag filters can't be
combined with other filter types. Use this Filters data type instead of
InstanceInformationFilterList, which is deprecated.
- `"InstanceInformationFilterList"`: This is a legacy method. We recommend that you don't
use this method. Instead, use the Filters data type. Filters enables you to return node
information by filtering based on tags applied to managed nodes. Attempting to use
InstanceInformationFilterList and Filters leads to an exception error.
- `"MaxResults"`: The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
The default value is 10 items.
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a previous call.)
"""
function describe_instance_information(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"DescribeInstanceInformation";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_instance_information(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DescribeInstanceInformation",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_instance_patch_states(instance_ids)
describe_instance_patch_states(instance_ids, params::Dict{String,<:Any})
Retrieves the high-level patch state of one or more managed nodes.
# Arguments
- `instance_ids`: The ID of the managed node for which patch state information should be
retrieved.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of managed nodes to return (per page).
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a previous call.)
"""
function describe_instance_patch_states(
InstanceIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DescribeInstancePatchStates",
Dict{String,Any}("InstanceIds" => InstanceIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_instance_patch_states(
InstanceIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"DescribeInstancePatchStates",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceIds" => InstanceIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_instance_patch_states_for_patch_group(patch_group)
describe_instance_patch_states_for_patch_group(patch_group, params::Dict{String,<:Any})
Retrieves the high-level patch state for the managed nodes in the specified patch group.
# Arguments
- `patch_group`: The name of the patch group for which the patch state information should
be retrieved.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Each entry in the array is a structure containing: Key (string between 1
and 200 characters) Values (array containing a single string) Type (string \"Equal\",
\"NotEqual\", \"LessThan\", \"GreaterThan\")
- `"MaxResults"`: The maximum number of patches to return (per page).
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a previous call.)
"""
function describe_instance_patch_states_for_patch_group(
PatchGroup; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DescribeInstancePatchStatesForPatchGroup",
Dict{String,Any}("PatchGroup" => PatchGroup);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_instance_patch_states_for_patch_group(
PatchGroup,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"DescribeInstancePatchStatesForPatchGroup",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PatchGroup" => PatchGroup), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_instance_patches(instance_id)
describe_instance_patches(instance_id, params::Dict{String,<:Any})
Retrieves information about the patches on the specified managed node and their state
relative to the patch baseline being used for the node.
# Arguments
- `instance_id`: The ID of the managed node whose patch state information should be
retrieved.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Each element in the array is a structure containing a key-value pair.
Supported keys for DescribeInstancePatchesinclude the following: Classification
Sample values: Security | SecurityUpdates KBId Sample values: KB4480056 |
java-1.7.0-openjdk.x86_64 Severity Sample values: Important | Medium | Low
State Sample values: Installed | InstalledOther | InstalledPendingReboot For lists of
all State values, see Understanding patch compliance state values in the Amazon Web
Services Systems Manager User Guide.
- `"MaxResults"`: The maximum number of patches to return (per page).
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a previous call.)
"""
function describe_instance_patches(
InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DescribeInstancePatches",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_instance_patches(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"DescribeInstancePatches",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_instance_properties()
describe_instance_properties(params::Dict{String,<:Any})
An API operation used by the Systems Manager console to display information about Systems
Manager managed nodes.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FiltersWithOperator"`: The request filters to use with the operator.
- `"InstancePropertyFilterList"`: An array of instance property filters.
- `"MaxResults"`: The maximum number of items to return for the call. The call also returns
a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: The token provided by a previous request to use to return the next set of
properties.
"""
function describe_instance_properties(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"DescribeInstanceProperties"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_instance_properties(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DescribeInstanceProperties",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_inventory_deletions()
describe_inventory_deletions(params::Dict{String,<:Any})
Describes a specific delete inventory operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeletionId"`: Specify the delete inventory ID for which you want information. This ID
was returned by the DeleteInventory operation.
- `"MaxResults"`: The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: A token to start the list. Use this token to get the next set of results.
"""
function describe_inventory_deletions(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"DescribeInventoryDeletions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_inventory_deletions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DescribeInventoryDeletions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_maintenance_window_execution_task_invocations(task_id, window_execution_id)
describe_maintenance_window_execution_task_invocations(task_id, window_execution_id, params::Dict{String,<:Any})
Retrieves the individual task executions (one per target) for a particular task run as part
of a maintenance window execution.
# Arguments
- `task_id`: The ID of the specific task in the maintenance window task that should be
retrieved.
- `window_execution_id`: The ID of the maintenance window execution the task is part of.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Optional filters used to scope down the returned task invocations. The
supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS,
FAILED, TIMED_OUT, CANCELLING, and CANCELLED.
- `"MaxResults"`: The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a previous call.)
"""
function describe_maintenance_window_execution_task_invocations(
TaskId, WindowExecutionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DescribeMaintenanceWindowExecutionTaskInvocations",
Dict{String,Any}("TaskId" => TaskId, "WindowExecutionId" => WindowExecutionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_maintenance_window_execution_task_invocations(
TaskId,
WindowExecutionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"DescribeMaintenanceWindowExecutionTaskInvocations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TaskId" => TaskId, "WindowExecutionId" => WindowExecutionId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_maintenance_window_execution_tasks(window_execution_id)
describe_maintenance_window_execution_tasks(window_execution_id, params::Dict{String,<:Any})
For a given maintenance window execution, lists the tasks that were run.
# Arguments
- `window_execution_id`: The ID of the maintenance window execution whose task executions
should be retrieved.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Optional filters used to scope down the returned tasks. The supported filter
key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED,
TIMED_OUT, CANCELLING, and CANCELLED.
- `"MaxResults"`: The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a previous call.)
"""
function describe_maintenance_window_execution_tasks(
WindowExecutionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DescribeMaintenanceWindowExecutionTasks",
Dict{String,Any}("WindowExecutionId" => WindowExecutionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_maintenance_window_execution_tasks(
WindowExecutionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"DescribeMaintenanceWindowExecutionTasks",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("WindowExecutionId" => WindowExecutionId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_maintenance_window_executions(window_id)
describe_maintenance_window_executions(window_id, params::Dict{String,<:Any})
Lists the executions of a maintenance window. This includes information about when the
maintenance window was scheduled to be active, and information about tasks registered and
run with the maintenance window.
# Arguments
- `window_id`: The ID of the maintenance window whose executions should be retrieved.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Each entry in the array is a structure containing: Key. A string between 1
and 128 characters. Supported keys include ExecutedBefore and ExecutedAfter. Values. An
array of strings, each between 1 and 256 characters. Supported values are date/time strings
in a valid ISO 8601 date/time format, such as 2021-11-04T05:00:00Z.
- `"MaxResults"`: The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a previous call.)
"""
function describe_maintenance_window_executions(
WindowId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DescribeMaintenanceWindowExecutions",
Dict{String,Any}("WindowId" => WindowId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_maintenance_window_executions(
WindowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"DescribeMaintenanceWindowExecutions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("WindowId" => WindowId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_maintenance_window_schedule()
describe_maintenance_window_schedule(params::Dict{String,<:Any})
Retrieves information about upcoming executions of a maintenance window.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters used to limit the range of results. For example, you can limit
maintenance window executions to only those scheduled before or after a certain date and
time.
- `"MaxResults"`: The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a previous call.)
- `"ResourceType"`: The type of resource you want to retrieve information about. For
example, INSTANCE.
- `"Targets"`: The managed node ID or key-value pair to retrieve information about.
- `"WindowId"`: The ID of the maintenance window to retrieve information about.
"""
function describe_maintenance_window_schedule(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DescribeMaintenanceWindowSchedule";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_maintenance_window_schedule(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DescribeMaintenanceWindowSchedule",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_maintenance_window_targets(window_id)
describe_maintenance_window_targets(window_id, params::Dict{String,<:Any})
Lists the targets registered with the maintenance window.
# Arguments
- `window_id`: The ID of the maintenance window whose targets should be retrieved.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Optional filters that can be used to narrow down the scope of the returned
window targets. The supported filter keys are Type, WindowTargetId, and OwnerInformation.
- `"MaxResults"`: The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a previous call.)
"""
function describe_maintenance_window_targets(
WindowId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DescribeMaintenanceWindowTargets",
Dict{String,Any}("WindowId" => WindowId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_maintenance_window_targets(
WindowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"DescribeMaintenanceWindowTargets",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("WindowId" => WindowId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_maintenance_window_tasks(window_id)
describe_maintenance_window_tasks(window_id, params::Dict{String,<:Any})
Lists the tasks in a maintenance window. For maintenance window tasks without a specified
target, you can't supply values for --max-errors and --max-concurrency. Instead, the system
inserts a placeholder value of 1, which may be reported in the response to this command.
These values don't affect the running of your task and can be ignored.
# Arguments
- `window_id`: The ID of the maintenance window whose tasks should be retrieved.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Optional filters used to narrow down the scope of the returned tasks. The
supported filter keys are WindowTaskId, TaskArn, Priority, and TaskType.
- `"MaxResults"`: The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a previous call.)
"""
function describe_maintenance_window_tasks(
WindowId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DescribeMaintenanceWindowTasks",
Dict{String,Any}("WindowId" => WindowId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_maintenance_window_tasks(
WindowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"DescribeMaintenanceWindowTasks",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("WindowId" => WindowId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_maintenance_windows()
describe_maintenance_windows(params::Dict{String,<:Any})
Retrieves the maintenance windows in an Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Optional filters used to narrow down the scope of the returned maintenance
windows. Supported filter keys are Name and Enabled. For example, Name=MyMaintenanceWindow
and Enabled=True.
- `"MaxResults"`: The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a previous call.)
"""
function describe_maintenance_windows(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"DescribeMaintenanceWindows"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_maintenance_windows(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DescribeMaintenanceWindows",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_maintenance_windows_for_target(resource_type, targets)
describe_maintenance_windows_for_target(resource_type, targets, params::Dict{String,<:Any})
Retrieves information about the maintenance window targets or tasks that a managed node is
associated with.
# Arguments
- `resource_type`: The type of resource you want to retrieve information about. For
example, INSTANCE.
- `targets`: The managed node ID or key-value pair to retrieve information about.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a previous call.)
"""
function describe_maintenance_windows_for_target(
ResourceType, Targets; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DescribeMaintenanceWindowsForTarget",
Dict{String,Any}("ResourceType" => ResourceType, "Targets" => Targets);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_maintenance_windows_for_target(
ResourceType,
Targets,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"DescribeMaintenanceWindowsForTarget",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceType" => ResourceType, "Targets" => Targets),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_ops_items()
describe_ops_items(params::Dict{String,<:Any})
Query a set of OpsItems. You must have permission in Identity and Access Management (IAM)
to query a list of OpsItems. For more information, see Set up OpsCenter in the Amazon Web
Services Systems Manager User Guide. Operations engineers and IT professionals use Amazon
Web Services Systems Manager OpsCenter to view, investigate, and remediate operational
issues impacting the performance and health of their Amazon Web Services resources. For
more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web
Services Systems Manager User Guide.
# 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 call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: A token to start the list. Use this token to get the next set of results.
- `"OpsItemFilters"`: One or more filters to limit the response. Key: CreatedTime
Operations: GreaterThan, LessThan Key: LastModifiedBy Operations: Contains, Equals Key:
LastModifiedTime Operations: GreaterThan, LessThan Key: Priority Operations: Equals
Key: Source Operations: Contains, Equals Key: Status Operations: Equals Key: Title*
Operations: Equals,Contains Key: OperationalData** Operations: Equals Key:
OperationalDataKey Operations: Equals Key: OperationalDataValue Operations: Equals,
Contains Key: OpsItemId Operations: Equals Key: ResourceId Operations: Contains Key:
AutomationId Operations: Equals Key: AccountId Operations: Equals *The Equals operator
for Title matches the first 100 characters. If you specify more than 100 characters, they
system returns an error that the filter value exceeds the length limit. **If you filter the
response by using the OperationalData operator, specify a key-value pair by using the
following JSON format: {\"key\":\"key_name\",\"value\":\"a_value\"}
"""
function describe_ops_items(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm("DescribeOpsItems"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_ops_items(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DescribeOpsItems", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_parameters()
describe_parameters(params::Dict{String,<:Any})
Lists the parameters in your Amazon Web Services account or the parameters shared with you
when you enable the Shared option. Request results are returned on a best-effort basis. If
you specify MaxResults in the request, the response includes information up to the limit
specified. The number of items returned, however, can be between zero and the value of
MaxResults. If the service reaches an internal limit while processing the results, it stops
the operation and returns the matching values up to that point and a NextToken. You can
specify the NextToken in a subsequent call to get the next set of results. If you change
the KMS key alias for the KMS key used to encrypt a parameter, then you must also update
the key alias the parameter uses to reference KMS. Otherwise, DescribeParameters retrieves
whatever the original key alias was referencing.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: This data type is deprecated. Instead, use ParameterFilters.
- `"MaxResults"`: The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a previous call.)
- `"ParameterFilters"`: Filters to limit the request results.
- `"Shared"`: Lists parameters that are shared with you. By default when using this
option, the command returns parameters that have been shared using a standard Resource
Access Manager Resource Share. In order for a parameter that was shared using the
PutResourcePolicy command to be returned, the associated RAM Resource Share Created From
Policy must have been promoted to a standard Resource Share using the RAM
PromoteResourceShareCreatedFromPolicy API operation. For more information about sharing
parameters, see Working with shared parameters in the Amazon Web Services Systems Manager
User Guide.
"""
function describe_parameters(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm("DescribeParameters"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_parameters(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DescribeParameters", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_patch_baselines()
describe_patch_baselines(params::Dict{String,<:Any})
Lists the patch baselines in your Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Each element in the array is a structure containing a key-value pair.
Supported keys for DescribePatchBaselines include the following: NAME_PREFIX Sample
values: AWS- | My- OWNER Sample values: AWS | Self OPERATING_SYSTEM Sample
values: AMAZON_LINUX | SUSE | WINDOWS
- `"MaxResults"`: The maximum number of patch baselines to return (per page).
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a previous call.)
"""
function describe_patch_baselines(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"DescribePatchBaselines"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_patch_baselines(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DescribePatchBaselines",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_patch_group_state(patch_group)
describe_patch_group_state(patch_group, params::Dict{String,<:Any})
Returns high-level aggregated patch compliance state information for a patch group.
# Arguments
- `patch_group`: The name of the patch group whose patch snapshot should be retrieved.
"""
function describe_patch_group_state(
PatchGroup; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DescribePatchGroupState",
Dict{String,Any}("PatchGroup" => PatchGroup);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_patch_group_state(
PatchGroup,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"DescribePatchGroupState",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PatchGroup" => PatchGroup), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_patch_groups()
describe_patch_groups(params::Dict{String,<:Any})
Lists all patch groups that have been registered with patch baselines.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Each element in the array is a structure containing a key-value pair.
Supported keys for DescribePatchGroups include the following: NAME_PREFIX Sample
values: AWS- | My-. OPERATING_SYSTEM Sample values: AMAZON_LINUX | SUSE | WINDOWS
- `"MaxResults"`: The maximum number of patch groups to return (per page).
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a previous call.)
"""
function describe_patch_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"DescribePatchGroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_patch_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DescribePatchGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_patch_properties(operating_system, property)
describe_patch_properties(operating_system, property, params::Dict{String,<:Any})
Lists the properties of available patches organized by product, product family,
classification, severity, and other properties of available patches. You can use the
reported properties in the filters you specify in requests for operations such as
CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and
DescribePatchBaselines. The following section lists the properties that can be used in
filters for each major operating system type: AMAZON_LINUX Valid properties: PRODUCT |
CLASSIFICATION | SEVERITY AMAZON_LINUX_2 Valid properties: PRODUCT | CLASSIFICATION |
SEVERITY CENTOS Valid properties: PRODUCT | CLASSIFICATION | SEVERITY DEBIAN Valid
properties: PRODUCT | PRIORITY MACOS Valid properties: PRODUCT | CLASSIFICATION
ORACLE_LINUX Valid properties: PRODUCT | CLASSIFICATION | SEVERITY
REDHAT_ENTERPRISE_LINUX Valid properties: PRODUCT | CLASSIFICATION | SEVERITY SUSE
Valid properties: PRODUCT | CLASSIFICATION | SEVERITY UBUNTU Valid properties: PRODUCT |
PRIORITY WINDOWS Valid properties: PRODUCT | PRODUCT_FAMILY | CLASSIFICATION |
MSRC_SEVERITY
# Arguments
- `operating_system`: The operating system type for which to list patches.
- `property`: The patch property for which you want to view patch details.
# 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 call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a previous call.)
- `"PatchSet"`: Indicates whether to list patches for the Windows operating system or for
applications released by Microsoft. Not applicable for the Linux or macOS operating systems.
"""
function describe_patch_properties(
OperatingSystem, Property; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DescribePatchProperties",
Dict{String,Any}("OperatingSystem" => OperatingSystem, "Property" => Property);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_patch_properties(
OperatingSystem,
Property,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"DescribePatchProperties",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"OperatingSystem" => OperatingSystem, "Property" => Property
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_sessions(state)
describe_sessions(state, params::Dict{String,<:Any})
Retrieves a list of all active sessions (both connected and disconnected) or terminated
sessions from the past 30 days.
# Arguments
- `state`: The session status to retrieve a list of sessions for. For example, \"Active\".
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: One or more filters to limit the type of sessions returned by the request.
- `"MaxResults"`: The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a previous call.)
"""
function describe_sessions(State; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"DescribeSessions",
Dict{String,Any}("State" => State);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_sessions(
State, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DescribeSessions",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("State" => State), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_ops_item_related_item(association_id, ops_item_id)
disassociate_ops_item_related_item(association_id, ops_item_id, params::Dict{String,<:Any})
Deletes the association between an OpsItem and a related item. For example, this API
operation can delete an Incident Manager incident from an OpsItem. Incident Manager is a
capability of Amazon Web Services Systems Manager.
# Arguments
- `association_id`: The ID of the association for which you want to delete an association
between the OpsItem and a related item.
- `ops_item_id`: The ID of the OpsItem for which you want to delete an association between
the OpsItem and a related item.
"""
function disassociate_ops_item_related_item(
AssociationId, OpsItemId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"DisassociateOpsItemRelatedItem",
Dict{String,Any}("AssociationId" => AssociationId, "OpsItemId" => OpsItemId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_ops_item_related_item(
AssociationId,
OpsItemId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"DisassociateOpsItemRelatedItem",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AssociationId" => AssociationId, "OpsItemId" => OpsItemId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_automation_execution(automation_execution_id)
get_automation_execution(automation_execution_id, params::Dict{String,<:Any})
Get detailed information about a particular Automation execution.
# Arguments
- `automation_execution_id`: The unique identifier for an existing automation execution to
examine. The execution ID is returned by StartAutomationExecution when the execution of an
Automation runbook is initiated.
"""
function get_automation_execution(
AutomationExecutionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"GetAutomationExecution",
Dict{String,Any}("AutomationExecutionId" => AutomationExecutionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_automation_execution(
AutomationExecutionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"GetAutomationExecution",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AutomationExecutionId" => AutomationExecutionId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_calendar_state(calendar_names)
get_calendar_state(calendar_names, params::Dict{String,<:Any})
Gets the state of a Amazon Web Services Systems Manager change calendar at the current time
or a specified time. If you specify a time, GetCalendarState returns the state of the
calendar at that specific time, and returns the next time that the change calendar state
will transition. If you don't specify a time, GetCalendarState uses the current time.
Change Calendar entries have two possible states: OPEN or CLOSED. If you specify more than
one calendar in a request, the command returns the status of OPEN only if all calendars in
the request are open. If one or more calendars in the request are closed, the status
returned is CLOSED. For more information about Change Calendar, a capability of Amazon Web
Services Systems Manager, see Amazon Web Services Systems Manager Change Calendar in the
Amazon Web Services Systems Manager User Guide.
# Arguments
- `calendar_names`: The names or Amazon Resource Names (ARNs) of the Systems Manager
documents (SSM documents) that represent the calendar entries for which you want to get the
state.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AtTime"`: (Optional) The specific time for which you want to get calendar state
information, in ISO 8601 format. If you don't specify a value or AtTime, the current time
is used.
"""
function get_calendar_state(
CalendarNames; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"GetCalendarState",
Dict{String,Any}("CalendarNames" => CalendarNames);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_calendar_state(
CalendarNames,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"GetCalendarState",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("CalendarNames" => CalendarNames), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_command_invocation(command_id, instance_id)
get_command_invocation(command_id, instance_id, params::Dict{String,<:Any})
Returns detailed information about command execution for an invocation or plugin.
GetCommandInvocation only gives the execution status of a plugin in a document. To get the
command execution status on a specific managed node, use ListCommandInvocations. To get the
command execution status across managed nodes, use ListCommands.
# Arguments
- `command_id`: (Required) The parent command ID of the invocation plugin.
- `instance_id`: (Required) The ID of the managed node targeted by the command. A managed
node can be an Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, and
on-premises server or VM in your hybrid environment that is configured for Amazon Web
Services Systems Manager.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PluginName"`: The name of the step for which you want detailed results. If the document
contains only one step, you can omit the name and details for that step. If the document
contains more than one step, you must specify the name of the step for which you want to
view details. Be sure to specify the name of the step, not the name of a plugin like
aws:RunShellScript. To find the PluginName, check the document content and find the name of
the step you want details for. Alternatively, use ListCommandInvocations with the CommandId
and Details parameters. The PluginName is the Name attribute of the CommandPlugin object in
the CommandPlugins list.
"""
function get_command_invocation(
CommandId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"GetCommandInvocation",
Dict{String,Any}("CommandId" => CommandId, "InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_command_invocation(
CommandId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"GetCommandInvocation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CommandId" => CommandId, "InstanceId" => InstanceId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_connection_status(target)
get_connection_status(target, params::Dict{String,<:Any})
Retrieves the Session Manager connection status for a managed node to determine whether it
is running and ready to receive Session Manager connections.
# Arguments
- `target`: The managed node ID.
"""
function get_connection_status(Target; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"GetConnectionStatus",
Dict{String,Any}("Target" => Target);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_connection_status(
Target, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"GetConnectionStatus",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Target" => Target), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_default_patch_baseline()
get_default_patch_baseline(params::Dict{String,<:Any})
Retrieves the default patch baseline. Amazon Web Services Systems Manager supports creating
multiple default patch baselines. For example, you can create a default patch baseline for
each operating system. If you don't specify an operating system value, the default patch
baseline for Windows is returned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"OperatingSystem"`: Returns the default patch baseline for the specified operating
system.
"""
function get_default_patch_baseline(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"GetDefaultPatchBaseline"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_default_patch_baseline(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"GetDefaultPatchBaseline",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_deployable_patch_snapshot_for_instance(instance_id, snapshot_id)
get_deployable_patch_snapshot_for_instance(instance_id, snapshot_id, params::Dict{String,<:Any})
Retrieves the current snapshot for the patch baseline the managed node uses. This API is
primarily used by the AWS-RunPatchBaseline Systems Manager document (SSM document). If you
run the command locally, such as with the Command Line Interface (CLI), the system attempts
to use your local Amazon Web Services credentials and the operation fails. To avoid this,
you can run the command in the Amazon Web Services Systems Manager console. Use Run
Command, a capability of Amazon Web Services Systems Manager, with an SSM document that
enables you to target a managed node with a script or command. For example, run the command
using the AWS-RunShellScript document or the AWS-RunPowerShellScript document.
# Arguments
- `instance_id`: The ID of the managed node for which the appropriate patch snapshot should
be retrieved.
- `snapshot_id`: The snapshot ID provided by the user when running AWS-RunPatchBaseline.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BaselineOverride"`: Defines the basic information about a patch baseline override.
"""
function get_deployable_patch_snapshot_for_instance(
InstanceId, SnapshotId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"GetDeployablePatchSnapshotForInstance",
Dict{String,Any}("InstanceId" => InstanceId, "SnapshotId" => SnapshotId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_deployable_patch_snapshot_for_instance(
InstanceId,
SnapshotId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"GetDeployablePatchSnapshotForInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InstanceId" => InstanceId, "SnapshotId" => SnapshotId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_document(name)
get_document(name, params::Dict{String,<:Any})
Gets the contents of the specified Amazon Web Services Systems Manager document (SSM
document).
# Arguments
- `name`: The name of the SSM document.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DocumentFormat"`: Returns the document in the specified format. The document format can
be either JSON or YAML. JSON is the default format.
- `"DocumentVersion"`: The document version for which you want information.
- `"VersionName"`: An optional field specifying the version of the artifact associated with
the document. For example, 12.6. This value is unique across all versions of a document and
can't be changed.
"""
function get_document(Name; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"GetDocument",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_document(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"GetDocument",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_inventory()
get_inventory(params::Dict{String,<:Any})
Query inventory information. This includes managed node status, such as Stopped or
Terminated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Aggregators"`: Returns counts of inventory types based on one or more expressions. For
example, if you aggregate by using an expression that uses the
AWS:InstanceInformation.PlatformType type, you can see a count of how many Windows and
Linux managed nodes exist in your inventoried fleet.
- `"Filters"`: One or more filters. Use a filter to return a more specific list of results.
- `"MaxResults"`: The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a previous call.)
- `"ResultAttributes"`: The list of inventory item types to return.
"""
function get_inventory(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm("GetInventory"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_inventory(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"GetInventory", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_inventory_schema()
get_inventory_schema(params::Dict{String,<:Any})
Return a list of inventory type names for the account, or return a list of attribute names
for a specific Inventory item type.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Aggregator"`: Returns inventory schemas that support aggregation. For example, this
call returns the AWS:InstanceInformation type, because it supports aggregation based on the
PlatformName, PlatformType, and PlatformVersion attributes.
- `"MaxResults"`: The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a previous call.)
- `"SubType"`: Returns the sub-type schema for a specified inventory type.
- `"TypeName"`: The type of inventory item to return.
"""
function get_inventory_schema(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm("GetInventorySchema"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_inventory_schema(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"GetInventorySchema", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_maintenance_window(window_id)
get_maintenance_window(window_id, params::Dict{String,<:Any})
Retrieves a maintenance window.
# Arguments
- `window_id`: The ID of the maintenance window for which you want to retrieve information.
"""
function get_maintenance_window(WindowId; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"GetMaintenanceWindow",
Dict{String,Any}("WindowId" => WindowId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_maintenance_window(
WindowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"GetMaintenanceWindow",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("WindowId" => WindowId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_maintenance_window_execution(window_execution_id)
get_maintenance_window_execution(window_execution_id, params::Dict{String,<:Any})
Retrieves details about a specific a maintenance window execution.
# Arguments
- `window_execution_id`: The ID of the maintenance window execution that includes the task.
"""
function get_maintenance_window_execution(
WindowExecutionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"GetMaintenanceWindowExecution",
Dict{String,Any}("WindowExecutionId" => WindowExecutionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_maintenance_window_execution(
WindowExecutionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"GetMaintenanceWindowExecution",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("WindowExecutionId" => WindowExecutionId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_maintenance_window_execution_task(task_id, window_execution_id)
get_maintenance_window_execution_task(task_id, window_execution_id, params::Dict{String,<:Any})
Retrieves the details about a specific task run as part of a maintenance window execution.
# Arguments
- `task_id`: The ID of the specific task execution in the maintenance window task that
should be retrieved.
- `window_execution_id`: The ID of the maintenance window execution that includes the task.
"""
function get_maintenance_window_execution_task(
TaskId, WindowExecutionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"GetMaintenanceWindowExecutionTask",
Dict{String,Any}("TaskId" => TaskId, "WindowExecutionId" => WindowExecutionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_maintenance_window_execution_task(
TaskId,
WindowExecutionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"GetMaintenanceWindowExecutionTask",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TaskId" => TaskId, "WindowExecutionId" => WindowExecutionId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_maintenance_window_execution_task_invocation(invocation_id, task_id, window_execution_id)
get_maintenance_window_execution_task_invocation(invocation_id, task_id, window_execution_id, params::Dict{String,<:Any})
Retrieves information about a specific task running on a specific target.
# Arguments
- `invocation_id`: The invocation ID to retrieve.
- `task_id`: The ID of the specific task in the maintenance window task that should be
retrieved.
- `window_execution_id`: The ID of the maintenance window execution for which the task is a
part.
"""
function get_maintenance_window_execution_task_invocation(
InvocationId,
TaskId,
WindowExecutionId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"GetMaintenanceWindowExecutionTaskInvocation",
Dict{String,Any}(
"InvocationId" => InvocationId,
"TaskId" => TaskId,
"WindowExecutionId" => WindowExecutionId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_maintenance_window_execution_task_invocation(
InvocationId,
TaskId,
WindowExecutionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"GetMaintenanceWindowExecutionTaskInvocation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InvocationId" => InvocationId,
"TaskId" => TaskId,
"WindowExecutionId" => WindowExecutionId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_maintenance_window_task(window_id, window_task_id)
get_maintenance_window_task(window_id, window_task_id, params::Dict{String,<:Any})
Retrieves the details of a maintenance window task. For maintenance window tasks without a
specified target, you can't supply values for --max-errors and --max-concurrency. Instead,
the system inserts a placeholder value of 1, which may be reported in the response to this
command. These values don't affect the running of your task and can be ignored. To
retrieve a list of tasks in a maintenance window, instead use the
DescribeMaintenanceWindowTasks command.
# Arguments
- `window_id`: The maintenance window ID that includes the task to retrieve.
- `window_task_id`: The maintenance window task ID to retrieve.
"""
function get_maintenance_window_task(
WindowId, WindowTaskId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"GetMaintenanceWindowTask",
Dict{String,Any}("WindowId" => WindowId, "WindowTaskId" => WindowTaskId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_maintenance_window_task(
WindowId,
WindowTaskId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"GetMaintenanceWindowTask",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("WindowId" => WindowId, "WindowTaskId" => WindowTaskId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_ops_item(ops_item_id)
get_ops_item(ops_item_id, params::Dict{String,<:Any})
Get information about an OpsItem by using the ID. You must have permission in Identity and
Access Management (IAM) to view information about an OpsItem. For more information, see Set
up OpsCenter in the Amazon Web Services Systems Manager User Guide. Operations engineers
and IT professionals use Amazon Web Services Systems Manager OpsCenter to view,
investigate, and remediate operational issues impacting the performance and health of their
Amazon Web Services resources. For more information, see Amazon Web Services Systems
Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.
# Arguments
- `ops_item_id`: The ID of the OpsItem that you want to get.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"OpsItemArn"`: The OpsItem Amazon Resource Name (ARN).
"""
function get_ops_item(OpsItemId; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"GetOpsItem",
Dict{String,Any}("OpsItemId" => OpsItemId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_ops_item(
OpsItemId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"GetOpsItem",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("OpsItemId" => OpsItemId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_ops_metadata(ops_metadata_arn)
get_ops_metadata(ops_metadata_arn, params::Dict{String,<:Any})
View operational metadata related to an application in Application Manager.
# Arguments
- `ops_metadata_arn`: The Amazon Resource Name (ARN) of an OpsMetadata Object to view.
# 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 call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: A token to start the list. Use this token to get the next set of results.
"""
function get_ops_metadata(OpsMetadataArn; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"GetOpsMetadata",
Dict{String,Any}("OpsMetadataArn" => OpsMetadataArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_ops_metadata(
OpsMetadataArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"GetOpsMetadata",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("OpsMetadataArn" => OpsMetadataArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_ops_summary()
get_ops_summary(params::Dict{String,<:Any})
View a summary of operations metadata (OpsData) based on specified filters and aggregators.
OpsData can include information about Amazon Web Services Systems Manager OpsCenter
operational workitems (OpsItems) as well as information about any Amazon Web Services
resource or service configured to report OpsData to Amazon Web Services Systems Manager
Explorer.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Aggregators"`: Optional aggregators that return counts of OpsData based on one or more
expressions.
- `"Filters"`: Optional filters used to scope down the returned OpsData.
- `"MaxResults"`: The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: A token to start the list. Use this token to get the next set of results.
- `"ResultAttributes"`: The OpsData data type to return.
- `"SyncName"`: Specify the name of a resource data sync to get.
"""
function get_ops_summary(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm("GetOpsSummary"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_ops_summary(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"GetOpsSummary", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_parameter(name)
get_parameter(name, params::Dict{String,<:Any})
Get information about a single parameter by specifying the parameter name. To get
information about more than one parameter at a time, use the GetParameters operation.
# Arguments
- `name`: The name or Amazon Resource Name (ARN) of the parameter that you want to query.
For parameters shared with you from another account, you must use the full ARN. To query by
parameter label, use \"Name\": \"name:label\". To query by parameter version, use \"Name\":
\"name:version\". For more information about shared parameters, see Working with shared
parameters in the Amazon Web Services Systems Manager User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"WithDecryption"`: Return decrypted values for secure string parameters. This flag is
ignored for String and StringList parameter types.
"""
function get_parameter(Name; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"GetParameter",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_parameter(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"GetParameter",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_parameter_history(name)
get_parameter_history(name, params::Dict{String,<:Any})
Retrieves the history of all changes to a parameter. If you change the KMS key alias for
the KMS key used to encrypt a parameter, then you must also update the key alias the
parameter uses to reference KMS. Otherwise, GetParameterHistory retrieves whatever the
original key alias was referencing.
# Arguments
- `name`: The name or Amazon Resource Name (ARN) of the parameter for which you want to
review history. For parameters shared with you from another account, you must use the full
ARN.
# 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 call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a previous call.)
- `"WithDecryption"`: Return decrypted values for secure string parameters. This flag is
ignored for String and StringList parameter types.
"""
function get_parameter_history(Name; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"GetParameterHistory",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_parameter_history(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"GetParameterHistory",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_parameters(names)
get_parameters(names, params::Dict{String,<:Any})
Get information about one or more parameters by specifying multiple parameter names. To
get information about a single parameter, you can use the GetParameter operation instead.
# Arguments
- `names`: The names or Amazon Resource Names (ARNs) of the parameters that you want to
query. For parameters shared with you from another account, you must use the full ARNs. To
query by parameter label, use \"Name\": \"name:label\". To query by parameter version, use
\"Name\": \"name:version\". The results for GetParameters requests are listed in
alphabetical order in query responses. For information about shared parameters, see
Working with shared parameters in the Amazon Web Services Systems Manager User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"WithDecryption"`: Return decrypted secure string value. Return decrypted values for
secure string parameters. This flag is ignored for String and StringList parameter types.
"""
function get_parameters(Names; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"GetParameters",
Dict{String,Any}("Names" => Names);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_parameters(
Names, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"GetParameters",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Names" => Names), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_parameters_by_path(path)
get_parameters_by_path(path, params::Dict{String,<:Any})
Retrieve information about one or more parameters in a specific hierarchy. Request results
are returned on a best-effort basis. If you specify MaxResults in the request, the response
includes information up to the limit specified. The number of items returned, however, can
be between zero and the value of MaxResults. If the service reaches an internal limit while
processing the results, it stops the operation and returns the matching values up to that
point and a NextToken. You can specify the NextToken in a subsequent call to get the next
set of results.
# Arguments
- `path`: The hierarchy for the parameter. Hierarchies start with a forward slash (/). The
hierarchy is the parameter name except the last part of the parameter. For the API call to
succeed, the last part of the parameter name can't be in the path. A parameter name
hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy:
/Finance/Prod/IAD/WinServ2016/license33
# 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 call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: A token to start the list. Use this token to get the next set of results.
- `"ParameterFilters"`: Filters to limit the request results. The following Key values are
supported for GetParametersByPath: Type, KeyId, and Label. The following Key values aren't
supported for GetParametersByPath: tag, DataType, Name, Path, and Tier.
- `"Recursive"`: Retrieve all parameters within a hierarchy. If a user has access to a
path, then the user can access all levels of that path. For example, if a user has
permission to access path /a, then the user can also access /a/b. Even if a user has
explicitly been denied access in IAM for parameter /a/b, they can still call the
GetParametersByPath API operation recursively for /a and view /a/b.
- `"WithDecryption"`: Retrieve all parameters in a hierarchy with their value decrypted.
"""
function get_parameters_by_path(Path; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"GetParametersByPath",
Dict{String,Any}("Path" => Path);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_parameters_by_path(
Path, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"GetParametersByPath",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Path" => Path), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_patch_baseline(baseline_id)
get_patch_baseline(baseline_id, params::Dict{String,<:Any})
Retrieves information about a patch baseline.
# Arguments
- `baseline_id`: The ID of the patch baseline to retrieve. To retrieve information about
an Amazon Web Services managed patch baseline, specify the full Amazon Resource Name (ARN)
of the baseline. For example, for the baseline AWS-AmazonLinuxDefaultPatchBaseline, specify
arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0e392de35e7c563b7 instead of
pb-0e392de35e7c563b7.
"""
function get_patch_baseline(BaselineId; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"GetPatchBaseline",
Dict{String,Any}("BaselineId" => BaselineId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_patch_baseline(
BaselineId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"GetPatchBaseline",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("BaselineId" => BaselineId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_patch_baseline_for_patch_group(patch_group)
get_patch_baseline_for_patch_group(patch_group, params::Dict{String,<:Any})
Retrieves the patch baseline that should be used for the specified patch group.
# Arguments
- `patch_group`: The name of the patch group whose patch baseline should be retrieved.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"OperatingSystem"`: Returns the operating system rule specified for patch groups using
the patch baseline.
"""
function get_patch_baseline_for_patch_group(
PatchGroup; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"GetPatchBaselineForPatchGroup",
Dict{String,Any}("PatchGroup" => PatchGroup);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_patch_baseline_for_patch_group(
PatchGroup,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"GetPatchBaselineForPatchGroup",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PatchGroup" => PatchGroup), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resource_policies(resource_arn)
get_resource_policies(resource_arn, params::Dict{String,<:Any})
Returns an array of the Policy object.
# Arguments
- `resource_arn`: Amazon Resource Name (ARN) of the resource to which the policies are
attached.
# 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 call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: A token to start the list. Use this token to get the next set of results.
"""
function get_resource_policies(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"GetResourcePolicies",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resource_policies(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"GetResourcePolicies",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_service_setting(setting_id)
get_service_setting(setting_id, params::Dict{String,<:Any})
ServiceSetting is an account-level setting for an Amazon Web Services service. This
setting defines how a user interacts with or uses a service or a feature of a service. For
example, if an Amazon Web Services service charges money to the account based on feature or
service usage, then the Amazon Web Services service team might create a default setting of
false. This means the user can't use this feature unless they change the setting to true
and intentionally opt in for a paid feature. Services map a SettingId object to a setting
value. Amazon Web Services services teams define the default value for a SettingId. You
can't create a new SettingId, but you can overwrite the default value if you have the
ssm:UpdateServiceSetting permission for the setting. Use the UpdateServiceSetting API
operation to change the default setting. Or use the ResetServiceSetting to change the value
back to the original value defined by the Amazon Web Services service team. Query the
current service setting for the Amazon Web Services account.
# Arguments
- `setting_id`: The ID of the service setting to get. The setting ID can be one of the
following. /ssm/managed-instance/default-ec2-instance-management-role
/ssm/automation/customer-script-log-destination
/ssm/automation/customer-script-log-group-name
/ssm/documents/console/public-sharing-permission /ssm/managed-instance/activation-tier
/ssm/opsinsights/opscenter /ssm/parameter-store/default-parameter-tier
/ssm/parameter-store/high-throughput-enabled
"""
function get_service_setting(SettingId; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"GetServiceSetting",
Dict{String,Any}("SettingId" => SettingId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_service_setting(
SettingId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"GetServiceSetting",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SettingId" => SettingId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
label_parameter_version(labels, name)
label_parameter_version(labels, name, params::Dict{String,<:Any})
A parameter label is a user-defined alias to help you manage different versions of a
parameter. When you modify a parameter, Amazon Web Services Systems Manager automatically
saves a new version and increments the version number by one. A label can help you remember
the purpose of a parameter when there are multiple versions. Parameter labels have the
following requirements and restrictions. A version of a parameter can have a maximum of
10 labels. You can't attach the same label to different versions of the same parameter.
For example, if version 1 has the label Production, then you can't attach Production to
version 2. You can move a label from one version of a parameter to another. You can't
create a label when you create a new parameter. You must attach a label to a specific
version of a parameter. If you no longer want to use a parameter label, then you can
either delete it or move it to a different version of a parameter. A label can have a
maximum of 100 characters. Labels can contain letters (case sensitive), numbers, periods
(.), hyphens (-), or underscores (_). Labels can't begin with a number, \"aws\" or
\"ssm\" (not case sensitive). If a label fails to meet these requirements, then the label
isn't associated with a parameter and the system displays it in the list of InvalidLabels.
# Arguments
- `labels`: One or more labels to attach to the specified parameter version.
- `name`: The parameter name on which you want to attach one or more labels. You can't
enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ParameterVersion"`: The specific version of the parameter on which you want to attach
one or more labels. If no version is specified, the system attaches the label to the latest
version.
"""
function label_parameter_version(
Labels, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"LabelParameterVersion",
Dict{String,Any}("Labels" => Labels, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function label_parameter_version(
Labels,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"LabelParameterVersion",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Labels" => Labels, "Name" => Name), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_association_versions(association_id)
list_association_versions(association_id, params::Dict{String,<:Any})
Retrieves all versions of an association for a specific association ID.
# Arguments
- `association_id`: The association ID for which you want to view all versions.
# 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 call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: A token to start the list. Use this token to get the next set of results.
"""
function list_association_versions(
AssociationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"ListAssociationVersions",
Dict{String,Any}("AssociationId" => AssociationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_association_versions(
AssociationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"ListAssociationVersions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AssociationId" => AssociationId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_associations()
list_associations(params::Dict{String,<:Any})
Returns all State Manager associations in the current Amazon Web Services account and
Amazon Web Services Region. You can limit the results to a specific State Manager
association document or managed node by specifying a filter. State Manager is a capability
of Amazon Web Services Systems Manager.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AssociationFilterList"`: One or more filters. Use a filter to return a more specific
list of results. Filtering associations using the InstanceID attribute only returns legacy
associations created using the InstanceID attribute. Associations targeting the managed
node that are part of the Target Attributes ResourceGroup or Tags aren't returned.
- `"MaxResults"`: The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a previous call.)
"""
function list_associations(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm("ListAssociations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_associations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"ListAssociations", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_command_invocations()
list_command_invocations(params::Dict{String,<:Any})
An invocation is copy of a command sent to a specific managed node. A command can apply to
one or more managed nodes. A command invocation applies to one managed node. For example,
if a user runs SendCommand against three managed nodes, then a command invocation is
created for each requested managed node ID. ListCommandInvocations provide status about
command execution.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CommandId"`: (Optional) The invocations for a specific command ID.
- `"Details"`: (Optional) If set this returns the response of the command executions and
any command output. The default value is false.
- `"Filters"`: (Optional) One or more filters. Use a filter to return a more specific list
of results.
- `"InstanceId"`: (Optional) The command execution details for a specific managed node ID.
- `"MaxResults"`: (Optional) The maximum number of items to return for this call. The call
also returns a token that you can specify in a subsequent call to get the next set of
results.
- `"NextToken"`: (Optional) The token for the next set of items to return. (You received
this token from a previous call.)
"""
function list_command_invocations(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"ListCommandInvocations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_command_invocations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"ListCommandInvocations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_commands()
list_commands(params::Dict{String,<:Any})
Lists the commands requested by users of the Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CommandId"`: (Optional) If provided, lists only the specified command.
- `"Filters"`: (Optional) One or more filters. Use a filter to return a more specific list
of results.
- `"InstanceId"`: (Optional) Lists commands issued against this managed node ID. You can't
specify a managed node ID in the same command that you specify Status = Pending. This is
because the command hasn't reached the managed node yet.
- `"MaxResults"`: (Optional) The maximum number of items to return for this call. The call
also returns a token that you can specify in a subsequent call to get the next set of
results.
- `"NextToken"`: (Optional) The token for the next set of items to return. (You received
this token from a previous call.)
"""
function list_commands(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm("ListCommands"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_commands(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"ListCommands", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_compliance_items()
list_compliance_items(params::Dict{String,<:Any})
For a specified resource ID, this API operation returns a list of compliance statuses for
different resource types. Currently, you can only specify one resource ID per call. List
results depend on the criteria specified in the filter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: One or more compliance filters. Use a filter to return a more specific list
of results.
- `"MaxResults"`: The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: A token to start the list. Use this token to get the next set of results.
- `"ResourceIds"`: The ID for the resources from which to get compliance information.
Currently, you can only specify one resource ID.
- `"ResourceTypes"`: The type of resource from which to get compliance information.
Currently, the only supported resource type is ManagedInstance.
"""
function list_compliance_items(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"ListComplianceItems"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_compliance_items(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"ListComplianceItems",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_compliance_summaries()
list_compliance_summaries(params::Dict{String,<:Any})
Returns a summary count of compliant and non-compliant resources for a compliance type. For
example, this call can return State Manager associations, patches, or custom compliance
types according to the filter criteria that you specify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: One or more compliance or inventory filters. Use a filter to return a more
specific list of results.
- `"MaxResults"`: The maximum number of items to return for this call. Currently, you can
specify null or 50. The call also returns a token that you can specify in a subsequent call
to get the next set of results.
- `"NextToken"`: A token to start the list. Use this token to get the next set of results.
"""
function list_compliance_summaries(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"ListComplianceSummaries"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_compliance_summaries(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"ListComplianceSummaries",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_document_metadata_history(metadata, name)
list_document_metadata_history(metadata, name, params::Dict{String,<:Any})
Information about approval reviews for a version of a change template in Change Manager.
# Arguments
- `metadata`: The type of data for which details are being requested. Currently, the only
supported value is DocumentReviews.
- `name`: The name of the change template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DocumentVersion"`: The version of the change template.
- `"MaxResults"`: The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a previous call.)
"""
function list_document_metadata_history(
Metadata, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"ListDocumentMetadataHistory",
Dict{String,Any}("Metadata" => Metadata, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_document_metadata_history(
Metadata,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"ListDocumentMetadataHistory",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Metadata" => Metadata, "Name" => Name), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_document_versions(name)
list_document_versions(name, params::Dict{String,<:Any})
List all versions for a document.
# Arguments
- `name`: The name of the document. You can specify an Amazon Resource Name (ARN).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a previous call.)
"""
function list_document_versions(Name; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"ListDocumentVersions",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_document_versions(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"ListDocumentVersions",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_documents()
list_documents(params::Dict{String,<:Any})
Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and
Amazon Web Services Region. You can limit the results of this request by using a filter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DocumentFilterList"`: This data type is deprecated. Instead, use Filters.
- `"Filters"`: One or more DocumentKeyValuesFilter objects. Use a filter to return a more
specific list of results. For keys, you can specify one or more key-value pair tags that
have been applied to a document. Other valid keys include Owner, Name, PlatformTypes,
DocumentType, and TargetType. For example, to return documents you own use
Key=Owner,Values=Self. To specify a custom key-value pair, use the format
Key=tag:tagName,Values=valueName. This API operation only supports filtering documents by
using a single tag key and one or more tag values. For example:
Key=tag:tagName,Values=valueName1,valueName2
- `"MaxResults"`: The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a previous call.)
"""
function list_documents(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm("ListDocuments"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_documents(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"ListDocuments", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_inventory_entries(instance_id, type_name)
list_inventory_entries(instance_id, type_name, params::Dict{String,<:Any})
A list of inventory items returned by the request.
# Arguments
- `instance_id`: The managed node ID for which you want inventory information.
- `type_name`: The type of inventory item for which you want information.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: One or more filters. Use a filter to return a more specific list of results.
- `"MaxResults"`: The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a previous call.)
"""
function list_inventory_entries(
InstanceId, TypeName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"ListInventoryEntries",
Dict{String,Any}("InstanceId" => InstanceId, "TypeName" => TypeName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_inventory_entries(
InstanceId,
TypeName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"ListInventoryEntries",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InstanceId" => InstanceId, "TypeName" => TypeName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_ops_item_events()
list_ops_item_events(params::Dict{String,<:Any})
Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon
Web Services account. You can limit the results to events associated with specific OpsItems
by specifying a filter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: One or more OpsItem filters. Use a filter to return a more specific list of
results.
- `"MaxResults"`: The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: A token to start the list. Use this token to get the next set of results.
"""
function list_ops_item_events(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm("ListOpsItemEvents"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_ops_item_events(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"ListOpsItemEvents", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_ops_item_related_items()
list_ops_item_related_items(params::Dict{String,<:Any})
Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem.
OpsCenter is a capability of Amazon Web Services Systems Manager.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: One or more OpsItem filters. Use a filter to return a more specific list of
results.
- `"MaxResults"`: The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a previous call.)
- `"OpsItemId"`: The ID of the OpsItem for which you want to list all related-item
resources.
"""
function list_ops_item_related_items(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"ListOpsItemRelatedItems"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_ops_item_related_items(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"ListOpsItemRelatedItems",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_ops_metadata()
list_ops_metadata(params::Dict{String,<:Any})
Amazon Web Services Systems Manager calls this API operation when displaying all
Application Manager OpsMetadata objects or blobs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: One or more filters to limit the number of OpsMetadata objects returned by
the call.
- `"MaxResults"`: The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: A token to start the list. Use this token to get the next set of results.
"""
function list_ops_metadata(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm("ListOpsMetadata"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_ops_metadata(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"ListOpsMetadata", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_resource_compliance_summaries()
list_resource_compliance_summaries(params::Dict{String,<:Any})
Returns a resource-level summary count. The summary includes information about compliant
and non-compliant statuses and detailed compliance-item severity counts, according to the
filter criteria you specify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: One or more filters. Use a filter to return a more specific list of results.
- `"MaxResults"`: The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: A token to start the list. Use this token to get the next set of results.
"""
function list_resource_compliance_summaries(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"ListResourceComplianceSummaries";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_resource_compliance_summaries(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"ListResourceComplianceSummaries",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_resource_data_sync()
list_resource_data_sync(params::Dict{String,<:Any})
Lists your resource data sync configurations. Includes information about the last time a
sync attempted to start, the last sync status, and the last time a sync successfully
completed. The number of sync configurations might be too large to return using a single
call to ListResourceDataSync. You can limit the number of sync configurations returned by
using the MaxResults parameter. To determine whether there are more sync configurations to
list, check the value of NextToken in the output. If there are more sync configurations to
list, you can request them by specifying the NextToken returned in the call to the
parameter of a subsequent call.
# 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 call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: A token to start the list. Use this token to get the next set of results.
- `"SyncType"`: View a list of resource data syncs according to the sync type. Specify
SyncToDestination to view resource data syncs that synchronize data to an Amazon S3 bucket.
Specify SyncFromSource to view resource data syncs from Organizations or from multiple
Amazon Web Services Regions.
"""
function list_resource_data_sync(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"ListResourceDataSync"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_resource_data_sync(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"ListResourceDataSync",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_id, resource_type)
list_tags_for_resource(resource_id, resource_type, params::Dict{String,<:Any})
Returns a list of the tags assigned to the specified resource. For information about the ID
format for each supported resource type, see AddTagsToResource.
# Arguments
- `resource_id`: The resource ID for which you want to see a list of tags.
- `resource_type`: Returns a list of tags for a specific resource type.
"""
function list_tags_for_resource(
ResourceId, ResourceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"ListTagsForResource",
Dict{String,Any}("ResourceId" => ResourceId, "ResourceType" => ResourceType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
ResourceId,
ResourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"ListTagsForResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ResourceId" => ResourceId, "ResourceType" => ResourceType
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_document_permission(name, permission_type)
modify_document_permission(name, permission_type, params::Dict{String,<:Any})
Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately.
If you share a document privately, you must specify the Amazon Web Services user IDs for
those people who can use the document. If you share a document publicly, you must specify
All as the account ID.
# Arguments
- `name`: The name of the document that you want to share.
- `permission_type`: The permission type for the document. The permission type can be Share.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccountIdsToAdd"`: The Amazon Web Services users that should have access to the
document. The account IDs can either be a group of account IDs or All.
- `"AccountIdsToRemove"`: The Amazon Web Services users that should no longer have access
to the document. The Amazon Web Services user can either be a group of account IDs or All.
This action has a higher priority than AccountIdsToAdd. If you specify an ID to add and the
same ID to remove, the system removes access to the document.
- `"SharedDocumentVersion"`: (Optional) The version of the document to share. If it isn't
specified, the system choose the Default version to share.
"""
function modify_document_permission(
Name, PermissionType; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"ModifyDocumentPermission",
Dict{String,Any}("Name" => Name, "PermissionType" => PermissionType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_document_permission(
Name,
PermissionType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"ModifyDocumentPermission",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Name" => Name, "PermissionType" => PermissionType),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_compliance_items(compliance_type, execution_summary, items, resource_id, resource_type)
put_compliance_items(compliance_type, execution_summary, items, resource_id, resource_type, params::Dict{String,<:Any})
Registers a compliance type and other compliance details on a designated resource. This
operation lets you register custom compliance details with a resource. This call overwrites
existing compliance information on the resource, so you must provide a full list of
compliance items each time that you send the request. ComplianceType can be one of the
following: ExecutionId: The execution ID when the patch, association, or custom
compliance item was applied. ExecutionType: Specify patch, association, or Custom:string.
ExecutionTime. The time the patch, association, or custom compliance item was applied to
the managed node. Id: The patch, association, or custom compliance ID. Title: A title.
Status: The status of the compliance item. For example, approved for patches, or Failed
for associations. Severity: A patch severity. For example, Critical. DocumentName: An
SSM document name. For example, AWS-RunPatchBaseline. DocumentVersion: An SSM document
version number. For example, 4. Classification: A patch classification. For example,
security updates. PatchBaselineId: A patch baseline ID. PatchSeverity: A patch
severity. For example, Critical. PatchState: A patch state. For example,
InstancesWithFailedPatches. PatchGroup: The name of a patch group. InstalledTime: The
time the association, patch, or custom compliance item was applied to the resource. Specify
the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'
# Arguments
- `compliance_type`: Specify the compliance type. For example, specify Association (for a
State Manager association), Patch, or Custom:string.
- `execution_summary`: A summary of the call execution that includes an execution ID, the
type of execution (for example, Command), and the date/time of the execution using a
datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'
- `items`: Information about the compliance as defined by the resource type. For example,
for a patch compliance type, Items includes information about the PatchSeverity,
Classification, and so on.
- `resource_id`: Specify an ID for this resource. For a managed node, this is the node ID.
- `resource_type`: Specify the type of resource. ManagedInstance is currently the only
supported resource type.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ItemContentHash"`: MD5 or SHA-256 content hash. The content hash is used to determine
if existing information should be overwritten or ignored. If the content hashes match, the
request to put compliance information is ignored.
- `"UploadType"`: The mode for uploading compliance items. You can specify COMPLETE or
PARTIAL. In COMPLETE mode, the system overwrites all existing compliance information for
the resource. You must provide a full list of compliance items each time you send the
request. In PARTIAL mode, the system overwrites compliance information for a specific
association. The association must be configured with SyncCompliance set to MANUAL. By
default, all requests use COMPLETE mode. This attribute is only valid for association
compliance.
"""
function put_compliance_items(
ComplianceType,
ExecutionSummary,
Items,
ResourceId,
ResourceType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"PutComplianceItems",
Dict{String,Any}(
"ComplianceType" => ComplianceType,
"ExecutionSummary" => ExecutionSummary,
"Items" => Items,
"ResourceId" => ResourceId,
"ResourceType" => ResourceType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_compliance_items(
ComplianceType,
ExecutionSummary,
Items,
ResourceId,
ResourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"PutComplianceItems",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ComplianceType" => ComplianceType,
"ExecutionSummary" => ExecutionSummary,
"Items" => Items,
"ResourceId" => ResourceId,
"ResourceType" => ResourceType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_inventory(instance_id, items)
put_inventory(instance_id, items, params::Dict{String,<:Any})
Bulk update custom inventory items on one or more managed nodes. The request adds an
inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.
# Arguments
- `instance_id`: An managed node ID where you want to add or update inventory items.
- `items`: The inventory items that you want to add or update on managed nodes.
"""
function put_inventory(InstanceId, Items; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"PutInventory",
Dict{String,Any}("InstanceId" => InstanceId, "Items" => Items);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_inventory(
InstanceId,
Items,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"PutInventory",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InstanceId" => InstanceId, "Items" => Items),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_parameter(name, value)
put_parameter(name, value, params::Dict{String,<:Any})
Add a parameter to the system.
# Arguments
- `name`: The fully qualified name of the parameter that you want to add to the system.
You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name
itself. The fully qualified name includes the complete hierarchy of the parameter path and
name. For parameters in a hierarchy, you must include a leading forward slash character (/)
when you create or reference a parameter. For example: /Dev/DBServer/MySQL/db-string13
Naming Constraints: Parameter names are case sensitive. A parameter name must be unique
within an Amazon Web Services Region A parameter name can't be prefixed with \"aws\" or
\"ssm\" (case-insensitive). Parameter names can include only the following symbols and
letters: a-zA-Z0-9_.- In addition, the slash character ( / ) is used to delineate
hierarchies in parameter names. For example: /Dev/Production/East/Project-ABC/MyParameter
A parameter name can't include spaces. Parameter hierarchies are limited to a maximum
depth of fifteen levels. For additional information about valid values for parameter
names, see Creating Systems Manager parameters in the Amazon Web Services Systems Manager
User Guide. The maximum length constraint of 2048 characters listed below includes 1037
characters reserved for internal use by Systems Manager. The maximum length for a parameter
name that you create is 1011 characters. This includes the characters in the ARN that
precede the name you specify, such as arn:aws:ssm:us-east-2:111122223333:parameter/.
- `value`: The parameter value that you want to add to the system. Standard parameters have
a value limit of 4 KB. Advanced parameters have a value limit of 8 KB. Parameters can't be
referenced or nested in the values of other parameters. You can't include {{}} or
{{ssm:parameter-name}} in a parameter value.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllowedPattern"`: A regular expression used to validate the parameter value. For
example, for String types with values restricted to numbers, you can specify the following:
AllowedPattern=^d+
- `"DataType"`: The data type for a String parameter. Supported data types include plain
text and Amazon Machine Image (AMI) IDs. The following data type values are supported.
text aws:ec2:image aws:ssm:integration When you create a String parameter and
specify aws:ec2:image, Amazon Web Services Systems Manager validates the parameter value is
in the required format, such as ami-12345abcdeEXAMPLE, and that the specified AMI is
available in your Amazon Web Services account. If the action is successful, the service
sends back an HTTP 200 response which indicates a successful PutParameter call for all
cases except for data type aws:ec2:image. If you call PutParameter with aws:ec2:image data
type, a successful HTTP 200 response does not guarantee that your parameter was
successfully created or updated. The aws:ec2:image value is validated asynchronously, and
the PutParameter call returns before the validation is complete. If you submit an invalid
AMI value, the PutParameter operation will return success, but the asynchronous validation
will fail and the parameter will not be created or updated. To monitor whether your
aws:ec2:image parameters are created successfully, see Setting up notifications or trigger
actions based on Parameter Store events. For more information about AMI format validation ,
see Native parameter support for Amazon Machine Image IDs.
- `"Description"`: Information about the parameter that you want to add to the system.
Optional but recommended. Don't enter personally identifiable information in this field.
- `"KeyId"`: The Key Management Service (KMS) ID that you want to use to encrypt a
parameter. Use a custom key for better security. Required for parameters that use the
SecureString data type. If you don't specify a key ID, the system uses the default key
associated with your Amazon Web Services account which is not as secure as using a custom
key. To use a custom KMS key, choose the SecureString data type with the Key ID
parameter.
- `"Overwrite"`: Overwrite an existing parameter. The default value is false.
- `"Policies"`: One or more policies to apply to a parameter. This operation takes a JSON
array. Parameter Store, a capability of Amazon Web Services Systems Manager supports the
following policy types: Expiration: This policy deletes the parameter after it expires.
When you create the policy, you specify the expiration date. You can update the expiration
date and time by updating the policy. Updating the parameter doesn't affect the expiration
date and time. When the expiration time is reached, Parameter Store deletes the parameter.
ExpirationNotification: This policy initiates an event in Amazon CloudWatch Events that
notifies you about the expiration. By using this policy, you can receive notification
before or after the expiration time is reached, in units of days or hours.
NoChangeNotification: This policy initiates a CloudWatch Events event if a parameter hasn't
been modified for a specified period of time. This policy type is useful when, for example,
a secret needs to be changed within a period of time, but it hasn't been changed. All
existing policies are preserved until you send new policies or an empty policy. For more
information about parameter policies, see Assigning parameter policies.
- `"Tags"`: Optional metadata that you assign to a resource. Tags enable you to categorize
a resource in different ways, such as by purpose, owner, or environment. For example, you
might want to tag a Systems Manager parameter to identify the type of resource to which it
applies, the environment, or the type of configuration data referenced by the parameter. In
this case, you could specify the following key-value pairs: Key=Resource,Value=S3bucket
Key=OS,Value=Windows Key=ParameterType,Value=LicenseKey To add tags to an
existing Systems Manager parameter, use the AddTagsToResource operation.
- `"Tier"`: The parameter tier to assign to a parameter. Parameter Store offers a standard
tier and an advanced tier for parameters. Standard parameters have a content size limit of
4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000
standard parameters for each Region in an Amazon Web Services account. Standard parameters
are offered at no additional cost. Advanced parameters have a content size limit of 8 KB
and can be configured to use parameter policies. You can create a maximum of 100,000
advanced parameters for each Region in an Amazon Web Services account. Advanced parameters
incur a charge. For more information, see Managing parameter tiers in the Amazon Web
Services Systems Manager User Guide. You can change a standard parameter to an advanced
parameter any time. But you can't revert an advanced parameter to a standard parameter.
Reverting an advanced parameter to a standard parameter would result in data loss because
the system would truncate the size of the parameter from 8 KB to 4 KB. Reverting would also
remove any policies attached to the parameter. Lastly, advanced parameters use a different
form of encryption than standard parameters. If you no longer need an advanced parameter,
or if you no longer want to incur charges for an advanced parameter, you must delete it and
recreate it as a new standard parameter. Using the Default Tier Configuration In
PutParameter requests, you can specify the tier to create the parameter in. Whenever you
specify a tier in the request, Parameter Store creates or updates the parameter according
to that request. However, if you don't specify a tier in a request, Parameter Store assigns
the tier based on the current Parameter Store default tier configuration. The default tier
when you begin using Parameter Store is the standard-parameter tier. If you use the
advanced-parameter tier, you can specify one of the following as the default: Advanced:
With this option, Parameter Store evaluates all requests as advanced parameters.
Intelligent-Tiering: With this option, Parameter Store evaluates each request to determine
if the parameter is standard or advanced. If the request doesn't include any options that
require an advanced parameter, the parameter is created in the standard-parameter tier. If
one or more options requiring an advanced parameter are included in the request, Parameter
Store create a parameter in the advanced-parameter tier. This approach helps control your
parameter-related costs by always creating standard parameters unless an advanced parameter
is necessary. Options that require an advanced parameter include the following: The
content size of the parameter is more than 4 KB. The parameter uses a parameter policy.
More than 10,000 parameters already exist in your Amazon Web Services account in the
current Amazon Web Services Region. For more information about configuring the default
tier option, see Specifying a default parameter tier in the Amazon Web Services Systems
Manager User Guide.
- `"Type"`: The type of parameter that you want to add to the system. SecureString isn't
currently supported for CloudFormation templates. Items in a StringList must be separated
by a comma (,). You can't use other punctuation or special character to escape items in the
list. If you have a parameter value that requires a comma, then use the String data type.
Specifying a parameter type isn't required when updating a parameter. You must specify a
parameter type when creating a parameter.
"""
function put_parameter(Name, Value; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"PutParameter",
Dict{String,Any}("Name" => Name, "Value" => Value);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_parameter(
Name,
Value,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"PutParameter",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Name" => Name, "Value" => Value), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_resource_policy(policy, resource_arn)
put_resource_policy(policy, resource_arn, params::Dict{String,<:Any})
Creates or updates a Systems Manager resource policy. A resource policy helps you to define
the IAM entity (for example, an Amazon Web Services account) that can manage your Systems
Manager resources. The following resources support Systems Manager resource policies.
OpsItemGroup - The resource policy for OpsItemGroup enables Amazon Web Services accounts to
view and interact with OpsCenter operational work items (OpsItems). Parameter - The
resource policy is used to share a parameter with other accounts using Resource Access
Manager (RAM). To share a parameter, it must be in the advanced parameter tier. For
information about parameter tiers, see Managing parameter tiers. For information about
changing an existing standard parameter to an advanced parameter, see Changing a standard
parameter to an advanced parameter. To share a SecureString parameter, it must be encrypted
with a customer managed key, and you must share the key separately through Key Management
Service. Amazon Web Services managed keys cannot be shared. Parameters encrypted with the
default Amazon Web Services managed key can be updated to use a customer managed key
instead. For KMS key definitions, see KMS concepts in the Key Management Service Developer
Guide. While you can share a parameter using the Systems Manager PutResourcePolicy
operation, we recommend using Resource Access Manager (RAM) instead. This is because using
PutResourcePolicy requires the extra step of promoting the parameter to a standard RAM
Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation.
Otherwise, the parameter won't be returned by the Systems Manager DescribeParameters API
operation using the --shared option. For more information, see Sharing a parameter in the
Amazon Web Services Systems Manager User Guide
# Arguments
- `policy`: A policy you want to associate with a resource.
- `resource_arn`: Amazon Resource Name (ARN) of the resource to which you want to attach a
policy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PolicyHash"`: ID of the current policy version. The hash helps to prevent a situation
where multiple users attempt to overwrite a policy. You must provide this hash when
updating or deleting a policy.
- `"PolicyId"`: The policy ID.
"""
function put_resource_policy(
Policy, ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"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 ssm(
"PutResourcePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Policy" => Policy, "ResourceArn" => ResourceArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_default_patch_baseline(baseline_id)
register_default_patch_baseline(baseline_id, params::Dict{String,<:Any})
Defines the default patch baseline for the relevant operating system. To reset the Amazon
Web Services-predefined patch baseline as the default, specify the full patch baseline
Amazon Resource Name (ARN) as the baseline ID value. For example, for CentOS, specify
arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed instead of
pb-0574b43a65ea646ed.
# Arguments
- `baseline_id`: The ID of the patch baseline that should be the default patch baseline.
"""
function register_default_patch_baseline(
BaselineId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"RegisterDefaultPatchBaseline",
Dict{String,Any}("BaselineId" => BaselineId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_default_patch_baseline(
BaselineId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"RegisterDefaultPatchBaseline",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("BaselineId" => BaselineId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_patch_baseline_for_patch_group(baseline_id, patch_group)
register_patch_baseline_for_patch_group(baseline_id, patch_group, params::Dict{String,<:Any})
Registers a patch baseline for a patch group.
# Arguments
- `baseline_id`: The ID of the patch baseline to register with the patch group.
- `patch_group`: The name of the patch group to be registered with the patch baseline.
"""
function register_patch_baseline_for_patch_group(
BaselineId, PatchGroup; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"RegisterPatchBaselineForPatchGroup",
Dict{String,Any}("BaselineId" => BaselineId, "PatchGroup" => PatchGroup);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_patch_baseline_for_patch_group(
BaselineId,
PatchGroup,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"RegisterPatchBaselineForPatchGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("BaselineId" => BaselineId, "PatchGroup" => PatchGroup),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_target_with_maintenance_window(resource_type, targets, window_id)
register_target_with_maintenance_window(resource_type, targets, window_id, params::Dict{String,<:Any})
Registers a target with a maintenance window.
# Arguments
- `resource_type`: The type of target being registered with the maintenance window.
- `targets`: The targets to register with the maintenance window. In other words, the
managed nodes to run commands on when the maintenance window runs. If a single maintenance
window task is registered with multiple targets, its task invocations occur sequentially
and not in parallel. If your task must run on multiple targets at the same time, register a
task for each target individually and assign each task the same priority level. You can
specify targets using managed node IDs, resource group names, or tags that have been
applied to managed nodes. Example 1: Specify managed node IDs
Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3>
Example 2: Use tag key-pairs applied to managed nodes
Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2> Example
3: Use tag-keys applied to managed nodes
Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2> Example 4: Use resource
group names Key=resource-groups:Name,Values=<resource-group-name> Example 5: Use
filters for resource group types
Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2&g
t; For Key=resource-groups:ResourceTypeFilters, specify resource types in the following
format Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC
For more information about these examples formats, including the best use case for each
one, see Examples: Register targets with a maintenance window in the Amazon Web Services
Systems Manager User Guide.
- `window_id`: The ID of the maintenance window the target should be registered with.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: User-provided idempotency token.
- `"Description"`: An optional description for the target.
- `"Name"`: An optional name for the target.
- `"OwnerInformation"`: User-provided value that will be included in any Amazon CloudWatch
Events events raised while running tasks for these targets in this maintenance window.
"""
function register_target_with_maintenance_window(
ResourceType, Targets, WindowId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"RegisterTargetWithMaintenanceWindow",
Dict{String,Any}(
"ResourceType" => ResourceType,
"Targets" => Targets,
"WindowId" => WindowId,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_target_with_maintenance_window(
ResourceType,
Targets,
WindowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"RegisterTargetWithMaintenanceWindow",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ResourceType" => ResourceType,
"Targets" => Targets,
"WindowId" => WindowId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_task_with_maintenance_window(task_arn, task_type, window_id)
register_task_with_maintenance_window(task_arn, task_type, window_id, params::Dict{String,<:Any})
Adds a new task to a maintenance window.
# Arguments
- `task_arn`: The ARN of the task to run.
- `task_type`: The type of task being registered.
- `window_id`: The ID of the maintenance window the task should be added to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AlarmConfiguration"`: The CloudWatch alarm you want to apply to your maintenance window
task.
- `"ClientToken"`: User-provided idempotency token.
- `"CutoffBehavior"`: Indicates whether tasks should continue to run after the cutoff time
specified in the maintenance windows is reached. CONTINUE_TASK: When the cutoff time is
reached, any tasks that are running continue. The default value. CANCEL_TASK: For
Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task
invocations that are already running continue, but no new task invocations are started.
For Run Command tasks: When the cutoff time is reached, the system sends a CancelCommand
operation that attempts to cancel the command associated with the task. However, there is
no guarantee that the command will be terminated and the underlying process stopped. The
status for tasks that are not completed is TIMED_OUT.
- `"Description"`: An optional description for the task.
- `"LoggingInfo"`: A structure containing information about an Amazon Simple Storage
Service (Amazon S3) bucket to write managed node-level logs to. LoggingInfo has been
deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs,
instead use the OutputS3BucketName and OutputS3KeyPrefix options in the
TaskInvocationParameters structure. For information about how Amazon Web Services Systems
Manager handles these options for the supported maintenance window task types, see
MaintenanceWindowTaskInvocationParameters.
- `"MaxConcurrency"`: The maximum number of targets this task can be run for, in parallel.
Although this element is listed as \"Required: No\", a value can be omitted only when you
are registering or updating a targetless task You must provide a value in all other cases.
For maintenance window tasks without a target specified, you can't supply a value for this
option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the
running of your task.
- `"MaxErrors"`: The maximum number of errors allowed before this task stops being
scheduled. Although this element is listed as \"Required: No\", a value can be omitted
only when you are registering or updating a targetless task You must provide a value in all
other cases. For maintenance window tasks without a target specified, you can't supply a
value for this option. Instead, the system inserts a placeholder value of 1. This value
doesn't affect the running of your task.
- `"Name"`: An optional name for the task.
- `"Priority"`: The priority of the task in the maintenance window, the lower the number
the higher the priority. Tasks in a maintenance window are scheduled in priority order with
tasks that have the same priority scheduled in parallel.
- `"ServiceRoleArn"`: The Amazon Resource Name (ARN) of the IAM service role for Amazon Web
Services Systems Manager to assume when running a maintenance window task. If you do not
specify a service role ARN, Systems Manager uses a service-linked role in your account. If
no appropriate service-linked role for Systems Manager exists in your account, it is
created when you run RegisterTaskWithMaintenanceWindow. However, for an improved security
posture, we strongly recommend creating a custom policy and custom service role for running
your maintenance window tasks. The policy can be crafted to provide only the permissions
needed for your particular maintenance window tasks. For more information, see Setting up
maintenance windows in the in the Amazon Web Services Systems Manager User Guide.
- `"Targets"`: The targets (either managed nodes or maintenance window targets). One or
more targets must be specified for maintenance window Run Command-type tasks. Depending on
the task, targets are optional for other maintenance window task types (Automation, Lambda,
and Step Functions). For more information about running tasks that don't specify targets,
see Registering maintenance window tasks without targets in the Amazon Web Services Systems
Manager User Guide. Specify managed nodes using the following format:
Key=InstanceIds,Values=<instance-id-1>,<instance-id-2> Specify maintenance
window targets using the following format:
Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2>
- `"TaskInvocationParameters"`: The parameters that the task should use during execution.
Populate only the fields that match the task type. All other fields should be empty.
- `"TaskParameters"`: The parameters that should be passed to the task when it is run.
TaskParameters has been deprecated. To specify parameters to pass to a task when it runs,
instead use the Parameters option in the TaskInvocationParameters structure. For
information about how Systems Manager handles these options for the supported maintenance
window task types, see MaintenanceWindowTaskInvocationParameters.
"""
function register_task_with_maintenance_window(
TaskArn, TaskType, WindowId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"RegisterTaskWithMaintenanceWindow",
Dict{String,Any}(
"TaskArn" => TaskArn,
"TaskType" => TaskType,
"WindowId" => WindowId,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_task_with_maintenance_window(
TaskArn,
TaskType,
WindowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"RegisterTaskWithMaintenanceWindow",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TaskArn" => TaskArn,
"TaskType" => TaskType,
"WindowId" => WindowId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_tags_from_resource(resource_id, resource_type, tag_keys)
remove_tags_from_resource(resource_id, resource_type, tag_keys, params::Dict{String,<:Any})
Removes tag keys from the specified resource.
# Arguments
- `resource_id`: The ID of the resource from which you want to remove tags. For example:
ManagedInstance: mi-012345abcde MaintenanceWindow: mw-012345abcde Automation:
example-c160-4567-8519-012345abcde PatchBaseline: pb-012345abcde OpsMetadata object:
ResourceID for tagging is created from the Amazon Resource Name (ARN) for the object.
Specifically, ResourceID is created from the strings that come after the word opsmetadata
in the ARN. For example, an OpsMetadata object with an ARN of
arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a ResourceID of
either aws/ssm/MyGroup/appmanager or /aws/ssm/MyGroup/appmanager. For the Document and
Parameter values, use the name of the resource. The ManagedInstance type for this API
operation is only for on-premises managed nodes. Specify the name of the managed node in
the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.
- `resource_type`: The type of resource from which you want to remove a tag. The
ManagedInstance type for this API operation is only for on-premises managed nodes. Specify
the name of the managed node in the following format: mi-ID_number . For example,
mi-1a2b3c4d5e6f.
- `tag_keys`: Tag keys that you want to remove from the specified resource.
"""
function remove_tags_from_resource(
ResourceId, ResourceType, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"RemoveTagsFromResource",
Dict{String,Any}(
"ResourceId" => ResourceId, "ResourceType" => ResourceType, "TagKeys" => TagKeys
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_tags_from_resource(
ResourceId,
ResourceType,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"RemoveTagsFromResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ResourceId" => ResourceId,
"ResourceType" => ResourceType,
"TagKeys" => TagKeys,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reset_service_setting(setting_id)
reset_service_setting(setting_id, params::Dict{String,<:Any})
ServiceSetting is an account-level setting for an Amazon Web Services service. This
setting defines how a user interacts with or uses a service or a feature of a service. For
example, if an Amazon Web Services service charges money to the account based on feature or
service usage, then the Amazon Web Services service team might create a default setting of
\"false\". This means the user can't use this feature unless they change the setting to
\"true\" and intentionally opt in for a paid feature. Services map a SettingId object to a
setting value. Amazon Web Services services teams define the default value for a SettingId.
You can't create a new SettingId, but you can overwrite the default value if you have the
ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API
operation to view the current value. Use the UpdateServiceSetting API operation to change
the default setting. Reset the service setting for the account to the default value as
provisioned by the Amazon Web Services service team.
# Arguments
- `setting_id`: The Amazon Resource Name (ARN) of the service setting to reset. The setting
ID can be one of the following.
/ssm/managed-instance/default-ec2-instance-management-role
/ssm/automation/customer-script-log-destination
/ssm/automation/customer-script-log-group-name
/ssm/documents/console/public-sharing-permission /ssm/managed-instance/activation-tier
/ssm/opsinsights/opscenter /ssm/parameter-store/default-parameter-tier
/ssm/parameter-store/high-throughput-enabled
"""
function reset_service_setting(SettingId; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"ResetServiceSetting",
Dict{String,Any}("SettingId" => SettingId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reset_service_setting(
SettingId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"ResetServiceSetting",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SettingId" => SettingId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
resume_session(session_id)
resume_session(session_id, params::Dict{String,<:Any})
Reconnects a session to a managed node after it has been disconnected. Connections can be
resumed for disconnected sessions, but not terminated sessions. This command is primarily
for use by client machines to automatically reconnect during intermittent network issues.
It isn't intended for any other use.
# Arguments
- `session_id`: The ID of the disconnected session to resume.
"""
function resume_session(SessionId; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"ResumeSession",
Dict{String,Any}("SessionId" => SessionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function resume_session(
SessionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"ResumeSession",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SessionId" => SessionId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_automation_signal(automation_execution_id, signal_type)
send_automation_signal(automation_execution_id, signal_type, params::Dict{String,<:Any})
Sends a signal to an Automation execution to change the current behavior or status of the
execution.
# Arguments
- `automation_execution_id`: The unique identifier for an existing Automation execution
that you want to send the signal to.
- `signal_type`: The type of signal to send to an Automation execution.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Payload"`: The data sent with the signal. The data schema depends on the type of signal
used in the request. For Approve and Reject signal types, the payload is an optional
comment that you can send with the signal type. For example: Comment=\"Looks good\" For
StartStep and Resume signal types, you must send the name of the Automation step to start
or resume as the payload. For example: StepName=\"step1\" For the StopStep signal type,
you must send the step execution ID as the payload. For example:
StepExecutionId=\"97fff367-fc5a-4299-aed8-0123456789ab\"
"""
function send_automation_signal(
AutomationExecutionId, SignalType; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"SendAutomationSignal",
Dict{String,Any}(
"AutomationExecutionId" => AutomationExecutionId, "SignalType" => SignalType
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_automation_signal(
AutomationExecutionId,
SignalType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"SendAutomationSignal",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AutomationExecutionId" => AutomationExecutionId,
"SignalType" => SignalType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_command(document_name)
send_command(document_name, params::Dict{String,<:Any})
Runs commands on one or more managed nodes.
# Arguments
- `document_name`: The name of the Amazon Web Services Systems Manager document (SSM
document) to run. This can be a public document or a custom document. To run a shared
document belonging to another account, specify the document Amazon Resource Name (ARN). For
more information about how to use shared documents, see Sharing SSM documents in the Amazon
Web Services Systems Manager User Guide. If you specify a document name or ARN that hasn't
been shared with your account, you receive an InvalidDocument error.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AlarmConfiguration"`: The CloudWatch alarm you want to apply to your command.
- `"CloudWatchOutputConfig"`: Enables Amazon Web Services Systems Manager to send Run
Command output to Amazon CloudWatch Logs. Run Command is a capability of Amazon Web
Services Systems Manager.
- `"Comment"`: User-specified information about the command, such as a brief description of
what the command should do.
- `"DocumentHash"`: The Sha256 or Sha1 hash created by the system when the document was
created. Sha1 hashes have been deprecated.
- `"DocumentHashType"`: Sha256 or Sha1. Sha1 hashes have been deprecated.
- `"DocumentVersion"`: The SSM document version to use in the request. You can specify
DEFAULT, LATEST, or a specific version number. If you run commands by using the Command
Line Interface (Amazon Web Services CLI), then you must escape the first two options by
using a backslash. If you specify a version number, then you don't need to use the
backslash. For example: --document-version \"DEFAULT\" --document-version \"LATEST\"
--document-version \"3\"
- `"InstanceIds"`: The IDs of the managed nodes where the command should run. Specifying
managed node IDs is most useful when you are targeting a limited number of managed nodes,
though you can specify up to 50 IDs. To target a larger number of managed nodes, or if you
prefer not to list individual node IDs, we recommend using the Targets option instead.
Using Targets, which accepts tag key-value pairs to identify the managed nodes to send
commands to, you can a send command to tens, hundreds, or thousands of nodes at once. For
more information about how to use targets, see Run commands at scale in the Amazon Web
Services Systems Manager User Guide.
- `"MaxConcurrency"`: (Optional) The maximum number of managed nodes that are allowed to
run the command at the same time. You can specify a number such as 10 or a percentage such
as 10%. The default value is 50. For more information about how to use MaxConcurrency, see
Using concurrency controls in the Amazon Web Services Systems Manager User Guide.
- `"MaxErrors"`: The maximum number of errors allowed without the command failing. When the
command fails one more time beyond the value of MaxErrors, the systems stops sending the
command to additional targets. You can specify a number like 10 or a percentage like 10%.
The default value is 0. For more information about how to use MaxErrors, see Using error
controls in the Amazon Web Services Systems Manager User Guide.
- `"NotificationConfig"`: Configurations for sending notifications.
- `"OutputS3BucketName"`: The name of the S3 bucket where command execution responses
should be stored.
- `"OutputS3KeyPrefix"`: The directory structure within the S3 bucket where the responses
should be stored.
- `"OutputS3Region"`: (Deprecated) You can no longer specify this parameter. The system
ignores it. Instead, Systems Manager automatically determines the Amazon Web Services
Region of the S3 bucket.
- `"Parameters"`: The required and optional parameters specified in the document being run.
- `"ServiceRoleArn"`: The ARN of the Identity and Access Management (IAM) service role to
use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run
Command commands. This role must provide the sns:Publish permission for your notification
topic. For information about creating and using this service role, see Monitoring Systems
Manager status changes using Amazon SNS notifications in the Amazon Web Services Systems
Manager User Guide.
- `"Targets"`: An array of search criteria that targets managed nodes using a Key,Value
combination that you specify. Specifying targets is most useful when you want to send a
command to a large number of managed nodes at once. Using Targets, which accepts tag
key-value pairs to identify managed nodes, you can send a command to tens, hundreds, or
thousands of nodes at once. To send a command to a smaller number of managed nodes, you can
use the InstanceIds option instead. For more information about how to use targets, see Run
commands at scale in the Amazon Web Services Systems Manager User Guide.
- `"TimeoutSeconds"`: If this time is reached and the command hasn't already started
running, it won't run.
"""
function send_command(DocumentName; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"SendCommand",
Dict{String,Any}("DocumentName" => DocumentName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_command(
DocumentName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"SendCommand",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DocumentName" => DocumentName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_associations_once(association_ids)
start_associations_once(association_ids, params::Dict{String,<:Any})
Runs an association immediately and only one time. This operation can be helpful when
troubleshooting associations.
# Arguments
- `association_ids`: The association IDs that you want to run immediately and only one time.
"""
function start_associations_once(
AssociationIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"StartAssociationsOnce",
Dict{String,Any}("AssociationIds" => AssociationIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_associations_once(
AssociationIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"StartAssociationsOnce",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AssociationIds" => AssociationIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_automation_execution(document_name)
start_automation_execution(document_name, params::Dict{String,<:Any})
Initiates execution of an Automation runbook.
# Arguments
- `document_name`: The name of the SSM document to run. This can be a public document or a
custom document. To run a shared document belonging to another account, specify the
document ARN. For more information about how to use shared documents, see Sharing SSM
documents in the Amazon Web Services Systems Manager User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AlarmConfiguration"`: The CloudWatch alarm you want to apply to your automation.
- `"ClientToken"`: User-provided idempotency token. The token must be unique, is case
insensitive, enforces the UUID format, and can't be reused.
- `"DocumentVersion"`: The version of the Automation runbook to use for this execution.
- `"MaxConcurrency"`: The maximum number of targets allowed to run this task in parallel.
You can specify a number, such as 10, or a percentage, such as 10%. The default value is 10.
- `"MaxErrors"`: The number of errors that are allowed before the system stops running the
automation on additional targets. You can specify either an absolute number of errors, for
example 10, or a percentage of the target set, for example 10%. If you specify 3, for
example, the system stops running the automation when the fourth error is received. If you
specify 0, then the system stops running the automation on additional targets after the
first error result is returned. If you run an automation on 50 resources and set max-errors
to 10%, then the system stops running the automation on additional targets when the sixth
error is received. Executions that are already running an automation when max-errors is
reached are allowed to complete, but some of these executions may fail as well. If you need
to ensure that there won't be more than max-errors failed executions, set max-concurrency
to 1 so the executions proceed one at a time.
- `"Mode"`: The execution mode of the automation. Valid modes include the following: Auto
and Interactive. The default mode is Auto.
- `"Parameters"`: A key-value map of execution parameters, which match the declared
parameters in the Automation runbook.
- `"Tags"`: Optional metadata that you assign to a resource. You can specify a maximum of
five tags for an automation. Tags enable you to categorize a resource in different ways,
such as by purpose, owner, or environment. For example, you might want to tag an automation
to identify an environment or operating system. In this case, you could specify the
following key-value pairs: Key=environment,Value=test Key=OS,Value=Windows To
add tags to an existing automation, use the AddTagsToResource operation.
- `"TargetLocations"`: A location is a combination of Amazon Web Services Regions and/or
Amazon Web Services accounts where you want to run the automation. Use this operation to
start an automation in multiple Amazon Web Services Regions and multiple Amazon Web
Services accounts. For more information, see Running Automation workflows in multiple
Amazon Web Services Regions and Amazon Web Services accounts in the Amazon Web Services
Systems Manager User Guide.
- `"TargetMaps"`: A key-value mapping of document parameters to target resources. Both
Targets and TargetMaps can't be specified together.
- `"TargetParameterName"`: The name of the parameter used as the target resource for the
rate-controlled execution. Required if you specify targets.
- `"Targets"`: A key-value mapping to target resources. Required if you specify
TargetParameterName.
"""
function start_automation_execution(
DocumentName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"StartAutomationExecution",
Dict{String,Any}("DocumentName" => DocumentName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_automation_execution(
DocumentName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"StartAutomationExecution",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DocumentName" => DocumentName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_change_request_execution(document_name, runbooks)
start_change_request_execution(document_name, runbooks, params::Dict{String,<:Any})
Creates a change request for Change Manager. The Automation runbooks specified in the
change request run only after all required approvals for the change request have been
received.
# Arguments
- `document_name`: The name of the change template document to run during the runbook
workflow.
- `runbooks`: Information about the Automation runbooks that are run during the runbook
workflow. The Automation runbooks specified for the runbook workflow can't run until all
required approvals for the change request have been received.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AutoApprove"`: Indicates whether the change request can be approved automatically
without the need for manual approvals. If AutoApprovable is enabled in a change template,
then setting AutoApprove to true in StartChangeRequestExecution creates a change request
that bypasses approver review. Change Calendar restrictions are not bypassed in this
scenario. If the state of an associated calendar is CLOSED, change freeze approvers must
still grant permission for this change request to run. If they don't, the change won't be
processed until the calendar state is again OPEN.
- `"ChangeDetails"`: User-provided details about the change. If no details are provided,
content specified in the Template information section of the associated change template is
added.
- `"ChangeRequestName"`: The name of the change request associated with the runbook
workflow to be run.
- `"ClientToken"`: The user-provided idempotency token. The token must be unique, is case
insensitive, enforces the UUID format, and can't be reused.
- `"DocumentVersion"`: The version of the change template document to run during the
runbook workflow.
- `"Parameters"`: A key-value map of parameters that match the declared parameters in the
change template document.
- `"ScheduledEndTime"`: The time that the requester expects the runbook workflow related to
the change request to complete. The time is an estimate only that the requester provides
for reviewers.
- `"ScheduledTime"`: The date and time specified in the change request to run the
Automation runbooks. The Automation runbooks specified for the runbook workflow can't run
until all required approvals for the change request have been received.
- `"Tags"`: Optional metadata that you assign to a resource. You can specify a maximum of
five tags for a change request. Tags enable you to categorize a resource in different ways,
such as by purpose, owner, or environment. For example, you might want to tag a change
request to identify an environment or target Amazon Web Services Region. In this case, you
could specify the following key-value pairs: Key=Environment,Value=Production
Key=Region,Value=us-east-2
"""
function start_change_request_execution(
DocumentName, Runbooks; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"StartChangeRequestExecution",
Dict{String,Any}("DocumentName" => DocumentName, "Runbooks" => Runbooks);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_change_request_execution(
DocumentName,
Runbooks,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"StartChangeRequestExecution",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DocumentName" => DocumentName, "Runbooks" => Runbooks),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_session(target)
start_session(target, params::Dict{String,<:Any})
Initiates a connection to a target (for example, a managed node) for a Session Manager
session. Returns a URL and token that can be used to open a WebSocket connection for
sending input and receiving outputs. Amazon Web Services CLI usage: start-session is an
interactive command that requires the Session Manager plugin to be installed on the client
machine making the call. For information, see Install the Session Manager plugin for the
Amazon Web Services CLI in the Amazon Web Services Systems Manager User Guide. Amazon Web
Services Tools for PowerShell usage: Start-SSMSession isn't currently supported by Amazon
Web Services Tools for PowerShell on Windows local machines.
# Arguments
- `target`: The managed node to connect to for the session.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DocumentName"`: The name of the SSM document you want to use to define the type of
session, input parameters, or preferences for the session. For example,
SSM-SessionManagerRunShell. You can call the GetDocument API to verify the document exists
before attempting to start a session. If no document name is provided, a shell to the
managed node is launched by default. For more information, see Start a session in the
Amazon Web Services Systems Manager User Guide.
- `"Parameters"`: The values you want to specify for the parameters defined in the Session
document.
- `"Reason"`: The reason for connecting to the instance. This value is included in the
details for the Amazon CloudWatch Events event created when you start the session.
"""
function start_session(Target; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"StartSession",
Dict{String,Any}("Target" => Target);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_session(
Target, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"StartSession",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Target" => Target), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_automation_execution(automation_execution_id)
stop_automation_execution(automation_execution_id, params::Dict{String,<:Any})
Stop an Automation that is currently running.
# Arguments
- `automation_execution_id`: The execution ID of the Automation to stop.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Type"`: The stop request type. Valid types include the following: Cancel and Complete.
The default type is Cancel.
"""
function stop_automation_execution(
AutomationExecutionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"StopAutomationExecution",
Dict{String,Any}("AutomationExecutionId" => AutomationExecutionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_automation_execution(
AutomationExecutionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"StopAutomationExecution",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AutomationExecutionId" => AutomationExecutionId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
terminate_session(session_id)
terminate_session(session_id, params::Dict{String,<:Any})
Permanently ends a session and closes the data connection between the Session Manager
client and SSM Agent on the managed node. A terminated session can't be resumed.
# Arguments
- `session_id`: The ID of the session to terminate.
"""
function terminate_session(SessionId; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"TerminateSession",
Dict{String,Any}("SessionId" => SessionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function terminate_session(
SessionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"TerminateSession",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SessionId" => SessionId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
unlabel_parameter_version(labels, name, parameter_version)
unlabel_parameter_version(labels, name, parameter_version, params::Dict{String,<:Any})
Remove a label or labels from a parameter.
# Arguments
- `labels`: One or more labels to delete from the specified parameter version.
- `name`: The name of the parameter from which you want to delete one or more labels. You
can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself.
- `parameter_version`: The specific version of the parameter which you want to delete one
or more labels from. If it isn't present, the call will fail.
"""
function unlabel_parameter_version(
Labels, Name, ParameterVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"UnlabelParameterVersion",
Dict{String,Any}(
"Labels" => Labels, "Name" => Name, "ParameterVersion" => ParameterVersion
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function unlabel_parameter_version(
Labels,
Name,
ParameterVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"UnlabelParameterVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Labels" => Labels,
"Name" => Name,
"ParameterVersion" => ParameterVersion,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_association(association_id)
update_association(association_id, params::Dict{String,<:Any})
Updates an association. You can update the association name and version, the document
version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output. When
you call UpdateAssociation, the system removes all optional parameters from the request and
overwrites the association with null values for those parameters. This is by design. You
must specify all optional parameters in the call, even if you are not changing the
parameters. This includes the Name parameter. Before calling this API action, we recommend
that you call the DescribeAssociation API operation and make a note of all optional
parameters required for your UpdateAssociation call. In order to call this API operation, a
user, group, or role must be granted permission to call the DescribeAssociation API
operation. If you don't have permission to call DescribeAssociation, then you receive the
following error: An error occurred (AccessDeniedException) when calling the
UpdateAssociation operation: User: <user_arn> isn't authorized to perform:
ssm:DescribeAssociation on resource: <resource_arn> When you update an association,
the association immediately runs against the specified targets. You can add the
ApplyOnlyAtCronInterval parameter to run the association during the next schedule run.
# Arguments
- `association_id`: The ID of the association you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AlarmConfiguration"`:
- `"ApplyOnlyAtCronInterval"`: By default, when you update an association, the system runs
it immediately after it is updated and then according to the schedule you specified.
Specify this option if you don't want an association to run immediately after you update
it. This parameter isn't supported for rate expressions. If you chose this option when you
created an association and later you edit that association or you make changes to the SSM
document on which that association is based (by using the Documents page in the console),
State Manager applies the association at the next specified cron interval. For example, if
you chose the Latest version of an SSM document when you created an association and you
edit the association by choosing a different document version on the Documents page, State
Manager applies the association at the next specified cron interval if you previously
selected this option. If this option wasn't selected, State Manager immediately runs the
association. You can reset this option. To do so, specify the
no-apply-only-at-cron-interval parameter when you update the association from the command
line. This parameter forces the association to run immediately after updating it and
according to the interval specified.
- `"AssociationName"`: The name of the association that you want to update.
- `"AssociationVersion"`: This parameter is provided for concurrency control purposes. You
must specify the latest association version in the service. If you want to ensure that this
request succeeds, either specify LATEST, or omit this parameter.
- `"AutomationTargetParameterName"`: Choose the parameter that will define how your
automation will branch out. This target is required for associations that use an Automation
runbook and target resources by using rate controls. Automation is a capability of Amazon
Web Services Systems Manager.
- `"CalendarNames"`: The names or Amazon Resource Names (ARNs) of the Change Calendar type
documents you want to gate your associations under. The associations only run when that
change calendar is open. For more information, see Amazon Web Services Systems Manager
Change Calendar.
- `"ComplianceSeverity"`: The severity level to assign to the association.
- `"DocumentVersion"`: The document version you want update for the association. State
Manager doesn't support running associations that use a new version of a document if that
document is shared from another account. State Manager always runs the default version of a
document if shared from another account, even though the Systems Manager console shows that
a new version was processed. If you want to run an association using a new version of a
document shared form another account, you must set the document version to default.
- `"Duration"`: The number of hours the association can run before it is canceled. Duration
applies to associations that are currently running, and any pending and in progress
commands on all targets. If a target was taken offline for the association to run, it is
made available again immediately, without a reboot. The Duration parameter applies only
when both these conditions are true: The association for which you specify a duration is
cancelable according to the parameters of the SSM command document or Automation runbook
associated with this execution. The command specifies the ApplyOnlyAtCronInterval
parameter, which means that the association doesn't run immediately after it is updated,
but only according to the specified schedule.
- `"MaxConcurrency"`: The maximum number of targets allowed to run the association at the
same time. You can specify a number, for example 10, or a percentage of the target set, for
example 10%. The default value is 100%, which means all targets run the association at the
same time. If a new managed node starts and attempts to run an association while Systems
Manager is running MaxConcurrency associations, the association is allowed to run. During
the next association interval, the new managed node will process its association within the
limit specified for MaxConcurrency.
- `"MaxErrors"`: The number of errors that are allowed before the system stops sending
requests to run the association on additional targets. You can specify either an absolute
number of errors, for example 10, or a percentage of the target set, for example 10%. If
you specify 3, for example, the system stops sending requests when the fourth error is
received. If you specify 0, then the system stops sending requests after the first error is
returned. If you run an association on 50 managed nodes and set MaxError to 10%, then the
system stops sending the request when the sixth error is received. Executions that are
already running an association when MaxErrors is reached are allowed to complete, but some
of these executions may fail as well. If you need to ensure that there won't be more than
max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a
time.
- `"Name"`: The name of the SSM Command document or Automation runbook that contains the
configuration information for the managed node. You can specify Amazon Web
Services-predefined documents, documents you created, or a document that is shared with you
from another account. For Systems Manager document (SSM document) that are shared with you
from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in
the following format: arn:aws:ssm:region:account-id:document/document-name For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document For Amazon Web
Services-predefined documents and SSM documents you created in your account, you only need
to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.
- `"OutputLocation"`: An S3 bucket where you want to store the results of this request.
- `"Parameters"`: The parameters you want to update for the association. If you create a
parameter using Parameter Store, a capability of Amazon Web Services Systems Manager, you
can reference the parameter using {{ssm:parameter-name}}.
- `"ScheduleExpression"`: The cron expression used to schedule the association that you
want to update.
- `"ScheduleOffset"`: Number of days to wait after the scheduled day to run an association.
For example, if you specified a cron schedule of cron(0 0 ? * THU#2 *), you could specify
an offset of 3 to run the association each Sunday after the second Thursday of the month.
For more information about cron schedules for associations, see Reference: Cron and rate
expressions for Systems Manager in the Amazon Web Services Systems Manager User Guide. To
use offsets, you must specify the ApplyOnlyAtCronInterval parameter. This option tells the
system not to run an association immediately after you create it.
- `"SyncCompliance"`: The mode for generating association compliance. You can specify AUTO
or MANUAL. In AUTO mode, the system uses the status of the association execution to
determine the compliance status. If the association execution runs successfully, then the
association is COMPLIANT. If the association execution doesn't run successfully, the
association is NON-COMPLIANT. In MANUAL mode, you must specify the AssociationId as a
parameter for the PutComplianceItems API operation. In this case, compliance data isn't
managed by State Manager, a capability of Amazon Web Services Systems Manager. It is
managed by your direct call to the PutComplianceItems API operation. By default, all
associations use AUTO mode.
- `"TargetLocations"`: A location is a combination of Amazon Web Services Regions and
Amazon Web Services accounts where you want to run the association. Use this action to
update an association in multiple Regions and multiple accounts.
- `"TargetMaps"`: A key-value mapping of document parameters to target resources. Both
Targets and TargetMaps can't be specified together.
- `"Targets"`: The targets of the association.
"""
function update_association(
AssociationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"UpdateAssociation",
Dict{String,Any}("AssociationId" => AssociationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_association(
AssociationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"UpdateAssociation",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AssociationId" => AssociationId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_association_status(association_status, instance_id, name)
update_association_status(association_status, instance_id, name, params::Dict{String,<:Any})
Updates the status of the Amazon Web Services Systems Manager document (SSM document)
associated with the specified managed node. UpdateAssociationStatus is primarily used by
the Amazon Web Services Systems Manager Agent (SSM Agent) to report status updates about
your associations and is only used for associations created with the InstanceId legacy
parameter.
# Arguments
- `association_status`: The association status.
- `instance_id`: The managed node ID.
- `name`: The name of the SSM document.
"""
function update_association_status(
AssociationStatus, InstanceId, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"UpdateAssociationStatus",
Dict{String,Any}(
"AssociationStatus" => AssociationStatus,
"InstanceId" => InstanceId,
"Name" => Name,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_association_status(
AssociationStatus,
InstanceId,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"UpdateAssociationStatus",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AssociationStatus" => AssociationStatus,
"InstanceId" => InstanceId,
"Name" => Name,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_document(content, name)
update_document(content, name, params::Dict{String,<:Any})
Updates one or more values for an SSM document.
# Arguments
- `content`: A valid JSON or YAML string.
- `name`: The name of the SSM document that you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Attachments"`: A list of key-value pairs that describe attachments to a version of a
document.
- `"DisplayName"`: The friendly name of the SSM document that you want to update. This
value can differ for each version of the document. If you don't specify a value for this
parameter in your request, the existing value is applied to the new document version.
- `"DocumentFormat"`: Specify the document format for the new document version. Systems
Manager supports JSON and YAML documents. JSON is the default format.
- `"DocumentVersion"`: The version of the document that you want to update. Currently,
Systems Manager supports updating only the latest version of the document. You can specify
the version number of the latest version or use the LATEST variable. If you change a
document version for a State Manager association, Systems Manager immediately runs the
association unless you previously specifed the apply-only-at-cron-interval parameter.
- `"TargetType"`: Specify a new target type for the document.
- `"VersionName"`: An optional field specifying the version of the artifact you are
updating with the document. For example, 12.6. This value is unique across all versions of
a document, and can't be changed.
"""
function update_document(Content, Name; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"UpdateDocument",
Dict{String,Any}("Content" => Content, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_document(
Content,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"UpdateDocument",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Content" => Content, "Name" => Name), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_document_default_version(document_version, name)
update_document_default_version(document_version, name, params::Dict{String,<:Any})
Set the default version of a document. If you change a document version for a State
Manager association, Systems Manager immediately runs the association unless you previously
specifed the apply-only-at-cron-interval parameter.
# Arguments
- `document_version`: The version of a custom document that you want to set as the default
version.
- `name`: The name of a custom document that you want to set as the default version.
"""
function update_document_default_version(
DocumentVersion, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"UpdateDocumentDefaultVersion",
Dict{String,Any}("DocumentVersion" => DocumentVersion, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_document_default_version(
DocumentVersion,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"UpdateDocumentDefaultVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DocumentVersion" => DocumentVersion, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_document_metadata(document_reviews, name)
update_document_metadata(document_reviews, name, params::Dict{String,<:Any})
Updates information related to approval reviews for a specific version of a change template
in Change Manager.
# Arguments
- `document_reviews`: The change template review details to update.
- `name`: The name of the change template for which a version's metadata is to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DocumentVersion"`: The version of a change template in which to update approval
metadata.
"""
function update_document_metadata(
DocumentReviews, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"UpdateDocumentMetadata",
Dict{String,Any}("DocumentReviews" => DocumentReviews, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_document_metadata(
DocumentReviews,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"UpdateDocumentMetadata",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DocumentReviews" => DocumentReviews, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_maintenance_window(window_id)
update_maintenance_window(window_id, params::Dict{String,<:Any})
Updates an existing maintenance window. Only specified parameters are modified. The value
you specify for Duration determines the specific end time for the maintenance window based
on the time it begins. No maintenance window tasks are permitted to start after the
resulting endtime minus the number of hours you specify for Cutoff. For example, if the
maintenance window starts at 3 PM, the duration is three hours, and the value you specify
for Cutoff is one hour, no maintenance window tasks can start after 5 PM.
# Arguments
- `window_id`: The ID of the maintenance window to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllowUnassociatedTargets"`: Whether targets must be registered with the maintenance
window before tasks can be defined for those targets.
- `"Cutoff"`: The number of hours before the end of the maintenance window that Amazon Web
Services Systems Manager stops scheduling new tasks for execution.
- `"Description"`: An optional description for the update request.
- `"Duration"`: The duration of the maintenance window in hours.
- `"Enabled"`: Whether the maintenance window is enabled.
- `"EndDate"`: The date and time, in ISO-8601 Extended format, for when you want the
maintenance window to become inactive. EndDate allows you to set a date and time in the
future when the maintenance window will no longer run.
- `"Name"`: The name of the maintenance window.
- `"Replace"`: If True, then all fields that are required by the CreateMaintenanceWindow
operation are also required for this API request. Optional fields that aren't specified are
set to null.
- `"Schedule"`: The schedule of the maintenance window in the form of a cron or rate
expression.
- `"ScheduleOffset"`: The number of days to wait after the date and time specified by a
cron expression before running the maintenance window. For example, the following cron
expression schedules a maintenance window to run the third Tuesday of every month at 11:30
PM. cron(30 23 ? * TUE#3 *) If the schedule offset is 2, the maintenance window won't run
until two days later.
- `"ScheduleTimezone"`: The time zone that the scheduled maintenance window executions are
based on, in Internet Assigned Numbers Authority (IANA) format. For example:
\"America/Los_Angeles\", \"UTC\", or \"Asia/Seoul\". For more information, see the Time
Zone Database on the IANA website.
- `"StartDate"`: The date and time, in ISO-8601 Extended format, for when you want the
maintenance window to become active. StartDate allows you to delay activation of the
maintenance window until the specified future date. When using a rate schedule, if you
provide a start date that occurs in the past, the current date and time are used as the
start date.
"""
function update_maintenance_window(
WindowId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"UpdateMaintenanceWindow",
Dict{String,Any}("WindowId" => WindowId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_maintenance_window(
WindowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"UpdateMaintenanceWindow",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("WindowId" => WindowId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_maintenance_window_target(window_id, window_target_id)
update_maintenance_window_target(window_id, window_target_id, params::Dict{String,<:Any})
Modifies the target of an existing maintenance window. You can change the following: Name
Description Owner IDs for an ID target Tags for a Tag target From any supported
tag type to another. The three supported tag types are ID target, Tag target, and resource
group. For more information, see Target. If a parameter is null, then the corresponding
field isn't modified.
# Arguments
- `window_id`: The maintenance window ID with which to modify the target.
- `window_target_id`: The target ID to modify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: An optional description for the update.
- `"Name"`: A name for the update.
- `"OwnerInformation"`: User-provided value that will be included in any Amazon CloudWatch
Events events raised while running tasks for these targets in this maintenance window.
- `"Replace"`: If True, then all fields that are required by the
RegisterTargetWithMaintenanceWindow operation are also required for this API request.
Optional fields that aren't specified are set to null.
- `"Targets"`: The targets to add or replace.
"""
function update_maintenance_window_target(
WindowId, WindowTargetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"UpdateMaintenanceWindowTarget",
Dict{String,Any}("WindowId" => WindowId, "WindowTargetId" => WindowTargetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_maintenance_window_target(
WindowId,
WindowTargetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"UpdateMaintenanceWindowTarget",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"WindowId" => WindowId, "WindowTargetId" => WindowTargetId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_maintenance_window_task(window_id, window_task_id)
update_maintenance_window_task(window_id, window_task_id, params::Dict{String,<:Any})
Modifies a task assigned to a maintenance window. You can't change the task type, but you
can change the following values: TaskARN. For example, you can change a RUN_COMMAND task
from AWS-RunPowerShellScript to AWS-RunShellScript. ServiceRoleArn
TaskInvocationParameters Priority MaxConcurrency MaxErrors One or more
targets must be specified for maintenance window Run Command-type tasks. Depending on the
task, targets are optional for other maintenance window task types (Automation, Lambda, and
Step Functions). For more information about running tasks that don't specify targets, see
Registering maintenance window tasks without targets in the Amazon Web Services Systems
Manager User Guide. If the value for a parameter in UpdateMaintenanceWindowTask is null,
then the corresponding field isn't modified. If you set Replace to true, then all fields
required by the RegisterTaskWithMaintenanceWindow operation are required for this request.
Optional fields that aren't specified are set to null. When you update a maintenance
window task that has options specified in TaskInvocationParameters, you must provide again
all the TaskInvocationParameters values that you want to retain. The values you don't
specify again are removed. For example, suppose that when you registered a Run Command
task, you specified TaskInvocationParameters values for Comment, NotificationConfig, and
OutputS3BucketName. If you update the maintenance window task and specify only a different
OutputS3BucketName value, the values for Comment and NotificationConfig are removed.
# Arguments
- `window_id`: The maintenance window ID that contains the task to modify.
- `window_task_id`: The task ID to modify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AlarmConfiguration"`: The CloudWatch alarm you want to apply to your maintenance window
task.
- `"CutoffBehavior"`: Indicates whether tasks should continue to run after the cutoff time
specified in the maintenance windows is reached. CONTINUE_TASK: When the cutoff time is
reached, any tasks that are running continue. The default value. CANCEL_TASK: For
Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task
invocations that are already running continue, but no new task invocations are started.
For Run Command tasks: When the cutoff time is reached, the system sends a CancelCommand
operation that attempts to cancel the command associated with the task. However, there is
no guarantee that the command will be terminated and the underlying process stopped. The
status for tasks that are not completed is TIMED_OUT.
- `"Description"`: The new task description to specify.
- `"LoggingInfo"`: The new logging location in Amazon S3 to specify. LoggingInfo has been
deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs,
instead use the OutputS3BucketName and OutputS3KeyPrefix options in the
TaskInvocationParameters structure. For information about how Amazon Web Services Systems
Manager handles these options for the supported maintenance window task types, see
MaintenanceWindowTaskInvocationParameters.
- `"MaxConcurrency"`: The new MaxConcurrency value you want to specify. MaxConcurrency is
the number of targets that are allowed to run this task, in parallel. Although this
element is listed as \"Required: No\", a value can be omitted only when you are registering
or updating a targetless task You must provide a value in all other cases. For maintenance
window tasks without a target specified, you can't supply a value for this option. Instead,
the system inserts a placeholder value of 1. This value doesn't affect the running of your
task.
- `"MaxErrors"`: The new MaxErrors value to specify. MaxErrors is the maximum number of
errors that are allowed before the task stops being scheduled. Although this element is
listed as \"Required: No\", a value can be omitted only when you are registering or
updating a targetless task You must provide a value in all other cases. For maintenance
window tasks without a target specified, you can't supply a value for this option. Instead,
the system inserts a placeholder value of 1. This value doesn't affect the running of your
task.
- `"Name"`: The new task name to specify.
- `"Priority"`: The new task priority to specify. The lower the number, the higher the
priority. Tasks that have the same priority are scheduled in parallel.
- `"Replace"`: If True, then all fields that are required by the
RegisterTaskWithMaintenanceWindow operation are also required for this API request.
Optional fields that aren't specified are set to null.
- `"ServiceRoleArn"`: The Amazon Resource Name (ARN) of the IAM service role for Amazon Web
Services Systems Manager to assume when running a maintenance window task. If you do not
specify a service role ARN, Systems Manager uses a service-linked role in your account. If
no appropriate service-linked role for Systems Manager exists in your account, it is
created when you run RegisterTaskWithMaintenanceWindow. However, for an improved security
posture, we strongly recommend creating a custom policy and custom service role for running
your maintenance window tasks. The policy can be crafted to provide only the permissions
needed for your particular maintenance window tasks. For more information, see Setting up
maintenance windows in the in the Amazon Web Services Systems Manager User Guide.
- `"Targets"`: The targets (either managed nodes or tags) to modify. Managed nodes are
specified using the format Key=instanceids,Values=instanceID_1,instanceID_2. Tags are
specified using the format Key=tag_name,Values=tag_value. One or more targets must be
specified for maintenance window Run Command-type tasks. Depending on the task, targets are
optional for other maintenance window task types (Automation, Lambda, and Step Functions).
For more information about running tasks that don't specify targets, see Registering
maintenance window tasks without targets in the Amazon Web Services Systems Manager User
Guide.
- `"TaskArn"`: The task ARN to modify.
- `"TaskInvocationParameters"`: The parameters that the task should use during execution.
Populate only the fields that match the task type. All other fields should be empty. When
you update a maintenance window task that has options specified in
TaskInvocationParameters, you must provide again all the TaskInvocationParameters values
that you want to retain. The values you don't specify again are removed. For example,
suppose that when you registered a Run Command task, you specified TaskInvocationParameters
values for Comment, NotificationConfig, and OutputS3BucketName. If you update the
maintenance window task and specify only a different OutputS3BucketName value, the values
for Comment and NotificationConfig are removed.
- `"TaskParameters"`: The parameters to modify. TaskParameters has been deprecated. To
specify parameters to pass to a task when it runs, instead use the Parameters option in the
TaskInvocationParameters structure. For information about how Systems Manager handles these
options for the supported maintenance window task types, see
MaintenanceWindowTaskInvocationParameters. The map has the following format: Key: string,
between 1 and 255 characters Value: an array of strings, each string is between 1 and 255
characters
"""
function update_maintenance_window_task(
WindowId, WindowTaskId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"UpdateMaintenanceWindowTask",
Dict{String,Any}("WindowId" => WindowId, "WindowTaskId" => WindowTaskId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_maintenance_window_task(
WindowId,
WindowTaskId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"UpdateMaintenanceWindowTask",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("WindowId" => WindowId, "WindowTaskId" => WindowTaskId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_managed_instance_role(iam_role, instance_id)
update_managed_instance_role(iam_role, instance_id, params::Dict{String,<:Any})
Changes the Identity and Access Management (IAM) role that is assigned to the on-premises
server, edge device, or virtual machines (VM). IAM roles are first assigned to these hybrid
nodes during the activation process. For more information, see CreateActivation.
# Arguments
- `iam_role`: The name of the Identity and Access Management (IAM) role that you want to
assign to the managed node. This IAM role must provide AssumeRole permissions for the
Amazon Web Services Systems Manager service principal ssm.amazonaws.com. For more
information, see Create an IAM service role for a hybrid and multicloud environment in the
Amazon Web Services Systems Manager User Guide. You can't specify an IAM service-linked
role for this parameter. You must create a unique role.
- `instance_id`: The ID of the managed node where you want to update the role.
"""
function update_managed_instance_role(
IamRole, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"UpdateManagedInstanceRole",
Dict{String,Any}("IamRole" => IamRole, "InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_managed_instance_role(
IamRole,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"UpdateManagedInstanceRole",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("IamRole" => IamRole, "InstanceId" => InstanceId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_ops_item(ops_item_id)
update_ops_item(ops_item_id, params::Dict{String,<:Any})
Edit or change an OpsItem. You must have permission in Identity and Access Management (IAM)
to update an OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services
Systems Manager User Guide. Operations engineers and IT professionals use Amazon Web
Services Systems Manager OpsCenter to view, investigate, and remediate operational issues
impacting the performance and health of their Amazon Web Services resources. For more
information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services
Systems Manager User Guide.
# Arguments
- `ops_item_id`: The ID of the OpsItem.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ActualEndTime"`: The time a runbook workflow ended. Currently reported only for the
OpsItem type /aws/changerequest.
- `"ActualStartTime"`: The time a runbook workflow started. Currently reported only for the
OpsItem type /aws/changerequest.
- `"Category"`: Specify a new category for an OpsItem.
- `"Description"`: User-defined text that contains information about the OpsItem, in
Markdown format.
- `"Notifications"`: The Amazon Resource Name (ARN) of an SNS topic where notifications are
sent when this OpsItem is edited or changed.
- `"OperationalData"`: Add new keys or edit existing key-value pairs of the OperationalData
map in the OpsItem object. Operational data is custom data that provides useful reference
details about the OpsItem. For example, you can specify log files, error strings, license
keys, troubleshooting tips, or other relevant data. You enter operational data as key-value
pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20
KB. Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon,
/aws, /amzn, /ssm. You can choose to make the data searchable by other users in the
account or you can restrict search access. Searchable data means that all users with access
to the OpsItem Overview page (as provided by the DescribeOpsItems API operation) can view
and search on the specified data. Operational data that isn't searchable is only viewable
by users who have access to the OpsItem (as provided by the GetOpsItem API operation). Use
the /aws/resources key in OperationalData to specify a related resource in the request. Use
the /aws/automations key in OperationalData to associate an Automation runbook with the
OpsItem. To view Amazon Web Services CLI example commands that use these keys, see Creating
OpsItems manually in the Amazon Web Services Systems Manager User Guide.
- `"OperationalDataToDelete"`: Keys that you want to remove from the OperationalData map.
- `"OpsItemArn"`: The OpsItem Amazon Resource Name (ARN).
- `"PlannedEndTime"`: The time specified in a change request for a runbook workflow to end.
Currently supported only for the OpsItem type /aws/changerequest.
- `"PlannedStartTime"`: The time specified in a change request for a runbook workflow to
start. Currently supported only for the OpsItem type /aws/changerequest.
- `"Priority"`: The importance of this OpsItem in relation to other OpsItems in the system.
- `"RelatedOpsItems"`: One or more OpsItems that share something in common with the current
OpsItems. For example, related OpsItems can include OpsItems with similar error messages,
impacted resources, or statuses for the impacted resource.
- `"Severity"`: Specify a new severity for an OpsItem.
- `"Status"`: The OpsItem status. Status can be Open, In Progress, or Resolved. For more
information, see Editing OpsItem details in the Amazon Web Services Systems Manager User
Guide.
- `"Title"`: A short heading that describes the nature of the OpsItem and the impacted
resource.
"""
function update_ops_item(OpsItemId; aws_config::AbstractAWSConfig=global_aws_config())
return ssm(
"UpdateOpsItem",
Dict{String,Any}("OpsItemId" => OpsItemId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_ops_item(
OpsItemId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"UpdateOpsItem",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("OpsItemId" => OpsItemId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_ops_metadata(ops_metadata_arn)
update_ops_metadata(ops_metadata_arn, params::Dict{String,<:Any})
Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in
Application Manager.
# Arguments
- `ops_metadata_arn`: The Amazon Resource Name (ARN) of the OpsMetadata Object to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"KeysToDelete"`: The metadata keys to delete from the OpsMetadata object.
- `"MetadataToUpdate"`: Metadata to add to an OpsMetadata object.
"""
function update_ops_metadata(
OpsMetadataArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"UpdateOpsMetadata",
Dict{String,Any}("OpsMetadataArn" => OpsMetadataArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_ops_metadata(
OpsMetadataArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"UpdateOpsMetadata",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("OpsMetadataArn" => OpsMetadataArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_patch_baseline(baseline_id)
update_patch_baseline(baseline_id, params::Dict{String,<:Any})
Modifies an existing patch baseline. Fields not specified in the request are left
unchanged. For information about valid key-value pairs in PatchFilters for each supported
operating system type, see PatchFilter.
# Arguments
- `baseline_id`: The ID of the patch baseline to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ApprovalRules"`: A set of rules used to include patches in the baseline.
- `"ApprovedPatches"`: A list of explicitly approved patches for the baseline. For
information about accepted formats for lists of approved patches and rejected patches, see
About package name formats for approved and rejected patch lists in the Amazon Web Services
Systems Manager User Guide.
- `"ApprovedPatchesComplianceLevel"`: Assigns a new compliance severity level to an
existing patch baseline.
- `"ApprovedPatchesEnableNonSecurity"`: Indicates whether the list of approved patches
includes non-security updates that should be applied to the managed nodes. The default
value is false. Applies to Linux managed nodes only.
- `"Description"`: A description of the patch baseline.
- `"GlobalFilters"`: A set of global filters used to include patches in the baseline.
- `"Name"`: The name of the patch baseline.
- `"RejectedPatches"`: A list of explicitly rejected patches for the baseline. For
information about accepted formats for lists of approved patches and rejected patches, see
About package name formats for approved and rejected patch lists in the Amazon Web Services
Systems Manager User Guide.
- `"RejectedPatchesAction"`: The action for Patch Manager to take on patches included in
the RejectedPackages list. ALLOW_AS_DEPENDENCY : A package in the Rejected patches list
is installed only if it is a dependency of another package. It is considered compliant with
the patch baseline, and its status is reported as InstalledOther. This is the default
action if no option is specified. BLOCK: Packages in the Rejected patches list, and
packages that include them as dependencies, aren't installed by Patch Manager under any
circumstances. If a package was installed before it was added to the Rejected patches list,
or is installed outside of Patch Manager afterward, it's considered noncompliant with the
patch baseline and its status is reported as InstalledRejected.
- `"Replace"`: If True, then all fields that are required by the CreatePatchBaseline
operation are also required for this API request. Optional fields that aren't specified are
set to null.
- `"Sources"`: Information about the patches to use to update the managed nodes, including
target operating systems and source repositories. Applies to Linux managed nodes only.
"""
function update_patch_baseline(
BaselineId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"UpdatePatchBaseline",
Dict{String,Any}("BaselineId" => BaselineId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_patch_baseline(
BaselineId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"UpdatePatchBaseline",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("BaselineId" => BaselineId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_resource_data_sync(sync_name, sync_source, sync_type)
update_resource_data_sync(sync_name, sync_source, sync_type, params::Dict{String,<:Any})
Update a resource data sync. After you create a resource data sync for a Region, you can't
change the account options for that sync. For example, if you create a sync in the
us-east-2 (Ohio) Region and you choose the Include only the current account option, you
can't edit that sync later and choose the Include all accounts from my Organizations
configuration option. Instead, you must delete the first resource data sync, and create a
new one. This API operation only supports a resource data sync that was created with a
SyncFromSource SyncType.
# Arguments
- `sync_name`: The name of the resource data sync you want to update.
- `sync_source`: Specify information about the data sources to synchronize.
- `sync_type`: The type of resource data sync. The supported SyncType is SyncFromSource.
"""
function update_resource_data_sync(
SyncName, SyncSource, SyncType; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"UpdateResourceDataSync",
Dict{String,Any}(
"SyncName" => SyncName, "SyncSource" => SyncSource, "SyncType" => SyncType
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_resource_data_sync(
SyncName,
SyncSource,
SyncType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"UpdateResourceDataSync",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SyncName" => SyncName,
"SyncSource" => SyncSource,
"SyncType" => SyncType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_service_setting(setting_id, setting_value)
update_service_setting(setting_id, setting_value, params::Dict{String,<:Any})
ServiceSetting is an account-level setting for an Amazon Web Services service. This
setting defines how a user interacts with or uses a service or a feature of a service. For
example, if an Amazon Web Services service charges money to the account based on feature or
service usage, then the Amazon Web Services service team might create a default setting of
\"false\". This means the user can't use this feature unless they change the setting to
\"true\" and intentionally opt in for a paid feature. Services map a SettingId object to a
setting value. Amazon Web Services services teams define the default value for a SettingId.
You can't create a new SettingId, but you can overwrite the default value if you have the
ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API
operation to view the current value. Or, use the ResetServiceSetting to change the value
back to the original value defined by the Amazon Web Services service team. Update the
service setting for the account.
# Arguments
- `setting_id`: The Amazon Resource Name (ARN) of the service setting to update. For
example,
arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enable
d. The setting ID can be one of the following.
/ssm/managed-instance/default-ec2-instance-management-role
/ssm/automation/customer-script-log-destination
/ssm/automation/customer-script-log-group-name
/ssm/documents/console/public-sharing-permission /ssm/managed-instance/activation-tier
/ssm/opsinsights/opscenter /ssm/parameter-store/default-parameter-tier
/ssm/parameter-store/high-throughput-enabled Permissions to update the
/ssm/managed-instance/default-ec2-instance-management-role setting should only be provided
to administrators. Implement least privilege access when allowing individuals to configure
or modify the Default Host Management Configuration.
- `setting_value`: The new value to specify for the service setting. The following list
specifies the available values for each setting. For
/ssm/managed-instance/default-ec2-instance-management-role, enter the name of an IAM role.
For /ssm/automation/customer-script-log-destination, enter CloudWatch. For
/ssm/automation/customer-script-log-group-name, enter the name of an Amazon CloudWatch Logs
log group. For /ssm/documents/console/public-sharing-permission, enter Enable or Disable.
For /ssm/managed-instance/activation-tier, enter standard or advanced. For
/ssm/opsinsights/opscenter, enter Enabled or Disabled. For
/ssm/parameter-store/default-parameter-tier, enter Standard, Advanced, or
Intelligent-Tiering For /ssm/parameter-store/high-throughput-enabled, enter true or
false.
"""
function update_service_setting(
SettingId, SettingValue; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm(
"UpdateServiceSetting",
Dict{String,Any}("SettingId" => SettingId, "SettingValue" => SettingValue);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_service_setting(
SettingId,
SettingValue,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm(
"UpdateServiceSetting",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("SettingId" => SettingId, "SettingValue" => SettingValue),
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 | 56220 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: ssm_contacts
using AWS.Compat
using AWS.UUIDs
"""
accept_page(accept_code, accept_type, page_id)
accept_page(accept_code, accept_type, page_id, params::Dict{String,<:Any})
Used to acknowledge an engagement to a contact channel during an incident.
# Arguments
- `accept_code`: A 6-digit code used to acknowledge the page.
- `accept_type`: The type indicates if the page was DELIVERED or READ.
- `page_id`: The Amazon Resource Name (ARN) of the engagement to a contact channel.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptCodeValidation"`: An optional field that Incident Manager uses to ENFORCE
AcceptCode validation when acknowledging an page. Acknowledgement can occur by replying to
a page, or when entering the AcceptCode in the console. Enforcing AcceptCode validation
causes Incident Manager to verify that the code entered by the user matches the code sent
by Incident Manager with the page. Incident Manager can also IGNORE AcceptCode validation.
Ignoring AcceptCode validation causes Incident Manager to accept any value entered for the
AcceptCode.
- `"ContactChannelId"`: The ARN of the contact channel.
- `"Note"`: Information provided by the user when the user acknowledges the page.
"""
function accept_page(
AcceptCode, AcceptType, PageId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_contacts(
"AcceptPage",
Dict{String,Any}(
"AcceptCode" => AcceptCode, "AcceptType" => AcceptType, "PageId" => PageId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function accept_page(
AcceptCode,
AcceptType,
PageId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_contacts(
"AcceptPage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AcceptCode" => AcceptCode,
"AcceptType" => AcceptType,
"PageId" => PageId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
activate_contact_channel(activation_code, contact_channel_id)
activate_contact_channel(activation_code, contact_channel_id, params::Dict{String,<:Any})
Activates a contact's contact channel. Incident Manager can't engage a contact until the
contact channel has been activated.
# Arguments
- `activation_code`: The code sent to the contact channel when it was created in the
contact.
- `contact_channel_id`: The Amazon Resource Name (ARN) of the contact channel.
"""
function activate_contact_channel(
ActivationCode, ContactChannelId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_contacts(
"ActivateContactChannel",
Dict{String,Any}(
"ActivationCode" => ActivationCode, "ContactChannelId" => ContactChannelId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function activate_contact_channel(
ActivationCode,
ContactChannelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_contacts(
"ActivateContactChannel",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ActivationCode" => ActivationCode,
"ContactChannelId" => ContactChannelId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_contact(alias, plan, type)
create_contact(alias, plan, type, params::Dict{String,<:Any})
Contacts are either the contacts that Incident Manager engages during an incident or the
escalation plans that Incident Manager uses to engage contacts in phases during an incident.
# Arguments
- `alias`: The short name to quickly identify a contact or escalation plan. The contact
alias must be unique and identifiable.
- `plan`: A list of stages. A contact has an engagement plan with stages that contact
specified contact channels. An escalation plan uses stages that contact specified contacts.
- `type`: To create an escalation plan use ESCALATION. To create a contact use PERSONAL.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DisplayName"`: The full name of the contact or escalation plan.
- `"IdempotencyToken"`: A token ensuring that the operation is called only once with the
specified details.
- `"Tags"`: Adds a tag to the target. You can only tag resources created in the first
Region of your replication set.
"""
function create_contact(
Alias, Plan, Type; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_contacts(
"CreateContact",
Dict{String,Any}(
"Alias" => Alias,
"Plan" => Plan,
"Type" => Type,
"IdempotencyToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_contact(
Alias,
Plan,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_contacts(
"CreateContact",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Alias" => Alias,
"Plan" => Plan,
"Type" => Type,
"IdempotencyToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_contact_channel(contact_id, delivery_address, name, type)
create_contact_channel(contact_id, delivery_address, name, type, params::Dict{String,<:Any})
A contact channel is the method that Incident Manager uses to engage your contact.
# Arguments
- `contact_id`: The Amazon Resource Name (ARN) of the contact you are adding the contact
channel to.
- `delivery_address`: The details that Incident Manager uses when trying to engage the
contact channel. The format is dependent on the type of the contact channel. The following
are the expected formats: SMS - '+' followed by the country code and phone number VOICE
- '+' followed by the country code and phone number EMAIL - any standard email format
- `name`: The name of the contact channel.
- `type`: Incident Manager supports three types of contact channels: SMS VOICE
EMAIL
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeferActivation"`: If you want to activate the channel at a later time, you can choose
to defer activation. Incident Manager can't engage your contact channel until it has been
activated.
- `"IdempotencyToken"`: A token ensuring that the operation is called only once with the
specified details.
"""
function create_contact_channel(
ContactId,
DeliveryAddress,
Name,
Type;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_contacts(
"CreateContactChannel",
Dict{String,Any}(
"ContactId" => ContactId,
"DeliveryAddress" => DeliveryAddress,
"Name" => Name,
"Type" => Type,
"IdempotencyToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_contact_channel(
ContactId,
DeliveryAddress,
Name,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_contacts(
"CreateContactChannel",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ContactId" => ContactId,
"DeliveryAddress" => DeliveryAddress,
"Name" => Name,
"Type" => Type,
"IdempotencyToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_rotation(contact_ids, name, recurrence, time_zone_id)
create_rotation(contact_ids, name, recurrence, time_zone_id, params::Dict{String,<:Any})
Creates a rotation in an on-call schedule.
# Arguments
- `contact_ids`: The Amazon Resource Names (ARNs) of the contacts to add to the rotation.
The order that you list the contacts in is their shift order in the rotation schedule. To
change the order of the contact's shifts, use the UpdateRotation operation.
- `name`: The name of the rotation.
- `recurrence`: Information about the rule that specifies when a shift's team members
rotate.
- `time_zone_id`: The time zone to base the rotation’s activity on in Internet Assigned
Numbers Authority (IANA) format. For example: \"America/Los_Angeles\", \"UTC\", or
\"Asia/Seoul\". For more information, see the Time Zone Database on the IANA website.
Designators for time zones that don’t support Daylight Savings Time rules, such as
Pacific Standard Time (PST) and Pacific Daylight Time (PDT), are not supported.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IdempotencyToken"`: A token that ensures that the operation is called only once with
the specified details.
- `"StartTime"`: The date and time that the rotation goes into effect.
- `"Tags"`: Optional metadata to assign to the rotation. Tags enable you to categorize a
resource in different ways, such as by purpose, owner, or environment. For more
information, see Tagging Incident Manager resources in the Incident Manager User Guide.
"""
function create_rotation(
ContactIds,
Name,
Recurrence,
TimeZoneId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_contacts(
"CreateRotation",
Dict{String,Any}(
"ContactIds" => ContactIds,
"Name" => Name,
"Recurrence" => Recurrence,
"TimeZoneId" => TimeZoneId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_rotation(
ContactIds,
Name,
Recurrence,
TimeZoneId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_contacts(
"CreateRotation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ContactIds" => ContactIds,
"Name" => Name,
"Recurrence" => Recurrence,
"TimeZoneId" => TimeZoneId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_rotation_override(end_time, new_contact_ids, rotation_id, start_time)
create_rotation_override(end_time, new_contact_ids, rotation_id, start_time, params::Dict{String,<:Any})
Creates an override for a rotation in an on-call schedule.
# Arguments
- `end_time`: The date and time when the override ends.
- `new_contact_ids`: The Amazon Resource Names (ARNs) of the contacts to replace those in
the current on-call rotation with. If you want to include any current team members in the
override shift, you must include their ARNs in the new contact ID list.
- `rotation_id`: The Amazon Resource Name (ARN) of the rotation to create an override for.
- `start_time`: The date and time when the override goes into effect.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IdempotencyToken"`: A token that ensures that the operation is called only once with
the specified details.
"""
function create_rotation_override(
EndTime,
NewContactIds,
RotationId,
StartTime;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_contacts(
"CreateRotationOverride",
Dict{String,Any}(
"EndTime" => EndTime,
"NewContactIds" => NewContactIds,
"RotationId" => RotationId,
"StartTime" => StartTime,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_rotation_override(
EndTime,
NewContactIds,
RotationId,
StartTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_contacts(
"CreateRotationOverride",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EndTime" => EndTime,
"NewContactIds" => NewContactIds,
"RotationId" => RotationId,
"StartTime" => StartTime,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deactivate_contact_channel(contact_channel_id)
deactivate_contact_channel(contact_channel_id, params::Dict{String,<:Any})
To no longer receive Incident Manager engagements to a contact channel, you can deactivate
the channel.
# Arguments
- `contact_channel_id`: The Amazon Resource Name (ARN) of the contact channel you're
deactivating.
"""
function deactivate_contact_channel(
ContactChannelId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_contacts(
"DeactivateContactChannel",
Dict{String,Any}("ContactChannelId" => ContactChannelId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deactivate_contact_channel(
ContactChannelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_contacts(
"DeactivateContactChannel",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ContactChannelId" => ContactChannelId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_contact(contact_id)
delete_contact(contact_id, params::Dict{String,<:Any})
To remove a contact from Incident Manager, you can delete the contact. Deleting a contact
removes them from all escalation plans and related response plans. Deleting an escalation
plan removes it from all related response plans. You will have to recreate the contact and
its contact channels before you can use it again.
# Arguments
- `contact_id`: The Amazon Resource Name (ARN) of the contact that you're deleting.
"""
function delete_contact(ContactId; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_contacts(
"DeleteContact",
Dict{String,Any}("ContactId" => ContactId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_contact(
ContactId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_contacts(
"DeleteContact",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ContactId" => ContactId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_contact_channel(contact_channel_id)
delete_contact_channel(contact_channel_id, params::Dict{String,<:Any})
To no longer receive engagements on a contact channel, you can delete the channel from a
contact. Deleting the contact channel removes it from the contact's engagement plan. If you
delete the only contact channel for a contact, you won't be able to engage that contact
during an incident.
# Arguments
- `contact_channel_id`: The Amazon Resource Name (ARN) of the contact channel.
"""
function delete_contact_channel(
ContactChannelId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_contacts(
"DeleteContactChannel",
Dict{String,Any}("ContactChannelId" => ContactChannelId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_contact_channel(
ContactChannelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_contacts(
"DeleteContactChannel",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ContactChannelId" => ContactChannelId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_rotation(rotation_id)
delete_rotation(rotation_id, params::Dict{String,<:Any})
Deletes a rotation from the system. If a rotation belongs to more than one on-call
schedule, this operation deletes it from all of them.
# Arguments
- `rotation_id`: The Amazon Resource Name (ARN) of the on-call rotation to delete.
"""
function delete_rotation(RotationId; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_contacts(
"DeleteRotation",
Dict{String,Any}("RotationId" => RotationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_rotation(
RotationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_contacts(
"DeleteRotation",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RotationId" => RotationId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_rotation_override(rotation_id, rotation_override_id)
delete_rotation_override(rotation_id, rotation_override_id, params::Dict{String,<:Any})
Deletes an existing override for an on-call rotation.
# Arguments
- `rotation_id`: The Amazon Resource Name (ARN) of the rotation that was overridden.
- `rotation_override_id`: The Amazon Resource Name (ARN) of the on-call rotation override
to delete.
"""
function delete_rotation_override(
RotationId, RotationOverrideId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_contacts(
"DeleteRotationOverride",
Dict{String,Any}(
"RotationId" => RotationId, "RotationOverrideId" => RotationOverrideId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_rotation_override(
RotationId,
RotationOverrideId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_contacts(
"DeleteRotationOverride",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"RotationId" => RotationId, "RotationOverrideId" => RotationOverrideId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_engagement(engagement_id)
describe_engagement(engagement_id, params::Dict{String,<:Any})
Incident Manager uses engagements to engage contacts and escalation plans during an
incident. Use this command to describe the engagement that occurred during an incident.
# Arguments
- `engagement_id`: The Amazon Resource Name (ARN) of the engagement you want the details of.
"""
function describe_engagement(
EngagementId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_contacts(
"DescribeEngagement",
Dict{String,Any}("EngagementId" => EngagementId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_engagement(
EngagementId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_contacts(
"DescribeEngagement",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EngagementId" => EngagementId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_page(page_id)
describe_page(page_id, params::Dict{String,<:Any})
Lists details of the engagement to a contact channel.
# Arguments
- `page_id`: The ID of the engagement to a contact channel.
"""
function describe_page(PageId; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_contacts(
"DescribePage",
Dict{String,Any}("PageId" => PageId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_page(
PageId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_contacts(
"DescribePage",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("PageId" => PageId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_contact(contact_id)
get_contact(contact_id, params::Dict{String,<:Any})
Retrieves information about the specified contact or escalation plan.
# Arguments
- `contact_id`: The Amazon Resource Name (ARN) of the contact or escalation plan.
"""
function get_contact(ContactId; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_contacts(
"GetContact",
Dict{String,Any}("ContactId" => ContactId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_contact(
ContactId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_contacts(
"GetContact",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ContactId" => ContactId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_contact_channel(contact_channel_id)
get_contact_channel(contact_channel_id, params::Dict{String,<:Any})
List details about a specific contact channel.
# Arguments
- `contact_channel_id`: The Amazon Resource Name (ARN) of the contact channel you want
information about.
"""
function get_contact_channel(
ContactChannelId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_contacts(
"GetContactChannel",
Dict{String,Any}("ContactChannelId" => ContactChannelId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_contact_channel(
ContactChannelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_contacts(
"GetContactChannel",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ContactChannelId" => ContactChannelId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_contact_policy(contact_arn)
get_contact_policy(contact_arn, params::Dict{String,<:Any})
Retrieves the resource policies attached to the specified contact or escalation plan.
# Arguments
- `contact_arn`: The Amazon Resource Name (ARN) of the contact or escalation plan.
"""
function get_contact_policy(ContactArn; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_contacts(
"GetContactPolicy",
Dict{String,Any}("ContactArn" => ContactArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_contact_policy(
ContactArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_contacts(
"GetContactPolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ContactArn" => ContactArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_rotation(rotation_id)
get_rotation(rotation_id, params::Dict{String,<:Any})
Retrieves information about an on-call rotation.
# Arguments
- `rotation_id`: The Amazon Resource Name (ARN) of the on-call rotation to retrieve
information about.
"""
function get_rotation(RotationId; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_contacts(
"GetRotation",
Dict{String,Any}("RotationId" => RotationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_rotation(
RotationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_contacts(
"GetRotation",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RotationId" => RotationId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_rotation_override(rotation_id, rotation_override_id)
get_rotation_override(rotation_id, rotation_override_id, params::Dict{String,<:Any})
Retrieves information about an override to an on-call rotation.
# Arguments
- `rotation_id`: The Amazon Resource Name (ARN) of the overridden rotation to retrieve
information about.
- `rotation_override_id`: The Amazon Resource Name (ARN) of the on-call rotation override
to retrieve information about.
"""
function get_rotation_override(
RotationId, RotationOverrideId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_contacts(
"GetRotationOverride",
Dict{String,Any}(
"RotationId" => RotationId, "RotationOverrideId" => RotationOverrideId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_rotation_override(
RotationId,
RotationOverrideId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_contacts(
"GetRotationOverride",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"RotationId" => RotationId, "RotationOverrideId" => RotationOverrideId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_contact_channels(contact_id)
list_contact_channels(contact_id, params::Dict{String,<:Any})
Lists all contact channels for the specified contact.
# Arguments
- `contact_id`: The Amazon Resource Name (ARN) of the contact.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of contact channels per page.
- `"NextToken"`: The pagination token to continue to the next page of results.
"""
function list_contact_channels(ContactId; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_contacts(
"ListContactChannels",
Dict{String,Any}("ContactId" => ContactId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_contact_channels(
ContactId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_contacts(
"ListContactChannels",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ContactId" => ContactId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_contacts()
list_contacts(params::Dict{String,<:Any})
Lists all contacts and escalation plans in Incident Manager.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AliasPrefix"`: Used to list only contacts who's aliases start with the specified prefix.
- `"MaxResults"`: The maximum number of contacts and escalation plans per page of results.
- `"NextToken"`: The pagination token to continue to the next page of results.
- `"Type"`: The type of contact. A contact is type PERSONAL and an escalation plan is type
ESCALATION.
"""
function list_contacts(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_contacts(
"ListContacts"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_contacts(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_contacts(
"ListContacts", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_engagements()
list_engagements(params::Dict{String,<:Any})
Lists all engagements that have happened in an incident.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IncidentId"`: The Amazon Resource Name (ARN) of the incident you're listing engagements
for.
- `"MaxResults"`: The maximum number of engagements per page of results.
- `"NextToken"`: The pagination token to continue to the next page of results.
- `"TimeRangeValue"`: The time range to lists engagements for an incident.
"""
function list_engagements(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_contacts(
"ListEngagements"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_engagements(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_contacts(
"ListEngagements", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_page_receipts(page_id)
list_page_receipts(page_id, params::Dict{String,<:Any})
Lists all of the engagements to contact channels that have been acknowledged.
# Arguments
- `page_id`: The Amazon Resource Name (ARN) of the engagement to a specific contact channel.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of acknowledgements per page of results.
- `"NextToken"`: The pagination token to continue to the next page of results.
"""
function list_page_receipts(PageId; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_contacts(
"ListPageReceipts",
Dict{String,Any}("PageId" => PageId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_page_receipts(
PageId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_contacts(
"ListPageReceipts",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("PageId" => PageId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_page_resolutions(page_id)
list_page_resolutions(page_id, params::Dict{String,<:Any})
Returns the resolution path of an engagement. For example, the escalation plan engaged in
an incident might target an on-call schedule that includes several contacts in a rotation,
but just one contact on-call when the incident starts. The resolution path indicates the
hierarchy of escalation plan > on-call schedule > contact.
# Arguments
- `page_id`: The Amazon Resource Name (ARN) of the contact engaged for the incident.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: A token to start the list. Use this token to get the next set of results.
"""
function list_page_resolutions(PageId; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_contacts(
"ListPageResolutions",
Dict{String,Any}("PageId" => PageId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_page_resolutions(
PageId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_contacts(
"ListPageResolutions",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("PageId" => PageId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_pages_by_contact(contact_id)
list_pages_by_contact(contact_id, params::Dict{String,<:Any})
Lists the engagements to a contact's contact channels.
# Arguments
- `contact_id`: The Amazon Resource Name (ARN) of the contact you are retrieving
engagements for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of engagements to contact channels to list per page of
results.
- `"NextToken"`: The pagination token to continue to the next page of results.
"""
function list_pages_by_contact(ContactId; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_contacts(
"ListPagesByContact",
Dict{String,Any}("ContactId" => ContactId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_pages_by_contact(
ContactId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_contacts(
"ListPagesByContact",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ContactId" => ContactId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_pages_by_engagement(engagement_id)
list_pages_by_engagement(engagement_id, params::Dict{String,<:Any})
Lists the engagements to contact channels that occurred by engaging a contact.
# Arguments
- `engagement_id`: The Amazon Resource Name (ARN) of the engagement.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of engagements to contact channels to list per page of
results.
- `"NextToken"`: The pagination token to continue to the next page of results.
"""
function list_pages_by_engagement(
EngagementId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_contacts(
"ListPagesByEngagement",
Dict{String,Any}("EngagementId" => EngagementId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_pages_by_engagement(
EngagementId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_contacts(
"ListPagesByEngagement",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EngagementId" => EngagementId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_preview_rotation_shifts(end_time, members, recurrence, time_zone_id)
list_preview_rotation_shifts(end_time, members, recurrence, time_zone_id, params::Dict{String,<:Any})
Returns a list of shifts based on rotation configuration parameters. The Incident Manager
primarily uses this operation to populate the Preview calendar. It is not typically run by
end users.
# Arguments
- `end_time`: The date and time a rotation shift would end.
- `members`: The contacts that would be assigned to a rotation.
- `recurrence`: Information about how long a rotation would last before restarting at the
beginning of the shift order.
- `time_zone_id`: The time zone the rotation’s activity would be based on, in Internet
Assigned Numbers Authority (IANA) format. For example: \"America/Los_Angeles\", \"UTC\", or
\"Asia/Seoul\".
# 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 call. The call also
returns a token that can be specified in a subsequent call to get the next set of results.
- `"NextToken"`: A token to start the list. This token is used to get the next set of
results.
- `"Overrides"`: Information about changes that would be made in a rotation override.
- `"RotationStartTime"`: The date and time a rotation would begin. The first shift is
calculated from this date and time.
- `"StartTime"`: Used to filter the range of calculated shifts before sending the response
back to the user.
"""
function list_preview_rotation_shifts(
EndTime,
Members,
Recurrence,
TimeZoneId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_contacts(
"ListPreviewRotationShifts",
Dict{String,Any}(
"EndTime" => EndTime,
"Members" => Members,
"Recurrence" => Recurrence,
"TimeZoneId" => TimeZoneId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_preview_rotation_shifts(
EndTime,
Members,
Recurrence,
TimeZoneId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_contacts(
"ListPreviewRotationShifts",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EndTime" => EndTime,
"Members" => Members,
"Recurrence" => Recurrence,
"TimeZoneId" => TimeZoneId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_rotation_overrides(end_time, rotation_id, start_time)
list_rotation_overrides(end_time, rotation_id, start_time, params::Dict{String,<:Any})
Retrieves a list of overrides currently specified for an on-call rotation.
# Arguments
- `end_time`: The date and time for the end of a time range for listing overrides.
- `rotation_id`: The Amazon Resource Name (ARN) of the rotation to retrieve information
about.
- `start_time`: The date and time for the beginning of a time range for listing overrides.
# 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 call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: A token to start the list. Use this token to get the next set of results.
"""
function list_rotation_overrides(
EndTime, RotationId, StartTime; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_contacts(
"ListRotationOverrides",
Dict{String,Any}(
"EndTime" => EndTime, "RotationId" => RotationId, "StartTime" => StartTime
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_rotation_overrides(
EndTime,
RotationId,
StartTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_contacts(
"ListRotationOverrides",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EndTime" => EndTime,
"RotationId" => RotationId,
"StartTime" => StartTime,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_rotation_shifts(end_time, rotation_id)
list_rotation_shifts(end_time, rotation_id, params::Dict{String,<:Any})
Returns a list of shifts generated by an existing rotation in the system.
# Arguments
- `end_time`: The date and time for the end of the time range to list shifts for.
- `rotation_id`: The Amazon Resource Name (ARN) of the rotation to retrieve shift
information about.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: A token to start the list. Use this token to get the next set of results.
- `"StartTime"`: The date and time for the beginning of the time range to list shifts for.
"""
function list_rotation_shifts(
EndTime, RotationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_contacts(
"ListRotationShifts",
Dict{String,Any}("EndTime" => EndTime, "RotationId" => RotationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_rotation_shifts(
EndTime,
RotationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_contacts(
"ListRotationShifts",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("EndTime" => EndTime, "RotationId" => RotationId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_rotations()
list_rotations(params::Dict{String,<:Any})
Retrieves a list of on-call rotations.
# 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 call. The call also
returns a token that you can specify in a subsequent call to get the next set of results.
- `"NextToken"`: A token to start the list. Use this token to get the next set of results.
- `"RotationNamePrefix"`: A filter to include rotations in list results based on their
common prefix. For example, entering prod returns a list of all rotation names that begin
with prod, such as production and prod-1.
"""
function list_rotations(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_contacts(
"ListRotations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_rotations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_contacts(
"ListRotations", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Lists the tags of an escalation plan or contact.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the contact or escalation plan.
"""
function list_tags_for_resource(
ResourceARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_contacts(
"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 ssm_contacts(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceARN" => ResourceARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_contact_policy(contact_arn, policy)
put_contact_policy(contact_arn, policy, params::Dict{String,<:Any})
Adds a resource policy to the specified contact or escalation plan. The resource policy is
used to share the contact or escalation plan using Resource Access Manager (RAM). For more
information about cross-account sharing, see Setting up cross-account functionality.
# Arguments
- `contact_arn`: The Amazon Resource Name (ARN) of the contact or escalation plan.
- `policy`: Details of the resource policy.
"""
function put_contact_policy(
ContactArn, Policy; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_contacts(
"PutContactPolicy",
Dict{String,Any}("ContactArn" => ContactArn, "Policy" => Policy);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_contact_policy(
ContactArn,
Policy,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_contacts(
"PutContactPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ContactArn" => ContactArn, "Policy" => Policy),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_activation_code(contact_channel_id)
send_activation_code(contact_channel_id, params::Dict{String,<:Any})
Sends an activation code to a contact channel. The contact can use this code to activate
the contact channel in the console or with the ActivateChannel operation. Incident Manager
can't engage a contact channel until it has been activated.
# Arguments
- `contact_channel_id`: The Amazon Resource Name (ARN) of the contact channel.
"""
function send_activation_code(
ContactChannelId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_contacts(
"SendActivationCode",
Dict{String,Any}("ContactChannelId" => ContactChannelId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_activation_code(
ContactChannelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_contacts(
"SendActivationCode",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ContactChannelId" => ContactChannelId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_engagement(contact_id, content, sender, subject)
start_engagement(contact_id, content, sender, subject, params::Dict{String,<:Any})
Starts an engagement to a contact or escalation plan. The engagement engages each contact
specified in the incident.
# Arguments
- `contact_id`: The Amazon Resource Name (ARN) of the contact being engaged.
- `content`: The secure content of the message that was sent to the contact. Use this field
for engagements to VOICE or EMAIL.
- `sender`: The user that started the engagement.
- `subject`: The secure subject of the message that was sent to the contact. Use this field
for engagements to VOICE or EMAIL.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IdempotencyToken"`: A token ensuring that the operation is called only once with the
specified details.
- `"IncidentId"`: The ARN of the incident that the engagement is part of.
- `"PublicContent"`: The insecure content of the message that was sent to the contact. Use
this field for engagements to SMS.
- `"PublicSubject"`: The insecure subject of the message that was sent to the contact. Use
this field for engagements to SMS.
"""
function start_engagement(
ContactId, Content, Sender, Subject; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_contacts(
"StartEngagement",
Dict{String,Any}(
"ContactId" => ContactId,
"Content" => Content,
"Sender" => Sender,
"Subject" => Subject,
"IdempotencyToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_engagement(
ContactId,
Content,
Sender,
Subject,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_contacts(
"StartEngagement",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ContactId" => ContactId,
"Content" => Content,
"Sender" => Sender,
"Subject" => Subject,
"IdempotencyToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_engagement(engagement_id)
stop_engagement(engagement_id, params::Dict{String,<:Any})
Stops an engagement before it finishes the final stage of the escalation plan or engagement
plan. Further contacts aren't engaged.
# Arguments
- `engagement_id`: The Amazon Resource Name (ARN) of the engagement.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Reason"`: The reason that you're stopping the engagement.
"""
function stop_engagement(EngagementId; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_contacts(
"StopEngagement",
Dict{String,Any}("EngagementId" => EngagementId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_engagement(
EngagementId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_contacts(
"StopEngagement",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EngagementId" => EngagementId), 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 contact or escalation plan. You can tag only contacts and escalation plans in the
first region of your replication set.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the contact or escalation plan.
- `tags`: A list of tags that you are adding to the contact or escalation plan.
"""
function tag_resource(ResourceARN, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_contacts(
"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 ssm_contacts(
"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 the specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the contact or escalation plan.
- `tag_keys`: The key of the tag that you want to remove.
"""
function untag_resource(
ResourceARN, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_contacts(
"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 ssm_contacts(
"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_contact(contact_id)
update_contact(contact_id, params::Dict{String,<:Any})
Updates the contact or escalation plan specified.
# Arguments
- `contact_id`: The Amazon Resource Name (ARN) of the contact or escalation plan you're
updating.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DisplayName"`: The full name of the contact or escalation plan.
- `"Plan"`: A list of stages. A contact has an engagement plan with stages for specified
contact channels. An escalation plan uses these stages to contact specified contacts.
"""
function update_contact(ContactId; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_contacts(
"UpdateContact",
Dict{String,Any}("ContactId" => ContactId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_contact(
ContactId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_contacts(
"UpdateContact",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ContactId" => ContactId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_contact_channel(contact_channel_id)
update_contact_channel(contact_channel_id, params::Dict{String,<:Any})
Updates a contact's contact channel.
# Arguments
- `contact_channel_id`: The Amazon Resource Name (ARN) of the contact channel you want to
update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeliveryAddress"`: The details that Incident Manager uses when trying to engage the
contact channel.
- `"Name"`: The name of the contact channel.
"""
function update_contact_channel(
ContactChannelId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_contacts(
"UpdateContactChannel",
Dict{String,Any}("ContactChannelId" => ContactChannelId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_contact_channel(
ContactChannelId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_contacts(
"UpdateContactChannel",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ContactChannelId" => ContactChannelId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_rotation(recurrence, rotation_id)
update_rotation(recurrence, rotation_id, params::Dict{String,<:Any})
Updates the information specified for an on-call rotation.
# Arguments
- `recurrence`: Information about how long the updated rotation lasts before restarting at
the beginning of the shift order.
- `rotation_id`: The Amazon Resource Name (ARN) of the rotation to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ContactIds"`: The Amazon Resource Names (ARNs) of the contacts to include in the
updated rotation. The order in which you list the contacts is their shift order in the
rotation schedule.
- `"StartTime"`: The date and time the rotation goes into effect.
- `"TimeZoneId"`: The time zone to base the updated rotation’s activity on, in Internet
Assigned Numbers Authority (IANA) format. For example: \"America/Los_Angeles\", \"UTC\", or
\"Asia/Seoul\". For more information, see the Time Zone Database on the IANA website.
Designators for time zones that don’t support Daylight Savings Time Rules, such as
Pacific Standard Time (PST) and Pacific Daylight Time (PDT), aren't supported.
"""
function update_rotation(
Recurrence, RotationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_contacts(
"UpdateRotation",
Dict{String,Any}("Recurrence" => Recurrence, "RotationId" => RotationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_rotation(
Recurrence,
RotationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_contacts(
"UpdateRotation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Recurrence" => Recurrence, "RotationId" => RotationId),
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 | 47631 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: ssm_incidents
using AWS.Compat
using AWS.UUIDs
"""
batch_get_incident_findings(finding_ids, incident_record_arn)
batch_get_incident_findings(finding_ids, incident_record_arn, params::Dict{String,<:Any})
Retrieves details about all specified findings for an incident, including descriptive
details about each finding. A finding represents a recent application environment change
made by an CodeDeploy deployment or an CloudFormation stack creation or update that can be
investigated as a potential cause of the incident.
# Arguments
- `finding_ids`: A list of IDs of findings for which you want to view details.
- `incident_record_arn`: The Amazon Resource Name (ARN) of the incident for which you want
to view finding details.
"""
function batch_get_incident_findings(
findingIds, incidentRecordArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_incidents(
"POST",
"/batchGetIncidentFindings",
Dict{String,Any}(
"findingIds" => findingIds, "incidentRecordArn" => incidentRecordArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_incident_findings(
findingIds,
incidentRecordArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_incidents(
"POST",
"/batchGetIncidentFindings",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"findingIds" => findingIds, "incidentRecordArn" => incidentRecordArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_replication_set(regions)
create_replication_set(regions, params::Dict{String,<:Any})
A replication set replicates and encrypts your data to the provided Regions with the
provided KMS key.
# Arguments
- `regions`: The Regions that Incident Manager replicates your data to. You can have up to
three Regions in your replication set.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token that ensures that the operation is called only once with the
specified details.
- `"tags"`: A list of tags to add to the replication set.
"""
function create_replication_set(regions; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_incidents(
"POST",
"/createReplicationSet",
Dict{String,Any}("regions" => regions, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_replication_set(
regions, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_incidents(
"POST",
"/createReplicationSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("regions" => regions, "clientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_response_plan(incident_template, name)
create_response_plan(incident_template, name, params::Dict{String,<:Any})
Creates a response plan that automates the initial response to incidents. A response plan
engages contacts, starts chat channel collaboration, and initiates runbooks at the
beginning of an incident.
# Arguments
- `incident_template`: Details used to create an incident when using this response plan.
- `name`: The short format name of the response plan. Can't include spaces.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"actions"`: The actions that the response plan starts at the beginning of an incident.
- `"chatChannel"`: The Chatbot chat channel used for collaboration during an incident.
- `"clientToken"`: A token ensuring that the operation is called only once with the
specified details.
- `"displayName"`: The long format of the response plan name. This field can contain spaces.
- `"engagements"`: The Amazon Resource Name (ARN) for the contacts and escalation plans
that the response plan engages during an incident.
- `"integrations"`: Information about third-party services integrated into the response
plan.
- `"tags"`: A list of tags that you are adding to the response plan.
"""
function create_response_plan(
incidentTemplate, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_incidents(
"POST",
"/createResponsePlan",
Dict{String,Any}(
"incidentTemplate" => incidentTemplate,
"name" => name,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_response_plan(
incidentTemplate,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_incidents(
"POST",
"/createResponsePlan",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"incidentTemplate" => incidentTemplate,
"name" => name,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_timeline_event(event_data, event_time, event_type, incident_record_arn)
create_timeline_event(event_data, event_time, event_type, incident_record_arn, params::Dict{String,<:Any})
Creates a custom timeline event on the incident details page of an incident record.
Incident Manager automatically creates timeline events that mark key moments during an
incident. You can create custom timeline events to mark important events that Incident
Manager can detect automatically.
# Arguments
- `event_data`: A short description of the event.
- `event_time`: The timestamp for when the event occurred.
- `event_type`: The type of event. You can create timeline events of type Custom Event and
Note. To make a Note-type event appear on the Incident notes panel in the console, specify
eventType as Noteand enter the Amazon Resource Name (ARN) of the incident as the value for
eventReference.
- `incident_record_arn`: The Amazon Resource Name (ARN) of the incident record that the
action adds the incident to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token that ensures that a client calls the action only once with the
specified details.
- `"eventReferences"`: Adds one or more references to the TimelineEvent. A reference is an
Amazon Web Services resource involved or associated with the incident. To specify a
reference, enter its Amazon Resource Name (ARN). You can also specify a related item
associated with a resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as
a resource, use the table's ARN. You can also specify an Amazon CloudWatch metric
associated with the DynamoDB table as a related item.
"""
function create_timeline_event(
eventData,
eventTime,
eventType,
incidentRecordArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_incidents(
"POST",
"/createTimelineEvent",
Dict{String,Any}(
"eventData" => eventData,
"eventTime" => eventTime,
"eventType" => eventType,
"incidentRecordArn" => incidentRecordArn,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_timeline_event(
eventData,
eventTime,
eventType,
incidentRecordArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_incidents(
"POST",
"/createTimelineEvent",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"eventData" => eventData,
"eventTime" => eventTime,
"eventType" => eventType,
"incidentRecordArn" => incidentRecordArn,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_incident_record(arn)
delete_incident_record(arn, params::Dict{String,<:Any})
Delete an incident record from Incident Manager.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the incident record you are deleting.
"""
function delete_incident_record(arn; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_incidents(
"POST",
"/deleteIncidentRecord",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_incident_record(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_incidents(
"POST",
"/deleteIncidentRecord",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_replication_set(arn)
delete_replication_set(arn, params::Dict{String,<:Any})
Deletes all Regions in your replication set. Deleting the replication set deletes all
Incident Manager data.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the replication set you're deleting.
"""
function delete_replication_set(arn; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_incidents(
"POST",
"/deleteReplicationSet",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_replication_set(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_incidents(
"POST",
"/deleteReplicationSet",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_resource_policy(policy_id, resource_arn)
delete_resource_policy(policy_id, resource_arn, params::Dict{String,<:Any})
Deletes the resource policy that Resource Access Manager uses to share your Incident
Manager resource.
# Arguments
- `policy_id`: The ID of the resource policy you're deleting.
- `resource_arn`: The Amazon Resource Name (ARN) of the resource you're deleting the policy
from.
"""
function delete_resource_policy(
policyId, resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_incidents(
"POST",
"/deleteResourcePolicy",
Dict{String,Any}("policyId" => policyId, "resourceArn" => resourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_resource_policy(
policyId,
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_incidents(
"POST",
"/deleteResourcePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("policyId" => policyId, "resourceArn" => resourceArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_response_plan(arn)
delete_response_plan(arn, params::Dict{String,<:Any})
Deletes the specified response plan. Deleting a response plan stops all linked CloudWatch
alarms and EventBridge events from creating an incident with this response plan.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the response plan.
"""
function delete_response_plan(arn; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_incidents(
"POST",
"/deleteResponsePlan",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_response_plan(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_incidents(
"POST",
"/deleteResponsePlan",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_timeline_event(event_id, incident_record_arn)
delete_timeline_event(event_id, incident_record_arn, params::Dict{String,<:Any})
Deletes a timeline event from an incident.
# Arguments
- `event_id`: The ID of the event to update. You can use ListTimelineEvents to find an
event's ID.
- `incident_record_arn`: The Amazon Resource Name (ARN) of the incident that includes the
timeline event.
"""
function delete_timeline_event(
eventId, incidentRecordArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_incidents(
"POST",
"/deleteTimelineEvent",
Dict{String,Any}("eventId" => eventId, "incidentRecordArn" => incidentRecordArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_timeline_event(
eventId,
incidentRecordArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_incidents(
"POST",
"/deleteTimelineEvent",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"eventId" => eventId, "incidentRecordArn" => incidentRecordArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_incident_record(arn)
get_incident_record(arn, params::Dict{String,<:Any})
Returns the details for the specified incident record.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the incident record.
"""
function get_incident_record(arn; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_incidents(
"GET",
"/getIncidentRecord",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_incident_record(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_incidents(
"GET",
"/getIncidentRecord",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_replication_set(arn)
get_replication_set(arn, params::Dict{String,<:Any})
Retrieve your Incident Manager replication set.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the replication set you want to retrieve.
"""
function get_replication_set(arn; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_incidents(
"GET",
"/getReplicationSet",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_replication_set(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_incidents(
"GET",
"/getReplicationSet",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resource_policies(resource_arn)
get_resource_policies(resource_arn, params::Dict{String,<:Any})
Retrieves the resource policies attached to the specified response plan.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the response plan with the attached
resource policy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of resource policies to display for each page of
results.
- `"nextToken"`: The pagination token for the next set of items to return. (You received
this token from a previous call.)
"""
function get_resource_policies(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_incidents(
"POST",
"/getResourcePolicies",
Dict{String,Any}("resourceArn" => resourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resource_policies(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_incidents(
"POST",
"/getResourcePolicies",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_response_plan(arn)
get_response_plan(arn, params::Dict{String,<:Any})
Retrieves the details of the specified response plan.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the response plan.
"""
function get_response_plan(arn; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_incidents(
"GET",
"/getResponsePlan",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_response_plan(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_incidents(
"GET",
"/getResponsePlan",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_timeline_event(event_id, incident_record_arn)
get_timeline_event(event_id, incident_record_arn, params::Dict{String,<:Any})
Retrieves a timeline event based on its ID and incident record.
# Arguments
- `event_id`: The ID of the event. You can get an event's ID when you create it, or by
using ListTimelineEvents.
- `incident_record_arn`: The Amazon Resource Name (ARN) of the incident that includes the
timeline event.
"""
function get_timeline_event(
eventId, incidentRecordArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_incidents(
"GET",
"/getTimelineEvent",
Dict{String,Any}("eventId" => eventId, "incidentRecordArn" => incidentRecordArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_timeline_event(
eventId,
incidentRecordArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_incidents(
"GET",
"/getTimelineEvent",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"eventId" => eventId, "incidentRecordArn" => incidentRecordArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_incident_findings(incident_record_arn)
list_incident_findings(incident_record_arn, params::Dict{String,<:Any})
Retrieves a list of the IDs of findings, plus their last modified times, that have been
identified for a specified incident. A finding represents a recent application environment
change made by an CloudFormation stack creation or update or an CodeDeploy deployment that
can be investigated as a potential cause of the incident.
# Arguments
- `incident_record_arn`: The Amazon Resource Name (ARN) of the incident for which you want
to view associated findings.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of findings to retrieve per call.
- `"nextToken"`: The pagination token for the next set of items to return. (You received
this token from a previous call.)
"""
function list_incident_findings(
incidentRecordArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_incidents(
"POST",
"/listIncidentFindings",
Dict{String,Any}("incidentRecordArn" => incidentRecordArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_incident_findings(
incidentRecordArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_incidents(
"POST",
"/listIncidentFindings",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("incidentRecordArn" => incidentRecordArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_incident_records()
list_incident_records(params::Dict{String,<:Any})
Lists all incident records in your account. Use this command to retrieve the Amazon
Resource Name (ARN) of the incident record you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: Filters the list of incident records you want to search through. You can
filter on the following keys: creationTime impact status createdBy Note
the following when when you use Filters: If you don't specify a Filter, the response
includes all incident records. If you specify more than one filter in a single request,
the response returns incident records that match all filters. If you specify a filter
with more than one value, the response returns incident records that match any of the
values provided.
- `"maxResults"`: The maximum number of results per page.
- `"nextToken"`: The pagination token for the next set of items to return. (You received
this token from a previous call.)
"""
function list_incident_records(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_incidents(
"POST",
"/listIncidentRecords";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_incident_records(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_incidents(
"POST",
"/listIncidentRecords",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_related_items(incident_record_arn)
list_related_items(incident_record_arn, params::Dict{String,<:Any})
List all related items for an incident record.
# Arguments
- `incident_record_arn`: The Amazon Resource Name (ARN) of the incident record containing
the listed related items.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of related items per page.
- `"nextToken"`: The pagination token for the next set of items to return. (You received
this token from a previous call.)
"""
function list_related_items(
incidentRecordArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_incidents(
"POST",
"/listRelatedItems",
Dict{String,Any}("incidentRecordArn" => incidentRecordArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_related_items(
incidentRecordArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_incidents(
"POST",
"/listRelatedItems",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("incidentRecordArn" => incidentRecordArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_replication_sets()
list_replication_sets(params::Dict{String,<:Any})
Lists details about the replication set configured 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 per page.
- `"nextToken"`: The pagination token for the next set of items to return. (You received
this token from a previous call.)
"""
function list_replication_sets(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_incidents(
"POST",
"/listReplicationSets";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_replication_sets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_incidents(
"POST",
"/listReplicationSets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_response_plans()
list_response_plans(params::Dict{String,<:Any})
Lists all response plans in your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of response plans per page.
- `"nextToken"`: The pagination token for the next set of items to return. (You received
this token from a previous call.)
"""
function list_response_plans(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_incidents(
"POST", "/listResponsePlans"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_response_plans(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_incidents(
"POST",
"/listResponsePlans",
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 attached to the specified response plan or incident.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the response plan or incident.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_incidents(
"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 ssm_incidents(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_timeline_events(incident_record_arn)
list_timeline_events(incident_record_arn, params::Dict{String,<:Any})
Lists timeline events for the specified incident record.
# Arguments
- `incident_record_arn`: The Amazon Resource Name (ARN) of the incident that includes the
timeline event.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: Filters the timeline events based on the provided conditional values. You
can filter timeline events with the following keys: eventReference eventTime
eventType Note the following when deciding how to use Filters: If you don't specify a
Filter, the response includes all timeline events. If you specify more than one filter in
a single request, the response returns timeline events that match all filters. If you
specify a filter with more than one value, the response returns timeline events that match
any of the values provided.
- `"maxResults"`: The maximum number of results per page.
- `"nextToken"`: The pagination token for the next set of items to return. (You received
this token from a previous call.)
- `"sortBy"`: Sort timeline events by the specified key value pair.
- `"sortOrder"`: Sorts the order of timeline events by the value specified in the sortBy
field.
"""
function list_timeline_events(
incidentRecordArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_incidents(
"POST",
"/listTimelineEvents",
Dict{String,Any}("incidentRecordArn" => incidentRecordArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_timeline_events(
incidentRecordArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_incidents(
"POST",
"/listTimelineEvents",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("incidentRecordArn" => incidentRecordArn), 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})
Adds a resource policy to the specified response plan. The resource policy is used to share
the response plan using Resource Access Manager (RAM). For more information about
cross-account sharing, see Cross-Region and cross-account incident management.
# Arguments
- `policy`: Details of the resource policy.
- `resource_arn`: The Amazon Resource Name (ARN) of the response plan to add the resource
policy to.
"""
function put_resource_policy(
policy, resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_incidents(
"POST",
"/putResourcePolicy",
Dict{String,Any}("policy" => policy, "resourceArn" => resourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_resource_policy(
policy,
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_incidents(
"POST",
"/putResourcePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("policy" => policy, "resourceArn" => resourceArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_incident(response_plan_arn)
start_incident(response_plan_arn, params::Dict{String,<:Any})
Used to start an incident from CloudWatch alarms, EventBridge events, or manually.
# Arguments
- `response_plan_arn`: The Amazon Resource Name (ARN) of the response plan that pre-defines
summary, chat channels, Amazon SNS topics, runbooks, title, and impact of the incident.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token ensuring that the operation is called only once with the
specified details.
- `"impact"`: Defines the impact to the customers. Providing an impact overwrites the
impact provided by a response plan. Supported impact codes 1 - Critical 2 - High
3 - Medium 4 - Low 5 - No Impact
- `"relatedItems"`: Add related items to the incident for other responders to use. Related
items are Amazon Web Services resources, external links, or files uploaded to an Amazon S3
bucket.
- `"title"`: Provide a title for the incident. Providing a title overwrites the title
provided by the response plan.
- `"triggerDetails"`: Details of what created the incident record in Incident Manager.
"""
function start_incident(responsePlanArn; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_incidents(
"POST",
"/startIncident",
Dict{String,Any}(
"responsePlanArn" => responsePlanArn, "clientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_incident(
responsePlanArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_incidents(
"POST",
"/startIncident",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"responsePlanArn" => responsePlanArn, "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})
Adds a tag to a response plan.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the response plan you're adding the
tags to.
- `tags`: A list of tags to add to the response plan.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_incidents(
"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 ssm_incidents(
"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 response plan you're removing a tag
from.
- `tag_keys`: The name of the tag to remove from the response plan.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_incidents(
"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 ssm_incidents(
"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_deletion_protection(arn, deletion_protected)
update_deletion_protection(arn, deletion_protected, params::Dict{String,<:Any})
Update deletion protection to either allow or deny deletion of the final Region in a
replication set.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the replication set to update.
- `deletion_protected`: Specifies if deletion protection is turned on or off in your
account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token that ensures that the operation is called only once with the
specified details.
"""
function update_deletion_protection(
arn, deletionProtected; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_incidents(
"POST",
"/updateDeletionProtection",
Dict{String,Any}(
"arn" => arn,
"deletionProtected" => deletionProtected,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_deletion_protection(
arn,
deletionProtected,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_incidents(
"POST",
"/updateDeletionProtection",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"arn" => arn,
"deletionProtected" => deletionProtected,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_incident_record(arn)
update_incident_record(arn, params::Dict{String,<:Any})
Update the details of an incident record. You can use this operation to update an incident
record from the defined chat channel. For more information about using actions in chat
channels, see Interacting through chat.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the incident record you are updating.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"chatChannel"`: The Chatbot chat channel where responders can collaborate.
- `"clientToken"`: A token that ensures that a client calls the operation only once with
the specified details.
- `"impact"`: Defines the impact of the incident to customers and applications. If you
provide an impact for an incident, it overwrites the impact provided by the response plan.
Supported impact codes 1 - Critical 2 - High 3 - Medium 4 - Low 5 - No
Impact
- `"notificationTargets"`: The Amazon SNS targets that Incident Manager notifies when a
client updates an incident. Using multiple SNS topics creates redundancy in the event that
a Region is down during the incident.
- `"status"`: The status of the incident. Possible statuses are Open or Resolved.
- `"summary"`: A longer description of what occurred during the incident.
- `"title"`: A brief description of the incident.
"""
function update_incident_record(arn; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_incidents(
"POST",
"/updateIncidentRecord",
Dict{String,Any}("arn" => arn, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_incident_record(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_incidents(
"POST",
"/updateIncidentRecord",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("arn" => arn, "clientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_related_items(incident_record_arn, related_items_update)
update_related_items(incident_record_arn, related_items_update, params::Dict{String,<:Any})
Add or remove related items from the related items tab of an incident record.
# Arguments
- `incident_record_arn`: The Amazon Resource Name (ARN) of the incident record that
contains the related items that you update.
- `related_items_update`: Details about the item that you are add to, or delete from, an
incident.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token that ensures that a client calls the operation only once with
the specified details.
"""
function update_related_items(
incidentRecordArn, relatedItemsUpdate; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_incidents(
"POST",
"/updateRelatedItems",
Dict{String,Any}(
"incidentRecordArn" => incidentRecordArn,
"relatedItemsUpdate" => relatedItemsUpdate,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_related_items(
incidentRecordArn,
relatedItemsUpdate,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_incidents(
"POST",
"/updateRelatedItems",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"incidentRecordArn" => incidentRecordArn,
"relatedItemsUpdate" => relatedItemsUpdate,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_replication_set(actions, arn)
update_replication_set(actions, arn, params::Dict{String,<:Any})
Add or delete Regions from your replication set.
# Arguments
- `actions`: An action to add or delete a Region.
- `arn`: The Amazon Resource Name (ARN) of the replication set you're updating.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token that ensures that the operation is called only once with the
specified details.
"""
function update_replication_set(
actions, arn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_incidents(
"POST",
"/updateReplicationSet",
Dict{String,Any}(
"actions" => actions, "arn" => arn, "clientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_replication_set(
actions,
arn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_incidents(
"POST",
"/updateReplicationSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"actions" => actions, "arn" => arn, "clientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_response_plan(arn)
update_response_plan(arn, params::Dict{String,<:Any})
Updates the specified response plan.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the response plan.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"actions"`: The actions that this response plan takes at the beginning of an incident.
- `"chatChannel"`: The Chatbot chat channel used for collaboration during an incident. Use
the empty structure to remove the chat channel from the response plan.
- `"clientToken"`: A token ensuring that the operation is called only once with the
specified details.
- `"displayName"`: The long format name of the response plan. The display name can't
contain spaces.
- `"engagements"`: The Amazon Resource Name (ARN) for the contacts and escalation plans
that the response plan engages during an incident.
- `"incidentTemplateDedupeString"`: The string Incident Manager uses to prevent duplicate
incidents from being created by the same incident in the same account.
- `"incidentTemplateImpact"`: Defines the impact to the customers. Providing an impact
overwrites the impact provided by a response plan. Supported impact codes 1 - Critical
2 - High 3 - Medium 4 - Low 5 - No Impact
- `"incidentTemplateNotificationTargets"`: The Amazon SNS targets that are notified when
updates are made to an incident.
- `"incidentTemplateSummary"`: A brief summary of the incident. This typically contains
what has happened, what's currently happening, and next steps.
- `"incidentTemplateTags"`: Tags to assign to the template. When the StartIncident API
action is called, Incident Manager assigns the tags specified in the template to the
incident. To call this action, you must also have permission to call the TagResource API
action for the incident record resource.
- `"incidentTemplateTitle"`: The short format name of the incident. The title can't contain
spaces.
- `"integrations"`: Information about third-party services integrated into the response
plan.
"""
function update_response_plan(arn; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_incidents(
"POST",
"/updateResponsePlan",
Dict{String,Any}("arn" => arn, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_response_plan(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_incidents(
"POST",
"/updateResponsePlan",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("arn" => arn, "clientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_timeline_event(event_id, incident_record_arn)
update_timeline_event(event_id, incident_record_arn, params::Dict{String,<:Any})
Updates a timeline event. You can update events of type Custom Event.
# Arguments
- `event_id`: The ID of the event to update. You can use ListTimelineEvents to find an
event's ID.
- `incident_record_arn`: The Amazon Resource Name (ARN) of the incident that includes the
timeline event.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token that ensures that a client calls the operation only once with
the specified details.
- `"eventData"`: A short description of the event.
- `"eventReferences"`: Updates all existing references in a TimelineEvent. A reference is
an Amazon Web Services resource involved or associated with the incident. To specify a
reference, enter its Amazon Resource Name (ARN). You can also specify a related item
associated with that resource. For example, to specify an Amazon DynamoDB (DynamoDB) table
as a resource, use its ARN. You can also specify an Amazon CloudWatch metric associated
with the DynamoDB table as a related item. This update action overrides all existing
references. If you want to keep existing references, you must specify them in the call. If
you don't, this action removes any existing references and enters only new references.
- `"eventTime"`: The timestamp for when the event occurred.
- `"eventType"`: The type of event. You can update events of type Custom Event and Note.
"""
function update_timeline_event(
eventId, incidentRecordArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_incidents(
"POST",
"/updateTimelineEvent",
Dict{String,Any}(
"eventId" => eventId,
"incidentRecordArn" => incidentRecordArn,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_timeline_event(
eventId,
incidentRecordArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_incidents(
"POST",
"/updateTimelineEvent",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"eventId" => eventId,
"incidentRecordArn" => incidentRecordArn,
"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 | 25714 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: ssm_sap
using AWS.Compat
using AWS.UUIDs
"""
delete_resource_permission(resource_arn)
delete_resource_permission(resource_arn, params::Dict{String,<:Any})
Removes permissions associated with the target database.
# 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:
- `"ActionType"`: Delete or restore the permissions on the target database.
- `"SourceResourceArn"`: The Amazon Resource Name (ARN) of the source resource.
"""
function delete_resource_permission(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_sap(
"POST",
"/delete-resource-permission",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_resource_permission(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_sap(
"POST",
"/delete-resource-permission",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_application(application_id)
deregister_application(application_id, params::Dict{String,<:Any})
Deregister an SAP application with AWS Systems Manager for SAP. This action does not
affect the existing setup of your SAP workloads on Amazon EC2.
# Arguments
- `application_id`: The ID of the application.
"""
function deregister_application(
ApplicationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_sap(
"POST",
"/deregister-application",
Dict{String,Any}("ApplicationId" => ApplicationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_application(
ApplicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_sap(
"POST",
"/deregister-application",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ApplicationId" => ApplicationId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_application()
get_application(params::Dict{String,<:Any})
Gets an application registered with AWS Systems Manager for SAP. It also returns the
components of the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AppRegistryArn"`: The Amazon Resource Name (ARN) of the application registry.
- `"ApplicationArn"`: The Amazon Resource Name (ARN) of the application.
- `"ApplicationId"`: The ID of the application.
"""
function get_application(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_sap(
"POST", "/get-application"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_application(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_sap(
"POST",
"/get-application",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_component(application_id, component_id)
get_component(application_id, component_id, params::Dict{String,<:Any})
Gets the component of an application registered with AWS Systems Manager for SAP.
# Arguments
- `application_id`: The ID of the application.
- `component_id`: The ID of the component.
"""
function get_component(
ApplicationId, ComponentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_sap(
"POST",
"/get-component",
Dict{String,Any}("ApplicationId" => ApplicationId, "ComponentId" => ComponentId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_component(
ApplicationId,
ComponentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_sap(
"POST",
"/get-component",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationId" => ApplicationId, "ComponentId" => ComponentId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_database()
get_database(params::Dict{String,<:Any})
Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ApplicationId"`: The ID of the application.
- `"ComponentId"`: The ID of the component.
- `"DatabaseArn"`: The Amazon Resource Name (ARN) of the database.
- `"DatabaseId"`: The ID of the database.
"""
function get_database(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_sap(
"POST", "/get-database"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_database(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_sap(
"POST",
"/get-database",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_operation(operation_id)
get_operation(operation_id, params::Dict{String,<:Any})
Gets the details of an operation by specifying the operation ID.
# Arguments
- `operation_id`: The ID of the operation.
"""
function get_operation(OperationId; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_sap(
"POST",
"/get-operation",
Dict{String,Any}("OperationId" => OperationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_operation(
OperationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_sap(
"POST",
"/get-operation",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("OperationId" => OperationId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resource_permission(resource_arn)
get_resource_permission(resource_arn, params::Dict{String,<:Any})
Gets permissions associated with the target database.
# 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:
- `"ActionType"`:
"""
function get_resource_permission(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_sap(
"POST",
"/get-resource-permission",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resource_permission(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_sap(
"POST",
"/get-resource-permission",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_applications()
list_applications(params::Dict{String,<:Any})
Lists all the applications registered with AWS Systems Manager for SAP.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: The filter of name, value, and operator.
- `"MaxResults"`: The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned nextToken value.
- `"NextToken"`: The token for the next page of results.
"""
function list_applications(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_sap(
"POST", "/list-applications"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_applications(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_sap(
"POST",
"/list-applications",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_components()
list_components(params::Dict{String,<:Any})
Lists all the components registered with AWS Systems Manager for SAP.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ApplicationId"`: The ID of the application.
- `"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 you do not
specify a value for MaxResults, the request returns 50 items per page by default.
- `"NextToken"`: The token for the next page of results.
"""
function list_components(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_sap(
"POST", "/list-components"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_components(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_sap(
"POST",
"/list-components",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_databases()
list_databases(params::Dict{String,<:Any})
Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ApplicationId"`: The ID of the application.
- `"ComponentId"`: The ID of the component.
- `"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 you do not
specify a value for MaxResults, the request returns 50 items per page by default.
- `"NextToken"`: The token for the next page of results.
"""
function list_databases(; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_sap(
"POST", "/list-databases"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_databases(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_sap(
"POST",
"/list-databases",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_operation_events(operation_id)
list_operation_events(operation_id, params::Dict{String,<:Any})
Returns a list of operations events. Available parameters include OperationID, as well as
optional parameters MaxResults, NextToken, and Filters.
# Arguments
- `operation_id`: The ID of the operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Optionally specify filters to narrow the returned operation event items.
Valid filter names include status, resourceID, and resourceType. The valid operator for all
three filters is Equals.
- `"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 you do not
specify a value for MaxResults, the request returns 50 items per page by default.
- `"NextToken"`: The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
"""
function list_operation_events(
OperationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_sap(
"POST",
"/list-operation-events",
Dict{String,Any}("OperationId" => OperationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_operation_events(
OperationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_sap(
"POST",
"/list-operation-events",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("OperationId" => OperationId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_operations(application_id)
list_operations(application_id, params::Dict{String,<:Any})
Lists the operations performed by AWS Systems Manager for SAP.
# Arguments
- `application_id`: The ID of the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: The filters of an operation.
- `"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 you do not
specify a value for MaxResults, the request returns 50 items per page by default.
- `"NextToken"`: The token for the next page of results.
"""
function list_operations(ApplicationId; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_sap(
"POST",
"/list-operations",
Dict{String,Any}("ApplicationId" => ApplicationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_operations(
ApplicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_sap(
"POST",
"/list-operations",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ApplicationId" => ApplicationId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Lists all tags on an SAP HANA application and/or database registered with AWS Systems
Manager for SAP.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_sap(
"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 ssm_sap(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_resource_permission(action_type, resource_arn, source_resource_arn)
put_resource_permission(action_type, resource_arn, source_resource_arn, params::Dict{String,<:Any})
Adds permissions to the target database.
# Arguments
- `action_type`:
- `resource_arn`:
- `source_resource_arn`:
"""
function put_resource_permission(
ActionType,
ResourceArn,
SourceResourceArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_sap(
"POST",
"/put-resource-permission",
Dict{String,Any}(
"ActionType" => ActionType,
"ResourceArn" => ResourceArn,
"SourceResourceArn" => SourceResourceArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_resource_permission(
ActionType,
ResourceArn,
SourceResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_sap(
"POST",
"/put-resource-permission",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ActionType" => ActionType,
"ResourceArn" => ResourceArn,
"SourceResourceArn" => SourceResourceArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_application(application_id, application_type, instances)
register_application(application_id, application_type, instances, params::Dict{String,<:Any})
Register an SAP application with AWS Systems Manager for SAP. You must meet the following
requirements before registering. The SAP application you want to register with AWS Systems
Manager for SAP is running on Amazon EC2. AWS Systems Manager Agent must be setup on an
Amazon EC2 instance along with the required IAM permissions. Amazon EC2 instance(s) must
have access to the secrets created in AWS Secrets Manager to manage SAP applications and
components.
# Arguments
- `application_id`: The ID of the application.
- `application_type`: The type of the application.
- `instances`: The Amazon EC2 instances on which your SAP application is running.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Credentials"`: The credentials of the SAP application.
- `"DatabaseArn"`: The Amazon Resource Name of the SAP HANA database.
- `"SapInstanceNumber"`: The SAP instance number of the application.
- `"Sid"`: The System ID of the application.
- `"Tags"`: The tags to be attached to the SAP application.
"""
function register_application(
ApplicationId,
ApplicationType,
Instances;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_sap(
"POST",
"/register-application",
Dict{String,Any}(
"ApplicationId" => ApplicationId,
"ApplicationType" => ApplicationType,
"Instances" => Instances,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_application(
ApplicationId,
ApplicationType,
Instances,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_sap(
"POST",
"/register-application",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationId" => ApplicationId,
"ApplicationType" => ApplicationType,
"Instances" => Instances,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_application(application_id)
start_application(application_id, params::Dict{String,<:Any})
Request is an operation which starts an application. Parameter ApplicationId is required.
# Arguments
- `application_id`: The ID of the application.
"""
function start_application(ApplicationId; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_sap(
"POST",
"/start-application",
Dict{String,Any}("ApplicationId" => ApplicationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_application(
ApplicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_sap(
"POST",
"/start-application",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ApplicationId" => ApplicationId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_application_refresh(application_id)
start_application_refresh(application_id, params::Dict{String,<:Any})
Refreshes a registered application.
# Arguments
- `application_id`: The ID of the application.
"""
function start_application_refresh(
ApplicationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_sap(
"POST",
"/start-application-refresh",
Dict{String,Any}("ApplicationId" => ApplicationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_application_refresh(
ApplicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_sap(
"POST",
"/start-application-refresh",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ApplicationId" => ApplicationId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_application(application_id)
stop_application(application_id, params::Dict{String,<:Any})
Request is an operation to stop an application. Parameter ApplicationId is required.
Parameters StopConnectedEntity and IncludeEc2InstanceShutdown are optional.
# Arguments
- `application_id`: The ID of the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IncludeEc2InstanceShutdown"`: Boolean. If included and if set to True, the
StopApplication operation will shut down the associated Amazon EC2 instance in addition to
the application.
- `"StopConnectedEntity"`: Specify the ConnectedEntityType. Accepted type is DBMS. If this
parameter is included, the connected DBMS (Database Management System) will be stopped.
"""
function stop_application(ApplicationId; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_sap(
"POST",
"/stop-application",
Dict{String,Any}("ApplicationId" => ApplicationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_application(
ApplicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_sap(
"POST",
"/stop-application",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ApplicationId" => ApplicationId), 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 tag for a resource by specifying the ARN.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
- `tags`: The tags on a resource.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return ssm_sap(
"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 ssm_sap(
"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})
Delete the tags for a resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
- `tag_keys`: Adds/updates or removes credentials for applications registered with AWS
Systems Manager for SAP.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_sap(
"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 ssm_sap(
"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_settings(application_id)
update_application_settings(application_id, params::Dict{String,<:Any})
Updates the settings of an application registered with AWS Systems Manager for SAP.
# Arguments
- `application_id`: The ID of the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Backint"`: Installation of AWS Backint Agent for SAP HANA.
- `"CredentialsToAddOrUpdate"`: The credentials to be added or updated.
- `"CredentialsToRemove"`: The credentials to be removed.
- `"DatabaseArn"`: The Amazon Resource Name of the SAP HANA database that replaces the
current SAP HANA connection with the SAP_ABAP application.
"""
function update_application_settings(
ApplicationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ssm_sap(
"POST",
"/update-application-settings",
Dict{String,Any}("ApplicationId" => ApplicationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_application_settings(
ApplicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ssm_sap(
"POST",
"/update-application-settings",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ApplicationId" => ApplicationId), 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 | 7874 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: sso
using AWS.Compat
using AWS.UUIDs
"""
get_role_credentials(account_id, role_name, x-amz-sso_bearer_token)
get_role_credentials(account_id, role_name, x-amz-sso_bearer_token, params::Dict{String,<:Any})
Returns the STS short-term credentials for a given role name that is assigned to the user.
# Arguments
- `account_id`: The identifier for the AWS account that is assigned to the user.
- `role_name`: The friendly name of the role that is assigned to the user.
- `x-amz-sso_bearer_token`: The token issued by the CreateToken API call. For more
information, see CreateToken in the IAM Identity Center OIDC API Reference Guide.
"""
function get_role_credentials(
account_id,
role_name,
x_amz_sso_bearer_token;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso(
"GET",
"/federation/credentials",
Dict{String,Any}(
"account_id" => account_id,
"role_name" => role_name,
"headers" =>
Dict{String,Any}("x-amz-sso_bearer_token" => x_amz_sso_bearer_token),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_role_credentials(
account_id,
role_name,
x_amz_sso_bearer_token,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso(
"GET",
"/federation/credentials",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"account_id" => account_id,
"role_name" => role_name,
"headers" => Dict{String,Any}(
"x-amz-sso_bearer_token" => x_amz_sso_bearer_token
),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_account_roles(account_id, x-amz-sso_bearer_token)
list_account_roles(account_id, x-amz-sso_bearer_token, params::Dict{String,<:Any})
Lists all roles that are assigned to the user for a given AWS account.
# Arguments
- `account_id`: The identifier for the AWS account that is assigned to the user.
- `x-amz-sso_bearer_token`: The token issued by the CreateToken API call. For more
information, see CreateToken in the IAM Identity Center OIDC API Reference Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max_result"`: The number of items that clients can request per page.
- `"next_token"`: The page token from the previous response output when you request
subsequent pages.
"""
function list_account_roles(
account_id, x_amz_sso_bearer_token; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso(
"GET",
"/assignment/roles",
Dict{String,Any}(
"account_id" => account_id,
"headers" =>
Dict{String,Any}("x-amz-sso_bearer_token" => x_amz_sso_bearer_token),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_account_roles(
account_id,
x_amz_sso_bearer_token,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso(
"GET",
"/assignment/roles",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"account_id" => account_id,
"headers" => Dict{String,Any}(
"x-amz-sso_bearer_token" => x_amz_sso_bearer_token
),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_accounts(x-amz-sso_bearer_token)
list_accounts(x-amz-sso_bearer_token, params::Dict{String,<:Any})
Lists all AWS accounts assigned to the user. These AWS accounts are assigned by the
administrator of the account. For more information, see Assign User Access in the IAM
Identity Center User Guide. This operation returns a paginated response.
# Arguments
- `x-amz-sso_bearer_token`: The token issued by the CreateToken API call. For more
information, see CreateToken in the IAM Identity Center OIDC API Reference Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max_result"`: This is the number of items clients can request per page.
- `"next_token"`: (Optional) When requesting subsequent pages, this is the page token from
the previous response output.
"""
function list_accounts(
x_amz_sso_bearer_token; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso(
"GET",
"/assignment/accounts",
Dict{String,Any}(
"headers" =>
Dict{String,Any}("x-amz-sso_bearer_token" => x_amz_sso_bearer_token),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_accounts(
x_amz_sso_bearer_token,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso(
"GET",
"/assignment/accounts",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}(
"x-amz-sso_bearer_token" => x_amz_sso_bearer_token
),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
logout(x-amz-sso_bearer_token)
logout(x-amz-sso_bearer_token, params::Dict{String,<:Any})
Removes the locally stored SSO tokens from the client-side cache and sends an API call to
the IAM Identity Center service to invalidate the corresponding server-side IAM Identity
Center sign in session. If a user uses IAM Identity Center to access the AWS CLI, the
user’s IAM Identity Center sign in session is used to obtain an IAM session, as specified
in the corresponding IAM Identity Center permission set. More specifically, IAM Identity
Center assumes an IAM role in the target account on behalf of the user, and the
corresponding temporary AWS credentials are returned to the client. After user logout, any
existing IAM role sessions that were created by using IAM Identity Center permission sets
continue based on the duration configured in the permission set. For more information, see
User authentications in the IAM Identity Center User Guide.
# Arguments
- `x-amz-sso_bearer_token`: The token issued by the CreateToken API call. For more
information, see CreateToken in the IAM Identity Center OIDC API Reference Guide.
"""
function logout(x_amz_sso_bearer_token; aws_config::AbstractAWSConfig=global_aws_config())
return sso(
"POST",
"/logout",
Dict{String,Any}(
"headers" =>
Dict{String,Any}("x-amz-sso_bearer_token" => x_amz_sso_bearer_token),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function logout(
x_amz_sso_bearer_token,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso(
"POST",
"/logout",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}(
"x-amz-sso_bearer_token" => x_amz_sso_bearer_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 | 133924 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: sso_admin
using AWS.Compat
using AWS.UUIDs
"""
attach_customer_managed_policy_reference_to_permission_set(customer_managed_policy_reference, instance_arn, permission_set_arn)
attach_customer_managed_policy_reference_to_permission_set(customer_managed_policy_reference, instance_arn, permission_set_arn, params::Dict{String,<:Any})
Attaches the specified customer managed policy to the specified PermissionSet.
# Arguments
- `customer_managed_policy_reference`: Specifies the name and path of a customer managed
policy. You must have an IAM policy that matches the name and path in each Amazon Web
Services account where you want to deploy your permission set.
- `instance_arn`: The ARN of the IAM Identity Center instance under which the operation
will be executed.
- `permission_set_arn`: The ARN of the PermissionSet.
"""
function attach_customer_managed_policy_reference_to_permission_set(
CustomerManagedPolicyReference,
InstanceArn,
PermissionSetArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"AttachCustomerManagedPolicyReferenceToPermissionSet",
Dict{String,Any}(
"CustomerManagedPolicyReference" => CustomerManagedPolicyReference,
"InstanceArn" => InstanceArn,
"PermissionSetArn" => PermissionSetArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function attach_customer_managed_policy_reference_to_permission_set(
CustomerManagedPolicyReference,
InstanceArn,
PermissionSetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"AttachCustomerManagedPolicyReferenceToPermissionSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CustomerManagedPolicyReference" => CustomerManagedPolicyReference,
"InstanceArn" => InstanceArn,
"PermissionSetArn" => PermissionSetArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
attach_managed_policy_to_permission_set(instance_arn, managed_policy_arn, permission_set_arn)
attach_managed_policy_to_permission_set(instance_arn, managed_policy_arn, permission_set_arn, params::Dict{String,<:Any})
Attaches an Amazon Web Services managed policy ARN to a permission set. If the permission
set is already referenced by one or more account assignments, you will need to call
ProvisionPermissionSet after this operation. Calling ProvisionPermissionSet applies the
corresponding IAM policy updates to all assigned accounts.
# Arguments
- `instance_arn`: The ARN of the IAM Identity Center instance under which the operation
will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and
Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
- `managed_policy_arn`: The Amazon Web Services managed policy ARN to be attached to a
permission set.
- `permission_set_arn`: The ARN of the PermissionSet that the managed policy should be
attached to.
"""
function attach_managed_policy_to_permission_set(
InstanceArn,
ManagedPolicyArn,
PermissionSetArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"AttachManagedPolicyToPermissionSet",
Dict{String,Any}(
"InstanceArn" => InstanceArn,
"ManagedPolicyArn" => ManagedPolicyArn,
"PermissionSetArn" => PermissionSetArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function attach_managed_policy_to_permission_set(
InstanceArn,
ManagedPolicyArn,
PermissionSetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"AttachManagedPolicyToPermissionSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceArn" => InstanceArn,
"ManagedPolicyArn" => ManagedPolicyArn,
"PermissionSetArn" => PermissionSetArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_account_assignment(instance_arn, permission_set_arn, principal_id, principal_type, target_id, target_type)
create_account_assignment(instance_arn, permission_set_arn, principal_id, principal_type, target_id, target_type, params::Dict{String,<:Any})
Assigns access to a principal for a specified Amazon Web Services account using a specified
permission set. The term principal here refers to a user or group that is defined in IAM
Identity Center. As part of a successful CreateAccountAssignment call, the specified
permission set will automatically be provisioned to the account in the form of an IAM
policy. That policy is attached to the IAM role created in IAM Identity Center. If the
permission set is subsequently updated, the corresponding IAM policies attached to roles in
your accounts will not be updated automatically. In this case, you must call
ProvisionPermissionSet to make these updates. After a successful response, call
DescribeAccountAssignmentCreationStatus to describe the status of an assignment creation
request.
# Arguments
- `instance_arn`: The ARN of the IAM Identity Center instance under which the operation
will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and
Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
- `permission_set_arn`: The ARN of the permission set that the admin wants to grant the
principal access to.
- `principal_id`: An identifier for an object in IAM Identity Center, such as a user or
group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more
information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity
Store API Reference.
- `principal_type`: The entity type for which the assignment will be created.
- `target_id`: TargetID is an Amazon Web Services account identifier, (For example,
123456789012).
- `target_type`: The entity type for which the assignment will be created.
"""
function create_account_assignment(
InstanceArn,
PermissionSetArn,
PrincipalId,
PrincipalType,
TargetId,
TargetType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"CreateAccountAssignment",
Dict{String,Any}(
"InstanceArn" => InstanceArn,
"PermissionSetArn" => PermissionSetArn,
"PrincipalId" => PrincipalId,
"PrincipalType" => PrincipalType,
"TargetId" => TargetId,
"TargetType" => TargetType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_account_assignment(
InstanceArn,
PermissionSetArn,
PrincipalId,
PrincipalType,
TargetId,
TargetType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"CreateAccountAssignment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceArn" => InstanceArn,
"PermissionSetArn" => PermissionSetArn,
"PrincipalId" => PrincipalId,
"PrincipalType" => PrincipalType,
"TargetId" => TargetId,
"TargetType" => TargetType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_application(application_provider_arn, instance_arn, name)
create_application(application_provider_arn, instance_arn, name, params::Dict{String,<:Any})
Creates an application in IAM Identity Center for the given application provider.
# Arguments
- `application_provider_arn`: The ARN of the application provider under which the operation
will run.
- `instance_arn`: The ARN of the instance of IAM Identity Center under which the operation
will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web
Services Service Namespaces in the Amazon Web Services General Reference.
- `name`: The name of the .
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Specifies a unique, case-sensitive ID that you provide to ensure the
idempotency of the request. This lets you safely retry the request without accidentally
performing the same operation a second time. Passing the same value to a later call to an
operation requires that you also pass the same value for all other parameters. We recommend
that you use a UUID type of value. If you don't provide this value, then Amazon Web
Services generates a random one for you. If you retry the operation with the same
ClientToken, but with different parameters, the retry fails with an
IdempotentParameterMismatch error.
- `"Description"`: The description of the .
- `"PortalOptions"`: A structure that describes the options for the portal associated with
an application.
- `"Status"`: Specifies whether the application is enabled or disabled.
- `"Tags"`: Specifies tags to be attached to the application.
"""
function create_application(
ApplicationProviderArn,
InstanceArn,
Name;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"CreateApplication",
Dict{String,Any}(
"ApplicationProviderArn" => ApplicationProviderArn,
"InstanceArn" => InstanceArn,
"Name" => Name,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_application(
ApplicationProviderArn,
InstanceArn,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"CreateApplication",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationProviderArn" => ApplicationProviderArn,
"InstanceArn" => InstanceArn,
"Name" => Name,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_application_assignment(application_arn, principal_id, principal_type)
create_application_assignment(application_arn, principal_id, principal_type, params::Dict{String,<:Any})
Grant application access to a user or group.
# Arguments
- `application_arn`: The ARN of the application provider under which the operation will run.
- `principal_id`: An identifier for an object in IAM Identity Center, such as a user or
group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more
information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity
Store API Reference.
- `principal_type`: The entity type for which the assignment will be created.
"""
function create_application_assignment(
ApplicationArn,
PrincipalId,
PrincipalType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"CreateApplicationAssignment",
Dict{String,Any}(
"ApplicationArn" => ApplicationArn,
"PrincipalId" => PrincipalId,
"PrincipalType" => PrincipalType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_application_assignment(
ApplicationArn,
PrincipalId,
PrincipalType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"CreateApplicationAssignment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationArn" => ApplicationArn,
"PrincipalId" => PrincipalId,
"PrincipalType" => PrincipalType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_instance()
create_instance(params::Dict{String,<:Any})
Creates an instance of IAM Identity Center for a standalone Amazon Web Services account
that is not managed by Organizations or a member Amazon Web Services account in an
organization. You can create only one instance per account and across all Amazon Web
Services Regions. The CreateInstance request is rejected if the following apply: The
instance is created within the organization management account. An instance already
exists in the same account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Specifies a unique, case-sensitive ID that you provide to ensure the
idempotency of the request. This lets you safely retry the request without accidentally
performing the same operation a second time. Passing the same value to a later call to an
operation requires that you also pass the same value for all other parameters. We recommend
that you use a UUID type of value. If you don't provide this value, then Amazon Web
Services generates a random one for you. If you retry the operation with the same
ClientToken, but with different parameters, the retry fails with an
IdempotentParameterMismatch error.
- `"Name"`: The name of the instance of IAM Identity Center.
- `"Tags"`: Specifies tags to be attached to the instance of IAM Identity Center.
"""
function create_instance(; aws_config::AbstractAWSConfig=global_aws_config())
return sso_admin(
"CreateInstance",
Dict{String,Any}("ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_instance(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"CreateInstance",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_instance_access_control_attribute_configuration(instance_access_control_attribute_configuration, instance_arn)
create_instance_access_control_attribute_configuration(instance_access_control_attribute_configuration, instance_arn, params::Dict{String,<:Any})
Enables the attributes-based access control (ABAC) feature for the specified IAM Identity
Center instance. You can also specify new attributes to add to your ABAC configuration
during the enabling process. For more information about ABAC, see Attribute-Based Access
Control in the IAM Identity Center User Guide. After a successful response, call
DescribeInstanceAccessControlAttributeConfiguration to validate that
InstanceAccessControlAttributeConfiguration was created.
# Arguments
- `instance_access_control_attribute_configuration`: Specifies the IAM Identity Center
identity store attributes to add to your ABAC configuration. When using an external
identity provider as an identity source, you can pass attributes through the SAML
assertion. Doing so provides an alternative to configuring attributes from the IAM Identity
Center identity store. If a SAML assertion passes any of these attributes, IAM Identity
Center will replace the attribute value with the value from the IAM Identity Center
identity store.
- `instance_arn`: The ARN of the IAM Identity Center instance under which the operation
will be executed.
"""
function create_instance_access_control_attribute_configuration(
InstanceAccessControlAttributeConfiguration,
InstanceArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"CreateInstanceAccessControlAttributeConfiguration",
Dict{String,Any}(
"InstanceAccessControlAttributeConfiguration" =>
InstanceAccessControlAttributeConfiguration,
"InstanceArn" => InstanceArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_instance_access_control_attribute_configuration(
InstanceAccessControlAttributeConfiguration,
InstanceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"CreateInstanceAccessControlAttributeConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceAccessControlAttributeConfiguration" =>
InstanceAccessControlAttributeConfiguration,
"InstanceArn" => InstanceArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_permission_set(instance_arn, name)
create_permission_set(instance_arn, name, params::Dict{String,<:Any})
Creates a permission set within a specified IAM Identity Center instance. To grant users
and groups access to Amazon Web Services account resources, use CreateAccountAssignment .
# Arguments
- `instance_arn`: The ARN of the IAM Identity Center instance under which the operation
will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and
Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
- `name`: The name of the PermissionSet.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description of the PermissionSet.
- `"RelayState"`: Used to redirect users within the application during the federation
authentication process.
- `"SessionDuration"`: The length of time that the application user sessions are valid in
the ISO-8601 standard.
- `"Tags"`: The tags to attach to the new PermissionSet.
"""
function create_permission_set(
InstanceArn, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"CreatePermissionSet",
Dict{String,Any}("InstanceArn" => InstanceArn, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_permission_set(
InstanceArn,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"CreatePermissionSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InstanceArn" => InstanceArn, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_trusted_token_issuer(instance_arn, name, trusted_token_issuer_configuration, trusted_token_issuer_type)
create_trusted_token_issuer(instance_arn, name, trusted_token_issuer_configuration, trusted_token_issuer_type, params::Dict{String,<:Any})
Creates a connection to a trusted token issuer in an instance of IAM Identity Center. A
trusted token issuer enables trusted identity propagation to be used with applications that
authenticate outside of Amazon Web Services. This trusted token issuer describes an
external identity provider (IdP) that can generate claims or assertions in the form of
access tokens for a user. Applications enabled for IAM Identity Center can use these tokens
for authentication.
# Arguments
- `instance_arn`: Specifies the ARN of the instance of IAM Identity Center to contain the
new trusted token issuer configuration.
- `name`: Specifies the name of the new trusted token issuer configuration.
- `trusted_token_issuer_configuration`: Specifies settings that apply to the new trusted
token issuer configuration. The settings that are available depend on what
TrustedTokenIssuerType you specify.
- `trusted_token_issuer_type`: Specifies the type of the new trusted token issuer.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Specifies a unique, case-sensitive ID that you provide to ensure the
idempotency of the request. This lets you safely retry the request without accidentally
performing the same operation a second time. Passing the same value to a later call to an
operation requires that you also pass the same value for all other parameters. We recommend
that you use a UUID type of value.. If you don't provide this value, then Amazon Web
Services generates a random one for you. If you retry the operation with the same
ClientToken, but with different parameters, the retry fails with an
IdempotentParameterMismatch error.
- `"Tags"`: Specifies tags to be attached to the new trusted token issuer configuration.
"""
function create_trusted_token_issuer(
InstanceArn,
Name,
TrustedTokenIssuerConfiguration,
TrustedTokenIssuerType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"CreateTrustedTokenIssuer",
Dict{String,Any}(
"InstanceArn" => InstanceArn,
"Name" => Name,
"TrustedTokenIssuerConfiguration" => TrustedTokenIssuerConfiguration,
"TrustedTokenIssuerType" => TrustedTokenIssuerType,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_trusted_token_issuer(
InstanceArn,
Name,
TrustedTokenIssuerConfiguration,
TrustedTokenIssuerType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"CreateTrustedTokenIssuer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceArn" => InstanceArn,
"Name" => Name,
"TrustedTokenIssuerConfiguration" => TrustedTokenIssuerConfiguration,
"TrustedTokenIssuerType" => TrustedTokenIssuerType,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_account_assignment(instance_arn, permission_set_arn, principal_id, principal_type, target_id, target_type)
delete_account_assignment(instance_arn, permission_set_arn, principal_id, principal_type, target_id, target_type, params::Dict{String,<:Any})
Deletes a principal's access from a specified Amazon Web Services account using a specified
permission set. After a successful response, call DescribeAccountAssignmentDeletionStatus
to describe the status of an assignment deletion request.
# Arguments
- `instance_arn`: The ARN of the IAM Identity Center instance under which the operation
will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and
Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
- `permission_set_arn`: The ARN of the permission set that will be used to remove access.
- `principal_id`: An identifier for an object in IAM Identity Center, such as a user or
group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more
information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity
Store API Reference.
- `principal_type`: The entity type for which the assignment will be deleted.
- `target_id`: TargetID is an Amazon Web Services account identifier, (For example,
123456789012).
- `target_type`: The entity type for which the assignment will be deleted.
"""
function delete_account_assignment(
InstanceArn,
PermissionSetArn,
PrincipalId,
PrincipalType,
TargetId,
TargetType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"DeleteAccountAssignment",
Dict{String,Any}(
"InstanceArn" => InstanceArn,
"PermissionSetArn" => PermissionSetArn,
"PrincipalId" => PrincipalId,
"PrincipalType" => PrincipalType,
"TargetId" => TargetId,
"TargetType" => TargetType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_account_assignment(
InstanceArn,
PermissionSetArn,
PrincipalId,
PrincipalType,
TargetId,
TargetType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"DeleteAccountAssignment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceArn" => InstanceArn,
"PermissionSetArn" => PermissionSetArn,
"PrincipalId" => PrincipalId,
"PrincipalType" => PrincipalType,
"TargetId" => TargetId,
"TargetType" => TargetType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_application(application_arn)
delete_application(application_arn, params::Dict{String,<:Any})
Deletes the association with the application. The connected service resource still exists.
# Arguments
- `application_arn`: Specifies the ARN of the application. For more information about ARNs,
see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon
Web Services General Reference.
"""
function delete_application(
ApplicationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"DeleteApplication",
Dict{String,Any}("ApplicationArn" => ApplicationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_application(
ApplicationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"DeleteApplication",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ApplicationArn" => ApplicationArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_application_access_scope(application_arn, scope)
delete_application_access_scope(application_arn, scope, params::Dict{String,<:Any})
Deletes an IAM Identity Center access scope from an application.
# Arguments
- `application_arn`: Specifies the ARN of the application with the access scope to delete.
- `scope`: Specifies the name of the access scope to remove from the application.
"""
function delete_application_access_scope(
ApplicationArn, Scope; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"DeleteApplicationAccessScope",
Dict{String,Any}("ApplicationArn" => ApplicationArn, "Scope" => Scope);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_application_access_scope(
ApplicationArn,
Scope,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"DeleteApplicationAccessScope",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ApplicationArn" => ApplicationArn, "Scope" => Scope),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_application_assignment(application_arn, principal_id, principal_type)
delete_application_assignment(application_arn, principal_id, principal_type, params::Dict{String,<:Any})
Revoke application access to an application by deleting application assignments for a user
or group.
# Arguments
- `application_arn`: Specifies the ARN of the application.
- `principal_id`: An identifier for an object in IAM Identity Center, such as a user or
group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more
information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity
Store API Reference.
- `principal_type`: The entity type for which the assignment will be deleted.
"""
function delete_application_assignment(
ApplicationArn,
PrincipalId,
PrincipalType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"DeleteApplicationAssignment",
Dict{String,Any}(
"ApplicationArn" => ApplicationArn,
"PrincipalId" => PrincipalId,
"PrincipalType" => PrincipalType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_application_assignment(
ApplicationArn,
PrincipalId,
PrincipalType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"DeleteApplicationAssignment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationArn" => ApplicationArn,
"PrincipalId" => PrincipalId,
"PrincipalType" => PrincipalType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_application_authentication_method(application_arn, authentication_method_type)
delete_application_authentication_method(application_arn, authentication_method_type, params::Dict{String,<:Any})
Deletes an authentication method from an application.
# Arguments
- `application_arn`: Specifies the ARN of the application with the authentication method to
delete.
- `authentication_method_type`: Specifies the authentication method type to delete from the
application.
"""
function delete_application_authentication_method(
ApplicationArn,
AuthenticationMethodType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"DeleteApplicationAuthenticationMethod",
Dict{String,Any}(
"ApplicationArn" => ApplicationArn,
"AuthenticationMethodType" => AuthenticationMethodType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_application_authentication_method(
ApplicationArn,
AuthenticationMethodType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"DeleteApplicationAuthenticationMethod",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationArn" => ApplicationArn,
"AuthenticationMethodType" => AuthenticationMethodType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_application_grant(application_arn, grant_type)
delete_application_grant(application_arn, grant_type, params::Dict{String,<:Any})
Deletes a grant from an application.
# Arguments
- `application_arn`: Specifies the ARN of the application with the grant to delete.
- `grant_type`: Specifies the type of grant to delete from the application.
"""
function delete_application_grant(
ApplicationArn, GrantType; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"DeleteApplicationGrant",
Dict{String,Any}("ApplicationArn" => ApplicationArn, "GrantType" => GrantType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_application_grant(
ApplicationArn,
GrantType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"DeleteApplicationGrant",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationArn" => ApplicationArn, "GrantType" => GrantType
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_inline_policy_from_permission_set(instance_arn, permission_set_arn)
delete_inline_policy_from_permission_set(instance_arn, permission_set_arn, params::Dict{String,<:Any})
Deletes the inline policy from a specified permission set.
# Arguments
- `instance_arn`: The ARN of the IAM Identity Center instance under which the operation
will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and
Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
- `permission_set_arn`: The ARN of the permission set that will be used to remove access.
"""
function delete_inline_policy_from_permission_set(
InstanceArn, PermissionSetArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"DeleteInlinePolicyFromPermissionSet",
Dict{String,Any}(
"InstanceArn" => InstanceArn, "PermissionSetArn" => PermissionSetArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_inline_policy_from_permission_set(
InstanceArn,
PermissionSetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"DeleteInlinePolicyFromPermissionSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceArn" => InstanceArn, "PermissionSetArn" => PermissionSetArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_instance(instance_arn)
delete_instance(instance_arn, params::Dict{String,<:Any})
Deletes the instance of IAM Identity Center. Only the account that owns the instance can
call this API. Neither the delegated administrator nor member account can delete the
organization instance, but those roles can delete their own instance.
# Arguments
- `instance_arn`: The ARN of the instance of IAM Identity Center under which the operation
will run.
"""
function delete_instance(InstanceArn; aws_config::AbstractAWSConfig=global_aws_config())
return sso_admin(
"DeleteInstance",
Dict{String,Any}("InstanceArn" => InstanceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_instance(
InstanceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"DeleteInstance",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceArn" => InstanceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_instance_access_control_attribute_configuration(instance_arn)
delete_instance_access_control_attribute_configuration(instance_arn, params::Dict{String,<:Any})
Disables the attributes-based access control (ABAC) feature for the specified IAM Identity
Center instance and deletes all of the attribute mappings that have been configured. Once
deleted, any attributes that are received from an identity source and any custom attributes
you have previously configured will not be passed. For more information about ABAC, see
Attribute-Based Access Control in the IAM Identity Center User Guide.
# Arguments
- `instance_arn`: The ARN of the IAM Identity Center instance under which the operation
will be executed.
"""
function delete_instance_access_control_attribute_configuration(
InstanceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"DeleteInstanceAccessControlAttributeConfiguration",
Dict{String,Any}("InstanceArn" => InstanceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_instance_access_control_attribute_configuration(
InstanceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"DeleteInstanceAccessControlAttributeConfiguration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceArn" => InstanceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_permission_set(instance_arn, permission_set_arn)
delete_permission_set(instance_arn, permission_set_arn, params::Dict{String,<:Any})
Deletes the specified permission set.
# Arguments
- `instance_arn`: The ARN of the IAM Identity Center instance under which the operation
will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and
Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
- `permission_set_arn`: The ARN of the permission set that should be deleted.
"""
function delete_permission_set(
InstanceArn, PermissionSetArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"DeletePermissionSet",
Dict{String,Any}(
"InstanceArn" => InstanceArn, "PermissionSetArn" => PermissionSetArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_permission_set(
InstanceArn,
PermissionSetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"DeletePermissionSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceArn" => InstanceArn, "PermissionSetArn" => PermissionSetArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_permissions_boundary_from_permission_set(instance_arn, permission_set_arn)
delete_permissions_boundary_from_permission_set(instance_arn, permission_set_arn, params::Dict{String,<:Any})
Deletes the permissions boundary from a specified PermissionSet.
# Arguments
- `instance_arn`: The ARN of the IAM Identity Center instance under which the operation
will be executed.
- `permission_set_arn`: The ARN of the PermissionSet.
"""
function delete_permissions_boundary_from_permission_set(
InstanceArn, PermissionSetArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"DeletePermissionsBoundaryFromPermissionSet",
Dict{String,Any}(
"InstanceArn" => InstanceArn, "PermissionSetArn" => PermissionSetArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_permissions_boundary_from_permission_set(
InstanceArn,
PermissionSetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"DeletePermissionsBoundaryFromPermissionSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceArn" => InstanceArn, "PermissionSetArn" => PermissionSetArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_trusted_token_issuer(trusted_token_issuer_arn)
delete_trusted_token_issuer(trusted_token_issuer_arn, params::Dict{String,<:Any})
Deletes a trusted token issuer configuration from an instance of IAM Identity Center.
Deleting this trusted token issuer configuration will cause users to lose access to any
applications that are configured to use the trusted token issuer.
# Arguments
- `trusted_token_issuer_arn`: Specifies the ARN of the trusted token issuer configuration
to delete.
"""
function delete_trusted_token_issuer(
TrustedTokenIssuerArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"DeleteTrustedTokenIssuer",
Dict{String,Any}("TrustedTokenIssuerArn" => TrustedTokenIssuerArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_trusted_token_issuer(
TrustedTokenIssuerArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"DeleteTrustedTokenIssuer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("TrustedTokenIssuerArn" => TrustedTokenIssuerArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_account_assignment_creation_status(account_assignment_creation_request_id, instance_arn)
describe_account_assignment_creation_status(account_assignment_creation_request_id, instance_arn, params::Dict{String,<:Any})
Describes the status of the assignment creation request.
# Arguments
- `account_assignment_creation_request_id`: The identifier that is used to track the
request operation progress.
- `instance_arn`: The ARN of the IAM Identity Center instance under which the operation
will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and
Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
"""
function describe_account_assignment_creation_status(
AccountAssignmentCreationRequestId,
InstanceArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"DescribeAccountAssignmentCreationStatus",
Dict{String,Any}(
"AccountAssignmentCreationRequestId" => AccountAssignmentCreationRequestId,
"InstanceArn" => InstanceArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_account_assignment_creation_status(
AccountAssignmentCreationRequestId,
InstanceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"DescribeAccountAssignmentCreationStatus",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AccountAssignmentCreationRequestId" =>
AccountAssignmentCreationRequestId,
"InstanceArn" => InstanceArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_account_assignment_deletion_status(account_assignment_deletion_request_id, instance_arn)
describe_account_assignment_deletion_status(account_assignment_deletion_request_id, instance_arn, params::Dict{String,<:Any})
Describes the status of the assignment deletion request.
# Arguments
- `account_assignment_deletion_request_id`: The identifier that is used to track the
request operation progress.
- `instance_arn`: The ARN of the IAM Identity Center instance under which the operation
will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and
Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
"""
function describe_account_assignment_deletion_status(
AccountAssignmentDeletionRequestId,
InstanceArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"DescribeAccountAssignmentDeletionStatus",
Dict{String,Any}(
"AccountAssignmentDeletionRequestId" => AccountAssignmentDeletionRequestId,
"InstanceArn" => InstanceArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_account_assignment_deletion_status(
AccountAssignmentDeletionRequestId,
InstanceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"DescribeAccountAssignmentDeletionStatus",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AccountAssignmentDeletionRequestId" =>
AccountAssignmentDeletionRequestId,
"InstanceArn" => InstanceArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_application(application_arn)
describe_application(application_arn, params::Dict{String,<:Any})
Retrieves the details of an application associated with an instance of IAM Identity Center.
# Arguments
- `application_arn`: Specifies the ARN of the application. For more information about ARNs,
see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon
Web Services General Reference.
"""
function describe_application(
ApplicationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"DescribeApplication",
Dict{String,Any}("ApplicationArn" => ApplicationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_application(
ApplicationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"DescribeApplication",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ApplicationArn" => ApplicationArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_application_assignment(application_arn, principal_id, principal_type)
describe_application_assignment(application_arn, principal_id, principal_type, params::Dict{String,<:Any})
Retrieves a direct assignment of a user or group to an application. If the user doesn’t
have a direct assignment to the application, the user may still have access to the
application through a group. Therefore, don’t use this API to test access to an
application for a user. Instead use ListApplicationAssignmentsForPrincipal.
# Arguments
- `application_arn`: Specifies the ARN of the application. For more information about ARNs,
see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon
Web Services General Reference.
- `principal_id`: An identifier for an object in IAM Identity Center, such as a user or
group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more
information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity
Store API Reference.
- `principal_type`: The entity type for which the assignment will be created.
"""
function describe_application_assignment(
ApplicationArn,
PrincipalId,
PrincipalType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"DescribeApplicationAssignment",
Dict{String,Any}(
"ApplicationArn" => ApplicationArn,
"PrincipalId" => PrincipalId,
"PrincipalType" => PrincipalType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_application_assignment(
ApplicationArn,
PrincipalId,
PrincipalType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"DescribeApplicationAssignment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationArn" => ApplicationArn,
"PrincipalId" => PrincipalId,
"PrincipalType" => PrincipalType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_application_provider(application_provider_arn)
describe_application_provider(application_provider_arn, params::Dict{String,<:Any})
Retrieves details about a provider that can be used to connect an Amazon Web Services
managed application or customer managed application to IAM Identity Center.
# Arguments
- `application_provider_arn`: Specifies the ARN of the application provider for which you
want details.
"""
function describe_application_provider(
ApplicationProviderArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"DescribeApplicationProvider",
Dict{String,Any}("ApplicationProviderArn" => ApplicationProviderArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_application_provider(
ApplicationProviderArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"DescribeApplicationProvider",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ApplicationProviderArn" => ApplicationProviderArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_instance(instance_arn)
describe_instance(instance_arn, params::Dict{String,<:Any})
Returns the details of an instance of IAM Identity Center. The status can be one of the
following: CREATE_IN_PROGRESS - The instance is in the process of being created. When
the instance is ready for use, DescribeInstance returns the status of ACTIVE. While the
instance is in the CREATE_IN_PROGRESS state, you can call only DescribeInstance and
DeleteInstance operations. DELETE_IN_PROGRESS - The instance is being deleted. Returns
AccessDeniedException after the delete operation completes. ACTIVE - The instance is
active.
# Arguments
- `instance_arn`: The ARN of the instance of IAM Identity Center under which the operation
will run.
"""
function describe_instance(InstanceArn; aws_config::AbstractAWSConfig=global_aws_config())
return sso_admin(
"DescribeInstance",
Dict{String,Any}("InstanceArn" => InstanceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_instance(
InstanceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"DescribeInstance",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceArn" => InstanceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_instance_access_control_attribute_configuration(instance_arn)
describe_instance_access_control_attribute_configuration(instance_arn, params::Dict{String,<:Any})
Returns the list of IAM Identity Center identity store attributes that have been configured
to work with attributes-based access control (ABAC) for the specified IAM Identity Center
instance. This will not return attributes configured and sent by an external identity
provider. For more information about ABAC, see Attribute-Based Access Control in the IAM
Identity Center User Guide.
# Arguments
- `instance_arn`: The ARN of the IAM Identity Center instance under which the operation
will be executed.
"""
function describe_instance_access_control_attribute_configuration(
InstanceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"DescribeInstanceAccessControlAttributeConfiguration",
Dict{String,Any}("InstanceArn" => InstanceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_instance_access_control_attribute_configuration(
InstanceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"DescribeInstanceAccessControlAttributeConfiguration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceArn" => InstanceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_permission_set(instance_arn, permission_set_arn)
describe_permission_set(instance_arn, permission_set_arn, params::Dict{String,<:Any})
Gets the details of the permission set.
# Arguments
- `instance_arn`: The ARN of the IAM Identity Center instance under which the operation
will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and
Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
- `permission_set_arn`: The ARN of the permission set.
"""
function describe_permission_set(
InstanceArn, PermissionSetArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"DescribePermissionSet",
Dict{String,Any}(
"InstanceArn" => InstanceArn, "PermissionSetArn" => PermissionSetArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_permission_set(
InstanceArn,
PermissionSetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"DescribePermissionSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceArn" => InstanceArn, "PermissionSetArn" => PermissionSetArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_permission_set_provisioning_status(instance_arn, provision_permission_set_request_id)
describe_permission_set_provisioning_status(instance_arn, provision_permission_set_request_id, params::Dict{String,<:Any})
Describes the status for the given permission set provisioning request.
# Arguments
- `instance_arn`: The ARN of the IAM Identity Center instance under which the operation
will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and
Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
- `provision_permission_set_request_id`: The identifier that is provided by the
ProvisionPermissionSet call to retrieve the current status of the provisioning workflow.
"""
function describe_permission_set_provisioning_status(
InstanceArn,
ProvisionPermissionSetRequestId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"DescribePermissionSetProvisioningStatus",
Dict{String,Any}(
"InstanceArn" => InstanceArn,
"ProvisionPermissionSetRequestId" => ProvisionPermissionSetRequestId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_permission_set_provisioning_status(
InstanceArn,
ProvisionPermissionSetRequestId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"DescribePermissionSetProvisioningStatus",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceArn" => InstanceArn,
"ProvisionPermissionSetRequestId" => ProvisionPermissionSetRequestId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_trusted_token_issuer(trusted_token_issuer_arn)
describe_trusted_token_issuer(trusted_token_issuer_arn, params::Dict{String,<:Any})
Retrieves details about a trusted token issuer configuration stored in an instance of IAM
Identity Center. Details include the name of the trusted token issuer, the issuer URL, and
the path of the source attribute and the destination attribute for a trusted token issuer
configuration.
# Arguments
- `trusted_token_issuer_arn`: Specifies the ARN of the trusted token issuer configuration
that you want details about.
"""
function describe_trusted_token_issuer(
TrustedTokenIssuerArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"DescribeTrustedTokenIssuer",
Dict{String,Any}("TrustedTokenIssuerArn" => TrustedTokenIssuerArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_trusted_token_issuer(
TrustedTokenIssuerArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"DescribeTrustedTokenIssuer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("TrustedTokenIssuerArn" => TrustedTokenIssuerArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detach_customer_managed_policy_reference_from_permission_set(customer_managed_policy_reference, instance_arn, permission_set_arn)
detach_customer_managed_policy_reference_from_permission_set(customer_managed_policy_reference, instance_arn, permission_set_arn, params::Dict{String,<:Any})
Detaches the specified customer managed policy from the specified PermissionSet.
# Arguments
- `customer_managed_policy_reference`: Specifies the name and path of a customer managed
policy. You must have an IAM policy that matches the name and path in each Amazon Web
Services account where you want to deploy your permission set.
- `instance_arn`: The ARN of the IAM Identity Center instance under which the operation
will be executed.
- `permission_set_arn`: The ARN of the PermissionSet.
"""
function detach_customer_managed_policy_reference_from_permission_set(
CustomerManagedPolicyReference,
InstanceArn,
PermissionSetArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"DetachCustomerManagedPolicyReferenceFromPermissionSet",
Dict{String,Any}(
"CustomerManagedPolicyReference" => CustomerManagedPolicyReference,
"InstanceArn" => InstanceArn,
"PermissionSetArn" => PermissionSetArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detach_customer_managed_policy_reference_from_permission_set(
CustomerManagedPolicyReference,
InstanceArn,
PermissionSetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"DetachCustomerManagedPolicyReferenceFromPermissionSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CustomerManagedPolicyReference" => CustomerManagedPolicyReference,
"InstanceArn" => InstanceArn,
"PermissionSetArn" => PermissionSetArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detach_managed_policy_from_permission_set(instance_arn, managed_policy_arn, permission_set_arn)
detach_managed_policy_from_permission_set(instance_arn, managed_policy_arn, permission_set_arn, params::Dict{String,<:Any})
Detaches the attached Amazon Web Services managed policy ARN from the specified permission
set.
# Arguments
- `instance_arn`: The ARN of the IAM Identity Center instance under which the operation
will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and
Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
- `managed_policy_arn`: The Amazon Web Services managed policy ARN to be detached from a
permission set.
- `permission_set_arn`: The ARN of the PermissionSet from which the policy should be
detached.
"""
function detach_managed_policy_from_permission_set(
InstanceArn,
ManagedPolicyArn,
PermissionSetArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"DetachManagedPolicyFromPermissionSet",
Dict{String,Any}(
"InstanceArn" => InstanceArn,
"ManagedPolicyArn" => ManagedPolicyArn,
"PermissionSetArn" => PermissionSetArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detach_managed_policy_from_permission_set(
InstanceArn,
ManagedPolicyArn,
PermissionSetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"DetachManagedPolicyFromPermissionSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceArn" => InstanceArn,
"ManagedPolicyArn" => ManagedPolicyArn,
"PermissionSetArn" => PermissionSetArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_application_access_scope(application_arn, scope)
get_application_access_scope(application_arn, scope, params::Dict{String,<:Any})
Retrieves the authorized targets for an IAM Identity Center access scope for an application.
# Arguments
- `application_arn`: Specifies the ARN of the application with the access scope that you
want to retrieve.
- `scope`: Specifies the name of the access scope for which you want the authorized targets.
"""
function get_application_access_scope(
ApplicationArn, Scope; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"GetApplicationAccessScope",
Dict{String,Any}("ApplicationArn" => ApplicationArn, "Scope" => Scope);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_application_access_scope(
ApplicationArn,
Scope,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"GetApplicationAccessScope",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ApplicationArn" => ApplicationArn, "Scope" => Scope),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_application_assignment_configuration(application_arn)
get_application_assignment_configuration(application_arn, params::Dict{String,<:Any})
Retrieves the configuration of PutApplicationAssignmentConfiguration.
# Arguments
- `application_arn`: Specifies the ARN of the application. For more information about ARNs,
see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon
Web Services General Reference.
"""
function get_application_assignment_configuration(
ApplicationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"GetApplicationAssignmentConfiguration",
Dict{String,Any}("ApplicationArn" => ApplicationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_application_assignment_configuration(
ApplicationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"GetApplicationAssignmentConfiguration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ApplicationArn" => ApplicationArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_application_authentication_method(application_arn, authentication_method_type)
get_application_authentication_method(application_arn, authentication_method_type, params::Dict{String,<:Any})
Retrieves details about an authentication method used by an application.
# Arguments
- `application_arn`: Specifies the ARN of the application.
- `authentication_method_type`: Specifies the type of authentication method for which you
want details.
"""
function get_application_authentication_method(
ApplicationArn,
AuthenticationMethodType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"GetApplicationAuthenticationMethod",
Dict{String,Any}(
"ApplicationArn" => ApplicationArn,
"AuthenticationMethodType" => AuthenticationMethodType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_application_authentication_method(
ApplicationArn,
AuthenticationMethodType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"GetApplicationAuthenticationMethod",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationArn" => ApplicationArn,
"AuthenticationMethodType" => AuthenticationMethodType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_application_grant(application_arn, grant_type)
get_application_grant(application_arn, grant_type, params::Dict{String,<:Any})
Retrieves details about an application grant.
# Arguments
- `application_arn`: Specifies the ARN of the application that contains the grant.
- `grant_type`: Specifies the type of grant.
"""
function get_application_grant(
ApplicationArn, GrantType; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"GetApplicationGrant",
Dict{String,Any}("ApplicationArn" => ApplicationArn, "GrantType" => GrantType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_application_grant(
ApplicationArn,
GrantType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"GetApplicationGrant",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationArn" => ApplicationArn, "GrantType" => GrantType
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_inline_policy_for_permission_set(instance_arn, permission_set_arn)
get_inline_policy_for_permission_set(instance_arn, permission_set_arn, params::Dict{String,<:Any})
Obtains the inline policy assigned to the permission set.
# Arguments
- `instance_arn`: The ARN of the IAM Identity Center instance under which the operation
will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and
Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
- `permission_set_arn`: The ARN of the permission set.
"""
function get_inline_policy_for_permission_set(
InstanceArn, PermissionSetArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"GetInlinePolicyForPermissionSet",
Dict{String,Any}(
"InstanceArn" => InstanceArn, "PermissionSetArn" => PermissionSetArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_inline_policy_for_permission_set(
InstanceArn,
PermissionSetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"GetInlinePolicyForPermissionSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceArn" => InstanceArn, "PermissionSetArn" => PermissionSetArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_permissions_boundary_for_permission_set(instance_arn, permission_set_arn)
get_permissions_boundary_for_permission_set(instance_arn, permission_set_arn, params::Dict{String,<:Any})
Obtains the permissions boundary for a specified PermissionSet.
# Arguments
- `instance_arn`: The ARN of the IAM Identity Center instance under which the operation
will be executed.
- `permission_set_arn`: The ARN of the PermissionSet.
"""
function get_permissions_boundary_for_permission_set(
InstanceArn, PermissionSetArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"GetPermissionsBoundaryForPermissionSet",
Dict{String,Any}(
"InstanceArn" => InstanceArn, "PermissionSetArn" => PermissionSetArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_permissions_boundary_for_permission_set(
InstanceArn,
PermissionSetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"GetPermissionsBoundaryForPermissionSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceArn" => InstanceArn, "PermissionSetArn" => PermissionSetArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_account_assignment_creation_status(instance_arn)
list_account_assignment_creation_status(instance_arn, params::Dict{String,<:Any})
Lists the status of the Amazon Web Services account assignment creation requests for a
specified IAM Identity Center instance.
# Arguments
- `instance_arn`: The ARN of the IAM Identity Center instance under which the operation
will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and
Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Filters results based on the passed attribute value.
- `"MaxResults"`: The maximum number of results to display for the assignment.
- `"NextToken"`: The pagination token for the list API. Initially the value is null. Use
the output of previous API calls to make subsequent calls.
"""
function list_account_assignment_creation_status(
InstanceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"ListAccountAssignmentCreationStatus",
Dict{String,Any}("InstanceArn" => InstanceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_account_assignment_creation_status(
InstanceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"ListAccountAssignmentCreationStatus",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceArn" => InstanceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_account_assignment_deletion_status(instance_arn)
list_account_assignment_deletion_status(instance_arn, params::Dict{String,<:Any})
Lists the status of the Amazon Web Services account assignment deletion requests for a
specified IAM Identity Center instance.
# Arguments
- `instance_arn`: The ARN of the IAM Identity Center instance under which the operation
will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and
Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Filters results based on the passed attribute value.
- `"MaxResults"`: The maximum number of results to display for the assignment.
- `"NextToken"`: The pagination token for the list API. Initially the value is null. Use
the output of previous API calls to make subsequent calls.
"""
function list_account_assignment_deletion_status(
InstanceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"ListAccountAssignmentDeletionStatus",
Dict{String,Any}("InstanceArn" => InstanceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_account_assignment_deletion_status(
InstanceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"ListAccountAssignmentDeletionStatus",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceArn" => InstanceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_account_assignments(account_id, instance_arn, permission_set_arn)
list_account_assignments(account_id, instance_arn, permission_set_arn, params::Dict{String,<:Any})
Lists the assignee of the specified Amazon Web Services account with the specified
permission set.
# Arguments
- `account_id`: The identifier of the Amazon Web Services account from which to list the
assignments.
- `instance_arn`: The ARN of the IAM Identity Center instance under which the operation
will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and
Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
- `permission_set_arn`: The ARN of the permission set from which to list assignments.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to display for the assignment.
- `"NextToken"`: The pagination token for the list API. Initially the value is null. Use
the output of previous API calls to make subsequent calls.
"""
function list_account_assignments(
AccountId,
InstanceArn,
PermissionSetArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"ListAccountAssignments",
Dict{String,Any}(
"AccountId" => AccountId,
"InstanceArn" => InstanceArn,
"PermissionSetArn" => PermissionSetArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_account_assignments(
AccountId,
InstanceArn,
PermissionSetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"ListAccountAssignments",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AccountId" => AccountId,
"InstanceArn" => InstanceArn,
"PermissionSetArn" => PermissionSetArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_account_assignments_for_principal(instance_arn, principal_id, principal_type)
list_account_assignments_for_principal(instance_arn, principal_id, principal_type, params::Dict{String,<:Any})
Retrieves a list of the IAM Identity Center associated Amazon Web Services accounts that
the principal has access to.
# Arguments
- `instance_arn`: Specifies the ARN of the instance of IAM Identity Center that contains
the principal.
- `principal_id`: Specifies the principal for which you want to retrieve the list of
account assignments.
- `principal_type`: Specifies the type of the principal.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Specifies an Amazon Web Services account ID number. Results are filtered to
only those that match this ID number.
- `"MaxResults"`: Specifies the total number of results that you want included in each
response. If additional items exist beyond the number you specify, the NextToken response
element is returned with a value (not null). Include the specified value as the NextToken
request parameter in the next call to the operation to get the next set of results. Note
that the service might return fewer results than the maximum even when there are more
results available. You should check NextToken after every operation to ensure that you
receive all of the results.
- `"NextToken"`: Specifies that you want to receive the next page of results. Valid only if
you received a NextToken response in the previous request. If you did, it indicates that
more output is available. Set this parameter to the value provided by the previous call's
NextToken response to request the next page of results.
"""
function list_account_assignments_for_principal(
InstanceArn,
PrincipalId,
PrincipalType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"ListAccountAssignmentsForPrincipal",
Dict{String,Any}(
"InstanceArn" => InstanceArn,
"PrincipalId" => PrincipalId,
"PrincipalType" => PrincipalType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_account_assignments_for_principal(
InstanceArn,
PrincipalId,
PrincipalType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"ListAccountAssignmentsForPrincipal",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceArn" => InstanceArn,
"PrincipalId" => PrincipalId,
"PrincipalType" => PrincipalType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_accounts_for_provisioned_permission_set(instance_arn, permission_set_arn)
list_accounts_for_provisioned_permission_set(instance_arn, permission_set_arn, params::Dict{String,<:Any})
Lists all the Amazon Web Services accounts where the specified permission set is
provisioned.
# Arguments
- `instance_arn`: The ARN of the IAM Identity Center instance under which the operation
will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and
Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
- `permission_set_arn`: The ARN of the PermissionSet from which the associated Amazon Web
Services accounts will 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 display for the PermissionSet.
- `"NextToken"`: The pagination token for the list API. Initially the value is null. Use
the output of previous API calls to make subsequent calls.
- `"ProvisioningStatus"`: The permission set provisioning status for an Amazon Web Services
account.
"""
function list_accounts_for_provisioned_permission_set(
InstanceArn, PermissionSetArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"ListAccountsForProvisionedPermissionSet",
Dict{String,Any}(
"InstanceArn" => InstanceArn, "PermissionSetArn" => PermissionSetArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_accounts_for_provisioned_permission_set(
InstanceArn,
PermissionSetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"ListAccountsForProvisionedPermissionSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceArn" => InstanceArn, "PermissionSetArn" => PermissionSetArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_application_access_scopes(application_arn)
list_application_access_scopes(application_arn, params::Dict{String,<:Any})
Lists the access scopes and authorized targets associated with an application.
# Arguments
- `application_arn`: Specifies the ARN of the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Specifies the total number of results that you want included in each
response. If additional items exist beyond the number you specify, the NextToken response
element is returned with a value (not null). Include the specified value as the NextToken
request parameter in the next call to the operation to get the next set of results. Note
that the service might return fewer results than the maximum even when there are more
results available. You should check NextToken after every operation to ensure that you
receive all of the results.
- `"NextToken"`: Specifies that you want to receive the next page of results. Valid only if
you received a NextToken response in the previous request. If you did, it indicates that
more output is available. Set this parameter to the value provided by the previous call's
NextToken response to request the next page of results.
"""
function list_application_access_scopes(
ApplicationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"ListApplicationAccessScopes",
Dict{String,Any}("ApplicationArn" => ApplicationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_application_access_scopes(
ApplicationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"ListApplicationAccessScopes",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ApplicationArn" => ApplicationArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_application_assignments(application_arn)
list_application_assignments(application_arn, params::Dict{String,<:Any})
Lists Amazon Web Services account users that are assigned to an application.
# Arguments
- `application_arn`: Specifies the ARN of the application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Specifies the total number of results that you want included in each
response. If additional items exist beyond the number you specify, the NextToken response
element is returned with a value (not null). Include the specified value as the NextToken
request parameter in the next call to the operation to get the next set of results. Note
that the service might return fewer results than the maximum even when there are more
results available. You should check NextToken after every operation to ensure that you
receive all of the results.
- `"NextToken"`: Specifies that you want to receive the next page of results. Valid only if
you received a NextToken response in the previous request. If you did, it indicates that
more output is available. Set this parameter to the value provided by the previous call's
NextToken response to request the next page of results.
"""
function list_application_assignments(
ApplicationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"ListApplicationAssignments",
Dict{String,Any}("ApplicationArn" => ApplicationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_application_assignments(
ApplicationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"ListApplicationAssignments",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ApplicationArn" => ApplicationArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_application_assignments_for_principal(instance_arn, principal_id, principal_type)
list_application_assignments_for_principal(instance_arn, principal_id, principal_type, params::Dict{String,<:Any})
Lists the applications to which a specified principal is assigned.
# Arguments
- `instance_arn`: Specifies the instance of IAM Identity Center that contains principal and
applications.
- `principal_id`: Specifies the unique identifier of the principal for which you want to
retrieve its assignments.
- `principal_type`: Specifies the type of the principal for which you want to retrieve its
assignments.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Filters the output to include only assignments associated with the
application that has the specified ARN.
- `"MaxResults"`: Specifies the total number of results that you want included in each
response. If additional items exist beyond the number you specify, the NextToken response
element is returned with a value (not null). Include the specified value as the NextToken
request parameter in the next call to the operation to get the next set of results. Note
that the service might return fewer results than the maximum even when there are more
results available. You should check NextToken after every operation to ensure that you
receive all of the results.
- `"NextToken"`: Specifies that you want to receive the next page of results. Valid only if
you received a NextToken response in the previous request. If you did, it indicates that
more output is available. Set this parameter to the value provided by the previous call's
NextToken response to request the next page of results.
"""
function list_application_assignments_for_principal(
InstanceArn,
PrincipalId,
PrincipalType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"ListApplicationAssignmentsForPrincipal",
Dict{String,Any}(
"InstanceArn" => InstanceArn,
"PrincipalId" => PrincipalId,
"PrincipalType" => PrincipalType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_application_assignments_for_principal(
InstanceArn,
PrincipalId,
PrincipalType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"ListApplicationAssignmentsForPrincipal",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceArn" => InstanceArn,
"PrincipalId" => PrincipalId,
"PrincipalType" => PrincipalType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_application_authentication_methods(application_arn)
list_application_authentication_methods(application_arn, params::Dict{String,<:Any})
Lists all of the authentication methods supported by the specified application.
# Arguments
- `application_arn`: Specifies the ARN of the application with the authentication methods
you want to list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: Specifies that you want to receive the next page of results. Valid only if
you received a NextToken response in the previous request. If you did, it indicates that
more output is available. Set this parameter to the value provided by the previous call's
NextToken response to request the next page of results.
"""
function list_application_authentication_methods(
ApplicationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"ListApplicationAuthenticationMethods",
Dict{String,Any}("ApplicationArn" => ApplicationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_application_authentication_methods(
ApplicationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"ListApplicationAuthenticationMethods",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ApplicationArn" => ApplicationArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_application_grants(application_arn)
list_application_grants(application_arn, params::Dict{String,<:Any})
List the grants associated with an application.
# Arguments
- `application_arn`: Specifies the ARN of the application whose grants you want to list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: Specifies that you want to receive the next page of results. Valid only if
you received a NextToken response in the previous request. If you did, it indicates that
more output is available. Set this parameter to the value provided by the previous call's
NextToken response to request the next page of results.
"""
function list_application_grants(
ApplicationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"ListApplicationGrants",
Dict{String,Any}("ApplicationArn" => ApplicationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_application_grants(
ApplicationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"ListApplicationGrants",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ApplicationArn" => ApplicationArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_application_providers()
list_application_providers(params::Dict{String,<:Any})
Lists the application providers configured in the IAM Identity Center identity store.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Specifies the total number of results that you want included in each
response. If additional items exist beyond the number you specify, the NextToken response
element is returned with a value (not null). Include the specified value as the NextToken
request parameter in the next call to the operation to get the next set of results. Note
that the service might return fewer results than the maximum even when there are more
results available. You should check NextToken after every operation to ensure that you
receive all of the results.
- `"NextToken"`: Specifies that you want to receive the next page of results. Valid only if
you received a NextToken response in the previous request. If you did, it indicates that
more output is available. Set this parameter to the value provided by the previous call's
NextToken response to request the next page of results.
"""
function list_application_providers(; aws_config::AbstractAWSConfig=global_aws_config())
return sso_admin(
"ListApplicationProviders"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_application_providers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"ListApplicationProviders",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_applications(instance_arn)
list_applications(instance_arn, params::Dict{String,<:Any})
Lists all applications associated with the instance of IAM Identity Center. When listing
applications for an instance in the management account, member accounts must use the
applicationAccount parameter to filter the list to only applications created from that
account.
# Arguments
- `instance_arn`: The ARN of the IAM Identity Center application under which the operation
will run. For more information about ARNs, see Amazon Resource Names (ARNs) and 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:
- `"Filter"`: Filters response results.
- `"MaxResults"`: Specifies the total number of results that you want included in each
response. If additional items exist beyond the number you specify, the NextToken response
element is returned with a value (not null). Include the specified value as the NextToken
request parameter in the next call to the operation to get the next set of results. Note
that the service might return fewer results than the maximum even when there are more
results available. You should check NextToken after every operation to ensure that you
receive all of the results.
- `"NextToken"`: Specifies that you want to receive the next page of results. Valid only if
you received a NextToken response in the previous request. If you did, it indicates that
more output is available. Set this parameter to the value provided by the previous call's
NextToken response to request the next page of results.
"""
function list_applications(InstanceArn; aws_config::AbstractAWSConfig=global_aws_config())
return sso_admin(
"ListApplications",
Dict{String,Any}("InstanceArn" => InstanceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_applications(
InstanceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"ListApplications",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceArn" => InstanceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_customer_managed_policy_references_in_permission_set(instance_arn, permission_set_arn)
list_customer_managed_policy_references_in_permission_set(instance_arn, permission_set_arn, params::Dict{String,<:Any})
Lists all customer managed policies attached to a specified PermissionSet.
# Arguments
- `instance_arn`: The ARN of the IAM Identity Center instance under which the operation
will be executed.
- `permission_set_arn`: The ARN of the PermissionSet.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to display for the list call.
- `"NextToken"`: The pagination token for the list API. Initially the value is null. Use
the output of previous API calls to make subsequent calls.
"""
function list_customer_managed_policy_references_in_permission_set(
InstanceArn, PermissionSetArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"ListCustomerManagedPolicyReferencesInPermissionSet",
Dict{String,Any}(
"InstanceArn" => InstanceArn, "PermissionSetArn" => PermissionSetArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_customer_managed_policy_references_in_permission_set(
InstanceArn,
PermissionSetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"ListCustomerManagedPolicyReferencesInPermissionSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceArn" => InstanceArn, "PermissionSetArn" => PermissionSetArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_instances()
list_instances(params::Dict{String,<:Any})
Lists the details of the organization and account instances of IAM Identity Center that
were created in or visible to the account calling this API.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to display for the instance.
- `"NextToken"`: The pagination token for the list API. Initially the value is null. Use
the output of previous API calls to make subsequent calls.
"""
function list_instances(; aws_config::AbstractAWSConfig=global_aws_config())
return sso_admin(
"ListInstances"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_instances(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"ListInstances", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_managed_policies_in_permission_set(instance_arn, permission_set_arn)
list_managed_policies_in_permission_set(instance_arn, permission_set_arn, params::Dict{String,<:Any})
Lists the Amazon Web Services managed policy that is attached to a specified permission set.
# Arguments
- `instance_arn`: The ARN of the IAM Identity Center instance under which the operation
will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and
Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
- `permission_set_arn`: The ARN of the PermissionSet whose managed policies will 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 display for the PermissionSet.
- `"NextToken"`: The pagination token for the list API. Initially the value is null. Use
the output of previous API calls to make subsequent calls.
"""
function list_managed_policies_in_permission_set(
InstanceArn, PermissionSetArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"ListManagedPoliciesInPermissionSet",
Dict{String,Any}(
"InstanceArn" => InstanceArn, "PermissionSetArn" => PermissionSetArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_managed_policies_in_permission_set(
InstanceArn,
PermissionSetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"ListManagedPoliciesInPermissionSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceArn" => InstanceArn, "PermissionSetArn" => PermissionSetArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_permission_set_provisioning_status(instance_arn)
list_permission_set_provisioning_status(instance_arn, params::Dict{String,<:Any})
Lists the status of the permission set provisioning requests for a specified IAM Identity
Center instance.
# Arguments
- `instance_arn`: The ARN of the IAM Identity Center instance under which the operation
will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and
Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Filters results based on the passed attribute value.
- `"MaxResults"`: The maximum number of results to display for the assignment.
- `"NextToken"`: The pagination token for the list API. Initially the value is null. Use
the output of previous API calls to make subsequent calls.
"""
function list_permission_set_provisioning_status(
InstanceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"ListPermissionSetProvisioningStatus",
Dict{String,Any}("InstanceArn" => InstanceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_permission_set_provisioning_status(
InstanceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"ListPermissionSetProvisioningStatus",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceArn" => InstanceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_permission_sets(instance_arn)
list_permission_sets(instance_arn, params::Dict{String,<:Any})
Lists the PermissionSets in an IAM Identity Center instance.
# Arguments
- `instance_arn`: The ARN of the IAM Identity Center instance under which the operation
will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and
Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to display for the assignment.
- `"NextToken"`: The pagination token for the list API. Initially the value is null. Use
the output of previous API calls to make subsequent calls.
"""
function list_permission_sets(
InstanceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"ListPermissionSets",
Dict{String,Any}("InstanceArn" => InstanceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_permission_sets(
InstanceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"ListPermissionSets",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceArn" => InstanceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_permission_sets_provisioned_to_account(account_id, instance_arn)
list_permission_sets_provisioned_to_account(account_id, instance_arn, params::Dict{String,<:Any})
Lists all the permission sets that are provisioned to a specified Amazon Web Services
account.
# Arguments
- `account_id`: The identifier of the Amazon Web Services account from which to list the
assignments.
- `instance_arn`: The ARN of the IAM Identity Center instance under which the operation
will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and
Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to display for the assignment.
- `"NextToken"`: The pagination token for the list API. Initially the value is null. Use
the output of previous API calls to make subsequent calls.
- `"ProvisioningStatus"`: The status object for the permission set provisioning operation.
"""
function list_permission_sets_provisioned_to_account(
AccountId, InstanceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"ListPermissionSetsProvisionedToAccount",
Dict{String,Any}("AccountId" => AccountId, "InstanceArn" => InstanceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_permission_sets_provisioned_to_account(
AccountId,
InstanceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"ListPermissionSetsProvisionedToAccount",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AccountId" => AccountId, "InstanceArn" => InstanceArn),
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 attached to a specified resource.
# Arguments
- `resource_arn`: The ARN of the resource with the tags to be listed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InstanceArn"`: The ARN of the IAM Identity Center instance under which the operation
will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and
Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
- `"NextToken"`: The pagination token for the list API. Initially the value is null. Use
the output of previous API calls to make subsequent calls.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"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 sso_admin(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_trusted_token_issuers(instance_arn)
list_trusted_token_issuers(instance_arn, params::Dict{String,<:Any})
Lists all the trusted token issuers configured in an instance of IAM Identity Center.
# Arguments
- `instance_arn`: Specifies the ARN of the instance of IAM Identity Center with the trusted
token issuer configurations that you want to list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Specifies the total number of results that you want included in each
response. If additional items exist beyond the number you specify, the NextToken response
element is returned with a value (not null). Include the specified value as the NextToken
request parameter in the next call to the operation to get the next set of results. Note
that the service might return fewer results than the maximum even when there are more
results available. You should check NextToken after every operation to ensure that you
receive all of the results.
- `"NextToken"`: Specifies that you want to receive the next page of results. Valid only if
you received a NextToken response in the previous request. If you did, it indicates that
more output is available. Set this parameter to the value provided by the previous call's
NextToken response to request the next page of results.
"""
function list_trusted_token_issuers(
InstanceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"ListTrustedTokenIssuers",
Dict{String,Any}("InstanceArn" => InstanceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_trusted_token_issuers(
InstanceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"ListTrustedTokenIssuers",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceArn" => InstanceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
provision_permission_set(instance_arn, permission_set_arn, target_type)
provision_permission_set(instance_arn, permission_set_arn, target_type, params::Dict{String,<:Any})
The process by which a specified permission set is provisioned to the specified target.
# Arguments
- `instance_arn`: The ARN of the IAM Identity Center instance under which the operation
will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and
Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
- `permission_set_arn`: The ARN of the permission set.
- `target_type`: The entity type for which the assignment will be created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"TargetId"`: TargetID is an Amazon Web Services account identifier, (For example,
123456789012).
"""
function provision_permission_set(
InstanceArn,
PermissionSetArn,
TargetType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"ProvisionPermissionSet",
Dict{String,Any}(
"InstanceArn" => InstanceArn,
"PermissionSetArn" => PermissionSetArn,
"TargetType" => TargetType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function provision_permission_set(
InstanceArn,
PermissionSetArn,
TargetType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"ProvisionPermissionSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceArn" => InstanceArn,
"PermissionSetArn" => PermissionSetArn,
"TargetType" => TargetType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_application_access_scope(application_arn, scope)
put_application_access_scope(application_arn, scope, params::Dict{String,<:Any})
Adds or updates the list of authorized targets for an IAM Identity Center access scope for
an application.
# Arguments
- `application_arn`: Specifies the ARN of the application with the access scope with the
targets to add or update.
- `scope`: Specifies the name of the access scope to be associated with the specified
targets.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AuthorizedTargets"`: Specifies an array list of ARNs that represent the authorized
targets for this access scope.
"""
function put_application_access_scope(
ApplicationArn, Scope; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"PutApplicationAccessScope",
Dict{String,Any}("ApplicationArn" => ApplicationArn, "Scope" => Scope);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_application_access_scope(
ApplicationArn,
Scope,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"PutApplicationAccessScope",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ApplicationArn" => ApplicationArn, "Scope" => Scope),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_application_assignment_configuration(application_arn, assignment_required)
put_application_assignment_configuration(application_arn, assignment_required, params::Dict{String,<:Any})
Configure how users gain access to an application. If AssignmentsRequired is true (default
value), users don’t have access to the application unless an assignment is created using
the CreateApplicationAssignment API. If false, all users have access to the application. If
an assignment is created using CreateApplicationAssignment., the user retains access if
AssignmentsRequired is set to true.
# Arguments
- `application_arn`: Specifies the ARN of the application. For more information about ARNs,
see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon
Web Services General Reference.
- `assignment_required`: If AssignmentsRequired is true (default value), users don’t have
access to the application unless an assignment is created using the
CreateApplicationAssignment API. If false, all users have access to the application.
"""
function put_application_assignment_configuration(
ApplicationArn, AssignmentRequired; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"PutApplicationAssignmentConfiguration",
Dict{String,Any}(
"ApplicationArn" => ApplicationArn, "AssignmentRequired" => AssignmentRequired
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_application_assignment_configuration(
ApplicationArn,
AssignmentRequired,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"PutApplicationAssignmentConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationArn" => ApplicationArn,
"AssignmentRequired" => AssignmentRequired,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_application_authentication_method(application_arn, authentication_method, authentication_method_type)
put_application_authentication_method(application_arn, authentication_method, authentication_method_type, params::Dict{String,<:Any})
Adds or updates an authentication method for an application.
# Arguments
- `application_arn`: Specifies the ARN of the application with the authentication method to
add or update.
- `authentication_method`: Specifies a structure that describes the authentication method
to add or update. The structure type you provide is determined by the
AuthenticationMethodType parameter.
- `authentication_method_type`: Specifies the type of the authentication method that you
want to add or update.
"""
function put_application_authentication_method(
ApplicationArn,
AuthenticationMethod,
AuthenticationMethodType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"PutApplicationAuthenticationMethod",
Dict{String,Any}(
"ApplicationArn" => ApplicationArn,
"AuthenticationMethod" => AuthenticationMethod,
"AuthenticationMethodType" => AuthenticationMethodType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_application_authentication_method(
ApplicationArn,
AuthenticationMethod,
AuthenticationMethodType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"PutApplicationAuthenticationMethod",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationArn" => ApplicationArn,
"AuthenticationMethod" => AuthenticationMethod,
"AuthenticationMethodType" => AuthenticationMethodType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_application_grant(application_arn, grant, grant_type)
put_application_grant(application_arn, grant, grant_type, params::Dict{String,<:Any})
Adds a grant to an application.
# Arguments
- `application_arn`: Specifies the ARN of the application to update.
- `grant`: Specifies a structure that describes the grant to update.
- `grant_type`: Specifies the type of grant to update.
"""
function put_application_grant(
ApplicationArn, Grant, GrantType; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"PutApplicationGrant",
Dict{String,Any}(
"ApplicationArn" => ApplicationArn, "Grant" => Grant, "GrantType" => GrantType
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_application_grant(
ApplicationArn,
Grant,
GrantType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"PutApplicationGrant",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationArn" => ApplicationArn,
"Grant" => Grant,
"GrantType" => GrantType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_inline_policy_to_permission_set(inline_policy, instance_arn, permission_set_arn)
put_inline_policy_to_permission_set(inline_policy, instance_arn, permission_set_arn, params::Dict{String,<:Any})
Attaches an inline policy to a permission set. If the permission set is already referenced
by one or more account assignments, you will need to call ProvisionPermissionSet after
this action to apply the corresponding IAM policy updates to all assigned accounts.
# Arguments
- `inline_policy`: The inline policy to attach to a PermissionSet.
- `instance_arn`: The ARN of the IAM Identity Center instance under which the operation
will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and
Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
- `permission_set_arn`: The ARN of the permission set.
"""
function put_inline_policy_to_permission_set(
InlinePolicy,
InstanceArn,
PermissionSetArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"PutInlinePolicyToPermissionSet",
Dict{String,Any}(
"InlinePolicy" => InlinePolicy,
"InstanceArn" => InstanceArn,
"PermissionSetArn" => PermissionSetArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_inline_policy_to_permission_set(
InlinePolicy,
InstanceArn,
PermissionSetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"PutInlinePolicyToPermissionSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InlinePolicy" => InlinePolicy,
"InstanceArn" => InstanceArn,
"PermissionSetArn" => PermissionSetArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_permissions_boundary_to_permission_set(instance_arn, permission_set_arn, permissions_boundary)
put_permissions_boundary_to_permission_set(instance_arn, permission_set_arn, permissions_boundary, params::Dict{String,<:Any})
Attaches an Amazon Web Services managed or customer managed policy to the specified
PermissionSet as a permissions boundary.
# Arguments
- `instance_arn`: The ARN of the IAM Identity Center instance under which the operation
will be executed.
- `permission_set_arn`: The ARN of the PermissionSet.
- `permissions_boundary`: The permissions boundary that you want to attach to a
PermissionSet.
"""
function put_permissions_boundary_to_permission_set(
InstanceArn,
PermissionSetArn,
PermissionsBoundary;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"PutPermissionsBoundaryToPermissionSet",
Dict{String,Any}(
"InstanceArn" => InstanceArn,
"PermissionSetArn" => PermissionSetArn,
"PermissionsBoundary" => PermissionsBoundary,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_permissions_boundary_to_permission_set(
InstanceArn,
PermissionSetArn,
PermissionsBoundary,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"PutPermissionsBoundaryToPermissionSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceArn" => InstanceArn,
"PermissionSetArn" => PermissionSetArn,
"PermissionsBoundary" => PermissionsBoundary,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Associates a set of tags with a specified resource.
# Arguments
- `resource_arn`: The ARN of the resource with the tags to be listed.
- `tags`: A set of key-value pairs that are used to manage the resource.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InstanceArn"`: The ARN of the IAM Identity Center instance under which the operation
will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and
Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return sso_admin(
"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 sso_admin(
"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})
Disassociates a set of tags from a specified resource.
# Arguments
- `resource_arn`: The ARN of the resource with the tags to be listed.
- `tag_keys`: The keys of tags that are attached to the resource.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InstanceArn"`: The ARN of the IAM Identity Center instance under which the operation
will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and
Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
"""
function untag_resource(
ResourceArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"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 sso_admin(
"UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_application(application_arn)
update_application(application_arn, params::Dict{String,<:Any})
Updates application properties.
# Arguments
- `application_arn`: Specifies the ARN of the application. For more information about ARNs,
see Amazon Resource Names (ARNs) and 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:
- `"Description"`: The description of the .
- `"Name"`: Specifies the updated name for the application.
- `"PortalOptions"`: A structure that describes the options for the portal associated with
an application.
- `"Status"`: Specifies whether the application is enabled or disabled.
"""
function update_application(
ApplicationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"UpdateApplication",
Dict{String,Any}("ApplicationArn" => ApplicationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_application(
ApplicationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"UpdateApplication",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ApplicationArn" => ApplicationArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_instance(instance_arn, name)
update_instance(instance_arn, name, params::Dict{String,<:Any})
Update the details for the instance of IAM Identity Center that is owned by the Amazon Web
Services account.
# Arguments
- `instance_arn`: The ARN of the instance of IAM Identity Center under which the operation
will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web
Services Service Namespaces in the Amazon Web Services General Reference.
- `name`: Updates the instance name.
"""
function update_instance(
InstanceArn, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"UpdateInstance",
Dict{String,Any}("InstanceArn" => InstanceArn, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_instance(
InstanceArn,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"UpdateInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InstanceArn" => InstanceArn, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_instance_access_control_attribute_configuration(instance_access_control_attribute_configuration, instance_arn)
update_instance_access_control_attribute_configuration(instance_access_control_attribute_configuration, instance_arn, params::Dict{String,<:Any})
Updates the IAM Identity Center identity store attributes that you can use with the IAM
Identity Center instance for attributes-based access control (ABAC). When using an external
identity provider as an identity source, you can pass attributes through the SAML assertion
as an alternative to configuring attributes from the IAM Identity Center identity store. If
a SAML assertion passes any of these attributes, IAM Identity Center replaces the attribute
value with the value from the IAM Identity Center identity store. For more information
about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.
# Arguments
- `instance_access_control_attribute_configuration`: Updates the attributes for your ABAC
configuration.
- `instance_arn`: The ARN of the IAM Identity Center instance under which the operation
will be executed.
"""
function update_instance_access_control_attribute_configuration(
InstanceAccessControlAttributeConfiguration,
InstanceArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"UpdateInstanceAccessControlAttributeConfiguration",
Dict{String,Any}(
"InstanceAccessControlAttributeConfiguration" =>
InstanceAccessControlAttributeConfiguration,
"InstanceArn" => InstanceArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_instance_access_control_attribute_configuration(
InstanceAccessControlAttributeConfiguration,
InstanceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"UpdateInstanceAccessControlAttributeConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceAccessControlAttributeConfiguration" =>
InstanceAccessControlAttributeConfiguration,
"InstanceArn" => InstanceArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_permission_set(instance_arn, permission_set_arn)
update_permission_set(instance_arn, permission_set_arn, params::Dict{String,<:Any})
Updates an existing permission set.
# Arguments
- `instance_arn`: The ARN of the IAM Identity Center instance under which the operation
will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and
Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
- `permission_set_arn`: The ARN of the permission set.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description of the PermissionSet.
- `"RelayState"`: Used to redirect users within the application during the federation
authentication process.
- `"SessionDuration"`: The length of time that the application user sessions are valid for
in the ISO-8601 standard.
"""
function update_permission_set(
InstanceArn, PermissionSetArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"UpdatePermissionSet",
Dict{String,Any}(
"InstanceArn" => InstanceArn, "PermissionSetArn" => PermissionSetArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_permission_set(
InstanceArn,
PermissionSetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"UpdatePermissionSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceArn" => InstanceArn, "PermissionSetArn" => PermissionSetArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_trusted_token_issuer(trusted_token_issuer_arn)
update_trusted_token_issuer(trusted_token_issuer_arn, params::Dict{String,<:Any})
Updates the name of the trusted token issuer, or the path of a source attribute or
destination attribute for a trusted token issuer configuration. Updating this trusted
token issuer configuration might cause users to lose access to any applications that are
configured to use the trusted token issuer.
# Arguments
- `trusted_token_issuer_arn`: Specifies the ARN of the trusted token issuer configuration
that you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Name"`: Specifies the updated name to be applied to the trusted token issuer
configuration.
- `"TrustedTokenIssuerConfiguration"`: Specifies a structure with settings to apply to the
specified trusted token issuer. The settings that you can provide are determined by the
type of the trusted token issuer that you are updating.
"""
function update_trusted_token_issuer(
TrustedTokenIssuerArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_admin(
"UpdateTrustedTokenIssuer",
Dict{String,Any}("TrustedTokenIssuerArn" => TrustedTokenIssuerArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_trusted_token_issuer(
TrustedTokenIssuerArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_admin(
"UpdateTrustedTokenIssuer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("TrustedTokenIssuerArn" => TrustedTokenIssuerArn),
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 | 12861 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: sso_oidc
using AWS.Compat
using AWS.UUIDs
"""
create_token(client_id, client_secret, grant_type)
create_token(client_id, client_secret, grant_type, params::Dict{String,<:Any})
Creates and returns access and refresh tokens for clients that are authenticated using
client secrets. The access token can be used to fetch short-term credentials for the
assigned AWS accounts or to access application APIs using bearer authentication.
# Arguments
- `client_id`: The unique identifier string for the client or application. This value comes
from the result of the RegisterClient API.
- `client_secret`: A secret string generated for the client. This value should come from
the persisted result of the RegisterClient API.
- `grant_type`: Supports the following OAuth grant types: Device Code and Refresh Token.
Specify either of the following values, depending on the grant type that you want: * Device
Code - urn:ietf:params:oauth:grant-type:device_code * Refresh Token - refresh_token For
information about how to obtain the device code, see the StartDeviceAuthorization topic.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"code"`: Used only when calling this API for the Authorization Code grant type. The
short-term code is used to identify this authorization request. This grant type is
currently unsupported for the CreateToken API.
- `"codeVerifier"`: Used only when calling this API for the Authorization Code grant type.
This value is generated by the client and presented to validate the original code challenge
value the client passed at authorization time.
- `"deviceCode"`: Used only when calling this API for the Device Code grant type. This
short-term code is used to identify this authorization request. This comes from the result
of the StartDeviceAuthorization API.
- `"redirectUri"`: Used only when calling this API for the Authorization Code grant type.
This value specifies the location of the client or application that has registered to
receive the authorization code.
- `"refreshToken"`: Used only when calling this API for the Refresh Token grant type. This
token is used to refresh short-term tokens, such as the access token, that might expire.
For more information about the features and limitations of the current IAM Identity Center
OIDC implementation, see Considerations for Using this Guide in the IAM Identity Center
OIDC API Reference.
- `"scope"`: The list of scopes for which authorization is requested. The access token that
is issued is limited to the scopes that are granted. If this value is not specified, IAM
Identity Center authorizes all scopes that are configured for the client during the call to
RegisterClient.
"""
function create_token(
clientId, clientSecret, grantType; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_oidc(
"POST",
"/token",
Dict{String,Any}(
"clientId" => clientId, "clientSecret" => clientSecret, "grantType" => grantType
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_token(
clientId,
clientSecret,
grantType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_oidc(
"POST",
"/token",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientId" => clientId,
"clientSecret" => clientSecret,
"grantType" => grantType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_token_with_iam(client_id, grant_type)
create_token_with_iam(client_id, grant_type, params::Dict{String,<:Any})
Creates and returns access and refresh tokens for clients and applications that are
authenticated using IAM entities. The access token can be used to fetch short-term
credentials for the assigned Amazon Web Services accounts or to access application APIs
using bearer authentication.
# Arguments
- `client_id`: The unique identifier string for the client or application. This value is an
application ARN that has OAuth grants configured.
- `grant_type`: Supports the following OAuth grant types: Authorization Code, Refresh
Token, JWT Bearer, and Token Exchange. Specify one of the following values, depending on
the grant type that you want: * Authorization Code - authorization_code * Refresh Token -
refresh_token * JWT Bearer - urn:ietf:params:oauth:grant-type:jwt-bearer * Token Exchange
- urn:ietf:params:oauth:grant-type:token-exchange
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"assertion"`: Used only when calling this API for the JWT Bearer grant type. This value
specifies the JSON Web Token (JWT) issued by a trusted token issuer. To authorize a trusted
token issuer, configure the JWT Bearer GrantOptions for the application.
- `"code"`: Used only when calling this API for the Authorization Code grant type. This
short-term code is used to identify this authorization request. The code is obtained
through a redirect from IAM Identity Center to a redirect URI persisted in the
Authorization Code GrantOptions for the application.
- `"codeVerifier"`: Used only when calling this API for the Authorization Code grant type.
This value is generated by the client and presented to validate the original code challenge
value the client passed at authorization time.
- `"redirectUri"`: Used only when calling this API for the Authorization Code grant type.
This value specifies the location of the client or application that has registered to
receive the authorization code.
- `"refreshToken"`: Used only when calling this API for the Refresh Token grant type. This
token is used to refresh short-term tokens, such as the access token, that might expire.
For more information about the features and limitations of the current IAM Identity Center
OIDC implementation, see Considerations for Using this Guide in the IAM Identity Center
OIDC API Reference.
- `"requestedTokenType"`: Used only when calling this API for the Token Exchange grant
type. This value specifies the type of token that the requester can receive. The following
values are supported: * Access Token - urn:ietf:params:oauth:token-type:access_token *
Refresh Token - urn:ietf:params:oauth:token-type:refresh_token
- `"scope"`: The list of scopes for which authorization is requested. The access token that
is issued is limited to the scopes that are granted. If the value is not specified, IAM
Identity Center authorizes all scopes configured for the application, including the
following default scopes: openid, aws, sts:identity_context.
- `"subjectToken"`: Used only when calling this API for the Token Exchange grant type. This
value specifies the subject of the exchange. The value of the subject token must be an
access token issued by IAM Identity Center to a different client or application. The access
token must have authorized scopes that indicate the requested application as a target
audience.
- `"subjectTokenType"`: Used only when calling this API for the Token Exchange grant type.
This value specifies the type of token that is passed as the subject of the exchange. The
following value is supported: * Access Token -
urn:ietf:params:oauth:token-type:access_token
"""
function create_token_with_iam(
clientId, grantType; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_oidc(
"POST",
"/token?aws_iam=t",
Dict{String,Any}("clientId" => clientId, "grantType" => grantType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_token_with_iam(
clientId,
grantType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_oidc(
"POST",
"/token?aws_iam=t",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("clientId" => clientId, "grantType" => grantType),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_client(client_name, client_type)
register_client(client_name, client_type, params::Dict{String,<:Any})
Registers a client with IAM Identity Center. This allows clients to initiate device
authorization. The output should be persisted for reuse through many authentication
requests.
# Arguments
- `client_name`: The friendly name of the client.
- `client_type`: The type of client. The service supports only public as a client type.
Anything other than public will be rejected by the service.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"entitledApplicationArn"`: This IAM Identity Center application ARN is used to define
administrator-managed configuration for public client access to resources. At
authorization, the scopes, grants, and redirect URI available to this client will be
restricted by this application resource.
- `"grantTypes"`: The list of OAuth 2.0 grant types that are defined by the client. This
list is used to restrict the token granting flows available to the client.
- `"issuerUrl"`: The IAM Identity Center Issuer URL associated with an instance of IAM
Identity Center. This value is needed for user access to resources through the client.
- `"redirectUris"`: The list of redirect URI that are defined by the client. At completion
of authorization, this list is used to restrict what locations the user agent can be
redirected back to.
- `"scopes"`: The list of scopes that are defined by the client. Upon authorization, this
list is used to restrict permissions when granting an access token.
"""
function register_client(
clientName, clientType; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_oidc(
"POST",
"/client/register",
Dict{String,Any}("clientName" => clientName, "clientType" => clientType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_client(
clientName,
clientType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_oidc(
"POST",
"/client/register",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("clientName" => clientName, "clientType" => clientType),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_device_authorization(client_id, client_secret, start_url)
start_device_authorization(client_id, client_secret, start_url, params::Dict{String,<:Any})
Initiates device authorization by requesting a pair of verification codes from the
authorization service.
# Arguments
- `client_id`: The unique identifier string for the client that is registered with IAM
Identity Center. This value should come from the persisted result of the RegisterClient API
operation.
- `client_secret`: A secret string that is generated for the client. This value should come
from the persisted result of the RegisterClient API operation.
- `start_url`: The URL for the Amazon Web Services access portal. For more information, see
Using the Amazon Web Services access portal in the IAM Identity Center User Guide.
"""
function start_device_authorization(
clientId, clientSecret, startUrl; aws_config::AbstractAWSConfig=global_aws_config()
)
return sso_oidc(
"POST",
"/device_authorization",
Dict{String,Any}(
"clientId" => clientId, "clientSecret" => clientSecret, "startUrl" => startUrl
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_device_authorization(
clientId,
clientSecret,
startUrl,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sso_oidc(
"POST",
"/device_authorization",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientId" => clientId,
"clientSecret" => clientSecret,
"startUrl" => startUrl,
),
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 | 190168 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: storage_gateway
using AWS.Compat
using AWS.UUIDs
"""
activate_gateway(activation_key, gateway_name, gateway_region, gateway_timezone)
activate_gateway(activation_key, gateway_name, gateway_region, gateway_timezone, params::Dict{String,<:Any})
Activates the gateway you previously deployed on your host. In the activation process, you
specify information such as the Amazon Web Services Region that you want to use for storing
snapshots or tapes, the time zone for scheduled snapshots the gateway snapshot schedule
window, an activation key, and a name for your gateway. The activation process also
associates your gateway with your account. For more information, see
UpdateGatewayInformation. You must turn on the gateway VM before you can activate your
gateway.
# Arguments
- `activation_key`: Your gateway activation key. You can obtain the activation key by
sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The
redirect URL returned in the response provides you the activation key for your gateway in
the query string parameter activationKey. It may also include other activation-related
parameters, however, these are merely defaults -- the arguments you pass to the
ActivateGateway API call determine the actual configuration of your gateway. For more
information, see Getting activation key in the Storage Gateway User Guide.
- `gateway_name`: The name you configured for your gateway.
- `gateway_region`: A value that indicates the Amazon Web Services Region where you want to
store your data. The gateway Amazon Web Services Region specified must be the same Amazon
Web Services Region as the Amazon Web Services Region in your Host header in the request.
For more information about available Amazon Web Services Regions and endpoints for Storage
Gateway, see Storage Gateway endpoints and quotas in the Amazon Web Services General
Reference. Valid Values: See Storage Gateway endpoints and quotas in the Amazon Web
Services General Reference.
- `gateway_timezone`: A value that indicates the time zone you want to set for the gateway.
The time zone is of the format \"GMT\", \"GMT-hr:mm\", or \"GMT+hr:mm\". For example, GMT
indicates Greenwich Mean Time without any offset. GMT-4:00 indicates the time is 4 hours
behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is used, for
example, for scheduling snapshots and your gateway's maintenance schedule.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GatewayType"`: A value that defines the type of gateway to activate. The type specified
is critical to all later functions of the gateway and cannot be changed after activation.
The default value is CACHED. Valid Values: STORED | CACHED | VTL | FILE_S3 | FILE_FSX_SMB
- `"MediumChangerType"`: The value that indicates the type of medium changer to use for
tape gateway. This field is optional. Valid Values: STK-L700 | AWS-Gateway-VTL |
IBM-03584L32-0402
- `"Tags"`: A list of up to 50 tags that you can assign to the gateway. Each tag is a
key-value pair. Valid characters for key and value are letters, spaces, and numbers that
can be represented in UTF-8 format, and the following special characters: + - = . _ : / @.
The maximum length of a tag's key is 128 characters, and the maximum length for a tag's
value is 256 characters.
- `"TapeDriveType"`: The value that indicates the type of tape drive to use for tape
gateway. This field is optional. Valid Values: IBM-ULT3580-TD5
"""
function activate_gateway(
ActivationKey,
GatewayName,
GatewayRegion,
GatewayTimezone;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"ActivateGateway",
Dict{String,Any}(
"ActivationKey" => ActivationKey,
"GatewayName" => GatewayName,
"GatewayRegion" => GatewayRegion,
"GatewayTimezone" => GatewayTimezone,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function activate_gateway(
ActivationKey,
GatewayName,
GatewayRegion,
GatewayTimezone,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"ActivateGateway",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ActivationKey" => ActivationKey,
"GatewayName" => GatewayName,
"GatewayRegion" => GatewayRegion,
"GatewayTimezone" => GatewayTimezone,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_cache(disk_ids, gateway_arn)
add_cache(disk_ids, gateway_arn, params::Dict{String,<:Any})
Configures one or more gateway local disks as cache for a gateway. This operation is only
supported in the cached volume, tape, and file gateway type (see How Storage Gateway works
(architecture). In the request, you specify the gateway Amazon Resource Name (ARN) to which
you want to add cache, and one or more disk IDs that you want to configure as cache.
# Arguments
- `disk_ids`: An array of strings that identify disks that are to be configured as working
storage. Each string has a minimum length of 1 and maximum length of 300. You can get the
disk IDs from the ListLocalDisks API.
- `gateway_arn`:
"""
function add_cache(DiskIds, GatewayARN; aws_config::AbstractAWSConfig=global_aws_config())
return storage_gateway(
"AddCache",
Dict{String,Any}("DiskIds" => DiskIds, "GatewayARN" => GatewayARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_cache(
DiskIds,
GatewayARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"AddCache",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DiskIds" => DiskIds, "GatewayARN" => GatewayARN),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_tags_to_resource(resource_arn, tags)
add_tags_to_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds one or more tags to the specified resource. You use tags to add metadata to resources,
which you can use to categorize these resources. For example, you can categorize resources
by purpose, owner, environment, or team. Each tag consists of a key and a value, which you
define. You can add tags to the following Storage Gateway resources: Storage gateways of
all types Storage volumes Virtual tapes NFS and SMB file shares File System
associations You can create a maximum of 50 tags for each resource. Virtual tapes and
storage volumes that are recovered to a new gateway maintain their tags.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource you want to add tags to.
- `tags`: The key-value pair that represents the tag you want to add to the resource. The
value can be an empty string. Valid characters for key and value are letters, spaces, and
numbers representable in UTF-8 format, and the following special characters: + - = . _ : /
@. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's
value is 256.
"""
function add_tags_to_resource(
ResourceARN, Tags; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"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 storage_gateway(
"AddTagsToResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceARN" => ResourceARN, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_upload_buffer(disk_ids, gateway_arn)
add_upload_buffer(disk_ids, gateway_arn, params::Dict{String,<:Any})
Configures one or more gateway local disks as upload buffer for a specified gateway. This
operation is supported for the stored volume, cached volume, and tape gateway types. In the
request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload
buffer, and one or more disk IDs that you want to configure as upload buffer.
# Arguments
- `disk_ids`: An array of strings that identify disks that are to be configured as working
storage. Each string has a minimum length of 1 and maximum length of 300. You can get the
disk IDs from the ListLocalDisks API.
- `gateway_arn`:
"""
function add_upload_buffer(
DiskIds, GatewayARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"AddUploadBuffer",
Dict{String,Any}("DiskIds" => DiskIds, "GatewayARN" => GatewayARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_upload_buffer(
DiskIds,
GatewayARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"AddUploadBuffer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DiskIds" => DiskIds, "GatewayARN" => GatewayARN),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_working_storage(disk_ids, gateway_arn)
add_working_storage(disk_ids, gateway_arn, params::Dict{String,<:Any})
Configures one or more gateway local disks as working storage for a gateway. This operation
is only supported in the stored volume gateway type. This operation is deprecated in cached
volume API version 20120630. Use AddUploadBuffer instead. Working storage is also referred
to as upload buffer. You can also use the AddUploadBuffer operation to add upload buffer to
a stored volume gateway. In the request, you specify the gateway Amazon Resource Name
(ARN) to which you want to add working storage, and one or more disk IDs that you want to
configure as working storage.
# Arguments
- `disk_ids`: An array of strings that identify disks that are to be configured as working
storage. Each string has a minimum length of 1 and maximum length of 300. You can get the
disk IDs from the ListLocalDisks API.
- `gateway_arn`:
"""
function add_working_storage(
DiskIds, GatewayARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"AddWorkingStorage",
Dict{String,Any}("DiskIds" => DiskIds, "GatewayARN" => GatewayARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_working_storage(
DiskIds,
GatewayARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"AddWorkingStorage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DiskIds" => DiskIds, "GatewayARN" => GatewayARN),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
assign_tape_pool(pool_id, tape_arn)
assign_tape_pool(pool_id, tape_arn, params::Dict{String,<:Any})
Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in the
S3 storage class that is associated with the pool. When you use your backup application to
eject the tape, the tape is archived directly into the S3 storage class (S3 Glacier or S3
Glacier Deep Archive) that corresponds to the pool.
# Arguments
- `pool_id`: The ID of the pool that you want to add your tape to for archiving. The tape
in this pool is archived in the S3 storage class that is associated with the pool. When you
use your backup application to eject the tape, the tape is archived directly into the
storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
- `tape_arn`: The unique Amazon Resource Name (ARN) of the virtual tape that you want to
add to the tape pool.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BypassGovernanceRetention"`: Set permissions to bypass governance retention. If the
lock type of the archived tape is Governance, the tape's archived age is not older than
RetentionLockInDays, and the user does not already have BypassGovernanceRetention, setting
this to TRUE enables the user to bypass the retention lock. This parameter is set to true
by default for calls from the console. Valid values: TRUE | FALSE
"""
function assign_tape_pool(
PoolId, TapeARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"AssignTapePool",
Dict{String,Any}("PoolId" => PoolId, "TapeARN" => TapeARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function assign_tape_pool(
PoolId,
TapeARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"AssignTapePool",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("PoolId" => PoolId, "TapeARN" => TapeARN), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_file_system(client_token, gateway_arn, location_arn, password, user_name)
associate_file_system(client_token, gateway_arn, location_arn, password, user_name, params::Dict{String,<:Any})
Associate an Amazon FSx file system with the FSx File Gateway. After the association
process is complete, the file shares on the Amazon FSx file system are available for access
through the gateway. This operation only supports the FSx File Gateway type.
# Arguments
- `client_token`: A unique string value that you supply that is used by the FSx File
Gateway to ensure idempotent file system association creation.
- `gateway_arn`:
- `location_arn`: The Amazon Resource Name (ARN) of the Amazon FSx file system to associate
with the FSx File Gateway.
- `password`: The password of the user credential.
- `user_name`: The user name of the user credential that has permission to access the root
share D of the Amazon FSx file system. The user account must belong to the Amazon FSx
delegated admin user group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AuditDestinationARN"`: The Amazon Resource Name (ARN) of the storage used for the audit
logs.
- `"CacheAttributes"`:
- `"EndpointNetworkConfiguration"`: Specifies the network configuration information for the
gateway associated with the Amazon FSx file system. If multiple file systems are
associated with this gateway, this parameter's IpAddresses field is required.
- `"Tags"`: A list of up to 50 tags that can be assigned to the file system association.
Each tag is a key-value pair.
"""
function associate_file_system(
ClientToken,
GatewayARN,
LocationARN,
Password,
UserName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"AssociateFileSystem",
Dict{String,Any}(
"ClientToken" => ClientToken,
"GatewayARN" => GatewayARN,
"LocationARN" => LocationARN,
"Password" => Password,
"UserName" => UserName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_file_system(
ClientToken,
GatewayARN,
LocationARN,
Password,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"AssociateFileSystem",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientToken" => ClientToken,
"GatewayARN" => GatewayARN,
"LocationARN" => LocationARN,
"Password" => Password,
"UserName" => UserName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
attach_volume(gateway_arn, network_interface_id, volume_arn)
attach_volume(gateway_arn, network_interface_id, volume_arn, params::Dict{String,<:Any})
Connects a volume to an iSCSI connection and then attaches the volume to the specified
gateway. Detaching and attaching a volume enables you to recover your data from one gateway
to a different gateway without creating a snapshot. It also makes it easier to move your
volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance.
# Arguments
- `gateway_arn`: The Amazon Resource Name (ARN) of the gateway that you want to attach the
volume to.
- `network_interface_id`: The network interface of the gateway on which to expose the iSCSI
target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of
the network interfaces available on a gateway. Valid Values: A valid IP address.
- `volume_arn`: The Amazon Resource Name (ARN) of the volume to attach to the specified
gateway.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DiskId"`: The unique device ID or other distinguishing data that identifies the local
disk used to create the volume. This value is only required when you are attaching a stored
volume.
- `"TargetName"`: The name of the iSCSI target used by an initiator to connect to a volume
and used as a suffix for the target ARN. For example, specifying TargetName as myvolume
results in the target ARN of
arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.am
azon:myvolume. The target name must be unique across all volumes on a gateway. If you don't
specify a value, Storage Gateway uses the value that was previously used for this volume as
the new target name.
"""
function attach_volume(
GatewayARN,
NetworkInterfaceId,
VolumeARN;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"AttachVolume",
Dict{String,Any}(
"GatewayARN" => GatewayARN,
"NetworkInterfaceId" => NetworkInterfaceId,
"VolumeARN" => VolumeARN,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function attach_volume(
GatewayARN,
NetworkInterfaceId,
VolumeARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"AttachVolume",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GatewayARN" => GatewayARN,
"NetworkInterfaceId" => NetworkInterfaceId,
"VolumeARN" => VolumeARN,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_archival(gateway_arn, tape_arn)
cancel_archival(gateway_arn, tape_arn, params::Dict{String,<:Any})
Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving
process is initiated. This operation is only supported in the tape gateway type.
# Arguments
- `gateway_arn`:
- `tape_arn`: The Amazon Resource Name (ARN) of the virtual tape you want to cancel
archiving for.
"""
function cancel_archival(
GatewayARN, TapeARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"CancelArchival",
Dict{String,Any}("GatewayARN" => GatewayARN, "TapeARN" => TapeARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_archival(
GatewayARN,
TapeARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"CancelArchival",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("GatewayARN" => GatewayARN, "TapeARN" => TapeARN),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_retrieval(gateway_arn, tape_arn)
cancel_retrieval(gateway_arn, tape_arn, params::Dict{String,<:Any})
Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after
the retrieval process is initiated. The virtual tape is returned to the VTS. This operation
is only supported in the tape gateway type.
# Arguments
- `gateway_arn`:
- `tape_arn`: The Amazon Resource Name (ARN) of the virtual tape you want to cancel
retrieval for.
"""
function cancel_retrieval(
GatewayARN, TapeARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"CancelRetrieval",
Dict{String,Any}("GatewayARN" => GatewayARN, "TapeARN" => TapeARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_retrieval(
GatewayARN,
TapeARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"CancelRetrieval",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("GatewayARN" => GatewayARN, "TapeARN" => TapeARN),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_cachedi_scsivolume(client_token, gateway_arn, network_interface_id, target_name, volume_size_in_bytes)
create_cachedi_scsivolume(client_token, gateway_arn, network_interface_id, target_name, volume_size_in_bytes, params::Dict{String,<:Any})
Creates a cached volume on a specified cached volume gateway. This operation is only
supported in the cached volume gateway type. Cache storage must be allocated to the
gateway before you can create a cached volume. Use the AddCache operation to add cache
storage to a gateway. In the request, you must specify the gateway, size of the volume in
bytes, the iSCSI target name, an IP address on which to expose the target, and a unique
client token. In response, the gateway creates the volume and returns information about it.
This information includes the volume Amazon Resource Name (ARN), its size, and the iSCSI
target ARN that initiators can use to connect to the volume target. Optionally, you can
provide the ARN for an existing volume as the SourceVolumeARN for this cached volume, which
creates an exact copy of the existing volume’s latest recovery point. The
VolumeSizeInBytes value must be equal to or larger than the size of the copied volume, in
bytes.
# Arguments
- `client_token`: A unique identifier that you use to retry a request. If you retry a
request, use the same ClientToken you specified in the initial request.
- `gateway_arn`:
- `network_interface_id`: The network interface of the gateway on which to expose the iSCSI
target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of
the network interfaces available on a gateway. Valid Values: A valid IP address.
- `target_name`: The name of the iSCSI target used by an initiator to connect to a volume
and used as a suffix for the target ARN. For example, specifying TargetName as myvolume
results in the target ARN of
arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.am
azon:myvolume. The target name must be unique across all volumes on a gateway. If you don't
specify a value, Storage Gateway uses the value that was previously used for this volume as
the new target name.
- `volume_size_in_bytes`: The size of the volume in bytes.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"KMSEncrypted"`: Set to true to use Amazon S3 server-side encryption with your own KMS
key, or false to use a key managed by Amazon S3. Optional. Valid Values: true | false
- `"KMSKey"`: The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs.
This value can only be set when KMSEncrypted is true. Optional.
- `"SnapshotId"`: The snapshot ID (e.g. \"snap-1122aabb\") of the snapshot to restore as
the new cached volume. Specify this field if you want to create the iSCSI storage volume
from a snapshot; otherwise, do not include this field. To list snapshots for your account
use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.
- `"SourceVolumeARN"`: The ARN for an existing volume. Specifying this ARN makes the new
volume into an exact copy of the specified existing volume's latest recovery point. The
VolumeSizeInBytes value for this new volume must be equal to or larger than the size of the
existing volume, in bytes.
- `"Tags"`: A list of up to 50 tags that you can assign to a cached volume. Each tag is a
key-value pair. Valid characters for key and value are letters, spaces, and numbers that
you can represent in UTF-8 format, and the following special characters: + - = . _ : / @.
The maximum length of a tag's key is 128 characters, and the maximum length for a tag's
value is 256 characters.
"""
function create_cachedi_scsivolume(
ClientToken,
GatewayARN,
NetworkInterfaceId,
TargetName,
VolumeSizeInBytes;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"CreateCachediSCSIVolume",
Dict{String,Any}(
"ClientToken" => ClientToken,
"GatewayARN" => GatewayARN,
"NetworkInterfaceId" => NetworkInterfaceId,
"TargetName" => TargetName,
"VolumeSizeInBytes" => VolumeSizeInBytes,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_cachedi_scsivolume(
ClientToken,
GatewayARN,
NetworkInterfaceId,
TargetName,
VolumeSizeInBytes,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"CreateCachediSCSIVolume",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientToken" => ClientToken,
"GatewayARN" => GatewayARN,
"NetworkInterfaceId" => NetworkInterfaceId,
"TargetName" => TargetName,
"VolumeSizeInBytes" => VolumeSizeInBytes,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_nfsfile_share(client_token, gateway_arn, location_arn, role)
create_nfsfile_share(client_token, gateway_arn, location_arn, role, params::Dict{String,<:Any})
Creates a Network File System (NFS) file share on an existing S3 File Gateway. In Storage
Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage.
Storage Gateway exposes file shares using an NFS interface. This operation is only
supported for S3 File Gateways. S3 File gateway requires Security Token Service (Amazon
Web Services STS) to be activated to enable you to create a file share. Make sure Amazon
Web Services STS is activated in the Amazon Web Services Region you are creating your S3
File Gateway in. If Amazon Web Services STS is not activated in the Amazon Web Services
Region, activate it. For information about how to activate Amazon Web Services STS, see
Activating and deactivating Amazon Web Services STS in an Amazon Web Services Region in the
Identity and Access Management User Guide. S3 File Gateways do not support creating hard or
symbolic links on a file share.
# Arguments
- `client_token`: A unique string value that you supply that is used by S3 File Gateway to
ensure idempotent file share creation.
- `gateway_arn`: The Amazon Resource Name (ARN) of the S3 File Gateway on which you want to
create a file share.
- `location_arn`: A custom ARN for the backend storage used for storing data for file
shares. It includes a resource ARN with an optional prefix concatenation. The prefix must
end with a forward slash (/). You can specify LocationARN as a bucket ARN, access point
ARN or access point alias, as shown in the following examples. Bucket ARN:
arn:aws:s3:::my-bucket/prefix/ Access point ARN:
arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/ If you specify an
access point, the bucket policy must be configured to delegate access control to the access
point. For information, see Delegating access control to access points in the Amazon S3
User Guide. Access point alias: test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias
- `role`: The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway
assumes when it accesses the underlying storage.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AuditDestinationARN"`: The Amazon Resource Name (ARN) of the storage used for audit
logs.
- `"BucketRegion"`: Specifies the Region of the S3 bucket where the NFS file share stores
files. This parameter is required for NFS file shares that connect to Amazon S3 through a
VPC endpoint, a VPC access point, or an access point alias that points to a VPC access
point.
- `"CacheAttributes"`: Specifies refresh cache information for the file share.
- `"ClientList"`: The list of clients that are allowed to access the S3 File Gateway. The
list must contain either valid IP addresses or valid CIDR blocks.
- `"DefaultStorageClass"`: The default storage class for objects put into an Amazon S3
bucket by the S3 File Gateway. The default value is S3_STANDARD. Optional. Valid Values:
S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA
- `"FileShareName"`: The name of the file share. Optional. FileShareName must be set if
an S3 prefix name is set in LocationARN, or if an access point or access point alias is
used.
- `"GuessMIMETypeEnabled"`: A value that enables guessing of the MIME type for uploaded
objects based on file extensions. Set this value to true to enable MIME type guessing,
otherwise set to false. The default value is true. Valid Values: true | false
- `"KMSEncrypted"`: Set to true to use Amazon S3 server-side encryption with your own KMS
key, or false to use a key managed by Amazon S3. Optional. Valid Values: true | false
- `"KMSKey"`: The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs.
This value can only be set when KMSEncrypted is true. Optional.
- `"NFSFileShareDefaults"`: File share default values. Optional.
- `"NotificationPolicy"`: The notification policy of the file share. SettlingTimeInSeconds
controls the number of seconds to wait after the last point in time a client wrote to a
file before generating an ObjectUploaded notification. Because clients can make many small
writes to files, it's best to set this parameter for as long as possible to avoid
generating multiple notifications for the same file in a small time period.
SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3,
only the timing of the notification. The following example sets NotificationPolicy on with
SettlingTimeInSeconds set to 60. {\"Upload\": {\"SettlingTimeInSeconds\": 60}} The
following example sets NotificationPolicy off. {}
- `"ObjectACL"`: A value that sets the access control list (ACL) permission for objects in
the S3 bucket that a S3 File Gateway puts objects into. The default value is private.
- `"ReadOnly"`: A value that sets the write status of a file share. Set this value to true
to set the write status to read-only, otherwise set to false. Valid Values: true | false
- `"RequesterPays"`: A value that sets who pays the cost of the request and the cost
associated with data download from the S3 bucket. If this value is set to true, the
requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner
always pays the cost of storing data. RequesterPays is a configuration for the S3 bucket
that backs the file share, so make sure that the configuration on the file share is the
same as the S3 bucket configuration. Valid Values: true | false
- `"Squash"`: A value that maps a user to anonymous user. Valid values are the following:
RootSquash: Only root is mapped to anonymous user. NoSquash: No one is mapped to
anonymous user. AllSquash: Everyone is mapped to anonymous user.
- `"Tags"`: A list of up to 50 tags that can be assigned to the NFS file share. Each tag is
a key-value pair. Valid characters for key and value are letters, spaces, and numbers
representable in UTF-8 format, and the following special characters: + - = . _ : / @. The
maximum length of a tag's key is 128 characters, and the maximum length for a tag's value
is 256.
- `"VPCEndpointDNSName"`: Specifies the DNS name for the VPC endpoint that the NFS file
share uses to connect to Amazon S3. This parameter is required for NFS file shares that
connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias
that points to a VPC access point.
"""
function create_nfsfile_share(
ClientToken,
GatewayARN,
LocationARN,
Role;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"CreateNFSFileShare",
Dict{String,Any}(
"ClientToken" => ClientToken,
"GatewayARN" => GatewayARN,
"LocationARN" => LocationARN,
"Role" => Role,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_nfsfile_share(
ClientToken,
GatewayARN,
LocationARN,
Role,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"CreateNFSFileShare",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientToken" => ClientToken,
"GatewayARN" => GatewayARN,
"LocationARN" => LocationARN,
"Role" => Role,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_smbfile_share(client_token, gateway_arn, location_arn, role)
create_smbfile_share(client_token, gateway_arn, location_arn, role, params::Dict{String,<:Any})
Creates a Server Message Block (SMB) file share on an existing S3 File Gateway. In Storage
Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage.
Storage Gateway exposes file shares using an SMB interface. This operation is only
supported for S3 File Gateways. S3 File Gateways require Security Token Service (Amazon
Web Services STS) to be activated to enable you to create a file share. Make sure that
Amazon Web Services STS is activated in the Amazon Web Services Region you are creating
your S3 File Gateway in. If Amazon Web Services STS is not activated in this Amazon Web
Services Region, activate it. For information about how to activate Amazon Web Services
STS, see Activating and deactivating Amazon Web Services STS in an Amazon Web Services
Region in the Identity and Access Management User Guide. File gateways don't support
creating hard or symbolic links on a file share.
# Arguments
- `client_token`: A unique string value that you supply that is used by S3 File Gateway to
ensure idempotent file share creation.
- `gateway_arn`: The ARN of the S3 File Gateway on which you want to create a file share.
- `location_arn`: A custom ARN for the backend storage used for storing data for file
shares. It includes a resource ARN with an optional prefix concatenation. The prefix must
end with a forward slash (/). You can specify LocationARN as a bucket ARN, access point
ARN or access point alias, as shown in the following examples. Bucket ARN:
arn:aws:s3:::my-bucket/prefix/ Access point ARN:
arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/ If you specify an
access point, the bucket policy must be configured to delegate access control to the access
point. For information, see Delegating access control to access points in the Amazon S3
User Guide. Access point alias: test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias
- `role`: The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway
assumes when it accesses the underlying storage.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccessBasedEnumeration"`: The files and folders on this share will only be visible to
users with read access.
- `"AdminUserList"`: A list of users or groups in the Active Directory that will be granted
administrator privileges on the file share. These users can do all file operations as the
super-user. Acceptable formats include: DOMAINUser1, user1, @group1, and @DOMAINgroup1.
Use this option very carefully, because any user in this list can do anything they like on
the file share, regardless of file permissions.
- `"AuditDestinationARN"`: The Amazon Resource Name (ARN) of the storage used for audit
logs.
- `"Authentication"`: The authentication method that users use to access the file share.
The default is ActiveDirectory. Valid Values: ActiveDirectory | GuestAccess
- `"BucketRegion"`: Specifies the Region of the S3 bucket where the SMB file share stores
files. This parameter is required for SMB file shares that connect to Amazon S3 through a
VPC endpoint, a VPC access point, or an access point alias that points to a VPC access
point.
- `"CacheAttributes"`: Specifies refresh cache information for the file share.
- `"CaseSensitivity"`: The case of an object name in an Amazon S3 bucket. For
ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway
determines the case sensitivity. The default value is ClientSpecified.
- `"DefaultStorageClass"`: The default storage class for objects put into an Amazon S3
bucket by the S3 File Gateway. The default value is S3_STANDARD. Optional. Valid Values:
S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA
- `"FileShareName"`: The name of the file share. Optional. FileShareName must be set if
an S3 prefix name is set in LocationARN, or if an access point or access point alias is
used.
- `"GuessMIMETypeEnabled"`: A value that enables guessing of the MIME type for uploaded
objects based on file extensions. Set this value to true to enable MIME type guessing,
otherwise set to false. The default value is true. Valid Values: true | false
- `"InvalidUserList"`: A list of users or groups in the Active Directory that are not
allowed to access the file share. A group must be prefixed with the @ character. Acceptable
formats include: DOMAINUser1, user1, @group1, and @DOMAINgroup1. Can only be set if
Authentication is set to ActiveDirectory.
- `"KMSEncrypted"`: Set to true to use Amazon S3 server-side encryption with your own KMS
key, or false to use a key managed by Amazon S3. Optional. Valid Values: true | false
- `"KMSKey"`: The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs.
This value can only be set when KMSEncrypted is true. Optional.
- `"NotificationPolicy"`: The notification policy of the file share. SettlingTimeInSeconds
controls the number of seconds to wait after the last point in time a client wrote to a
file before generating an ObjectUploaded notification. Because clients can make many small
writes to files, it's best to set this parameter for as long as possible to avoid
generating multiple notifications for the same file in a small time period.
SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3,
only the timing of the notification. The following example sets NotificationPolicy on with
SettlingTimeInSeconds set to 60. {\"Upload\": {\"SettlingTimeInSeconds\": 60}} The
following example sets NotificationPolicy off. {}
- `"ObjectACL"`: A value that sets the access control list (ACL) permission for objects in
the S3 bucket that a S3 File Gateway puts objects into. The default value is private.
- `"OplocksEnabled"`: Specifies whether opportunistic locking is enabled for the SMB file
share. Enabling opportunistic locking on case-sensitive shares is not recommended for
workloads that involve access to files with the same name in different case. Valid Values:
true | false
- `"ReadOnly"`: A value that sets the write status of a file share. Set this value to true
to set the write status to read-only, otherwise set to false. Valid Values: true | false
- `"RequesterPays"`: A value that sets who pays the cost of the request and the cost
associated with data download from the S3 bucket. If this value is set to true, the
requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner
always pays the cost of storing data. RequesterPays is a configuration for the S3 bucket
that backs the file share, so make sure that the configuration on the file share is the
same as the S3 bucket configuration. Valid Values: true | false
- `"SMBACLEnabled"`: Set this value to true to enable access control list (ACL) on the SMB
file share. Set it to false to map file and directory permissions to the POSIX permissions.
For more information, see Using Microsoft Windows ACLs to control access to an SMB file
share in the Storage Gateway User Guide. Valid Values: true | false
- `"Tags"`: A list of up to 50 tags that can be assigned to the NFS file share. Each tag is
a key-value pair. Valid characters for key and value are letters, spaces, and numbers
representable in UTF-8 format, and the following special characters: + - = . _ : / @. The
maximum length of a tag's key is 128 characters, and the maximum length for a tag's value
is 256.
- `"VPCEndpointDNSName"`: Specifies the DNS name for the VPC endpoint that the SMB file
share uses to connect to Amazon S3. This parameter is required for SMB file shares that
connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias
that points to a VPC access point.
- `"ValidUserList"`: A list of users or groups in the Active Directory that are allowed to
access the file share. A group must be prefixed with the @ character. Acceptable formats
include: DOMAINUser1, user1, @group1, and @DOMAINgroup1. Can only be set if Authentication
is set to ActiveDirectory.
"""
function create_smbfile_share(
ClientToken,
GatewayARN,
LocationARN,
Role;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"CreateSMBFileShare",
Dict{String,Any}(
"ClientToken" => ClientToken,
"GatewayARN" => GatewayARN,
"LocationARN" => LocationARN,
"Role" => Role,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_smbfile_share(
ClientToken,
GatewayARN,
LocationARN,
Role,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"CreateSMBFileShare",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientToken" => ClientToken,
"GatewayARN" => GatewayARN,
"LocationARN" => LocationARN,
"Role" => Role,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_snapshot(snapshot_description, volume_arn)
create_snapshot(snapshot_description, volume_arn, params::Dict{String,<:Any})
Initiates a snapshot of a volume. Storage Gateway provides the ability to back up
point-in-time snapshots of your data to Amazon Simple Storage (Amazon S3) for durable
off-site recovery, and also import the data to an Amazon Elastic Block Store (EBS) volume
in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a
scheduled or ad hoc basis. This API enables you to take an ad hoc snapshot. For more
information, see Editing a snapshot schedule. In the CreateSnapshot request, you identify
the volume by providing its Amazon Resource Name (ARN). You must also provide description
for the snapshot. When Storage Gateway takes the snapshot of specified volume, the snapshot
and description appears in the Storage Gateway console. In response, Storage Gateway
returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or
later use it when you want to create a volume from a snapshot. This operation is only
supported in stored and cached volume gateway type. To list or delete a snapshot, you must
use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in
the Amazon Elastic Compute Cloud API Reference. Volume and snapshot IDs are changing to a
longer length ID format. For more information, see the important note on the Welcome page.
# Arguments
- `snapshot_description`: Textual description of the snapshot that appears in the Amazon
EC2 console, Elastic Block Store snapshots panel in the Description field, and in the
Storage Gateway snapshot Details pane, Description field.
- `volume_arn`: The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation
to return a list of gateway volumes.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: A list of up to 50 tags that can be assigned to a snapshot. Each tag is a
key-value pair. Valid characters for key and value are letters, spaces, and numbers
representable in UTF-8 format, and the following special characters: + - = . _ : / @. The
maximum length of a tag's key is 128 characters, and the maximum length for a tag's value
is 256.
"""
function create_snapshot(
SnapshotDescription, VolumeARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"CreateSnapshot",
Dict{String,Any}(
"SnapshotDescription" => SnapshotDescription, "VolumeARN" => VolumeARN
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_snapshot(
SnapshotDescription,
VolumeARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"CreateSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SnapshotDescription" => SnapshotDescription, "VolumeARN" => VolumeARN
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_snapshot_from_volume_recovery_point(snapshot_description, volume_arn)
create_snapshot_from_volume_recovery_point(snapshot_description, volume_arn, params::Dict{String,<:Any})
Initiates a snapshot of a gateway from a volume recovery point. This operation is only
supported in the cached volume gateway type. A volume recovery point is a point in time at
which all data of the volume is consistent and from which you can create a snapshot. To get
a list of volume recovery point for cached volume gateway, use ListVolumeRecoveryPoints. In
the CreateSnapshotFromVolumeRecoveryPoint request, you identify the volume by providing its
Amazon Resource Name (ARN). You must also provide a description for the snapshot. When the
gateway takes a snapshot of the specified volume, the snapshot and its description appear
in the Storage Gateway console. In response, the gateway returns you a snapshot ID. You can
use this snapshot ID to check the snapshot progress or later use it when you want to create
a volume from a snapshot. To list or delete a snapshot, you must use the Amazon EC2 API.
For more information, see DescribeSnapshots or DeleteSnapshot in the Amazon Elastic Compute
Cloud API Reference.
# Arguments
- `snapshot_description`: Textual description of the snapshot that appears in the Amazon
EC2 console, Elastic Block Store snapshots panel in the Description field, and in the
Storage Gateway snapshot Details pane, Description field.
- `volume_arn`: The Amazon Resource Name (ARN) of the iSCSI volume target. Use the
DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified
VolumeARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: A list of up to 50 tags that can be assigned to a snapshot. Each tag is a
key-value pair. Valid characters for key and value are letters, spaces, and numbers
representable in UTF-8 format, and the following special characters: + - = . _ : / @. The
maximum length of a tag's key is 128 characters, and the maximum length for a tag's value
is 256.
"""
function create_snapshot_from_volume_recovery_point(
SnapshotDescription, VolumeARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"CreateSnapshotFromVolumeRecoveryPoint",
Dict{String,Any}(
"SnapshotDescription" => SnapshotDescription, "VolumeARN" => VolumeARN
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_snapshot_from_volume_recovery_point(
SnapshotDescription,
VolumeARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"CreateSnapshotFromVolumeRecoveryPoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SnapshotDescription" => SnapshotDescription, "VolumeARN" => VolumeARN
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_storedi_scsivolume(disk_id, gateway_arn, network_interface_id, preserve_existing_data, target_name)
create_storedi_scsivolume(disk_id, gateway_arn, network_interface_id, preserve_existing_data, target_name, params::Dict{String,<:Any})
Creates a volume on a specified gateway. This operation is only supported in the stored
volume gateway type. The size of the volume to create is inferred from the disk size. You
can choose to preserve existing data on the disk, create volume from an existing snapshot,
or create an empty volume. If you choose to create an empty gateway volume, then any
existing data on the disk is erased. In the request, you must specify the gateway and the
disk information on which you are creating the volume. In response, the gateway creates the
volume and returns volume information such as the volume Amazon Resource Name (ARN), its
size, and the iSCSI target ARN that initiators can use to connect to the volume target.
# Arguments
- `disk_id`: The unique identifier for the gateway local disk that is configured as a
stored volume. Use ListLocalDisks to list disk IDs for a gateway.
- `gateway_arn`:
- `network_interface_id`: The network interface of the gateway on which to expose the iSCSI
target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of
the network interfaces available on a gateway. Valid Values: A valid IP address.
- `preserve_existing_data`: Set to true if you want to preserve the data on the local disk.
Otherwise, set to false to create an empty volume. Valid Values: true | false
- `target_name`: The name of the iSCSI target used by an initiator to connect to a volume
and used as a suffix for the target ARN. For example, specifying TargetName as myvolume
results in the target ARN of
arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.am
azon:myvolume. The target name must be unique across all volumes on a gateway. If you don't
specify a value, Storage Gateway uses the value that was previously used for this volume as
the new target name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"KMSEncrypted"`: Set to true to use Amazon S3 server-side encryption with your own KMS
key, or false to use a key managed by Amazon S3. Optional. Valid Values: true | false
- `"KMSKey"`: The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs.
This value can only be set when KMSEncrypted is true. Optional.
- `"SnapshotId"`: The snapshot ID (e.g., \"snap-1122aabb\") of the snapshot to restore as
the new stored volume. Specify this field if you want to create the iSCSI storage volume
from a snapshot; otherwise, do not include this field. To list snapshots for your account
use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.
- `"Tags"`: A list of up to 50 tags that can be assigned to a stored volume. Each tag is a
key-value pair. Valid characters for key and value are letters, spaces, and numbers
representable in UTF-8 format, and the following special characters: + - = . _ : / @. The
maximum length of a tag's key is 128 characters, and the maximum length for a tag's value
is 256.
"""
function create_storedi_scsivolume(
DiskId,
GatewayARN,
NetworkInterfaceId,
PreserveExistingData,
TargetName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"CreateStorediSCSIVolume",
Dict{String,Any}(
"DiskId" => DiskId,
"GatewayARN" => GatewayARN,
"NetworkInterfaceId" => NetworkInterfaceId,
"PreserveExistingData" => PreserveExistingData,
"TargetName" => TargetName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_storedi_scsivolume(
DiskId,
GatewayARN,
NetworkInterfaceId,
PreserveExistingData,
TargetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"CreateStorediSCSIVolume",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DiskId" => DiskId,
"GatewayARN" => GatewayARN,
"NetworkInterfaceId" => NetworkInterfaceId,
"PreserveExistingData" => PreserveExistingData,
"TargetName" => TargetName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_tape_pool(pool_name, storage_class)
create_tape_pool(pool_name, storage_class, params::Dict{String,<:Any})
Creates a new custom tape pool. You can use custom tape pool to enable tape retention lock
on tapes that are archived in the custom pool.
# Arguments
- `pool_name`: The name of the new custom tape pool.
- `storage_class`: The storage class that is associated with the new custom pool. When you
use your backup application to eject the tape, the tape is archived directly into the
storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"RetentionLockTimeInDays"`: Tape retention lock time is set in days. Tape retention lock
can be enabled for up to 100 years (36,500 days).
- `"RetentionLockType"`: Tape retention lock can be configured in two modes. When
configured in governance mode, Amazon Web Services accounts with specific IAM permissions
are authorized to remove the tape retention lock from archived virtual tapes. When
configured in compliance mode, the tape retention lock cannot be removed by any user,
including the root Amazon Web Services account.
- `"Tags"`: A list of up to 50 tags that can be assigned to tape pool. Each tag is a
key-value pair. Valid characters for key and value are letters, spaces, and numbers
representable in UTF-8 format, and the following special characters: + - = . _ : / @. The
maximum length of a tag's key is 128 characters, and the maximum length for a tag's value
is 256.
"""
function create_tape_pool(
PoolName, StorageClass; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"CreateTapePool",
Dict{String,Any}("PoolName" => PoolName, "StorageClass" => StorageClass);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_tape_pool(
PoolName,
StorageClass,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"CreateTapePool",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("PoolName" => PoolName, "StorageClass" => StorageClass),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_tape_with_barcode(gateway_arn, tape_barcode, tape_size_in_bytes)
create_tape_with_barcode(gateway_arn, tape_barcode, tape_size_in_bytes, params::Dict{String,<:Any})
Creates a virtual tape by using your own barcode. You write data to the virtual tape and
then archive the tape. A barcode is unique and cannot be reused if it has already been used
on a tape. This applies to barcodes used on deleted tapes. This operation is only supported
in the tape gateway type. Cache storage must be allocated to the gateway before you can
create a virtual tape. Use the AddCache operation to add cache storage to a gateway.
# Arguments
- `gateway_arn`: The unique Amazon Resource Name (ARN) that represents the gateway to
associate the virtual tape with. Use the ListGateways operation to return a list of
gateways for your account and Amazon Web Services Region.
- `tape_barcode`: The barcode that you want to assign to the tape. Barcodes cannot be
reused. This includes barcodes used for tapes that have been deleted.
- `tape_size_in_bytes`: The size, in bytes, of the virtual tape that you want to create.
The size must be aligned by gigabyte (1024*1024*1024 bytes).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"KMSEncrypted"`: Set to true to use Amazon S3 server-side encryption with your own KMS
key, or false to use a key managed by Amazon S3. Optional. Valid Values: true | false
- `"KMSKey"`: The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs.
This value can only be set when KMSEncrypted is true. Optional.
- `"PoolId"`: The ID of the pool that you want to add your tape to for archiving. The tape
in this pool is archived in the S3 storage class that is associated with the pool. When you
use your backup application to eject the tape, the tape is archived directly into the
storage class (S3 Glacier or S3 Deep Archive) that corresponds to the pool.
- `"Tags"`: A list of up to 50 tags that can be assigned to a virtual tape that has a
barcode. Each tag is a key-value pair. Valid characters for key and value are letters,
spaces, and numbers representable in UTF-8 format, and the following special characters: +
- = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length
for a tag's value is 256.
- `"Worm"`: Set to TRUE if the tape you are creating is to be configured as a
write-once-read-many (WORM) tape.
"""
function create_tape_with_barcode(
GatewayARN,
TapeBarcode,
TapeSizeInBytes;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"CreateTapeWithBarcode",
Dict{String,Any}(
"GatewayARN" => GatewayARN,
"TapeBarcode" => TapeBarcode,
"TapeSizeInBytes" => TapeSizeInBytes,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_tape_with_barcode(
GatewayARN,
TapeBarcode,
TapeSizeInBytes,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"CreateTapeWithBarcode",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GatewayARN" => GatewayARN,
"TapeBarcode" => TapeBarcode,
"TapeSizeInBytes" => TapeSizeInBytes,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_tapes(client_token, gateway_arn, num_tapes_to_create, tape_barcode_prefix, tape_size_in_bytes)
create_tapes(client_token, gateway_arn, num_tapes_to_create, tape_barcode_prefix, tape_size_in_bytes, params::Dict{String,<:Any})
Creates one or more virtual tapes. You write data to the virtual tapes and then archive the
tapes. This operation is only supported in the tape gateway type. Cache storage must be
allocated to the gateway before you can create virtual tapes. Use the AddCache operation to
add cache storage to a gateway.
# Arguments
- `client_token`: A unique identifier that you use to retry a request. If you retry a
request, use the same ClientToken you specified in the initial request. Using the same
ClientToken prevents creating the tape multiple times.
- `gateway_arn`: The unique Amazon Resource Name (ARN) that represents the gateway to
associate the virtual tapes with. Use the ListGateways operation to return a list of
gateways for your account and Amazon Web Services Region.
- `num_tapes_to_create`: The number of virtual tapes that you want to create.
- `tape_barcode_prefix`: A prefix that you append to the barcode of the virtual tape you
are creating. This prefix makes the barcode unique. The prefix must be 1-4 characters in
length and must be one of the uppercase letters from A to Z.
- `tape_size_in_bytes`: The size, in bytes, of the virtual tapes that you want to create.
The size must be aligned by gigabyte (1024*1024*1024 bytes).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"KMSEncrypted"`: Set to true to use Amazon S3 server-side encryption with your own KMS
key, or false to use a key managed by Amazon S3. Optional. Valid Values: true | false
- `"KMSKey"`: The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs.
This value can only be set when KMSEncrypted is true. Optional.
- `"PoolId"`: The ID of the pool that you want to add your tape to for archiving. The tape
in this pool is archived in the S3 storage class that is associated with the pool. When you
use your backup application to eject the tape, the tape is archived directly into the
storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
- `"Tags"`: A list of up to 50 tags that can be assigned to a virtual tape. Each tag is a
key-value pair. Valid characters for key and value are letters, spaces, and numbers
representable in UTF-8 format, and the following special characters: + - = . _ : / @. The
maximum length of a tag's key is 128 characters, and the maximum length for a tag's value
is 256.
- `"Worm"`: Set to TRUE if the tape you are creating is to be configured as a
write-once-read-many (WORM) tape.
"""
function create_tapes(
ClientToken,
GatewayARN,
NumTapesToCreate,
TapeBarcodePrefix,
TapeSizeInBytes;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"CreateTapes",
Dict{String,Any}(
"ClientToken" => ClientToken,
"GatewayARN" => GatewayARN,
"NumTapesToCreate" => NumTapesToCreate,
"TapeBarcodePrefix" => TapeBarcodePrefix,
"TapeSizeInBytes" => TapeSizeInBytes,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_tapes(
ClientToken,
GatewayARN,
NumTapesToCreate,
TapeBarcodePrefix,
TapeSizeInBytes,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"CreateTapes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientToken" => ClientToken,
"GatewayARN" => GatewayARN,
"NumTapesToCreate" => NumTapesToCreate,
"TapeBarcodePrefix" => TapeBarcodePrefix,
"TapeSizeInBytes" => TapeSizeInBytes,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_automatic_tape_creation_policy(gateway_arn)
delete_automatic_tape_creation_policy(gateway_arn, params::Dict{String,<:Any})
Deletes the automatic tape creation policy of a gateway. If you delete this policy, new
virtual tapes must be created manually. Use the Amazon Resource Name (ARN) of the gateway
in your request to remove the policy.
# Arguments
- `gateway_arn`:
"""
function delete_automatic_tape_creation_policy(
GatewayARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"DeleteAutomaticTapeCreationPolicy",
Dict{String,Any}("GatewayARN" => GatewayARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_automatic_tape_creation_policy(
GatewayARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"DeleteAutomaticTapeCreationPolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GatewayARN" => GatewayARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_bandwidth_rate_limit(bandwidth_type, gateway_arn)
delete_bandwidth_rate_limit(bandwidth_type, gateway_arn, params::Dict{String,<:Any})
Deletes the bandwidth rate limits of a gateway. You can delete either the upload and
download bandwidth rate limit, or you can delete both. If you delete only one of the
limits, the other limit remains unchanged. To specify which gateway to work with, use the
Amazon Resource Name (ARN) of the gateway in your request. This operation is supported only
for the stored volume, cached volume, and tape gateway types.
# Arguments
- `bandwidth_type`: One of the BandwidthType values that indicates the gateway bandwidth
rate limit to delete. Valid Values: UPLOAD | DOWNLOAD | ALL
- `gateway_arn`:
"""
function delete_bandwidth_rate_limit(
BandwidthType, GatewayARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"DeleteBandwidthRateLimit",
Dict{String,Any}("BandwidthType" => BandwidthType, "GatewayARN" => GatewayARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_bandwidth_rate_limit(
BandwidthType,
GatewayARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"DeleteBandwidthRateLimit",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"BandwidthType" => BandwidthType, "GatewayARN" => GatewayARN
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_chap_credentials(initiator_name, target_arn)
delete_chap_credentials(initiator_name, target_arn, params::Dict{String,<:Any})
Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified
iSCSI target and initiator pair. This operation is supported in volume and tape gateway
types.
# Arguments
- `initiator_name`: The iSCSI initiator that connects to the target.
- `target_arn`: The Amazon Resource Name (ARN) of the iSCSI volume target. Use the
DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified
VolumeARN.
"""
function delete_chap_credentials(
InitiatorName, TargetARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"DeleteChapCredentials",
Dict{String,Any}("InitiatorName" => InitiatorName, "TargetARN" => TargetARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_chap_credentials(
InitiatorName,
TargetARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"DeleteChapCredentials",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InitiatorName" => InitiatorName, "TargetARN" => TargetARN
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_file_share(file_share_arn)
delete_file_share(file_share_arn, params::Dict{String,<:Any})
Deletes a file share from an S3 File Gateway. This operation is only supported for S3 File
Gateways.
# Arguments
- `file_share_arn`: The Amazon Resource Name (ARN) of the file share to be deleted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ForceDelete"`: If this value is set to true, the operation deletes a file share
immediately and aborts all data uploads to Amazon Web Services. Otherwise, the file share
is not deleted until all data is uploaded to Amazon Web Services. This process aborts the
data upload process, and the file share enters the FORCE_DELETING status. Valid Values:
true | false
"""
function delete_file_share(FileShareARN; aws_config::AbstractAWSConfig=global_aws_config())
return storage_gateway(
"DeleteFileShare",
Dict{String,Any}("FileShareARN" => FileShareARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_file_share(
FileShareARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"DeleteFileShare",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("FileShareARN" => FileShareARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_gateway(gateway_arn)
delete_gateway(gateway_arn, params::Dict{String,<:Any})
Deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN)
of the gateway in your request. The operation deletes the gateway; however, it does not
delete the gateway virtual machine (VM) from your host computer. After you delete a
gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not
deleted upon deleting the gateway, however, pending snapshots will not complete. After you
delete a gateway, your next step is to remove it from your environment. You no longer pay
software charges after the gateway is deleted; however, your existing Amazon EBS snapshots
persist and you will continue to be billed for these snapshots. You can choose to remove
all remaining Amazon EBS snapshots by canceling your Amazon EC2 subscription. If you
prefer not to cancel your Amazon EC2 subscription, you can delete your snapshots using the
Amazon EC2 console. For more information, see the Storage Gateway detail page.
# Arguments
- `gateway_arn`:
"""
function delete_gateway(GatewayARN; aws_config::AbstractAWSConfig=global_aws_config())
return storage_gateway(
"DeleteGateway",
Dict{String,Any}("GatewayARN" => GatewayARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_gateway(
GatewayARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"DeleteGateway",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GatewayARN" => GatewayARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_snapshot_schedule(volume_arn)
delete_snapshot_schedule(volume_arn, params::Dict{String,<:Any})
Deletes a snapshot of a volume. You can take snapshots of your gateway volumes on a
scheduled or ad hoc basis. This API action enables you to delete a snapshot schedule for a
volume. For more information, see Backing up your volumes. In the DeleteSnapshotSchedule
request, you identify the volume by providing its Amazon Resource Name (ARN). This
operation is only supported for cached volume gateway types. To list or delete a snapshot,
you must use the Amazon EC2 API. For more information, go to DescribeSnapshots in the
Amazon Elastic Compute Cloud API Reference.
# Arguments
- `volume_arn`: The volume which snapshot schedule to delete.
"""
function delete_snapshot_schedule(
VolumeARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"DeleteSnapshotSchedule",
Dict{String,Any}("VolumeARN" => VolumeARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_snapshot_schedule(
VolumeARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"DeleteSnapshotSchedule",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("VolumeARN" => VolumeARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_tape(gateway_arn, tape_arn)
delete_tape(gateway_arn, tape_arn, params::Dict{String,<:Any})
Deletes the specified virtual tape. This operation is only supported in the tape gateway
type.
# Arguments
- `gateway_arn`: The unique Amazon Resource Name (ARN) of the gateway that the virtual tape
to delete is associated with. Use the ListGateways operation to return a list of gateways
for your account and Amazon Web Services Region.
- `tape_arn`: The Amazon Resource Name (ARN) of the virtual tape to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BypassGovernanceRetention"`: Set to TRUE to delete an archived tape that belongs to a
custom pool with tape retention lock. Only archived tapes with tape retention lock set to
governance can be deleted. Archived tapes with tape retention lock set to compliance can't
be deleted.
"""
function delete_tape(GatewayARN, TapeARN; aws_config::AbstractAWSConfig=global_aws_config())
return storage_gateway(
"DeleteTape",
Dict{String,Any}("GatewayARN" => GatewayARN, "TapeARN" => TapeARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_tape(
GatewayARN,
TapeARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"DeleteTape",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("GatewayARN" => GatewayARN, "TapeARN" => TapeARN),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_tape_archive(tape_arn)
delete_tape_archive(tape_arn, params::Dict{String,<:Any})
Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is
only supported in the tape gateway type.
# Arguments
- `tape_arn`: The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual
tape shelf (VTS).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BypassGovernanceRetention"`: Set to TRUE to delete an archived tape that belongs to a
custom pool with tape retention lock. Only archived tapes with tape retention lock set to
governance can be deleted. Archived tapes with tape retention lock set to compliance can't
be deleted.
"""
function delete_tape_archive(TapeARN; aws_config::AbstractAWSConfig=global_aws_config())
return storage_gateway(
"DeleteTapeArchive",
Dict{String,Any}("TapeARN" => TapeARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_tape_archive(
TapeARN, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"DeleteTapeArchive",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("TapeARN" => TapeARN), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_tape_pool(pool_arn)
delete_tape_pool(pool_arn, params::Dict{String,<:Any})
Delete a custom tape pool. A custom tape pool can only be deleted if there are no tapes in
the pool and if there are no automatic tape creation policies that reference the custom
tape pool.
# Arguments
- `pool_arn`: The Amazon Resource Name (ARN) of the custom tape pool to delete.
"""
function delete_tape_pool(PoolARN; aws_config::AbstractAWSConfig=global_aws_config())
return storage_gateway(
"DeleteTapePool",
Dict{String,Any}("PoolARN" => PoolARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_tape_pool(
PoolARN, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"DeleteTapePool",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("PoolARN" => PoolARN), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_volume(volume_arn)
delete_volume(volume_arn, params::Dict{String,<:Any})
Deletes the specified storage volume that you previously created using the
CreateCachediSCSIVolume or CreateStorediSCSIVolume API. This operation is only supported in
the cached volume and stored volume types. For stored volume gateways, the local disk that
was configured as the storage volume is not deleted. You can reuse the local disk to create
another storage volume. Before you delete a volume, make sure there are no iSCSI
connections to the volume you are deleting. You should also make sure there is no snapshot
in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query
snapshots on the volume you are deleting and check the snapshot status. For more
information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference. In
the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want
to delete.
# Arguments
- `volume_arn`: The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation
to return a list of gateway volumes.
"""
function delete_volume(VolumeARN; aws_config::AbstractAWSConfig=global_aws_config())
return storage_gateway(
"DeleteVolume",
Dict{String,Any}("VolumeARN" => VolumeARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_volume(
VolumeARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"DeleteVolume",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("VolumeARN" => VolumeARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_availability_monitor_test(gateway_arn)
describe_availability_monitor_test(gateway_arn, params::Dict{String,<:Any})
Returns information about the most recent high availability monitoring test that was
performed on the host in a cluster. If a test isn't performed, the status and start time in
the response would be null.
# Arguments
- `gateway_arn`:
"""
function describe_availability_monitor_test(
GatewayARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"DescribeAvailabilityMonitorTest",
Dict{String,Any}("GatewayARN" => GatewayARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_availability_monitor_test(
GatewayARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"DescribeAvailabilityMonitorTest",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GatewayARN" => GatewayARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_bandwidth_rate_limit(gateway_arn)
describe_bandwidth_rate_limit(gateway_arn, params::Dict{String,<:Any})
Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which
means no bandwidth rate limiting is in effect. This operation is supported only for the
stored volume, cached volume, and tape gateway types. To describe bandwidth rate limits for
S3 file gateways, use DescribeBandwidthRateLimitSchedule. This operation returns a value
for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway,
then this operation returns only the gateway ARN in the response body. To specify which
gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
# Arguments
- `gateway_arn`:
"""
function describe_bandwidth_rate_limit(
GatewayARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"DescribeBandwidthRateLimit",
Dict{String,Any}("GatewayARN" => GatewayARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_bandwidth_rate_limit(
GatewayARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"DescribeBandwidthRateLimit",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GatewayARN" => GatewayARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_bandwidth_rate_limit_schedule(gateway_arn)
describe_bandwidth_rate_limit_schedule(gateway_arn, params::Dict{String,<:Any})
Returns information about the bandwidth rate limit schedule of a gateway. By default,
gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting
is in effect. This operation is supported only for volume, tape and S3 file gateways. FSx
file gateways do not support bandwidth rate limits. This operation returns information
about a gateway's bandwidth rate limit schedule. A bandwidth rate limit schedule consists
of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a
period of time on one or more days of the week, during which bandwidth rate limits are
specified for uploading, downloading, or both. A bandwidth rate limit interval consists
of one or more days of the week, a start hour and minute, an ending hour and minute, and
bandwidth rate limits for uploading and downloading If no bandwidth rate limit schedule
intervals are set for the gateway, this operation returns an empty response. To specify
which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your
request.
# Arguments
- `gateway_arn`:
"""
function describe_bandwidth_rate_limit_schedule(
GatewayARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"DescribeBandwidthRateLimitSchedule",
Dict{String,Any}("GatewayARN" => GatewayARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_bandwidth_rate_limit_schedule(
GatewayARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"DescribeBandwidthRateLimitSchedule",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GatewayARN" => GatewayARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_cache(gateway_arn)
describe_cache(gateway_arn, params::Dict{String,<:Any})
Returns information about the cache of a gateway. This operation is only supported in the
cached volume, tape, and file gateway types. The response includes disk IDs that are
configured as cache, and it includes the amount of cache allocated and used.
# Arguments
- `gateway_arn`:
"""
function describe_cache(GatewayARN; aws_config::AbstractAWSConfig=global_aws_config())
return storage_gateway(
"DescribeCache",
Dict{String,Any}("GatewayARN" => GatewayARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_cache(
GatewayARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"DescribeCache",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GatewayARN" => GatewayARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_cachedi_scsivolumes(volume_arns)
describe_cachedi_scsivolumes(volume_arns, params::Dict{String,<:Any})
Returns a description of the gateway volumes specified in the request. This operation is
only supported in the cached volume gateway types. The list of gateway volumes in the
request must be from one gateway. In the response, Storage Gateway returns volume
information sorted by volume Amazon Resource Name (ARN).
# Arguments
- `volume_arns`: An array of strings where each string represents the Amazon Resource Name
(ARN) of a cached volume. All of the specified cached volumes must be from the same
gateway. Use ListVolumes to get volume ARNs for a gateway.
"""
function describe_cachedi_scsivolumes(
VolumeARNs; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"DescribeCachediSCSIVolumes",
Dict{String,Any}("VolumeARNs" => VolumeARNs);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_cachedi_scsivolumes(
VolumeARNs,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"DescribeCachediSCSIVolumes",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("VolumeARNs" => VolumeARNs), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_chap_credentials(target_arn)
describe_chap_credentials(target_arn, params::Dict{String,<:Any})
Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials
information for a specified iSCSI target, one for each target-initiator pair. This
operation is supported in the volume and tape gateway types.
# Arguments
- `target_arn`: The Amazon Resource Name (ARN) of the iSCSI volume target. Use the
DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified
VolumeARN.
"""
function describe_chap_credentials(
TargetARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"DescribeChapCredentials",
Dict{String,Any}("TargetARN" => TargetARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_chap_credentials(
TargetARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"DescribeChapCredentials",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TargetARN" => TargetARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_file_system_associations(file_system_association_arnlist)
describe_file_system_associations(file_system_association_arnlist, params::Dict{String,<:Any})
Gets the file system association information. This operation is only supported for FSx File
Gateways.
# Arguments
- `file_system_association_arnlist`: An array containing the Amazon Resource Name (ARN) of
each file system association to be described.
"""
function describe_file_system_associations(
FileSystemAssociationARNList; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"DescribeFileSystemAssociations",
Dict{String,Any}("FileSystemAssociationARNList" => FileSystemAssociationARNList);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_file_system_associations(
FileSystemAssociationARNList,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"DescribeFileSystemAssociations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FileSystemAssociationARNList" => FileSystemAssociationARNList
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_gateway_information(gateway_arn)
describe_gateway_information(gateway_arn, params::Dict{String,<:Any})
Returns metadata about a gateway such as its name, network interfaces, time zone, status,
and software version. To specify which gateway to describe, use the Amazon Resource Name
(ARN) of the gateway in your request.
# Arguments
- `gateway_arn`:
"""
function describe_gateway_information(
GatewayARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"DescribeGatewayInformation",
Dict{String,Any}("GatewayARN" => GatewayARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_gateway_information(
GatewayARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"DescribeGatewayInformation",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GatewayARN" => GatewayARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_maintenance_start_time(gateway_arn)
describe_maintenance_start_time(gateway_arn, params::Dict{String,<:Any})
Returns your gateway's maintenance window schedule information, with values for monthly or
weekly cadence, specific day and time to begin maintenance, and which types of updates to
apply. Time values returned are for the gateway's time zone.
# Arguments
- `gateway_arn`:
"""
function describe_maintenance_start_time(
GatewayARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"DescribeMaintenanceStartTime",
Dict{String,Any}("GatewayARN" => GatewayARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_maintenance_start_time(
GatewayARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"DescribeMaintenanceStartTime",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GatewayARN" => GatewayARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_nfsfile_shares(file_share_arnlist)
describe_nfsfile_shares(file_share_arnlist, params::Dict{String,<:Any})
Gets a description for one or more Network File System (NFS) file shares from an S3 File
Gateway. This operation is only supported for S3 File Gateways.
# Arguments
- `file_share_arnlist`: An array containing the Amazon Resource Name (ARN) of each file
share to be described.
"""
function describe_nfsfile_shares(
FileShareARNList; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"DescribeNFSFileShares",
Dict{String,Any}("FileShareARNList" => FileShareARNList);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_nfsfile_shares(
FileShareARNList,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"DescribeNFSFileShares",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("FileShareARNList" => FileShareARNList), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_smbfile_shares(file_share_arnlist)
describe_smbfile_shares(file_share_arnlist, params::Dict{String,<:Any})
Gets a description for one or more Server Message Block (SMB) file shares from a S3 File
Gateway. This operation is only supported for S3 File Gateways.
# Arguments
- `file_share_arnlist`: An array containing the Amazon Resource Name (ARN) of each file
share to be described.
"""
function describe_smbfile_shares(
FileShareARNList; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"DescribeSMBFileShares",
Dict{String,Any}("FileShareARNList" => FileShareARNList);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_smbfile_shares(
FileShareARNList,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"DescribeSMBFileShares",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("FileShareARNList" => FileShareARNList), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_smbsettings(gateway_arn)
describe_smbsettings(gateway_arn, params::Dict{String,<:Any})
Gets a description of a Server Message Block (SMB) file share settings from a file gateway.
This operation is only supported for file gateways.
# Arguments
- `gateway_arn`:
"""
function describe_smbsettings(GatewayARN; aws_config::AbstractAWSConfig=global_aws_config())
return storage_gateway(
"DescribeSMBSettings",
Dict{String,Any}("GatewayARN" => GatewayARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_smbsettings(
GatewayARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"DescribeSMBSettings",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GatewayARN" => GatewayARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_snapshot_schedule(volume_arn)
describe_snapshot_schedule(volume_arn, params::Dict{String,<:Any})
Describes the snapshot schedule for the specified gateway volume. The snapshot schedule
information includes intervals at which snapshots are automatically initiated on the
volume. This operation is only supported in the cached volume and stored volume types.
# Arguments
- `volume_arn`: The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation
to return a list of gateway volumes.
"""
function describe_snapshot_schedule(
VolumeARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"DescribeSnapshotSchedule",
Dict{String,Any}("VolumeARN" => VolumeARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_snapshot_schedule(
VolumeARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"DescribeSnapshotSchedule",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("VolumeARN" => VolumeARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_storedi_scsivolumes(volume_arns)
describe_storedi_scsivolumes(volume_arns, params::Dict{String,<:Any})
Returns the description of the gateway volumes specified in the request. The list of
gateway volumes in the request must be from one gateway. In the response, Storage Gateway
returns volume information sorted by volume ARNs. This operation is only supported in
stored volume gateway type.
# Arguments
- `volume_arns`: An array of strings where each string represents the Amazon Resource Name
(ARN) of a stored volume. All of the specified stored volumes must be from the same
gateway. Use ListVolumes to get volume ARNs for a gateway.
"""
function describe_storedi_scsivolumes(
VolumeARNs; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"DescribeStorediSCSIVolumes",
Dict{String,Any}("VolumeARNs" => VolumeARNs);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_storedi_scsivolumes(
VolumeARNs,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"DescribeStorediSCSIVolumes",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("VolumeARNs" => VolumeARNs), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_tape_archives()
describe_tape_archives(params::Dict{String,<:Any})
Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This
operation is only supported in the tape gateway type. If a specific TapeARN is not
specified, Storage Gateway returns a description of all virtual tapes found in the VTS
associated with your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies that the number of virtual tapes described be limited to the
specified number.
- `"Marker"`: An opaque string that indicates the position at which to begin describing
virtual tapes.
- `"TapeARNs"`: Specifies one or more unique Amazon Resource Names (ARNs) that represent
the virtual tapes you want to describe.
"""
function describe_tape_archives(; aws_config::AbstractAWSConfig=global_aws_config())
return storage_gateway(
"DescribeTapeArchives"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_tape_archives(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"DescribeTapeArchives",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_tape_recovery_points(gateway_arn)
describe_tape_recovery_points(gateway_arn, params::Dict{String,<:Any})
Returns a list of virtual tape recovery points that are available for the specified tape
gateway. A recovery point is a point-in-time view of a virtual tape at which all the data
on the virtual tape is consistent. If your gateway crashes, virtual tapes that have
recovery points can be recovered to a new gateway. This operation is only supported in the
tape gateway type.
# Arguments
- `gateway_arn`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies that the number of virtual tape recovery points that are described
be limited to the specified number.
- `"Marker"`: An opaque string that indicates the position at which to begin describing the
virtual tape recovery points.
"""
function describe_tape_recovery_points(
GatewayARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"DescribeTapeRecoveryPoints",
Dict{String,Any}("GatewayARN" => GatewayARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_tape_recovery_points(
GatewayARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"DescribeTapeRecoveryPoints",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GatewayARN" => GatewayARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_tapes(gateway_arn)
describe_tapes(gateway_arn, params::Dict{String,<:Any})
Returns a description of virtual tapes that correspond to the specified Amazon Resource
Names (ARNs). If TapeARN is not specified, returns a description of the virtual tapes
associated with the specified gateway. This operation is only supported for the tape
gateway type. The operation supports pagination. By default, the operation returns a
maximum of up to 100 tapes. You can optionally specify the Limit field in the body to limit
the number of tapes in the response. If the number of tapes returned in the response is
truncated, the response includes a Marker field. You can use this Marker value in your
subsequent request to retrieve the next set of tapes.
# Arguments
- `gateway_arn`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies that the number of virtual tapes described be limited to the
specified number. Amazon Web Services may impose its own limit, if this field is not set.
- `"Marker"`: A marker value, obtained in a previous call to DescribeTapes. This marker
indicates which page of results to retrieve. If not specified, the first page of results is
retrieved.
- `"TapeARNs"`: Specifies one or more unique Amazon Resource Names (ARNs) that represent
the virtual tapes you want to describe. If this parameter is not specified, Tape gateway
returns a description of all virtual tapes associated with the specified gateway.
"""
function describe_tapes(GatewayARN; aws_config::AbstractAWSConfig=global_aws_config())
return storage_gateway(
"DescribeTapes",
Dict{String,Any}("GatewayARN" => GatewayARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_tapes(
GatewayARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"DescribeTapes",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GatewayARN" => GatewayARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_upload_buffer(gateway_arn)
describe_upload_buffer(gateway_arn, params::Dict{String,<:Any})
Returns information about the upload buffer of a gateway. This operation is supported for
the stored volume, cached volume, and tape gateway types. The response includes disk IDs
that are configured as upload buffer space, and it includes the amount of upload buffer
space allocated and used.
# Arguments
- `gateway_arn`:
"""
function describe_upload_buffer(
GatewayARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"DescribeUploadBuffer",
Dict{String,Any}("GatewayARN" => GatewayARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_upload_buffer(
GatewayARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"DescribeUploadBuffer",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GatewayARN" => GatewayARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_vtldevices(gateway_arn)
describe_vtldevices(gateway_arn, params::Dict{String,<:Any})
Returns a description of virtual tape library (VTL) devices for the specified tape gateway.
In the response, Storage Gateway returns VTL device information. This operation is only
supported in the tape gateway type.
# Arguments
- `gateway_arn`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies that the number of VTL devices described be limited to the specified
number.
- `"Marker"`: An opaque string that indicates the position at which to begin describing the
VTL devices.
- `"VTLDeviceARNs"`: An array of strings, where each string represents the Amazon Resource
Name (ARN) of a VTL device. All of the specified VTL devices must be from the same
gateway. If no VTL devices are specified, the result will contain all devices on the
specified gateway.
"""
function describe_vtldevices(GatewayARN; aws_config::AbstractAWSConfig=global_aws_config())
return storage_gateway(
"DescribeVTLDevices",
Dict{String,Any}("GatewayARN" => GatewayARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_vtldevices(
GatewayARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"DescribeVTLDevices",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GatewayARN" => GatewayARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_working_storage(gateway_arn)
describe_working_storage(gateway_arn, params::Dict{String,<:Any})
Returns information about the working storage of a gateway. This operation is only
supported in the stored volumes gateway type. This operation is deprecated in cached
volumes API version (20120630). Use DescribeUploadBuffer instead. Working storage is also
referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add
upload buffer to a stored volume gateway. The response includes disk IDs that are
configured as working storage, and it includes the amount of working storage allocated and
used.
# Arguments
- `gateway_arn`:
"""
function describe_working_storage(
GatewayARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"DescribeWorkingStorage",
Dict{String,Any}("GatewayARN" => GatewayARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_working_storage(
GatewayARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"DescribeWorkingStorage",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GatewayARN" => GatewayARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detach_volume(volume_arn)
detach_volume(volume_arn, params::Dict{String,<:Any})
Disconnects a volume from an iSCSI connection and then detaches the volume from the
specified gateway. Detaching and attaching a volume enables you to recover your data from
one gateway to a different gateway without creating a snapshot. It also makes it easier to
move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2
instance. This operation is only supported in the volume gateway type.
# Arguments
- `volume_arn`: The Amazon Resource Name (ARN) of the volume to detach from the gateway.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ForceDetach"`: Set to true to forcibly remove the iSCSI connection of the target volume
and detach the volume. The default is false. If this value is set to false, you must
manually disconnect the iSCSI connection from the target volume. Valid Values: true | false
"""
function detach_volume(VolumeARN; aws_config::AbstractAWSConfig=global_aws_config())
return storage_gateway(
"DetachVolume",
Dict{String,Any}("VolumeARN" => VolumeARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detach_volume(
VolumeARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"DetachVolume",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("VolumeARN" => VolumeARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_gateway(gateway_arn)
disable_gateway(gateway_arn, params::Dict{String,<:Any})
Disables a tape gateway when the gateway is no longer functioning. For example, if your
gateway VM is damaged, you can disable the gateway so you can recover virtual tapes. Use
this operation for a tape gateway that is not reachable or not functioning. This operation
is only supported in the tape gateway type. After a gateway is disabled, it cannot be
enabled.
# Arguments
- `gateway_arn`:
"""
function disable_gateway(GatewayARN; aws_config::AbstractAWSConfig=global_aws_config())
return storage_gateway(
"DisableGateway",
Dict{String,Any}("GatewayARN" => GatewayARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_gateway(
GatewayARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"DisableGateway",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GatewayARN" => GatewayARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_file_system(file_system_association_arn)
disassociate_file_system(file_system_association_arn, params::Dict{String,<:Any})
Disassociates an Amazon FSx file system from the specified gateway. After the
disassociation process finishes, the gateway can no longer access the Amazon FSx file
system. This operation is only supported in the FSx File Gateway type.
# Arguments
- `file_system_association_arn`: The Amazon Resource Name (ARN) of the file system
association to be deleted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ForceDelete"`: If this value is set to true, the operation disassociates an Amazon FSx
file system immediately. It ends all data uploads to the file system, and the file system
association enters the FORCE_DELETING status. If this value is set to false, the Amazon FSx
file system does not disassociate until all data is uploaded.
"""
function disassociate_file_system(
FileSystemAssociationARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"DisassociateFileSystem",
Dict{String,Any}("FileSystemAssociationARN" => FileSystemAssociationARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_file_system(
FileSystemAssociationARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"DisassociateFileSystem",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("FileSystemAssociationARN" => FileSystemAssociationARN),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
join_domain(domain_name, gateway_arn, password, user_name)
join_domain(domain_name, gateway_arn, password, user_name, params::Dict{String,<:Any})
Adds a file gateway to an Active Directory domain. This operation is only supported for
file gateways that support the SMB file protocol. Joining a domain creates an Active
Directory computer account in the default organizational unit, using the gateway's Gateway
ID as the account name (for example, SGW-1234ADE). If your Active Directory environment
requires that you pre-stage accounts to facilitate the join domain process, you will need
to create this account ahead of time. To create the gateway's computer account in an
organizational unit other than the default, you must specify the organizational unit when
joining the domain.
# Arguments
- `domain_name`: The name of the domain that you want the gateway to join.
- `gateway_arn`: The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
operation to return a list of gateways for your account and Amazon Web Services Region.
- `password`: Sets the password of the user who has permission to add the gateway to the
Active Directory domain.
- `user_name`: Sets the user name of user who has permission to add the gateway to the
Active Directory domain. The domain user account should be enabled to join computers to the
domain. For example, you can use the domain administrator account or an account with
delegated permissions to join computers to the domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DomainControllers"`: List of IPv4 addresses, NetBIOS names, or host names of your
domain server. If you need to specify the port number include it after the colon (“:”).
For example, mydc.mydomain.com:389.
- `"OrganizationalUnit"`: The organizational unit (OU) is a container in an Active
Directory that can hold users, groups, computers, and other OUs and this parameter
specifies the OU that the gateway will join within the AD domain.
- `"TimeoutInSeconds"`: Specifies the time in seconds, in which the JoinDomain operation
must complete. The default is 20 seconds.
"""
function join_domain(
DomainName,
GatewayARN,
Password,
UserName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"JoinDomain",
Dict{String,Any}(
"DomainName" => DomainName,
"GatewayARN" => GatewayARN,
"Password" => Password,
"UserName" => UserName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function join_domain(
DomainName,
GatewayARN,
Password,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"JoinDomain",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DomainName" => DomainName,
"GatewayARN" => GatewayARN,
"Password" => Password,
"UserName" => UserName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_automatic_tape_creation_policies()
list_automatic_tape_creation_policies(params::Dict{String,<:Any})
Lists the automatic tape creation policies for a gateway. If there are no automatic tape
creation policies for the gateway, it returns an empty list. This operation is only
supported for tape gateways.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GatewayARN"`:
"""
function list_automatic_tape_creation_policies(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"ListAutomaticTapeCreationPolicies";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_automatic_tape_creation_policies(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"ListAutomaticTapeCreationPolicies",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_file_shares()
list_file_shares(params::Dict{String,<:Any})
Gets a list of the file shares for a specific S3 File Gateway, or the list of file shares
that belong to the calling Amazon Web Services account. This operation is only supported
for S3 File Gateways.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GatewayARN"`: The Amazon Resource Name (ARN) of the gateway whose file shares you want
to list. If this field is not present, all file shares under your account are listed.
- `"Limit"`: The maximum number of file shares to return in the response. The value must be
an integer with a value greater than zero. Optional.
- `"Marker"`: Opaque pagination token returned from a previous ListFileShares operation. If
present, Marker specifies where to continue the list from after a previous call to
ListFileShares. Optional.
"""
function list_file_shares(; aws_config::AbstractAWSConfig=global_aws_config())
return storage_gateway(
"ListFileShares"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_file_shares(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"ListFileShares", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_file_system_associations()
list_file_system_associations(params::Dict{String,<:Any})
Gets a list of FileSystemAssociationSummary objects. Each object contains a summary of a
file system association. This operation is only supported for FSx File Gateways.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GatewayARN"`:
- `"Limit"`: The maximum number of file system associations to return in the response. If
present, Limit must be an integer with a value greater than zero. Optional.
- `"Marker"`: Opaque pagination token returned from a previous ListFileSystemAssociations
operation. If present, Marker specifies where to continue the list from after a previous
call to ListFileSystemAssociations. Optional.
"""
function list_file_system_associations(; aws_config::AbstractAWSConfig=global_aws_config())
return storage_gateway(
"ListFileSystemAssociations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_file_system_associations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"ListFileSystemAssociations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_gateways()
list_gateways(params::Dict{String,<:Any})
Lists gateways owned by an Amazon Web Services account in an Amazon Web Services Region
specified in the request. The returned list is ordered by gateway Amazon Resource Name
(ARN). By default, the operation returns a maximum of 100 gateways. This operation supports
pagination that allows you to optionally reduce the number of gateways returned in a
response. If you have more gateways than are returned in a response (that is, the response
returns only a truncated list of your gateways), the response contains a marker that you
can specify in your next request to fetch the next page of gateways.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies that the list of gateways returned be limited to the specified
number of items.
- `"Marker"`: An opaque string that indicates the position at which to begin the returned
list of gateways.
"""
function list_gateways(; aws_config::AbstractAWSConfig=global_aws_config())
return storage_gateway(
"ListGateways"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_gateways(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"ListGateways", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_local_disks(gateway_arn)
list_local_disks(gateway_arn, params::Dict{String,<:Any})
Returns a list of the gateway's local disks. To specify which gateway to describe, you use
the Amazon Resource Name (ARN) of the gateway in the body of the request. The request
returns a list of all disks, specifying which are configured as working storage, cache
storage, or stored volume or not configured at all. The response includes a DiskStatus
field. This field can have a value of present (the disk is available to use), missing (the
disk is no longer connected to the gateway), or mismatch (the disk node is occupied by a
disk that has incorrect metadata or the disk content is corrupted).
# Arguments
- `gateway_arn`:
"""
function list_local_disks(GatewayARN; aws_config::AbstractAWSConfig=global_aws_config())
return storage_gateway(
"ListLocalDisks",
Dict{String,Any}("GatewayARN" => GatewayARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_local_disks(
GatewayARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"ListLocalDisks",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GatewayARN" => GatewayARN), 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 have been added to the specified resource. This operation is supported
in storage gateways of all types.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource for which you want to list
tags.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies that the list of tags returned be limited to the specified number of
items.
- `"Marker"`: An opaque string that indicates the position at which to begin returning the
list of tags.
"""
function list_tags_for_resource(
ResourceARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"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 storage_gateway(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceARN" => ResourceARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tape_pools()
list_tape_pools(params::Dict{String,<:Any})
Lists custom tape pools. You specify custom tape pools to list by specifying one or more
custom tape pool Amazon Resource Names (ARNs). If you don't specify a custom tape pool ARN,
the operation lists all custom tape pools. This operation supports pagination. You can
optionally specify the Limit parameter in the body to limit the number of tape pools in the
response. If the number of tape pools returned in the response is truncated, the response
includes a Marker element that you can use in your subsequent request to retrieve the next
set of tape pools.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: An optional number limit for the tape pools in the list returned by this call.
- `"Marker"`: A string that indicates the position at which to begin the returned list of
tape pools.
- `"PoolARNs"`: The Amazon Resource Name (ARN) of each of the custom tape pools you want to
list. If you don't specify a custom tape pool ARN, the response lists all custom tape
pools.
"""
function list_tape_pools(; aws_config::AbstractAWSConfig=global_aws_config())
return storage_gateway(
"ListTapePools"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_tape_pools(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"ListTapePools", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tapes()
list_tapes(params::Dict{String,<:Any})
Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS).
You specify the tapes to list by specifying one or more tape Amazon Resource Names (ARNs).
If you don't specify a tape ARN, the operation lists all virtual tapes in both your VTL and
VTS. This operation supports pagination. By default, the operation returns a maximum of up
to 100 tapes. You can optionally specify the Limit parameter in the body to limit the
number of tapes in the response. If the number of tapes returned in the response is
truncated, the response includes a Marker element that you can use in your subsequent
request to retrieve the next set of tapes. This operation is only supported in the tape
gateway type.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: An optional number limit for the tapes in the list returned by this call.
- `"Marker"`: A string that indicates the position at which to begin the returned list of
tapes.
- `"TapeARNs"`:
"""
function list_tapes(; aws_config::AbstractAWSConfig=global_aws_config())
return storage_gateway(
"ListTapes"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_tapes(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"ListTapes", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_volume_initiators(volume_arn)
list_volume_initiators(volume_arn, params::Dict{String,<:Any})
Lists iSCSI initiators that are connected to a volume. You can use this operation to
determine whether a volume is being used or not. This operation is only supported in the
cached volume and stored volume gateway types.
# Arguments
- `volume_arn`: The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation
to return a list of gateway volumes for the gateway.
"""
function list_volume_initiators(
VolumeARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"ListVolumeInitiators",
Dict{String,Any}("VolumeARN" => VolumeARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_volume_initiators(
VolumeARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"ListVolumeInitiators",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("VolumeARN" => VolumeARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_volume_recovery_points(gateway_arn)
list_volume_recovery_points(gateway_arn, params::Dict{String,<:Any})
Lists the recovery points for a specified gateway. This operation is only supported in the
cached volume gateway type. Each cache volume has one recovery point. A volume recovery
point is a point in time at which all data of the volume is consistent and from which you
can create a snapshot or clone a new cached volume from a source volume. To create a
snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint
operation.
# Arguments
- `gateway_arn`:
"""
function list_volume_recovery_points(
GatewayARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"ListVolumeRecoveryPoints",
Dict{String,Any}("GatewayARN" => GatewayARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_volume_recovery_points(
GatewayARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"ListVolumeRecoveryPoints",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GatewayARN" => GatewayARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_volumes()
list_volumes(params::Dict{String,<:Any})
Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response
includes only the volume ARNs. If you want additional volume information, use the
DescribeStorediSCSIVolumes or the DescribeCachediSCSIVolumes API. The operation supports
pagination. By default, the operation returns a maximum of up to 100 volumes. You can
optionally specify the Limit field in the body to limit the number of volumes in the
response. If the number of volumes returned in the response is truncated, the response
includes a Marker field. You can use this Marker value in your subsequent request to
retrieve the next set of volumes. This operation is only supported in the cached volume and
stored volume gateway types.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GatewayARN"`:
- `"Limit"`: Specifies that the list of volumes returned be limited to the specified number
of items.
- `"Marker"`: A string that indicates the position at which to begin the returned list of
volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.
"""
function list_volumes(; aws_config::AbstractAWSConfig=global_aws_config())
return storage_gateway(
"ListVolumes"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_volumes(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"ListVolumes", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
notify_when_uploaded(file_share_arn)
notify_when_uploaded(file_share_arn, params::Dict{String,<:Any})
Sends you notification through CloudWatch Events when all files written to your file share
have been uploaded to Amazon S3. Storage Gateway can send a notification through Amazon
CloudWatch Events when all files written to your file share up to that point in time have
been uploaded to Amazon S3. These files include files written to the file share up to the
time that you make a request for notification. When the upload is done, Storage Gateway
sends you notification through an Amazon CloudWatch Event. You can configure CloudWatch
Events to send the notification through event targets such as Amazon SNS or Lambda
function. This operation is only supported for S3 File Gateways. For more information, see
Getting file upload notification in the Amazon S3 File Gateway User Guide.
# Arguments
- `file_share_arn`:
"""
function notify_when_uploaded(
FileShareARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"NotifyWhenUploaded",
Dict{String,Any}("FileShareARN" => FileShareARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function notify_when_uploaded(
FileShareARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"NotifyWhenUploaded",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("FileShareARN" => FileShareARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
refresh_cache(file_share_arn)
refresh_cache(file_share_arn, params::Dict{String,<:Any})
Refreshes the cached inventory of objects for the specified file share. This operation
finds objects in the Amazon S3 bucket that were added, removed, or replaced since the
gateway last listed the bucket's contents and cached the results. This operation does not
import files into the S3 File Gateway cache storage. It only updates the cached inventory
to reflect changes in the inventory of the objects in the S3 bucket. This operation is only
supported in the S3 File Gateway types. You can subscribe to be notified through an Amazon
CloudWatch event when your RefreshCache operation completes. For more information, see
Getting notified about file operations in the Amazon S3 File Gateway User Guide. This
operation is Only supported for S3 File Gateways. When this API is called, it only
initiates the refresh operation. When the API call completes and returns a success code, it
doesn't necessarily mean that the file refresh has completed. You should use the
refresh-complete notification to determine that the operation has completed before you
check for new files on the gateway file share. You can subscribe to be notified through a
CloudWatch event when your RefreshCache operation completes. Throttle limit: This API is
asynchronous, so the gateway will accept no more than two refreshes at any time. We
recommend using the refresh-complete CloudWatch event notification before issuing
additional requests. For more information, see Getting notified about file operations in
the Amazon S3 File Gateway User Guide. Wait at least 60 seconds between consecutive
RefreshCache API requests. If you invoke the RefreshCache API when two requests are
already being processed, any new request will cause an InvalidGatewayRequestException error
because too many requests were sent to the server. The S3 bucket name does not need to
be included when entering the list of folders in the FolderList parameter. For more
information, see Getting notified about file operations in the Amazon S3 File Gateway User
Guide.
# Arguments
- `file_share_arn`: The Amazon Resource Name (ARN) of the file share you want to refresh.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FolderList"`: A comma-separated list of the paths of folders to refresh in the cache.
The default is [\"/\"]. The default refreshes objects and folders at the root of the Amazon
S3 bucket. If Recursive is set to true, the entire S3 bucket that the file share has access
to is refreshed. Do not include / when specifying folder names. For example, you would
specify samplefolder rather than samplefolder/.
- `"Recursive"`: A value that specifies whether to recursively refresh folders in the
cache. The refresh includes folders that were in the cache the last time the gateway listed
the folder's contents. If this value set to true, each folder that is listed in FolderList
is recursively updated. Otherwise, subfolders listed in FolderList are not refreshed. Only
objects that are in folders listed directly under FolderList are found and used for the
update. The default is true. Valid Values: true | false
"""
function refresh_cache(FileShareARN; aws_config::AbstractAWSConfig=global_aws_config())
return storage_gateway(
"RefreshCache",
Dict{String,Any}("FileShareARN" => FileShareARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function refresh_cache(
FileShareARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"RefreshCache",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("FileShareARN" => FileShareARN), 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 one or more tags from the specified resource. This operation is supported in
storage gateways of all types.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource you want to remove the
tags from.
- `tag_keys`: The keys of the tags you want to remove from the specified resource. A tag is
composed of a key-value pair.
"""
function remove_tags_from_resource(
ResourceARN, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"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 storage_gateway(
"RemoveTagsFromResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceARN" => ResourceARN, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reset_cache(gateway_arn)
reset_cache(gateway_arn, params::Dict{String,<:Any})
Resets all cache disks that have encountered an error and makes the disks available for
reconfiguration as cache storage. If your cache disk encounters an error, the gateway
prevents read and write operations on virtual tapes in the gateway. For example, an error
can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the
gateway loses its cache storage. At this point, you can reconfigure the disks as cache
disks. This operation is only supported in the cached volume and tape types. If the cache
disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data
can be lost. After you reset cache disks, there will be no configured cache disks left in
the gateway, so you must configure at least one new cache disk for your gateway to function
properly.
# Arguments
- `gateway_arn`:
"""
function reset_cache(GatewayARN; aws_config::AbstractAWSConfig=global_aws_config())
return storage_gateway(
"ResetCache",
Dict{String,Any}("GatewayARN" => GatewayARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reset_cache(
GatewayARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"ResetCache",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GatewayARN" => GatewayARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
retrieve_tape_archive(gateway_arn, tape_arn)
retrieve_tape_archive(gateway_arn, tape_arn, params::Dict{String,<:Any})
Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway.
Virtual tapes archived in the VTS are not associated with any gateway. However after a tape
is retrieved, it is associated with a gateway, even though it is also listed in the VTS,
that is, archive. This operation is only supported in the tape gateway type. Once a tape is
successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You
must archive the tape again before you can retrieve it to another gateway. This operation
is only supported in the tape gateway type.
# Arguments
- `gateway_arn`: The Amazon Resource Name (ARN) of the gateway you want to retrieve the
virtual tape to. Use the ListGateways operation to return a list of gateways for your
account and Amazon Web Services Region. You retrieve archived virtual tapes to only one
gateway and the gateway must be a tape gateway.
- `tape_arn`: The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from
the virtual tape shelf (VTS).
"""
function retrieve_tape_archive(
GatewayARN, TapeARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"RetrieveTapeArchive",
Dict{String,Any}("GatewayARN" => GatewayARN, "TapeARN" => TapeARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function retrieve_tape_archive(
GatewayARN,
TapeARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"RetrieveTapeArchive",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("GatewayARN" => GatewayARN, "TapeARN" => TapeARN),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
retrieve_tape_recovery_point(gateway_arn, tape_arn)
retrieve_tape_recovery_point(gateway_arn, tape_arn, params::Dict{String,<:Any})
Retrieves the recovery point for the specified virtual tape. This operation is only
supported in the tape gateway type. A recovery point is a point in time view of a virtual
tape at which all the data on the tape is consistent. If your gateway crashes, virtual
tapes that have recovery points can be recovered to a new gateway. The virtual tape can be
retrieved to only one gateway. The retrieved tape is read-only. The virtual tape can be
retrieved to only a tape gateway. There is no charge for retrieving recovery points.
# Arguments
- `gateway_arn`:
- `tape_arn`: The Amazon Resource Name (ARN) of the virtual tape for which you want to
retrieve the recovery point.
"""
function retrieve_tape_recovery_point(
GatewayARN, TapeARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"RetrieveTapeRecoveryPoint",
Dict{String,Any}("GatewayARN" => GatewayARN, "TapeARN" => TapeARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function retrieve_tape_recovery_point(
GatewayARN,
TapeARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"RetrieveTapeRecoveryPoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("GatewayARN" => GatewayARN, "TapeARN" => TapeARN),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_local_console_password(gateway_arn, local_console_password)
set_local_console_password(gateway_arn, local_console_password, params::Dict{String,<:Any})
Sets the password for your VM local console. When you log in to the local console for the
first time, you log in to the VM with the default credentials. We recommend that you set a
new password. You don't need to know the default password to set a new password.
# Arguments
- `gateway_arn`:
- `local_console_password`: The password you want to set for your VM local console.
"""
function set_local_console_password(
GatewayARN, LocalConsolePassword; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"SetLocalConsolePassword",
Dict{String,Any}(
"GatewayARN" => GatewayARN, "LocalConsolePassword" => LocalConsolePassword
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_local_console_password(
GatewayARN,
LocalConsolePassword,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"SetLocalConsolePassword",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GatewayARN" => GatewayARN,
"LocalConsolePassword" => LocalConsolePassword,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_smbguest_password(gateway_arn, password)
set_smbguest_password(gateway_arn, password, params::Dict{String,<:Any})
Sets the password for the guest user smbguest. The smbguest user is the user when the
authentication method for the file share is set to GuestAccess. This operation only
supported for S3 File Gateways
# Arguments
- `gateway_arn`: The Amazon Resource Name (ARN) of the S3 File Gateway the SMB file share
is associated with.
- `password`: The password that you want to set for your SMB server.
"""
function set_smbguest_password(
GatewayARN, Password; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"SetSMBGuestPassword",
Dict{String,Any}("GatewayARN" => GatewayARN, "Password" => Password);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_smbguest_password(
GatewayARN,
Password,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"SetSMBGuestPassword",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("GatewayARN" => GatewayARN, "Password" => Password),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
shutdown_gateway(gateway_arn)
shutdown_gateway(gateway_arn, params::Dict{String,<:Any})
Shuts down a Tape Gateway or Volume Gateway. To specify which gateway to shut down, use the
Amazon Resource Name (ARN) of the gateway in the body of your request. This API action
cannot be used to shut down S3 File Gateway or FSx File Gateway. The operation shuts down
the gateway service component running in the gateway's virtual machine (VM) and not the
host VM. If you want to shut down the VM, it is recommended that you first shut down the
gateway component in the VM to avoid unpredictable conditions. After the gateway is
shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation,
and ListGateways. For more information, see ActivateGateway. Your applications cannot read
from or write to the gateway's storage volumes, and there are no snapshots taken. When you
make a shutdown request, you will get a 200 OK success response immediately. However, it
might take some time for the gateway to shut down. You can call the
DescribeGatewayInformation API to check the status. For more information, see
ActivateGateway. If do not intend to use the gateway again, you must delete the gateway
(using DeleteGateway) to no longer pay software charges associated with the gateway.
# Arguments
- `gateway_arn`:
"""
function shutdown_gateway(GatewayARN; aws_config::AbstractAWSConfig=global_aws_config())
return storage_gateway(
"ShutdownGateway",
Dict{String,Any}("GatewayARN" => GatewayARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function shutdown_gateway(
GatewayARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"ShutdownGateway",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GatewayARN" => GatewayARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_availability_monitor_test(gateway_arn)
start_availability_monitor_test(gateway_arn, params::Dict{String,<:Any})
Start a test that verifies that the specified gateway is configured for High Availability
monitoring in your host environment. This request only initiates the test and that a
successful response only indicates that the test was started. It doesn't indicate that the
test passed. For the status of the test, invoke the DescribeAvailabilityMonitorTest API.
Starting this test will cause your gateway to go offline for a brief period.
# Arguments
- `gateway_arn`:
"""
function start_availability_monitor_test(
GatewayARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"StartAvailabilityMonitorTest",
Dict{String,Any}("GatewayARN" => GatewayARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_availability_monitor_test(
GatewayARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"StartAvailabilityMonitorTest",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GatewayARN" => GatewayARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_gateway(gateway_arn)
start_gateway(gateway_arn, params::Dict{String,<:Any})
Starts a gateway that you previously shut down (see ShutdownGateway). After the gateway
starts, you can then make other API calls, your applications can read from or write to the
gateway's storage volumes and you will be able to take snapshot backups. When you make a
request, you will get a 200 OK success response immediately. However, it might take some
time for the gateway to be ready. You should call DescribeGatewayInformation and check the
status before making any additional API calls. For more information, see ActivateGateway.
To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in
your request.
# Arguments
- `gateway_arn`:
"""
function start_gateway(GatewayARN; aws_config::AbstractAWSConfig=global_aws_config())
return storage_gateway(
"StartGateway",
Dict{String,Any}("GatewayARN" => GatewayARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_gateway(
GatewayARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"StartGateway",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GatewayARN" => GatewayARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_automatic_tape_creation_policy(automatic_tape_creation_rules, gateway_arn)
update_automatic_tape_creation_policy(automatic_tape_creation_rules, gateway_arn, params::Dict{String,<:Any})
Updates the automatic tape creation policy of a gateway. Use this to update the policy with
a new set of automatic tape creation rules. This is only supported for tape gateways. By
default, there is no automatic tape creation policy. A gateway can have only one automatic
tape creation policy.
# Arguments
- `automatic_tape_creation_rules`: An automatic tape creation policy consists of a list of
automatic tape creation rules. The rules determine when and how to automatically create new
tapes.
- `gateway_arn`:
"""
function update_automatic_tape_creation_policy(
AutomaticTapeCreationRules,
GatewayARN;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"UpdateAutomaticTapeCreationPolicy",
Dict{String,Any}(
"AutomaticTapeCreationRules" => AutomaticTapeCreationRules,
"GatewayARN" => GatewayARN,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_automatic_tape_creation_policy(
AutomaticTapeCreationRules,
GatewayARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"UpdateAutomaticTapeCreationPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AutomaticTapeCreationRules" => AutomaticTapeCreationRules,
"GatewayARN" => GatewayARN,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_bandwidth_rate_limit(gateway_arn)
update_bandwidth_rate_limit(gateway_arn, params::Dict{String,<:Any})
Updates the bandwidth rate limits of a gateway. You can update both the upload and download
bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate
limit, the existing rate limit remains. This operation is supported only for the stored
volume, cached volume, and tape gateway types. To update bandwidth rate limits for S3 file
gateways, use UpdateBandwidthRateLimitSchedule. By default, a gateway's bandwidth rate
limits are not set. If you don't set any limit, the gateway does not have any limitations
on its bandwidth usage and could potentially use the maximum available bandwidth. To
specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your
request.
# Arguments
- `gateway_arn`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AverageDownloadRateLimitInBitsPerSec"`: The average download bandwidth rate limit in
bits per second.
- `"AverageUploadRateLimitInBitsPerSec"`: The average upload bandwidth rate limit in bits
per second.
"""
function update_bandwidth_rate_limit(
GatewayARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"UpdateBandwidthRateLimit",
Dict{String,Any}("GatewayARN" => GatewayARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_bandwidth_rate_limit(
GatewayARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"UpdateBandwidthRateLimit",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GatewayARN" => GatewayARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_bandwidth_rate_limit_schedule(bandwidth_rate_limit_intervals, gateway_arn)
update_bandwidth_rate_limit_schedule(bandwidth_rate_limit_intervals, gateway_arn, params::Dict{String,<:Any})
Updates the bandwidth rate limit schedule for a specified gateway. By default, gateways do
not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in
effect. Use this to initiate or update a gateway's bandwidth rate limit schedule. This
operation is supported for volume, tape, and S3 file gateways. S3 file gateways support
bandwidth rate limits for upload only. FSx file gateways do not support bandwidth rate
limits.
# Arguments
- `bandwidth_rate_limit_intervals`: An array containing bandwidth rate limit schedule
intervals for a gateway. When no bandwidth rate limit intervals have been scheduled, the
array is empty.
- `gateway_arn`:
"""
function update_bandwidth_rate_limit_schedule(
BandwidthRateLimitIntervals,
GatewayARN;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"UpdateBandwidthRateLimitSchedule",
Dict{String,Any}(
"BandwidthRateLimitIntervals" => BandwidthRateLimitIntervals,
"GatewayARN" => GatewayARN,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_bandwidth_rate_limit_schedule(
BandwidthRateLimitIntervals,
GatewayARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"UpdateBandwidthRateLimitSchedule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"BandwidthRateLimitIntervals" => BandwidthRateLimitIntervals,
"GatewayARN" => GatewayARN,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_chap_credentials(initiator_name, secret_to_authenticate_initiator, target_arn)
update_chap_credentials(initiator_name, secret_to_authenticate_initiator, target_arn, params::Dict{String,<:Any})
Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified
iSCSI target. By default, a gateway does not have CHAP enabled; however, for added
security, you might use it. This operation is supported in the volume and tape gateway
types. When you update CHAP credentials, all existing connections on the target are closed
and initiators must reconnect with the new credentials.
# Arguments
- `initiator_name`: The iSCSI initiator that connects to the target.
- `secret_to_authenticate_initiator`: The secret key that the initiator (for example, the
Windows client) must provide to participate in mutual CHAP with the target. The secret key
must be between 12 and 16 bytes when encoded in UTF-8.
- `target_arn`: The Amazon Resource Name (ARN) of the iSCSI volume target. Use the
DescribeStorediSCSIVolumes operation to return the TargetARN for specified VolumeARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SecretToAuthenticateTarget"`: The secret key that the target must provide to
participate in mutual CHAP with the initiator (e.g. Windows client). Byte constraints:
Minimum bytes of 12. Maximum bytes of 16. The secret key must be between 12 and 16 bytes
when encoded in UTF-8.
"""
function update_chap_credentials(
InitiatorName,
SecretToAuthenticateInitiator,
TargetARN;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"UpdateChapCredentials",
Dict{String,Any}(
"InitiatorName" => InitiatorName,
"SecretToAuthenticateInitiator" => SecretToAuthenticateInitiator,
"TargetARN" => TargetARN,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_chap_credentials(
InitiatorName,
SecretToAuthenticateInitiator,
TargetARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"UpdateChapCredentials",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InitiatorName" => InitiatorName,
"SecretToAuthenticateInitiator" => SecretToAuthenticateInitiator,
"TargetARN" => TargetARN,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_file_system_association(file_system_association_arn)
update_file_system_association(file_system_association_arn, params::Dict{String,<:Any})
Updates a file system association. This operation is only supported in the FSx File
Gateways.
# Arguments
- `file_system_association_arn`: The Amazon Resource Name (ARN) of the file system
association that you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AuditDestinationARN"`: The Amazon Resource Name (ARN) of the storage used for the audit
logs.
- `"CacheAttributes"`:
- `"Password"`: The password of the user credential.
- `"UserName"`: The user name of the user credential that has permission to access the root
share D of the Amazon FSx file system. The user account must belong to the Amazon FSx
delegated admin user group.
"""
function update_file_system_association(
FileSystemAssociationARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"UpdateFileSystemAssociation",
Dict{String,Any}("FileSystemAssociationARN" => FileSystemAssociationARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_file_system_association(
FileSystemAssociationARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"UpdateFileSystemAssociation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("FileSystemAssociationARN" => FileSystemAssociationARN),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_gateway_information(gateway_arn)
update_gateway_information(gateway_arn, params::Dict{String,<:Any})
Updates a gateway's metadata, which includes the gateway's name, time zone, and metadata
cache size. To specify which gateway to update, use the Amazon Resource Name (ARN) of the
gateway in your request. For gateways activated after September 2, 2015, the gateway's ARN
contains the gateway ID rather than the gateway name. However, changing the name of the
gateway has no effect on the gateway's ARN.
# Arguments
- `gateway_arn`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CloudWatchLogGroupARN"`: The Amazon Resource Name (ARN) of the Amazon CloudWatch log
group that you want to use to monitor and log events in the gateway. For more information,
see What is Amazon CloudWatch Logs?
- `"GatewayCapacity"`: Specifies the size of the gateway's metadata cache. This setting
impacts gateway performance and hardware recommendations. For more information, see
Performance guidance for gateways with multiple file shares in the Amazon S3 File Gateway
User Guide.
- `"GatewayName"`:
- `"GatewayTimezone"`: A value that indicates the time zone of the gateway.
"""
function update_gateway_information(
GatewayARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"UpdateGatewayInformation",
Dict{String,Any}("GatewayARN" => GatewayARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_gateway_information(
GatewayARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"UpdateGatewayInformation",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GatewayARN" => GatewayARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_gateway_software_now(gateway_arn)
update_gateway_software_now(gateway_arn, params::Dict{String,<:Any})
Updates the gateway virtual machine (VM) software. The request immediately triggers the
software update. When you make this request, you get a 200 OK success response
immediately. However, it might take some time for the update to complete. You can call
DescribeGatewayInformation to verify the gateway is in the STATE_RUNNING state. A
software update forces a system restart of your gateway. You can minimize the chance of any
disruption to your applications by increasing your iSCSI Initiators' timeouts. For more
information about increasing iSCSI Initiator timeouts for Windows and Linux, see
Customizing your Windows iSCSI settings and Customizing your Linux iSCSI settings,
respectively.
# Arguments
- `gateway_arn`:
"""
function update_gateway_software_now(
GatewayARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"UpdateGatewaySoftwareNow",
Dict{String,Any}("GatewayARN" => GatewayARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_gateway_software_now(
GatewayARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"UpdateGatewaySoftwareNow",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GatewayARN" => GatewayARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_maintenance_start_time(gateway_arn)
update_maintenance_start_time(gateway_arn, params::Dict{String,<:Any})
Updates a gateway's maintenance window schedule, with settings for monthly or weekly
cadence, specific day and time to begin maintenance, and which types of updates to apply.
Time configuration uses the gateway's time zone. You can pass values for a complete
maintenance schedule, or update policy, or both. Previous values will persist for whichever
setting you choose not to modify. If an incomplete or invalid maintenance schedule is
passed, the entire request will be rejected with an error and no changes will occur. A
complete maintenance schedule must include values for both MinuteOfHour and HourOfDay, and
either DayOfMonth or DayOfWeek. We recommend keeping maintenance updates turned on, except
in specific use cases where the brief disruptions caused by updating the gateway could
critically impact your deployment.
# Arguments
- `gateway_arn`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DayOfMonth"`: The day of the month component of the maintenance start time represented
as an ordinal number from 1 to 28, where 1 represents the first day of the month. It is not
possible to set the maintenance schedule to start on days 29 through 31.
- `"DayOfWeek"`: The day of the week component of the maintenance start time week
represented as an ordinal number from 0 to 6, where 0 represents Sunday and 6 represents
Saturday.
- `"HourOfDay"`: The hour component of the maintenance start time represented as hh, where
hh is the hour (00 to 23). The hour of the day is in the time zone of the gateway.
- `"MinuteOfHour"`: The minute component of the maintenance start time represented as mm,
where mm is the minute (00 to 59). The minute of the hour is in the time zone of the
gateway.
- `"SoftwareUpdatePreferences"`: A set of variables indicating the software update
preferences for the gateway. Includes AutomaticUpdatePolicy field with the following
inputs: ALL_VERSIONS - Enables regular gateway maintenance updates.
EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance updates.
"""
function update_maintenance_start_time(
GatewayARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"UpdateMaintenanceStartTime",
Dict{String,Any}("GatewayARN" => GatewayARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_maintenance_start_time(
GatewayARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"UpdateMaintenanceStartTime",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GatewayARN" => GatewayARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_nfsfile_share(file_share_arn)
update_nfsfile_share(file_share_arn, params::Dict{String,<:Any})
Updates a Network File System (NFS) file share. This operation is only supported in S3 File
Gateways. To leave a file share field unchanged, set the corresponding input field to
null. Updates the following file share settings: Default storage class for your S3
bucket Metadata defaults for your S3 bucket Allowed NFS clients for your file share
Squash settings Write status of your file share
# Arguments
- `file_share_arn`: The Amazon Resource Name (ARN) of the file share to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AuditDestinationARN"`: The Amazon Resource Name (ARN) of the storage used for audit
logs.
- `"CacheAttributes"`: Specifies refresh cache information for the file share.
- `"ClientList"`: The list of clients that are allowed to access the S3 File Gateway. The
list must contain either valid IP addresses or valid CIDR blocks.
- `"DefaultStorageClass"`: The default storage class for objects put into an Amazon S3
bucket by the S3 File Gateway. The default value is S3_STANDARD. Optional. Valid Values:
S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA
- `"FileShareName"`: The name of the file share. Optional. FileShareName must be set if
an S3 prefix name is set in LocationARN, or if an access point or access point alias is
used.
- `"GuessMIMETypeEnabled"`: A value that enables guessing of the MIME type for uploaded
objects based on file extensions. Set this value to true to enable MIME type guessing,
otherwise set to false. The default value is true. Valid Values: true | false
- `"KMSEncrypted"`: Set to true to use Amazon S3 server-side encryption with your own KMS
key, or false to use a key managed by Amazon S3. Optional. Valid Values: true | false
- `"KMSKey"`: The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs.
This value can only be set when KMSEncrypted is true. Optional.
- `"NFSFileShareDefaults"`: The default values for the file share. Optional.
- `"NotificationPolicy"`: The notification policy of the file share. SettlingTimeInSeconds
controls the number of seconds to wait after the last point in time a client wrote to a
file before generating an ObjectUploaded notification. Because clients can make many small
writes to files, it's best to set this parameter for as long as possible to avoid
generating multiple notifications for the same file in a small time period.
SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3,
only the timing of the notification. The following example sets NotificationPolicy on with
SettlingTimeInSeconds set to 60. {\"Upload\": {\"SettlingTimeInSeconds\": 60}} The
following example sets NotificationPolicy off. {}
- `"ObjectACL"`: A value that sets the access control list (ACL) permission for objects in
the S3 bucket that a S3 File Gateway puts objects into. The default value is private.
- `"ReadOnly"`: A value that sets the write status of a file share. Set this value to true
to set the write status to read-only, otherwise set to false. Valid Values: true | false
- `"RequesterPays"`: A value that sets who pays the cost of the request and the cost
associated with data download from the S3 bucket. If this value is set to true, the
requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner
always pays the cost of storing data. RequesterPays is a configuration for the S3 bucket
that backs the file share, so make sure that the configuration on the file share is the
same as the S3 bucket configuration. Valid Values: true | false
- `"Squash"`: The user mapped to anonymous user. Valid values are the following:
RootSquash: Only root is mapped to anonymous user. NoSquash: No one is mapped to
anonymous user. AllSquash: Everyone is mapped to anonymous user.
"""
function update_nfsfile_share(
FileShareARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"UpdateNFSFileShare",
Dict{String,Any}("FileShareARN" => FileShareARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_nfsfile_share(
FileShareARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"UpdateNFSFileShare",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("FileShareARN" => FileShareARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_smbfile_share(file_share_arn)
update_smbfile_share(file_share_arn, params::Dict{String,<:Any})
Updates a Server Message Block (SMB) file share. This operation is only supported for S3
File Gateways. To leave a file share field unchanged, set the corresponding input field to
null. File gateways require Security Token Service (Amazon Web Services STS) to be
activated to enable you to create a file share. Make sure that Amazon Web Services STS is
activated in the Amazon Web Services Region you are creating your file gateway in. If
Amazon Web Services STS is not activated in this Amazon Web Services Region, activate it.
For information about how to activate Amazon Web Services STS, see Activating and
deactivating Amazon Web Services STS in an Amazon Web Services Region in the Identity and
Access Management User Guide. File gateways don't support creating hard or symbolic links
on a file share.
# Arguments
- `file_share_arn`: The Amazon Resource Name (ARN) of the SMB file share that you want to
update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccessBasedEnumeration"`: The files and folders on this share will only be visible to
users with read access.
- `"AdminUserList"`: A list of users or groups in the Active Directory that have
administrator rights to the file share. A group must be prefixed with the @ character.
Acceptable formats include: DOMAINUser1, user1, @group1, and @DOMAINgroup1. Can only be set
if Authentication is set to ActiveDirectory.
- `"AuditDestinationARN"`: The Amazon Resource Name (ARN) of the storage used for audit
logs.
- `"CacheAttributes"`: Specifies refresh cache information for the file share.
- `"CaseSensitivity"`: The case of an object name in an Amazon S3 bucket. For
ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway
determines the case sensitivity. The default value is ClientSpecified.
- `"DefaultStorageClass"`: The default storage class for objects put into an Amazon S3
bucket by the S3 File Gateway. The default value is S3_STANDARD. Optional. Valid Values:
S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA
- `"FileShareName"`: The name of the file share. Optional. FileShareName must be set if
an S3 prefix name is set in LocationARN, or if an access point or access point alias is
used.
- `"GuessMIMETypeEnabled"`: A value that enables guessing of the MIME type for uploaded
objects based on file extensions. Set this value to true to enable MIME type guessing,
otherwise set to false. The default value is true. Valid Values: true | false
- `"InvalidUserList"`: A list of users or groups in the Active Directory that are not
allowed to access the file share. A group must be prefixed with the @ character. Acceptable
formats include: DOMAINUser1, user1, @group1, and @DOMAINgroup1. Can only be set if
Authentication is set to ActiveDirectory.
- `"KMSEncrypted"`: Set to true to use Amazon S3 server-side encryption with your own KMS
key, or false to use a key managed by Amazon S3. Optional. Valid Values: true | false
- `"KMSKey"`: The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs.
This value can only be set when KMSEncrypted is true. Optional.
- `"NotificationPolicy"`: The notification policy of the file share. SettlingTimeInSeconds
controls the number of seconds to wait after the last point in time a client wrote to a
file before generating an ObjectUploaded notification. Because clients can make many small
writes to files, it's best to set this parameter for as long as possible to avoid
generating multiple notifications for the same file in a small time period.
SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3,
only the timing of the notification. The following example sets NotificationPolicy on with
SettlingTimeInSeconds set to 60. {\"Upload\": {\"SettlingTimeInSeconds\": 60}} The
following example sets NotificationPolicy off. {}
- `"ObjectACL"`: A value that sets the access control list (ACL) permission for objects in
the S3 bucket that a S3 File Gateway puts objects into. The default value is private.
- `"OplocksEnabled"`: Specifies whether opportunistic locking is enabled for the SMB file
share. Enabling opportunistic locking on case-sensitive shares is not recommended for
workloads that involve access to files with the same name in different case. Valid Values:
true | false
- `"ReadOnly"`: A value that sets the write status of a file share. Set this value to true
to set write status to read-only, otherwise set to false. Valid Values: true | false
- `"RequesterPays"`: A value that sets who pays the cost of the request and the cost
associated with data download from the S3 bucket. If this value is set to true, the
requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner
always pays the cost of storing data. RequesterPays is a configuration for the S3 bucket
that backs the file share, so make sure that the configuration on the file share is the
same as the S3 bucket configuration. Valid Values: true | false
- `"SMBACLEnabled"`: Set this value to true to enable access control list (ACL) on the SMB
file share. Set it to false to map file and directory permissions to the POSIX permissions.
For more information, see Using Microsoft Windows ACLs to control access to an SMB file
share in the Storage Gateway User Guide. Valid Values: true | false
- `"ValidUserList"`: A list of users or groups in the Active Directory that are allowed to
access the file share. A group must be prefixed with the @ character. Acceptable formats
include: DOMAINUser1, user1, @group1, and @DOMAINgroup1. Can only be set if Authentication
is set to ActiveDirectory.
"""
function update_smbfile_share(
FileShareARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"UpdateSMBFileShare",
Dict{String,Any}("FileShareARN" => FileShareARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_smbfile_share(
FileShareARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"UpdateSMBFileShare",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("FileShareARN" => FileShareARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_smbfile_share_visibility(file_shares_visible, gateway_arn)
update_smbfile_share_visibility(file_shares_visible, gateway_arn, params::Dict{String,<:Any})
Controls whether the shares on an S3 File Gateway are visible in a net view or browse list.
The operation is only supported for S3 File Gateways.
# Arguments
- `file_shares_visible`: The shares on this gateway appear when listing shares.
- `gateway_arn`:
"""
function update_smbfile_share_visibility(
FileSharesVisible, GatewayARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"UpdateSMBFileShareVisibility",
Dict{String,Any}(
"FileSharesVisible" => FileSharesVisible, "GatewayARN" => GatewayARN
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_smbfile_share_visibility(
FileSharesVisible,
GatewayARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"UpdateSMBFileShareVisibility",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FileSharesVisible" => FileSharesVisible, "GatewayARN" => GatewayARN
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_smblocal_groups(gateway_arn, smblocal_groups)
update_smblocal_groups(gateway_arn, smblocal_groups, params::Dict{String,<:Any})
Updates the list of Active Directory users and groups that have special permissions for SMB
file shares on the gateway.
# Arguments
- `gateway_arn`:
- `smblocal_groups`: A list of Active Directory users and groups that you want to grant
special permissions for SMB file shares on the gateway.
"""
function update_smblocal_groups(
GatewayARN, SMBLocalGroups; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"UpdateSMBLocalGroups",
Dict{String,Any}("GatewayARN" => GatewayARN, "SMBLocalGroups" => SMBLocalGroups);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_smblocal_groups(
GatewayARN,
SMBLocalGroups,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"UpdateSMBLocalGroups",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GatewayARN" => GatewayARN, "SMBLocalGroups" => SMBLocalGroups
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_smbsecurity_strategy(gateway_arn, smbsecurity_strategy)
update_smbsecurity_strategy(gateway_arn, smbsecurity_strategy, params::Dict{String,<:Any})
Updates the SMB security strategy level for an Amazon S3 file gateway. This action is only
supported for Amazon S3 file gateways. For information about configuring this setting
using the Amazon Web Services console, see Setting a security level for your gateway in the
Amazon S3 File Gateway User Guide. A higher security strategy level can affect performance
of the gateway.
# Arguments
- `gateway_arn`:
- `smbsecurity_strategy`: Specifies the type of security strategy. ClientSpecified: If you
choose this option, requests are established based on what is negotiated by the client.
This option is recommended when you want to maximize compatibility across different clients
in your environment. Supported only for S3 File Gateway. MandatorySigning: If you choose
this option, File Gateway only allows connections from SMBv2 or SMBv3 clients that have
signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows
Server 2008 or newer. MandatoryEncryption: If you choose this option, File Gateway only
allows connections from SMBv3 clients that have encryption enabled. This option is
recommended for environments that handle sensitive data. This option works with SMB clients
on Microsoft Windows 8, Windows Server 2012 or newer. MandatoryEncryptionNoAes128: If you
choose this option, File Gateway only allows connections from SMBv3 clients that use
256-bit AES encryption algorithms. 128-bit algorithms are not allowed. This option is
recommended for environments that handle sensitive data. It works with SMB clients on
Microsoft Windows 8, Windows Server 2012, or later.
"""
function update_smbsecurity_strategy(
GatewayARN, SMBSecurityStrategy; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"UpdateSMBSecurityStrategy",
Dict{String,Any}(
"GatewayARN" => GatewayARN, "SMBSecurityStrategy" => SMBSecurityStrategy
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_smbsecurity_strategy(
GatewayARN,
SMBSecurityStrategy,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"UpdateSMBSecurityStrategy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GatewayARN" => GatewayARN, "SMBSecurityStrategy" => SMBSecurityStrategy
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_snapshot_schedule(recurrence_in_hours, start_at, volume_arn)
update_snapshot_schedule(recurrence_in_hours, start_at, volume_arn, params::Dict{String,<:Any})
Updates a snapshot schedule configured for a gateway volume. This operation is only
supported in the cached volume and stored volume gateway types. The default snapshot
schedule for volume is once every 24 hours, starting at the creation time of the volume.
You can use this API to change the snapshot schedule configured for the volume. In the
request you must identify the gateway volume whose snapshot schedule you want to update,
and the schedule information, including when you want the snapshot to begin on a day and
the frequency (in hours) of snapshots.
# Arguments
- `recurrence_in_hours`: Frequency of snapshots. Specify the number of hours between
snapshots.
- `start_at`: The hour of the day at which the snapshot schedule begins represented as hh,
where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.
- `volume_arn`: The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation
to return a list of gateway volumes.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: Optional description of the snapshot that overwrites the existing
description.
- `"Tags"`: A list of up to 50 tags that can be assigned to a snapshot. Each tag is a
key-value pair. Valid characters for key and value are letters, spaces, and numbers
representable in UTF-8 format, and the following special characters: + - = . _ : / @. The
maximum length of a tag's key is 128 characters, and the maximum length for a tag's value
is 256.
"""
function update_snapshot_schedule(
RecurrenceInHours, StartAt, VolumeARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"UpdateSnapshotSchedule",
Dict{String,Any}(
"RecurrenceInHours" => RecurrenceInHours,
"StartAt" => StartAt,
"VolumeARN" => VolumeARN,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_snapshot_schedule(
RecurrenceInHours,
StartAt,
VolumeARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"UpdateSnapshotSchedule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"RecurrenceInHours" => RecurrenceInHours,
"StartAt" => StartAt,
"VolumeARN" => VolumeARN,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_vtldevice_type(device_type, vtldevice_arn)
update_vtldevice_type(device_type, vtldevice_arn, params::Dict{String,<:Any})
Updates the type of medium changer in a tape gateway. When you activate a tape gateway, you
select a medium changer type for the tape gateway. This operation enables you to select a
different type of medium changer after a tape gateway is activated. This operation is only
supported in the tape gateway type.
# Arguments
- `device_type`: The type of medium changer you want to select. Valid Values: STK-L700 |
AWS-Gateway-VTL | IBM-03584L32-0402
- `vtldevice_arn`: The Amazon Resource Name (ARN) of the medium changer you want to select.
"""
function update_vtldevice_type(
DeviceType, VTLDeviceARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return storage_gateway(
"UpdateVTLDeviceType",
Dict{String,Any}("DeviceType" => DeviceType, "VTLDeviceARN" => VTLDeviceARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_vtldevice_type(
DeviceType,
VTLDeviceARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return storage_gateway(
"UpdateVTLDeviceType",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DeviceType" => DeviceType, "VTLDeviceARN" => VTLDeviceARN
),
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 | 67235 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: sts
using AWS.Compat
using AWS.UUIDs
"""
assume_role(role_arn, role_session_name)
assume_role(role_arn, role_session_name, params::Dict{String,<:Any})
Returns a set of temporary security credentials that you can use to access Amazon Web
Services resources. These temporary credentials consist of an access key ID, a secret
access key, and a security token. Typically, you use AssumeRole within your account or for
cross-account access. For a comparison of AssumeRole with other API operations that produce
temporary credentials, see Requesting Temporary Security Credentials and Comparing the
Amazon Web Services STS API operations in the IAM User Guide. Permissions The temporary
security credentials created by AssumeRole can be used to make API calls to any Amazon Web
Services service with the following exception: You cannot call the Amazon Web Services STS
GetFederationToken or GetSessionToken API operations. (Optional) You can pass inline or
managed session policies to this operation. You can pass a single JSON policy document to
use as an inline session policy. You can also specify up to 10 managed policy Amazon
Resource Names (ARNs) to use as managed session policies. The plaintext that you use for
both inline and managed session policies can't exceed 2,048 characters. Passing policies to
this operation returns new temporary credentials. The resulting session's permissions are
the intersection of the role's identity-based policy and the session policies. You can use
the role's temporary credentials in subsequent Amazon Web Services API calls to access
resources in the account that owns the role. You cannot use session policies to grant more
permissions than those allowed by the identity-based policy of the role that is being
assumed. For more information, see Session Policies in the IAM User Guide. When you create
a role, you create two policies: a role trust policy that specifies who can assume the
role, and a permissions policy that specifies what can be done with the role. You specify
the trusted principal that is allowed to assume the role in the role trust policy. To
assume a role from a different account, your Amazon Web Services account must be trusted by
the role. The trust relationship is defined in the role's trust policy when the role is
created. That trust policy states which accounts are allowed to delegate that access to
users in the account. A user who wants to access a role in a different account must also
have permissions that are delegated from the account administrator. The administrator must
attach a policy that allows the user to call AssumeRole for the ARN of the role in the
other account. To allow a user to assume a role in the same account, you can do either of
the following: Attach a policy to the user that allows the user to call AssumeRole (as
long as the role's trust policy trusts the account). Add the user as a principal directly
in the role's trust policy. You can do either because the role’s trust policy acts as
an IAM resource-based policy. When a resource-based policy grants access to a principal in
the same account, no additional identity-based policy is required. For more information
about trust policies and resource-based policies, see IAM Policies in the IAM User Guide.
Tags (Optional) You can pass tag key-value pairs to your session. These tags are called
session tags. For more information about session tags, see Passing Session Tags in STS in
the IAM User Guide. An administrator must grant you the permissions necessary to pass
session tags. The administrator can also create granular permissions to allow you to pass
only specific session tags. For more information, see Tutorial: Using Tags for
Attribute-Based Access Control in the IAM User Guide. You can set the session tags as
transitive. Transitive tags persist during role chaining. For more information, see
Chaining Roles with Session Tags in the IAM User Guide. Using MFA with AssumeRole
(Optional) You can include multi-factor authentication (MFA) information when you call
AssumeRole. This is useful for cross-account scenarios to ensure that the user that assumes
the role has been authenticated with an Amazon Web Services MFA device. In that scenario,
the trust policy of the role being assumed includes a condition that tests for MFA
authentication. If the caller does not include valid MFA information, the request to assume
the role is denied. The condition in a trust policy that tests for MFA authentication might
look like the following example. \"Condition\": {\"Bool\":
{\"aws:MultiFactorAuthPresent\": true}} For more information, see Configuring
MFA-Protected API Access in the IAM User Guide guide. To use MFA with AssumeRole, you pass
values for the SerialNumber and TokenCode parameters. The SerialNumber value identifies the
user's hardware or virtual MFA device. The TokenCode is the time-based one-time password
(TOTP) that the MFA device produces.
# Arguments
- `role_arn`: The Amazon Resource Name (ARN) of the role to assume.
- `role_session_name`: An identifier for the assumed role session. Use the role session
name to uniquely identify a session when the same role is assumed by different principals
or for different reasons. In cross-account scenarios, the role session name is visible to,
and can be logged by the account that owns the role. The role session name is also used in
the ARN of the assumed role principal. This means that subsequent cross-account API
requests that use the temporary security credentials will expose the role session name to
the external account in their CloudTrail logs. The regex used to validate this parameter is
a string of characters consisting of upper- and lower-case alphanumeric characters with no
spaces. You can also include underscores or any of the following characters: =,.@-
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DurationSeconds"`: The duration, in seconds, of the role session. The value specified
can range from 900 seconds (15 minutes) up to the maximum session duration set for the
role. The maximum session duration setting can have a value from 1 hour to 12 hours. If you
specify a value higher than this setting or the administrator setting (whichever is lower),
the operation fails. For example, if you specify a session duration of 12 hours, but your
administrator set the maximum session duration to 6 hours, your operation fails. Role
chaining limits your Amazon Web Services CLI or Amazon Web Services API role session to a
maximum of one hour. When you use the AssumeRole API operation to assume a role, you can
specify the duration of your role session with the DurationSeconds parameter. You can
specify a parameter value of up to 43200 seconds (12 hours), depending on the maximum
session duration setting for your role. However, if you assume a role using role chaining
and provide a DurationSeconds parameter value greater than one hour, the operation fails.
To learn how to view the maximum value for your role, see View the Maximum Session Duration
Setting for a Role in the IAM User Guide. By default, the value is set to 3600 seconds.
The DurationSeconds parameter is separate from the duration of a console session that you
might request using the returned credentials. The request to the federation endpoint for a
console sign-in token takes a SessionDuration parameter that specifies the maximum length
of the console session. For more information, see Creating a URL that Enables Federated
Users to Access the Amazon Web Services Management Console in the IAM User Guide.
- `"ExternalId"`: A unique identifier that might be required when you assume a role in
another account. If the administrator of the account to which the role belongs provided you
with an external ID, then provide that value in the ExternalId parameter. This value can be
any string, such as a passphrase or account number. A cross-account role is usually set up
to trust everyone in an account. Therefore, the administrator of the trusting account might
send an external ID to the administrator of the trusted account. That way, only someone
with the ID can assume the role, rather than everyone in the account. For more information
about the external ID, see How to Use an External ID When Granting Access to Your Amazon
Web Services Resources to a Third Party in the IAM User Guide. The regex used to validate
this parameter is a string of characters consisting of upper- and lower-case alphanumeric
characters with no spaces. You can also include underscores or any of the following
characters: =,.@:/-
- `"Policy"`: An IAM policy in JSON format that you want to use as an inline session
policy. This parameter is optional. Passing policies to this operation returns new
temporary credentials. The resulting session's permissions are the intersection of the
role's identity-based policy and the session policies. You can use the role's temporary
credentials in subsequent Amazon Web Services API calls to access resources in the account
that owns the role. You cannot use session policies to grant more permissions than those
allowed by the identity-based policy of the role that is being assumed. For more
information, see Session Policies in the IAM User Guide. The plaintext that you use for
both inline and managed session policies can't exceed 2,048 characters. The JSON policy
characters can be any ASCII character from the space character to the end of the valid
character list (u0020 through u00FF). It can also include the tab (u0009), linefeed
(u000A), and carriage return (u000D) characters. An Amazon Web Services conversion
compresses the passed inline session policy, managed policy ARNs, and session tags into a
packed binary format that has a separate limit. Your request can fail for this limit even
if your plaintext meets the other requirements. The PackedPolicySize response element
indicates by percentage how close the policies and tags for your request are to the upper
size limit.
- `"PolicyArns"`: The Amazon Resource Names (ARNs) of the IAM managed policies that you
want to use as managed session policies. The policies must exist in the same account as the
role. This parameter is optional. You can provide up to 10 managed policy ARNs. However,
the plaintext that you use for both inline and managed session policies can't exceed 2,048
characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon
Web Services Service Namespaces in the Amazon Web Services General Reference. An Amazon
Web Services conversion compresses the passed inline session policy, managed policy ARNs,
and session tags into a packed binary format that has a separate limit. Your request can
fail for this limit even if your plaintext meets the other requirements. The
PackedPolicySize response element indicates by percentage how close the policies and tags
for your request are to the upper size limit. Passing policies to this operation returns
new temporary credentials. The resulting session's permissions are the intersection of the
role's identity-based policy and the session policies. You can use the role's temporary
credentials in subsequent Amazon Web Services API calls to access resources in the account
that owns the role. You cannot use session policies to grant more permissions than those
allowed by the identity-based policy of the role that is being assumed. For more
information, see Session Policies in the IAM User Guide.
- `"ProvidedContexts"`: A list of previously acquired trusted context assertions in the
format of a JSON array. The trusted context assertion is signed and encrypted by Amazon Web
Services STS. The following is an example of a ProvidedContext value that includes a single
trusted context assertion and the ARN of the context provider from which the trusted
context assertion was generated.
[{\"ProviderArn\":\"arn:aws:iam::aws:contextProvider/IdentityCenter\",\"ContextAssertion
\":\"trusted-context-assertion\"}]
- `"SerialNumber"`: The identification number of the MFA device that is associated with the
user who is making the AssumeRole call. Specify this value if the trust policy of the role
being assumed includes a condition that requires MFA authentication. The value is either
the serial number for a hardware device (such as GAHT12345678) or an Amazon Resource Name
(ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user). The regex used to
validate this parameter is a string of characters consisting of upper- and lower-case
alphanumeric characters with no spaces. You can also include underscores or any of the
following characters: =,.@-
- `"SourceIdentity"`: The source identity specified by the principal that is calling the
AssumeRole operation. You can require users to specify a source identity when they assume a
role. You do this by using the sts:SourceIdentity condition key in a role trust policy. You
can use source identity information in CloudTrail logs to determine who took actions with a
role. You can use the aws:SourceIdentity condition key to further control access to Amazon
Web Services resources based on the value of source identity. For more information about
using source identity, see Monitor and control actions taken with assumed roles in the IAM
User Guide. The regex used to validate this parameter is a string of characters consisting
of upper- and lower-case alphanumeric characters with no spaces. You can also include
underscores or any of the following characters: =,.@-. You cannot use a value that begins
with the text aws:. This prefix is reserved for Amazon Web Services internal use.
- `"Tags"`: A list of session tags that you want to pass. Each session tag consists of a
key name and an associated value. For more information about session tags, see Tagging
Amazon Web Services STS Sessions in the IAM User Guide. This parameter is optional. You can
pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters,
and the values can’t exceed 256 characters. For these and additional limits, see IAM and
STS Character Limits in the IAM User Guide. An Amazon Web Services conversion compresses
the passed inline session policy, managed policy ARNs, and session tags into a packed
binary format that has a separate limit. Your request can fail for this limit even if your
plaintext meets the other requirements. The PackedPolicySize response element indicates by
percentage how close the policies and tags for your request are to the upper size limit.
You can pass a session tag with the same key as a tag that is already attached to the role.
When you do, session tags override a role tag with the same key. Tag key–value pairs are
not case sensitive, but case is preserved. This means that you cannot have separate
Department and department tag keys. Assume that the role has the Department=Marketing tag
and you pass the department=engineering session tag. Department and department are not
saved as separate tags, and the session tag passed in the request takes precedence over the
role tag. Additionally, if you used temporary credentials to perform this operation, the
new session inherits any transitive session tags from the calling session. If you pass a
session tag with the same key as an inherited tag, the operation fails. To view the
inherited tags for a session, see the CloudTrail logs. For more information, see Viewing
Session Tags in CloudTrail in the IAM User Guide.
- `"TokenCode"`: The value provided by the MFA device, if the trust policy of the role
being assumed requires MFA. (In other words, if the policy includes a condition that tests
for MFA). If the role being assumed requires MFA and if the TokenCode value is missing or
expired, the AssumeRole call returns an \"access denied\" error. The format for this
parameter, as described by its regex pattern, is a sequence of six numeric digits.
- `"TransitiveTagKeys"`: A list of keys for session tags that you want to set as
transitive. If you set a tag key as transitive, the corresponding key and value passes to
subsequent sessions in a role chain. For more information, see Chaining Roles with Session
Tags in the IAM User Guide. This parameter is optional. When you set session tags as
transitive, the session policy and session tags packed binary limit is not affected. If you
choose not to specify a transitive tag key, then no tags are passed from this session to
any subsequent sessions.
"""
function assume_role(
RoleArn, RoleSessionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return sts(
"AssumeRole",
Dict{String,Any}("RoleArn" => RoleArn, "RoleSessionName" => RoleSessionName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function assume_role(
RoleArn,
RoleSessionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sts(
"AssumeRole",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"RoleArn" => RoleArn, "RoleSessionName" => RoleSessionName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
assume_role_with_saml(principal_arn, role_arn, samlassertion)
assume_role_with_saml(principal_arn, role_arn, samlassertion, params::Dict{String,<:Any})
Returns a set of temporary security credentials for users who have been authenticated via a
SAML authentication response. This operation provides a mechanism for tying an enterprise
identity store or directory to role-based Amazon Web Services access without user-specific
credentials or configuration. For a comparison of AssumeRoleWithSAML with the other API
operations that produce temporary credentials, see Requesting Temporary Security
Credentials and Comparing the Amazon Web Services STS API operations in the IAM User Guide.
The temporary security credentials returned by this operation consist of an access key ID,
a secret access key, and a security token. Applications can use these temporary security
credentials to sign calls to Amazon Web Services services. Session Duration By default,
the temporary security credentials created by AssumeRoleWithSAML last for one hour.
However, you can use the optional DurationSeconds parameter to specify the duration of your
session. Your role session lasts for the duration that you specify, or until the time
specified in the SAML authentication response's SessionNotOnOrAfter value, whichever is
shorter. You can provide a DurationSeconds value from 900 seconds (15 minutes) up to the
maximum session duration setting for the role. This setting can have a value from 1 hour to
12 hours. To learn how to view the maximum value for your role, see View the Maximum
Session Duration Setting for a Role in the IAM User Guide. The maximum session duration
limit applies when you use the AssumeRole* API operations or the assume-role* CLI commands.
However the limit 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. Role chaining limits your
CLI or Amazon Web Services API role session to a maximum of one hour. When you use the
AssumeRole API operation to assume a role, you can specify the duration of your role
session with the DurationSeconds parameter. You can specify a parameter value of up to
43200 seconds (12 hours), depending on the maximum session duration setting for your role.
However, if you assume a role using role chaining and provide a DurationSeconds parameter
value greater than one hour, the operation fails. Permissions The temporary security
credentials created by AssumeRoleWithSAML can be used to make API calls to any Amazon Web
Services service with the following exception: you cannot call the STS GetFederationToken
or GetSessionToken API operations. (Optional) You can pass inline or managed session
policies to this operation. You can pass a single JSON policy document to use as an inline
session policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs)
to use as managed session policies. The plaintext that you use for both inline and managed
session policies can't exceed 2,048 characters. Passing policies to this operation returns
new temporary credentials. The resulting session's permissions are the intersection of the
role's identity-based policy and the session policies. You can use the role's temporary
credentials in subsequent Amazon Web Services API calls to access resources in the account
that owns the role. You cannot use session policies to grant more permissions than those
allowed by the identity-based policy of the role that is being assumed. For more
information, see Session Policies in the IAM User Guide. Calling AssumeRoleWithSAML does
not require the use of Amazon Web Services security credentials. The identity of the caller
is validated by using keys in the metadata document that is uploaded for the SAML provider
entity for your identity provider. Calling AssumeRoleWithSAML can result in an entry in
your CloudTrail logs. The entry includes the value in the NameID element of the SAML
assertion. We recommend that you use a NameIDType that is not associated with any
personally identifiable information (PII). For example, you could instead use the
persistent identifier (urn:oasis:names:tc:SAML:2.0:nameid-format:persistent). Tags
(Optional) You can configure your IdP to pass attributes into your SAML assertion as
session tags. Each session tag consists of a key name and an associated value. For more
information about session tags, see Passing Session Tags in STS in the IAM User Guide. You
can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128
characters and the values can’t exceed 256 characters. For these and additional limits,
see IAM and STS Character Limits in the IAM User Guide. An Amazon Web Services conversion
compresses the passed inline session policy, managed policy ARNs, and session tags into a
packed binary format that has a separate limit. Your request can fail for this limit even
if your plaintext meets the other requirements. The PackedPolicySize response element
indicates by percentage how close the policies and tags for your request are to the upper
size limit. You can pass a session tag with the same key as a tag that is attached to the
role. When you do, session tags override the role's tags with the same key. An
administrator must grant you the permissions necessary to pass session tags. The
administrator can also create granular permissions to allow you to pass only specific
session tags. For more information, see Tutorial: Using Tags for Attribute-Based Access
Control in the IAM User Guide. You can set the session tags as transitive. Transitive tags
persist during role chaining. For more information, see Chaining Roles with Session Tags in
the IAM User Guide. SAML Configuration Before your application can call
AssumeRoleWithSAML, you must configure your SAML identity provider (IdP) to issue the
claims required by Amazon Web Services. Additionally, you must use Identity and Access
Management (IAM) to create a SAML provider entity in your Amazon Web Services account that
represents your identity provider. You must also create an IAM role that specifies this
SAML provider in its trust policy. For more information, see the following resources:
About SAML 2.0-based Federation in the IAM User Guide. Creating SAML Identity Providers
in the IAM User Guide. Configuring a Relying Party and Claims in the IAM User Guide.
Creating a Role for SAML 2.0 Federation in the IAM User Guide.
# Arguments
- `principal_arn`: The Amazon Resource Name (ARN) of the SAML provider in IAM that
describes the IdP.
- `role_arn`: The Amazon Resource Name (ARN) of the role that the caller is assuming.
- `samlassertion`: The base64 encoded SAML authentication response provided by the IdP. For
more information, see Configuring a Relying Party and Adding Claims in the IAM User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DurationSeconds"`: The duration, in seconds, of the role session. Your role session
lasts for the duration that you specify for the DurationSeconds parameter, or until the
time specified in the SAML authentication response's SessionNotOnOrAfter value, whichever
is shorter. You can provide a DurationSeconds value from 900 seconds (15 minutes) up to the
maximum session duration setting for the role. This setting can have a value from 1 hour to
12 hours. If you specify a value higher than this setting, the operation fails. For
example, if you specify a session duration of 12 hours, but your administrator set the
maximum session duration to 6 hours, your operation fails. To learn how to view the maximum
value for your role, see View the Maximum Session Duration Setting for a Role in the IAM
User Guide. By default, the value is set to 3600 seconds. The DurationSeconds parameter
is separate from the duration of a console session that you might request using the
returned credentials. The request to the federation endpoint for a console sign-in token
takes a SessionDuration parameter that specifies the maximum length of the console session.
For more information, see Creating a URL that Enables Federated Users to Access the Amazon
Web Services Management Console in the IAM User Guide.
- `"Policy"`: An IAM policy in JSON format that you want to use as an inline session
policy. This parameter is optional. Passing policies to this operation returns new
temporary credentials. The resulting session's permissions are the intersection of the
role's identity-based policy and the session policies. You can use the role's temporary
credentials in subsequent Amazon Web Services API calls to access resources in the account
that owns the role. You cannot use session policies to grant more permissions than those
allowed by the identity-based policy of the role that is being assumed. For more
information, see Session Policies in the IAM User Guide. The plaintext that you use for
both inline and managed session policies can't exceed 2,048 characters. The JSON policy
characters can be any ASCII character from the space character to the end of the valid
character list (u0020 through u00FF). It can also include the tab (u0009), linefeed
(u000A), and carriage return (u000D) characters. An Amazon Web Services conversion
compresses the passed inline session policy, managed policy ARNs, and session tags into a
packed binary format that has a separate limit. Your request can fail for this limit even
if your plaintext meets the other requirements. The PackedPolicySize response element
indicates by percentage how close the policies and tags for your request are to the upper
size limit.
- `"PolicyArns"`: The Amazon Resource Names (ARNs) of the IAM managed policies that you
want to use as managed session policies. The policies must exist in the same account as the
role. This parameter is optional. You can provide up to 10 managed policy ARNs. However,
the plaintext that you use for both inline and managed session policies can't exceed 2,048
characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon
Web Services Service Namespaces in the Amazon Web Services General Reference. An Amazon
Web Services conversion compresses the passed inline session policy, managed policy ARNs,
and session tags into a packed binary format that has a separate limit. Your request can
fail for this limit even if your plaintext meets the other requirements. The
PackedPolicySize response element indicates by percentage how close the policies and tags
for your request are to the upper size limit. Passing policies to this operation returns
new temporary credentials. The resulting session's permissions are the intersection of the
role's identity-based policy and the session policies. You can use the role's temporary
credentials in subsequent Amazon Web Services API calls to access resources in the account
that owns the role. You cannot use session policies to grant more permissions than those
allowed by the identity-based policy of the role that is being assumed. For more
information, see Session Policies in the IAM User Guide.
"""
function assume_role_with_saml(
PrincipalArn, RoleArn, SAMLAssertion; aws_config::AbstractAWSConfig=global_aws_config()
)
return sts(
"AssumeRoleWithSAML",
Dict{String,Any}(
"PrincipalArn" => PrincipalArn,
"RoleArn" => RoleArn,
"SAMLAssertion" => SAMLAssertion,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function assume_role_with_saml(
PrincipalArn,
RoleArn,
SAMLAssertion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sts(
"AssumeRoleWithSAML",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PrincipalArn" => PrincipalArn,
"RoleArn" => RoleArn,
"SAMLAssertion" => SAMLAssertion,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
assume_role_with_web_identity(role_arn, role_session_name, web_identity_token)
assume_role_with_web_identity(role_arn, role_session_name, web_identity_token, params::Dict{String,<:Any})
Returns a set of temporary security credentials for users who have been authenticated in a
mobile or web application with a web identity provider. Example providers include the OAuth
2.0 providers Login with Amazon and Facebook, or any OpenID Connect-compatible identity
provider such as Google or Amazon Cognito federated identities. For mobile applications,
we recommend that you use Amazon Cognito. You can use Amazon Cognito with the Amazon Web
Services SDK for iOS Developer Guide and the Amazon Web Services SDK for Android Developer
Guide to uniquely identify a user. You can also supply the user with a consistent identity
throughout the lifetime of an application. To learn more about Amazon Cognito, see Amazon
Cognito identity pools in Amazon Cognito Developer Guide. Calling
AssumeRoleWithWebIdentity does not require the use of Amazon Web Services security
credentials. Therefore, you can distribute an application (for example, on mobile devices)
that requests temporary security credentials without including long-term Amazon Web
Services credentials in the application. You also don't need to deploy server-based proxy
services that use long-term Amazon Web Services credentials. Instead, the identity of the
caller is validated by using a token from the web identity provider. For a comparison of
AssumeRoleWithWebIdentity with the other API operations that produce temporary credentials,
see Requesting Temporary Security Credentials and Comparing the Amazon Web Services STS API
operations in the IAM User Guide. The temporary security credentials returned by this API
consist of an access key ID, a secret access key, and a security token. Applications can
use these temporary security credentials to sign calls to Amazon Web Services service API
operations. Session Duration By default, the temporary security credentials created by
AssumeRoleWithWebIdentity last for one hour. However, you can use the optional
DurationSeconds parameter to specify the duration of your session. You can provide a value
from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This
setting can have a value from 1 hour to 12 hours. To learn how to view the maximum value
for your role, see View the Maximum Session Duration Setting for a Role in the IAM User
Guide. The maximum session duration limit applies when you use the AssumeRole* API
operations or the assume-role* CLI commands. However the limit 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. Permissions The temporary security credentials created by
AssumeRoleWithWebIdentity can be used to make API calls to any Amazon Web Services service
with the following exception: you cannot call the STS GetFederationToken or GetSessionToken
API operations. (Optional) You can pass inline or managed session policies to this
operation. You can pass a single JSON policy document to use as an inline session policy.
You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as managed
session policies. The plaintext that you use for both inline and managed session policies
can't exceed 2,048 characters. Passing policies to this operation returns new temporary
credentials. The resulting session's permissions are the intersection of the role's
identity-based policy and the session policies. You can use the role's temporary
credentials in subsequent Amazon Web Services API calls to access resources in the account
that owns the role. You cannot use session policies to grant more permissions than those
allowed by the identity-based policy of the role that is being assumed. For more
information, see Session Policies in the IAM User Guide. Tags (Optional) You can
configure your IdP to pass attributes into your web identity token as session tags. Each
session tag consists of a key name and an associated value. For more information about
session tags, see Passing Session Tags in STS in the IAM User Guide. You can pass up to 50
session tags. The plaintext session tag keys can’t exceed 128 characters and the values
can’t exceed 256 characters. For these and additional limits, see IAM and STS Character
Limits in the IAM User Guide. An Amazon Web Services conversion compresses the passed
inline session policy, managed policy ARNs, and session tags into a packed binary format
that has a separate limit. Your request can fail for this limit even if your plaintext
meets the other requirements. The PackedPolicySize response element indicates by percentage
how close the policies and tags for your request are to the upper size limit. You can pass
a session tag with the same key as a tag that is attached to the role. When you do, the
session tag overrides the role tag with the same key. An administrator must grant you the
permissions necessary to pass session tags. The administrator can also create granular
permissions to allow you to pass only specific session tags. For more information, see
Tutorial: Using Tags for Attribute-Based Access Control in the IAM User Guide. You can set
the session tags as transitive. Transitive tags persist during role chaining. For more
information, see Chaining Roles with Session Tags in the IAM User Guide. Identities
Before your application can call AssumeRoleWithWebIdentity, you must have an identity token
from a supported identity provider and create a role that the application can assume. The
role that your application assumes must trust the identity provider that is associated with
the identity token. In other words, the identity provider must be specified in the role's
trust policy. Calling AssumeRoleWithWebIdentity can result in an entry in your CloudTrail
logs. The entry includes the Subject of the provided web identity token. We recommend that
you avoid using any personally identifiable information (PII) in this field. For example,
you could instead use a GUID or a pairwise identifier, as suggested in the OIDC
specification. For more information about how to use web identity federation and the
AssumeRoleWithWebIdentity API, see the following resources: Using Web Identity
Federation API Operations for Mobile Apps and Federation Through a Web-based Identity
Provider. Web Identity Federation Playground. Walk through the process of
authenticating through Login with Amazon, Facebook, or Google, getting temporary security
credentials, and then using those credentials to make a request to Amazon Web Services.
Amazon Web Services SDK for iOS Developer Guide and Amazon Web Services SDK for Android
Developer Guide. These toolkits contain sample apps that show how to invoke the identity
providers. The toolkits then show how to use the information from these providers to get
and use temporary security credentials. Web Identity Federation with Mobile
Applications. This article discusses web identity federation and shows an example of how to
use web identity federation to get access to content in Amazon S3.
# Arguments
- `role_arn`: The Amazon Resource Name (ARN) of the role that the caller is assuming.
- `role_session_name`: An identifier for the assumed role session. Typically, you pass the
name or identifier that is associated with the user who is using your application. That
way, the temporary security credentials that your application will use are associated with
that user. This session name is included as part of the ARN and assumed role ID in the
AssumedRoleUser response element. The regex used to validate this parameter is a string of
characters consisting of upper- and lower-case alphanumeric characters with no spaces. You
can also include underscores or any of the following characters: =,.@-
- `web_identity_token`: The OAuth 2.0 access token or OpenID Connect ID token that is
provided by the identity provider. Your application must get this token by authenticating
the user who is using your application with a web identity provider before the application
makes an AssumeRoleWithWebIdentity call. Only tokens with RSA algorithms (RS256) are
supported.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DurationSeconds"`: The duration, in seconds, of the role session. The value can range
from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This
setting can have a value from 1 hour to 12 hours. If you specify a value higher than this
setting, the operation fails. For example, if you specify a session duration of 12 hours,
but your administrator set the maximum session duration to 6 hours, your operation fails.
To learn how to view the maximum value for your role, see View the Maximum Session Duration
Setting for a Role in the IAM User Guide. By default, the value is set to 3600 seconds.
The DurationSeconds parameter is separate from the duration of a console session that you
might request using the returned credentials. The request to the federation endpoint for a
console sign-in token takes a SessionDuration parameter that specifies the maximum length
of the console session. For more information, see Creating a URL that Enables Federated
Users to Access the Amazon Web Services Management Console in the IAM User Guide.
- `"Policy"`: An IAM policy in JSON format that you want to use as an inline session
policy. This parameter is optional. Passing policies to this operation returns new
temporary credentials. The resulting session's permissions are the intersection of the
role's identity-based policy and the session policies. You can use the role's temporary
credentials in subsequent Amazon Web Services API calls to access resources in the account
that owns the role. You cannot use session policies to grant more permissions than those
allowed by the identity-based policy of the role that is being assumed. For more
information, see Session Policies in the IAM User Guide. The plaintext that you use for
both inline and managed session policies can't exceed 2,048 characters. The JSON policy
characters can be any ASCII character from the space character to the end of the valid
character list (u0020 through u00FF). It can also include the tab (u0009), linefeed
(u000A), and carriage return (u000D) characters. An Amazon Web Services conversion
compresses the passed inline session policy, managed policy ARNs, and session tags into a
packed binary format that has a separate limit. Your request can fail for this limit even
if your plaintext meets the other requirements. The PackedPolicySize response element
indicates by percentage how close the policies and tags for your request are to the upper
size limit.
- `"PolicyArns"`: The Amazon Resource Names (ARNs) of the IAM managed policies that you
want to use as managed session policies. The policies must exist in the same account as the
role. This parameter is optional. You can provide up to 10 managed policy ARNs. However,
the plaintext that you use for both inline and managed session policies can't exceed 2,048
characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon
Web Services Service Namespaces in the Amazon Web Services General Reference. An Amazon
Web Services conversion compresses the passed inline session policy, managed policy ARNs,
and session tags into a packed binary format that has a separate limit. Your request can
fail for this limit even if your plaintext meets the other requirements. The
PackedPolicySize response element indicates by percentage how close the policies and tags
for your request are to the upper size limit. Passing policies to this operation returns
new temporary credentials. The resulting session's permissions are the intersection of the
role's identity-based policy and the session policies. You can use the role's temporary
credentials in subsequent Amazon Web Services API calls to access resources in the account
that owns the role. You cannot use session policies to grant more permissions than those
allowed by the identity-based policy of the role that is being assumed. For more
information, see Session Policies in the IAM User Guide.
- `"ProviderId"`: The fully qualified host component of the domain name of the OAuth 2.0
identity provider. Do not specify this value for an OpenID Connect identity provider.
Currently www.amazon.com and graph.facebook.com are the only supported identity providers
for OAuth 2.0 access tokens. Do not include URL schemes and port numbers. Do not specify
this value for OpenID Connect ID tokens.
"""
function assume_role_with_web_identity(
RoleArn,
RoleSessionName,
WebIdentityToken;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sts(
"AssumeRoleWithWebIdentity",
Dict{String,Any}(
"RoleArn" => RoleArn,
"RoleSessionName" => RoleSessionName,
"WebIdentityToken" => WebIdentityToken,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function assume_role_with_web_identity(
RoleArn,
RoleSessionName,
WebIdentityToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sts(
"AssumeRoleWithWebIdentity",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"RoleArn" => RoleArn,
"RoleSessionName" => RoleSessionName,
"WebIdentityToken" => WebIdentityToken,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
decode_authorization_message(encoded_message)
decode_authorization_message(encoded_message, params::Dict{String,<:Any})
Decodes additional information about the authorization status of a request from an encoded
message returned in response to an Amazon Web Services request. For example, if a user is
not authorized to perform an operation that he or she has requested, the request returns a
Client.UnauthorizedOperation response (an HTTP 403 response). Some Amazon Web Services
operations additionally return an encoded message that can provide details about this
authorization failure. Only certain Amazon Web Services operations return an encoded
authorization message. The documentation for an individual operation indicates whether that
operation returns an encoded message in addition to returning an HTTP code. The message is
encoded because the details of the authorization status can contain privileged information
that the user who requested the operation should not see. To decode an authorization status
message, a user must be granted permissions through an IAM policy to request the
DecodeAuthorizationMessage (sts:DecodeAuthorizationMessage) action. The decoded message
includes the following type of information: Whether the request was denied due to an
explicit deny or due to the absence of an explicit allow. For more information, see
Determining Whether a Request is Allowed or Denied in the IAM User Guide. The principal
who made the request. The requested action. The requested resource. The values of
condition keys in the context of the user's request.
# Arguments
- `encoded_message`: The encoded message that was returned with the response.
"""
function decode_authorization_message(
EncodedMessage; aws_config::AbstractAWSConfig=global_aws_config()
)
return sts(
"DecodeAuthorizationMessage",
Dict{String,Any}("EncodedMessage" => EncodedMessage);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function decode_authorization_message(
EncodedMessage,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sts(
"DecodeAuthorizationMessage",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EncodedMessage" => EncodedMessage), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_access_key_info(access_key_id)
get_access_key_info(access_key_id, params::Dict{String,<:Any})
Returns the account identifier for the specified access key ID. Access keys consist of two
parts: an access key ID (for example, AKIAIOSFODNN7EXAMPLE) and a secret access key (for
example, wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY). For more information about access keys,
see Managing Access Keys for IAM Users in the IAM User Guide. When you pass an access key
ID to this operation, it returns the ID of the Amazon Web Services account to which the
keys belong. Access key IDs beginning with AKIA are long-term credentials for an IAM user
or the Amazon Web Services account root user. Access key IDs beginning with ASIA are
temporary credentials that are created using STS operations. If the account in the response
belongs to you, you can sign in as the root user and review your root user access keys.
Then, you can pull a credentials report to learn which IAM user owns the keys. To learn who
requested the temporary credentials for an ASIA access key, view the STS events in your
CloudTrail logs in the IAM User Guide. This operation does not indicate the state of the
access key. The key might be active, inactive, or deleted. Active keys might not have
permissions to perform an operation. Providing a deleted access key might return an error
that the key doesn't exist.
# 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 lowercase letter or
digit.
"""
function get_access_key_info(AccessKeyId; aws_config::AbstractAWSConfig=global_aws_config())
return sts(
"GetAccessKeyInfo",
Dict{String,Any}("AccessKeyId" => AccessKeyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_access_key_info(
AccessKeyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return sts(
"GetAccessKeyInfo",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AccessKeyId" => AccessKeyId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_caller_identity()
get_caller_identity(params::Dict{String,<:Any})
Returns details about the IAM user or role whose credentials are used to call the
operation. No permissions are required to perform this operation. If an administrator
attaches a policy to your identity that explicitly denies access to the
sts:GetCallerIdentity action, you can still perform this operation. Permissions are not
required because the same information is returned when access is denied. To view an example
response, see I Am Not Authorized to Perform: iam:DeleteVirtualMFADevice in the IAM User
Guide.
"""
function get_caller_identity(; aws_config::AbstractAWSConfig=global_aws_config())
return sts("GetCallerIdentity"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_caller_identity(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sts(
"GetCallerIdentity", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_federation_token(name)
get_federation_token(name, params::Dict{String,<:Any})
Returns a set of temporary security credentials (consisting of an access key ID, a secret
access key, and a security token) for a user. A typical use is in a proxy application that
gets temporary security credentials on behalf of distributed applications inside a
corporate network. You must call the GetFederationToken operation using the long-term
security credentials of an IAM user. As a result, this call is appropriate in contexts
where those credentials can be safeguarded, usually in a server-based application. For a
comparison of GetFederationToken with the other API operations that produce temporary
credentials, see Requesting Temporary Security Credentials and Comparing the Amazon Web
Services STS API operations in the IAM User Guide. Although it is possible to call
GetFederationToken using the security credentials of an Amazon Web Services account root
user rather than an IAM user that you create for the purpose of a proxy application, we do
not recommend it. For more information, see Safeguard your root user credentials and don't
use them for everyday tasks in the IAM User Guide. You can create a mobile-based or
browser-based app that can authenticate users using a web identity provider like Login with
Amazon, Facebook, Google, or an OpenID Connect-compatible identity provider. In this case,
we recommend that you use Amazon Cognito or AssumeRoleWithWebIdentity. For more
information, see Federation Through a Web-based Identity Provider in the IAM User Guide.
Session duration The temporary credentials are valid for the specified duration, from 900
seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours). The default session
duration is 43,200 seconds (12 hours). Temporary credentials obtained by using the root
user credentials have a maximum duration of 3,600 seconds (1 hour). Permissions You can
use the temporary credentials created by GetFederationToken in any Amazon Web Services
service with the following exceptions: You cannot call any IAM operations using the CLI
or the Amazon Web Services API. This limitation does not apply to console sessions. You
cannot call any STS operations except GetCallerIdentity. You can use temporary
credentials for single sign-on (SSO) to the console. You must pass an inline or managed
session policy to this operation. You can pass a single JSON policy document to use as an
inline session policy. You can also specify up to 10 managed policy Amazon Resource Names
(ARNs) to use as managed session policies. The plaintext that you use for both inline and
managed session policies can't exceed 2,048 characters. Though the session policy
parameters are optional, if you do not pass a policy, then the resulting federated user
session has no permissions. When you pass session policies, the session permissions are the
intersection of the IAM user policies and the session policies that you pass. This gives
you a way to further restrict the permissions for a federated user. You cannot use session
policies to grant more permissions than those that are defined in the permissions policy of
the IAM user. For more information, see Session Policies in the IAM User Guide. For
information about using GetFederationToken to create temporary security credentials, see
GetFederationToken—Federation Through a Custom Identity Broker. You can use the
credentials to access a resource that has a resource-based policy. If that policy
specifically references the federated user session in the Principal element of the policy,
the session has the permissions allowed by the policy. These permissions are granted in
addition to the permissions granted by the session policies. Tags (Optional) You can pass
tag key-value pairs to your session. These are called session tags. For more information
about session tags, see Passing Session Tags in STS in the IAM User Guide. You can create
a mobile-based or browser-based app that can authenticate users using a web identity
provider like Login with Amazon, Facebook, Google, or an OpenID Connect-compatible identity
provider. In this case, we recommend that you use Amazon Cognito or
AssumeRoleWithWebIdentity. For more information, see Federation Through a Web-based
Identity Provider in the IAM User Guide. An administrator must grant you the permissions
necessary to pass session tags. The administrator can also create granular permissions to
allow you to pass only specific session tags. For more information, see Tutorial: Using
Tags for Attribute-Based Access Control in the IAM User Guide. Tag key–value pairs are
not case sensitive, but case is preserved. This means that you cannot have separate
Department and department tag keys. Assume that the user that you are federating has the
Department=Marketing tag and you pass the department=engineering session tag. Department
and department are not saved as separate tags, and the session tag passed in the request
takes precedence over the user tag.
# Arguments
- `name`: The name of the federated user. The name is used as an identifier for the
temporary security credentials (such as Bob). For example, you can reference the federated
user name in a resource-based policy, such as in an Amazon S3 bucket policy. The regex used
to validate this parameter is a string of characters consisting of upper- and lower-case
alphanumeric characters with no spaces. You can also include underscores or any of the
following characters: =,.@-
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DurationSeconds"`: The duration, in seconds, that the session should last. Acceptable
durations for federation sessions range from 900 seconds (15 minutes) to 129,600 seconds
(36 hours), with 43,200 seconds (12 hours) as the default. Sessions obtained using root
user credentials are restricted to a maximum of 3,600 seconds (one hour). If the specified
duration is longer than one hour, the session obtained by using root user credentials
defaults to one hour.
- `"Policy"`: An IAM policy in JSON format that you want to use as an inline session
policy. You must pass an inline or managed session policy to this operation. You can pass a
single JSON policy document to use as an inline session policy. You can also specify up to
10 managed policy Amazon Resource Names (ARNs) to use as managed session policies. This
parameter is optional. However, if you do not pass any session policies, then the resulting
federated user session has no permissions. When you pass session policies, the session
permissions are the intersection of the IAM user policies and the session policies that you
pass. This gives you a way to further restrict the permissions for a federated user. You
cannot use session policies to grant more permissions than those that are defined in the
permissions policy of the IAM user. For more information, see Session Policies in the IAM
User Guide. The resulting credentials can be used to access a resource that has a
resource-based policy. If that policy specifically references the federated user session in
the Principal element of the policy, the session has the permissions allowed by the policy.
These permissions are granted in addition to the permissions that are granted by the
session policies. The plaintext that you use for both inline and managed session policies
can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from
the space character to the end of the valid character list (u0020 through u00FF). It can
also include the tab (u0009), linefeed (u000A), and carriage return (u000D) characters. An
Amazon Web Services conversion compresses the passed inline session policy, managed policy
ARNs, and session tags into a packed binary format that has a separate limit. Your request
can fail for this limit even if your plaintext meets the other requirements. The
PackedPolicySize response element indicates by percentage how close the policies and tags
for your request are to the upper size limit.
- `"PolicyArns"`: The Amazon Resource Names (ARNs) of the IAM managed policies that you
want to use as a managed session policy. The policies must exist in the same account as the
IAM user that is requesting federated access. You must pass an inline or managed session
policy to this operation. You can pass a single JSON policy document to use as an inline
session policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs)
to use as managed session policies. The plaintext that you use for both inline and managed
session policies can't exceed 2,048 characters. You can provide up to 10 managed policy
ARNs. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web
Services Service Namespaces in the Amazon Web Services General Reference. This parameter is
optional. However, if you do not pass any session policies, then the resulting federated
user session has no permissions. When you pass session policies, the session permissions
are the intersection of the IAM user policies and the session policies that you pass. This
gives you a way to further restrict the permissions for a federated user. You cannot use
session policies to grant more permissions than those that are defined in the permissions
policy of the IAM user. For more information, see Session Policies in the IAM User Guide.
The resulting credentials can be used to access a resource that has a resource-based
policy. If that policy specifically references the federated user session in the Principal
element of the policy, the session has the permissions allowed by the policy. These
permissions are granted in addition to the permissions that are granted by the session
policies. An Amazon Web Services conversion compresses the passed inline session policy,
managed policy ARNs, and session tags into a packed binary format that has a separate
limit. Your request can fail for this limit even if your plaintext meets the other
requirements. The PackedPolicySize response element indicates by percentage how close the
policies and tags for your request are to the upper size limit.
- `"Tags"`: A list of session tags. Each session tag consists of a key name and an
associated value. For more information about session tags, see Passing Session Tags in STS
in the IAM User Guide. This parameter is optional. You can pass up to 50 session tags. The
plaintext session tag keys can’t exceed 128 characters and the values can’t exceed 256
characters. For these and additional limits, see IAM and STS Character Limits in the IAM
User Guide. An Amazon Web Services conversion compresses the passed inline session policy,
managed policy ARNs, and session tags into a packed binary format that has a separate
limit. Your request can fail for this limit even if your plaintext meets the other
requirements. The PackedPolicySize response element indicates by percentage how close the
policies and tags for your request are to the upper size limit. You can pass a session tag
with the same key as a tag that is already attached to the user you are federating. When
you do, session tags override a user tag with the same key. Tag key–value pairs are not
case sensitive, but case is preserved. This means that you cannot have separate Department
and department tag keys. Assume that the role has the Department=Marketing tag and you pass
the department=engineering session tag. Department and department are not saved as separate
tags, and the session tag passed in the request takes precedence over the role tag.
"""
function get_federation_token(Name; aws_config::AbstractAWSConfig=global_aws_config())
return sts(
"GetFederationToken",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_federation_token(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sts(
"GetFederationToken",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_session_token()
get_session_token(params::Dict{String,<:Any})
Returns a set of temporary credentials for an Amazon Web Services account or IAM user. The
credentials consist of an access key ID, a secret access key, and a security token.
Typically, you use GetSessionToken if you want to use MFA to protect programmatic calls to
specific Amazon Web Services API operations like Amazon EC2 StopInstances. MFA-enabled IAM
users must call GetSessionToken and submit an MFA code that is associated with their MFA
device. Using the temporary security credentials that the call returns, IAM users can then
make programmatic calls to API operations that require MFA authentication. An incorrect MFA
code causes the API to return an access denied error. For a comparison of GetSessionToken
with the other API operations that produce temporary credentials, see Requesting Temporary
Security Credentials and Comparing the Amazon Web Services STS API operations in the IAM
User Guide. No permissions are required for users to perform this operation. The purpose
of the sts:GetSessionToken operation is to authenticate the user using MFA. You cannot use
policies to control authentication operations. For more information, see Permissions for
GetSessionToken in the IAM User Guide. Session Duration The GetSessionToken operation
must be called by using the long-term Amazon Web Services security credentials of an IAM
user. Credentials that are created by IAM users are valid for the duration that you
specify. This duration can range from 900 seconds (15 minutes) up to a maximum of 129,600
seconds (36 hours), with a default of 43,200 seconds (12 hours). Credentials based on
account credentials can range from 900 seconds (15 minutes) up to 3,600 seconds (1 hour),
with a default of 1 hour. Permissions The temporary security credentials created by
GetSessionToken can be used to make API calls to any Amazon Web Services service with the
following exceptions: You cannot call any IAM API operations unless MFA authentication
information is included in the request. You cannot call any STS API except AssumeRole or
GetCallerIdentity. The credentials that GetSessionToken returns are based on permissions
associated with the IAM user whose credentials were used to call the operation. The
temporary credentials have the same permissions as the IAM user. Although it is possible
to call GetSessionToken using the security credentials of an Amazon Web Services account
root user rather than an IAM user, we do not recommend it. If GetSessionToken is called
using root user credentials, the temporary credentials have root user permissions. For more
information, see Safeguard your root user credentials and don't use them for everyday tasks
in the IAM User Guide For more information about using GetSessionToken to create
temporary credentials, see Temporary Credentials for Users in Untrusted Environments in the
IAM User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DurationSeconds"`: The duration, in seconds, that the credentials should remain valid.
Acceptable durations for IAM user sessions range from 900 seconds (15 minutes) to 129,600
seconds (36 hours), with 43,200 seconds (12 hours) as the default. Sessions for Amazon Web
Services account owners are restricted to a maximum of 3,600 seconds (one hour). If the
duration is longer than one hour, the session for Amazon Web Services account owners
defaults to one hour.
- `"SerialNumber"`: The identification number of the MFA device that is associated with the
IAM user who is making the GetSessionToken call. Specify this value if the IAM user has a
policy that requires MFA authentication. The value is either the serial number for a
hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual
device (such as arn:aws:iam::123456789012:mfa/user). You can find the device for an IAM
user by going to the Amazon Web Services Management Console and viewing the user's security
credentials. The regex used to validate this parameter is a string of characters
consisting of upper- and lower-case alphanumeric characters with no spaces. You can also
include underscores or any of the following characters: =,.@:/-
- `"TokenCode"`: The value provided by the MFA device, if MFA is required. If any policy
requires the IAM user to submit an MFA code, specify this value. If MFA authentication is
required, the user must provide a code when requesting a set of temporary security
credentials. A user who fails to provide the code receives an \"access denied\" response
when requesting resources that require MFA authentication. The format for this parameter,
as described by its regex pattern, is a sequence of six numeric digits.
"""
function get_session_token(; aws_config::AbstractAWSConfig=global_aws_config())
return sts("GetSessionToken"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_session_token(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return sts(
"GetSessionToken", 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 | 5123 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: supplychain
using AWS.Compat
using AWS.UUIDs
"""
create_bill_of_materials_import_job(instance_id, s3uri)
create_bill_of_materials_import_job(instance_id, s3uri, params::Dict{String,<:Any})
CreateBillOfMaterialsImportJob creates an import job for the Product Bill Of Materials
(BOM) entity. For information on the product_bom entity, see the AWS Supply Chain User
Guide. The CSV file must be located in an Amazon S3 location accessible to AWS Supply
Chain. It is recommended to use the same Amazon S3 bucket created during your AWS Supply
Chain instance creation.
# Arguments
- `instance_id`: The AWS Supply Chain instance identifier.
- `s3uri`: The S3 URI of the CSV file to be imported. The bucket must grant permissions for
AWS Supply Chain to read the file.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: An idempotency token.
"""
function create_bill_of_materials_import_job(
instanceId, s3uri; aws_config::AbstractAWSConfig=global_aws_config()
)
return supplychain(
"POST",
"/api/configuration/instances/$(instanceId)/bill-of-materials-import-jobs",
Dict{String,Any}("s3uri" => s3uri, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_bill_of_materials_import_job(
instanceId,
s3uri,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return supplychain(
"POST",
"/api/configuration/instances/$(instanceId)/bill-of-materials-import-jobs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("s3uri" => s3uri, "clientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bill_of_materials_import_job(instance_id, job_id)
get_bill_of_materials_import_job(instance_id, job_id, params::Dict{String,<:Any})
Get status and details of a BillOfMaterialsImportJob.
# Arguments
- `instance_id`: The AWS Supply Chain instance identifier.
- `job_id`: The BillOfMaterialsImportJob identifier.
"""
function get_bill_of_materials_import_job(
instanceId, jobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return supplychain(
"GET",
"/api/configuration/instances/$(instanceId)/bill-of-materials-import-jobs/$(jobId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_bill_of_materials_import_job(
instanceId,
jobId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return supplychain(
"GET",
"/api/configuration/instances/$(instanceId)/bill-of-materials-import-jobs/$(jobId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_data_integration_event(data, event_group_id, event_type, instance_id)
send_data_integration_event(data, event_group_id, event_type, instance_id, params::Dict{String,<:Any})
Send transactional data events with real-time data for analysis or monitoring.
# Arguments
- `data`: The data payload of the event.
- `event_group_id`: Event identifier (for example, orderId for InboundOrder) used for data
sharing or partitioning.
- `event_type`: The data event type.
- `instance_id`: The AWS Supply Chain instance identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: The idempotent client token.
- `"eventTimestamp"`: The event timestamp (in epoch seconds).
"""
function send_data_integration_event(
data,
eventGroupId,
eventType,
instanceId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return supplychain(
"POST",
"/api-data/data-integration/instance/$(instanceId)/data-integration-events",
Dict{String,Any}(
"data" => data,
"eventGroupId" => eventGroupId,
"eventType" => eventType,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_data_integration_event(
data,
eventGroupId,
eventType,
instanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return supplychain(
"POST",
"/api-data/data-integration/instance/$(instanceId)/data-integration-events",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"data" => data,
"eventGroupId" => eventGroupId,
"eventType" => eventType,
"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 | 38423 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: support
using AWS.Compat
using AWS.UUIDs
"""
add_attachments_to_set(attachments)
add_attachments_to_set(attachments, params::Dict{String,<:Any})
Adds one or more attachments to an attachment set. An attachment set is a temporary
container for attachments that you add to a case or case communication. The set is
available for 1 hour after it's created. The expiryTime returned in the response is when
the set expires. You must have a Business, Enterprise On-Ramp, or Enterprise Support
plan to use the Amazon Web Services Support API. If you call the Amazon Web Services
Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise
Support plan, the SubscriptionRequiredException error message appears. For information
about changing your support plan, see Amazon Web Services Support.
# Arguments
- `attachments`: One or more attachments to add to the set. You can add up to three
attachments per set. The size limit is 5 MB per attachment. In the Attachment object, use
the data parameter to specify the contents of the attachment file. In the previous request
syntax, the value for data appear as blob, which is represented as a base64-encoded string.
The value for fileName is the name of the attachment, such as troubleshoot-screenshot.png.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"attachmentSetId"`: The ID of the attachment set. If an attachmentSetId is not
specified, a new attachment set is created, and the ID of the set is returned in the
response. If an attachmentSetId is specified, the attachments are added to the specified
set, if it exists.
"""
function add_attachments_to_set(
attachments; aws_config::AbstractAWSConfig=global_aws_config()
)
return support(
"AddAttachmentsToSet",
Dict{String,Any}("attachments" => attachments);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_attachments_to_set(
attachments,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return support(
"AddAttachmentsToSet",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("attachments" => attachments), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_communication_to_case(communication_body)
add_communication_to_case(communication_body, params::Dict{String,<:Any})
Adds additional customer communication to an Amazon Web Services Support case. Use the
caseId parameter to identify the case to which to add communication. You can list a set of
email addresses to copy on the communication by using the ccEmailAddresses parameter. The
communicationBody value contains the text of the communication. You must have a
Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services
Support API. If you call the Amazon Web Services Support API from an account that
doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredException error message appears. For information about changing your
support plan, see Amazon Web Services Support.
# Arguments
- `communication_body`: The body of an email communication to add to the support case.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"attachmentSetId"`: The ID of a set of one or more attachments for the communication to
add to the case. Create the set by calling AddAttachmentsToSet
- `"caseId"`: The support case ID requested or returned in the call. The case ID is an
alphanumeric string formatted as shown in this example:
case-12345678910-2013-c4c1d2bf33c5cf47
- `"ccEmailAddresses"`: The email addresses in the CC line of an email to be added to the
support case.
"""
function add_communication_to_case(
communicationBody; aws_config::AbstractAWSConfig=global_aws_config()
)
return support(
"AddCommunicationToCase",
Dict{String,Any}("communicationBody" => communicationBody);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_communication_to_case(
communicationBody,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return support(
"AddCommunicationToCase",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("communicationBody" => communicationBody), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_case(communication_body, subject)
create_case(communication_body, subject, params::Dict{String,<:Any})
Creates a case in the Amazon Web Services Support Center. This operation is similar to how
you create a case in the Amazon Web Services Support Center Create Case page. The Amazon
Web Services Support API doesn't support requesting service limit increases. You can submit
a service limit increase in the following ways: Submit a request from the Amazon Web
Services Support Center Create Case page. Use the Service Quotas
RequestServiceQuotaIncrease operation. A successful CreateCase request returns an Amazon
Web Services Support case number. You can use the DescribeCases operation and specify the
case number to get existing Amazon Web Services Support cases. After you create a case, use
the AddCommunicationToCase operation to add additional communication or attachments to an
existing case. The caseId is separate from the displayId that appears in the Amazon Web
Services Support Center. Use the DescribeCases operation to get the displayId. You must
have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web
Services Support API. If you call the Amazon Web Services Support API from an account
that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredException error message appears. For information about changing your
support plan, see Amazon Web Services Support.
# Arguments
- `communication_body`: The communication body text that describes the issue. This text
appears in the Description field on the Amazon Web Services Support Center Create Case page.
- `subject`: The title of the support case. The title appears in the Subject field on the
Amazon Web Services Support Center Create Case page.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"attachmentSetId"`: The ID of a set of one or more attachments for the case. Create the
set by using the AddAttachmentsToSet operation.
- `"categoryCode"`: The category of problem for the support case. You also use the
DescribeServices operation to get the category code for a service. Each Amazon Web Services
service defines its own set of category codes.
- `"ccEmailAddresses"`: A list of email addresses that Amazon Web Services Support copies
on case correspondence. Amazon Web Services Support identifies the account that creates the
case when you specify your Amazon Web Services credentials in an HTTP POST method or use
the Amazon Web Services SDKs.
- `"issueType"`: The type of issue for the case. You can specify customer-service or
technical. If you don't specify a value, the default is technical.
- `"language"`: The language in which Amazon Web Services Support handles the case. Amazon
Web Services Support currently supports Chinese (“zh”), English (\"en\"), Japanese
(\"ja\") and Korean (“ko”). You must specify the ISO 639-1 code for the language
parameter if you want support in that language.
- `"serviceCode"`: The code for the Amazon Web Services service. You can use the
DescribeServices operation to get the possible serviceCode values.
- `"severityCode"`: A value that indicates the urgency of the case. This value determines
the response time according to your service level agreement with Amazon Web Services
Support. You can use the DescribeSeverityLevels operation to get the possible values for
severityCode. For more information, see SeverityLevel and Choosing a Severity in the
Amazon Web Services Support User Guide. The availability of severity levels depends on the
support plan for the Amazon Web Services account.
"""
function create_case(
communicationBody, subject; aws_config::AbstractAWSConfig=global_aws_config()
)
return support(
"CreateCase",
Dict{String,Any}("communicationBody" => communicationBody, "subject" => subject);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_case(
communicationBody,
subject,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return support(
"CreateCase",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"communicationBody" => communicationBody, "subject" => subject
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_attachment(attachment_id)
describe_attachment(attachment_id, params::Dict{String,<:Any})
Returns the attachment that has the specified ID. Attachments can include screenshots,
error logs, or other files that describe your issue. Attachment IDs are generated by the
case management system when you add an attachment to a case or case communication.
Attachment IDs are returned in the AttachmentDetails objects that are returned by the
DescribeCommunications operation. You must have a Business, Enterprise On-Ramp, or
Enterprise Support plan to use the Amazon Web Services Support API. If you call the
Amazon Web Services Support API from an account that doesn't have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message
appears. For information about changing your support plan, see Amazon Web Services Support.
# Arguments
- `attachment_id`: The ID of the attachment to return. Attachment IDs are returned by the
DescribeCommunications operation.
"""
function describe_attachment(
attachmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return support(
"DescribeAttachment",
Dict{String,Any}("attachmentId" => attachmentId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_attachment(
attachmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return support(
"DescribeAttachment",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("attachmentId" => attachmentId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_cases()
describe_cases(params::Dict{String,<:Any})
Returns a list of cases that you specify by passing one or more case IDs. You can use the
afterTime and beforeTime parameters to filter the cases by date. You can set values for the
includeResolvedCases and includeCommunications parameters to specify how much information
to return. The response returns the following in JSON format: One or more CaseDetails
data types. One or more nextToken values, which specify where to paginate the returned
records represented by the CaseDetails objects. Case data is available for 12 months
after creation. If a case was created more than 12 months ago, a request might return an
error. You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use
the Amazon Web Services Support API. If you call the Amazon Web Services Support API
from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support
plan, the SubscriptionRequiredException error message appears. For information about
changing your support plan, see Amazon Web Services Support.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"afterTime"`: The start date for a filtered date search on support case communications.
Case communications are available for 12 months after creation.
- `"beforeTime"`: The end date for a filtered date search on support case communications.
Case communications are available for 12 months after creation.
- `"caseIdList"`: A list of ID numbers of the support cases you want returned. The maximum
number of cases is 100.
- `"displayId"`: The ID displayed for a case in the Amazon Web Services Support Center user
interface.
- `"includeCommunications"`: Specifies whether to include communications in the
DescribeCases response. By default, communications are included.
- `"includeResolvedCases"`: Specifies whether to include resolved support cases in the
DescribeCases response. By default, resolved cases aren't included.
- `"language"`: The language in which Amazon Web Services Support handles the case. Amazon
Web Services Support currently supports Chinese (“zh”), English (\"en\"), Japanese
(\"ja\") and Korean (“ko”). You must specify the ISO 639-1 code for the language
parameter if you want support in that language.
- `"maxResults"`: The maximum number of results to return before paginating.
- `"nextToken"`: A resumption point for pagination.
"""
function describe_cases(; aws_config::AbstractAWSConfig=global_aws_config())
return support("DescribeCases"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_cases(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return support(
"DescribeCases", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_communications(case_id)
describe_communications(case_id, params::Dict{String,<:Any})
Returns communications and attachments for one or more support cases. Use the afterTime and
beforeTime parameters to filter by date. You can use the caseId parameter to restrict the
results to a specific case. Case data is available for 12 months after creation. If a case
was created more than 12 months ago, a request for data might cause an error. You can use
the maxResults and nextToken parameters to control the pagination of the results. Set
maxResults to the number of cases that you want to display on each page, and use nextToken
to specify the resumption of pagination. You must have a Business, Enterprise On-Ramp,
or Enterprise Support plan to use the Amazon Web Services Support API. If you call the
Amazon Web Services Support API from an account that doesn't have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message
appears. For information about changing your support plan, see Amazon Web Services Support.
# Arguments
- `case_id`: The support case ID requested or returned in the call. The case ID is an
alphanumeric string formatted as shown in this example:
case-12345678910-2013-c4c1d2bf33c5cf47
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"afterTime"`: The start date for a filtered date search on support case communications.
Case communications are available for 12 months after creation.
- `"beforeTime"`: The end date for a filtered date search on support case communications.
Case communications are available for 12 months after creation.
- `"maxResults"`: The maximum number of results to return before paginating.
- `"nextToken"`: A resumption point for pagination.
"""
function describe_communications(caseId; aws_config::AbstractAWSConfig=global_aws_config())
return support(
"DescribeCommunications",
Dict{String,Any}("caseId" => caseId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_communications(
caseId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return support(
"DescribeCommunications",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("caseId" => caseId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_create_case_options(category_code, issue_type, language, service_code)
describe_create_case_options(category_code, issue_type, language, service_code, params::Dict{String,<:Any})
Returns a list of CreateCaseOption types along with the corresponding supported hours and
language availability. You can specify the language categoryCode, issueType and serviceCode
used to retrieve the CreateCaseOptions. You must have a Business, Enterprise On-Ramp, or
Enterprise Support plan to use the Amazon Web Services Support API. If you call the
Amazon Web Services Support API from an account that doesn't have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message
appears. For information about changing your support plan, see Amazon Web Services Support.
# Arguments
- `category_code`: The category of problem for the support case. You also use the
DescribeServices operation to get the category code for a service. Each Amazon Web Services
service defines its own set of category codes.
- `issue_type`: The type of issue for the case. You can specify customer-service or
technical. If you don't specify a value, the default is technical.
- `language`: The language in which Amazon Web Services Support handles the case. Amazon
Web Services Support currently supports Chinese (“zh”), English (\"en\"), Japanese
(\"ja\") and Korean (“ko”). You must specify the ISO 639-1 code for the language
parameter if you want support in that language.
- `service_code`: The code for the Amazon Web Services service. You can use the
DescribeServices operation to get the possible serviceCode values.
"""
function describe_create_case_options(
categoryCode,
issueType,
language,
serviceCode;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return support(
"DescribeCreateCaseOptions",
Dict{String,Any}(
"categoryCode" => categoryCode,
"issueType" => issueType,
"language" => language,
"serviceCode" => serviceCode,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_create_case_options(
categoryCode,
issueType,
language,
serviceCode,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return support(
"DescribeCreateCaseOptions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"categoryCode" => categoryCode,
"issueType" => issueType,
"language" => language,
"serviceCode" => serviceCode,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_services()
describe_services(params::Dict{String,<:Any})
Returns the current list of Amazon Web Services services and a list of service categories
for each service. You then use service names and categories in your CreateCase requests.
Each Amazon Web Services service has its own set of categories. The service codes and
category codes correspond to the values that appear in the Service and Category lists on
the Amazon Web Services Support Center Create Case page. The values in those fields don't
necessarily match the service codes and categories returned by the DescribeServices
operation. Always use the service codes and categories that the DescribeServices operation
returns, so that you have the most recent set of service and category codes. You must
have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web
Services Support API. If you call the Amazon Web Services Support API from an account
that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredException error message appears. For information about changing your
support plan, see Amazon Web Services Support.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"language"`: The language in which Amazon Web Services Support handles the case. Amazon
Web Services Support currently supports Chinese (“zh”), English (\"en\"), Japanese
(\"ja\") and Korean (“ko”). You must specify the ISO 639-1 code for the language
parameter if you want support in that language.
- `"serviceCodeList"`: A JSON-formatted list of service codes available for Amazon Web
Services services.
"""
function describe_services(; aws_config::AbstractAWSConfig=global_aws_config())
return support(
"DescribeServices"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_services(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return support(
"DescribeServices", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_severity_levels()
describe_severity_levels(params::Dict{String,<:Any})
Returns the list of severity levels that you can assign to a support case. The severity
level for a case is also a field in the CaseDetails data type that you include for a
CreateCase request. You must have a Business, Enterprise On-Ramp, or Enterprise Support
plan to use the Amazon Web Services Support API. If you call the Amazon Web Services
Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise
Support plan, the SubscriptionRequiredException error message appears. For information
about changing your support plan, see Amazon Web Services Support.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"language"`: The language in which Amazon Web Services Support handles the case. Amazon
Web Services Support currently supports Chinese (“zh”), English (\"en\"), Japanese
(\"ja\") and Korean (“ko”). You must specify the ISO 639-1 code for the language
parameter if you want support in that language.
"""
function describe_severity_levels(; aws_config::AbstractAWSConfig=global_aws_config())
return support(
"DescribeSeverityLevels"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_severity_levels(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return support(
"DescribeSeverityLevels",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_supported_languages(category_code, issue_type, service_code)
describe_supported_languages(category_code, issue_type, service_code, params::Dict{String,<:Any})
Returns a list of supported languages for a specified categoryCode, issueType and
serviceCode. The returned supported languages will include a ISO 639-1 code for the
language, and the language display name. You must have a Business, Enterprise On-Ramp,
or Enterprise Support plan to use the Amazon Web Services Support API. If you call the
Amazon Web Services Support API from an account that doesn't have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message
appears. For information about changing your support plan, see Amazon Web Services Support.
# Arguments
- `category_code`: The category of problem for the support case. You also use the
DescribeServices operation to get the category code for a service. Each Amazon Web Services
service defines its own set of category codes.
- `issue_type`: The type of issue for the case. You can specify customer-service or
technical.
- `service_code`: The code for the Amazon Web Services service. You can use the
DescribeServices operation to get the possible serviceCode values.
"""
function describe_supported_languages(
categoryCode, issueType, serviceCode; aws_config::AbstractAWSConfig=global_aws_config()
)
return support(
"DescribeSupportedLanguages",
Dict{String,Any}(
"categoryCode" => categoryCode,
"issueType" => issueType,
"serviceCode" => serviceCode,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_supported_languages(
categoryCode,
issueType,
serviceCode,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return support(
"DescribeSupportedLanguages",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"categoryCode" => categoryCode,
"issueType" => issueType,
"serviceCode" => serviceCode,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_trusted_advisor_check_refresh_statuses(check_ids)
describe_trusted_advisor_check_refresh_statuses(check_ids, params::Dict{String,<:Any})
Returns the refresh status of the Trusted Advisor checks that have the specified check IDs.
You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation. Some
checks are refreshed automatically, and you can't return their refresh statuses by using
the DescribeTrustedAdvisorCheckRefreshStatuses operation. If you call this operation for
these checks, you might see an InvalidParameterValue error. You must have a Business,
Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a
Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException
error message appears. For information about changing your support plan, see Amazon Web
Services Support. To call the Trusted Advisor operations in the Amazon Web Services
Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West
(Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For
more information, see About the Amazon Web Services Support API in the Amazon Web Services
Support User Guide.
# Arguments
- `check_ids`: The IDs of the Trusted Advisor checks to get the status. If you specify the
check ID of a check that is automatically refreshed, you might see an InvalidParameterValue
error.
"""
function describe_trusted_advisor_check_refresh_statuses(
checkIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return support(
"DescribeTrustedAdvisorCheckRefreshStatuses",
Dict{String,Any}("checkIds" => checkIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_trusted_advisor_check_refresh_statuses(
checkIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return support(
"DescribeTrustedAdvisorCheckRefreshStatuses",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("checkIds" => checkIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_trusted_advisor_check_result(check_id)
describe_trusted_advisor_check_result(check_id, params::Dict{String,<:Any})
Returns the results of the Trusted Advisor check that has the specified check ID. You can
get the check IDs by calling the DescribeTrustedAdvisorChecks operation. The response
contains a TrustedAdvisorCheckResult object, which contains these three objects:
TrustedAdvisorCategorySpecificSummary TrustedAdvisorResourceDetail
TrustedAdvisorResourcesSummary In addition, the response contains these fields:
status - The alert status of the check can be ok (green), warning (yellow), error (red), or
not_available. timestamp - The time of the last refresh of the check. checkId - The
unique identifier for the check. You must have a Business, Enterprise On-Ramp, or
Enterprise Support plan to use the Amazon Web Services Support API. If you call the
Amazon Web Services Support API from an account that doesn't have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message
appears. For information about changing your support plan, see Amazon Web Services Support.
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must
use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe
(Ireland) endpoints don't support the Trusted Advisor operations. For more information, see
About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.
# Arguments
- `check_id`: The unique identifier for the Trusted Advisor check.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"language"`: The ISO 639-1 code for the language that you want your check results to
appear in. The Amazon Web Services Support API currently supports the following languages
for Trusted Advisor: Chinese, Simplified - zh Chinese, Traditional - zh_TW English
- en French - fr German - de Indonesian - id Italian - it Japanese - ja
Korean - ko Portuguese, Brazilian - pt_BR Spanish - es
"""
function describe_trusted_advisor_check_result(
checkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return support(
"DescribeTrustedAdvisorCheckResult",
Dict{String,Any}("checkId" => checkId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_trusted_advisor_check_result(
checkId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return support(
"DescribeTrustedAdvisorCheckResult",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("checkId" => checkId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_trusted_advisor_check_summaries(check_ids)
describe_trusted_advisor_check_summaries(check_ids, params::Dict{String,<:Any})
Returns the results for the Trusted Advisor check summaries for the check IDs that you
specified. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
The response contains an array of TrustedAdvisorCheckSummary objects. You must have a
Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services
Support API. If you call the Amazon Web Services Support API from an account that
doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredException error message appears. For information about changing your
support plan, see Amazon Web Services Support. To call the Trusted Advisor operations in
the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint.
Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted
Advisor operations. For more information, see About the Amazon Web Services Support API in
the Amazon Web Services Support User Guide.
# Arguments
- `check_ids`: The IDs of the Trusted Advisor checks.
"""
function describe_trusted_advisor_check_summaries(
checkIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return support(
"DescribeTrustedAdvisorCheckSummaries",
Dict{String,Any}("checkIds" => checkIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_trusted_advisor_check_summaries(
checkIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return support(
"DescribeTrustedAdvisorCheckSummaries",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("checkIds" => checkIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_trusted_advisor_checks(language)
describe_trusted_advisor_checks(language, params::Dict{String,<:Any})
Returns information about all available Trusted Advisor checks, including the name, ID,
category, description, and metadata. You must specify a language code. The response
contains a TrustedAdvisorCheckDescription object for each check. You must set the Amazon
Web Services Region to us-east-1. You must have a Business, Enterprise On-Ramp, or
Enterprise Support plan to use the Amazon Web Services Support API. If you call the
Amazon Web Services Support API from an account that doesn't have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message
appears. For information about changing your support plan, see Amazon Web Services Support.
The names and descriptions for Trusted Advisor checks are subject to change. We recommend
that you specify the check ID in your code to uniquely identify a check. To call the
Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East
(N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints
don't support the Trusted Advisor operations. For more information, see About the Amazon
Web Services Support API in the Amazon Web Services Support User Guide.
# Arguments
- `language`: The ISO 639-1 code for the language that you want your checks to appear in.
The Amazon Web Services Support API currently supports the following languages for Trusted
Advisor: Chinese, Simplified - zh Chinese, Traditional - zh_TW English - en
French - fr German - de Indonesian - id Italian - it Japanese - ja Korean -
ko Portuguese, Brazilian - pt_BR Spanish - es
"""
function describe_trusted_advisor_checks(
language; aws_config::AbstractAWSConfig=global_aws_config()
)
return support(
"DescribeTrustedAdvisorChecks",
Dict{String,Any}("language" => language);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_trusted_advisor_checks(
language,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return support(
"DescribeTrustedAdvisorChecks",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("language" => language), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
refresh_trusted_advisor_check(check_id)
refresh_trusted_advisor_check(check_id, params::Dict{String,<:Any})
Refreshes the Trusted Advisor check that you specify using the check ID. You can get the
check IDs by calling the DescribeTrustedAdvisorChecks operation. Some checks are refreshed
automatically. If you call the RefreshTrustedAdvisorCheck operation to refresh them, you
might see the InvalidParameterValue error. The response contains a
TrustedAdvisorCheckRefreshStatus object. You must have a Business, Enterprise On-Ramp,
or Enterprise Support plan to use the Amazon Web Services Support API. If you call the
Amazon Web Services Support API from an account that doesn't have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message
appears. For information about changing your support plan, see Amazon Web Services Support.
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must
use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe
(Ireland) endpoints don't support the Trusted Advisor operations. For more information, see
About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.
# Arguments
- `check_id`: The unique identifier for the Trusted Advisor check to refresh. Specifying
the check ID of a check that is automatically refreshed causes an InvalidParameterValue
error.
"""
function refresh_trusted_advisor_check(
checkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return support(
"RefreshTrustedAdvisorCheck",
Dict{String,Any}("checkId" => checkId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function refresh_trusted_advisor_check(
checkId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return support(
"RefreshTrustedAdvisorCheck",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("checkId" => checkId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
resolve_case()
resolve_case(params::Dict{String,<:Any})
Resolves a support case. This operation takes a caseId and returns the initial and final
state of the case. You must have a Business, Enterprise On-Ramp, or Enterprise Support
plan to use the Amazon Web Services Support API. If you call the Amazon Web Services
Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise
Support plan, the SubscriptionRequiredException error message appears. For information
about changing your support plan, see Amazon Web Services Support.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"caseId"`: The support case ID requested or returned in the call. The case ID is an
alphanumeric string formatted as shown in this example:
case-12345678910-2013-c4c1d2bf33c5cf47
"""
function resolve_case(; aws_config::AbstractAWSConfig=global_aws_config())
return support("ResolveCase"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function resolve_case(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return support(
"ResolveCase", 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 | 17327 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: support_app
using AWS.Compat
using AWS.UUIDs
"""
create_slack_channel_configuration(channel_id, channel_role_arn, notify_on_case_severity, team_id)
create_slack_channel_configuration(channel_id, channel_role_arn, notify_on_case_severity, team_id, params::Dict{String,<:Any})
Creates a Slack channel configuration for your Amazon Web Services account. You can add
up to 5 Slack workspaces for your account. You can add up to 20 Slack channels for your
account. A Slack channel can have up to 100 Amazon Web Services accounts. This means
that only 100 accounts can add the same Slack channel to the Amazon Web Services Support
App. We recommend that you only add the accounts that you need to manage support cases for
your organization. This can reduce the notifications about case updates that you receive in
the Slack channel. We recommend that you choose a private Slack channel so that only
members in that channel have read and write access to your support cases. Anyone in your
Slack channel can create, update, or resolve support cases for your account. Users require
an invitation to join private channels.
# Arguments
- `channel_id`: The channel ID in Slack. This ID identifies a channel within a Slack
workspace.
- `channel_role_arn`: The Amazon Resource Name (ARN) of an IAM role that you want to use to
perform operations on Amazon Web Services. For more information, see Managing access to the
Amazon Web Services Support App in the Amazon Web Services Support User Guide.
- `notify_on_case_severity`: The case severity for a support case that you want to receive
notifications. If you specify high or all, you must specify true for at least one of the
following parameters: notifyOnAddCorrespondenceToCase notifyOnCreateOrReopenCase
notifyOnResolveCase If you specify none, the following parameters must be null or false:
notifyOnAddCorrespondenceToCase notifyOnCreateOrReopenCase notifyOnResolveCase
If you don't specify these parameters in your request, they default to false.
- `team_id`: The team ID in Slack. This ID uniquely identifies a Slack workspace, such as
T012ABCDEFG.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"channelName"`: The name of the Slack channel that you configure for the Amazon Web
Services Support App.
- `"notifyOnAddCorrespondenceToCase"`: Whether you want to get notified when a support case
has a new correspondence.
- `"notifyOnCreateOrReopenCase"`: Whether you want to get notified when a support case is
created or reopened.
- `"notifyOnResolveCase"`: Whether you want to get notified when a support case is resolved.
"""
function create_slack_channel_configuration(
channelId,
channelRoleArn,
notifyOnCaseSeverity,
teamId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return support_app(
"POST",
"/control/create-slack-channel-configuration",
Dict{String,Any}(
"channelId" => channelId,
"channelRoleArn" => channelRoleArn,
"notifyOnCaseSeverity" => notifyOnCaseSeverity,
"teamId" => teamId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_slack_channel_configuration(
channelId,
channelRoleArn,
notifyOnCaseSeverity,
teamId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return support_app(
"POST",
"/control/create-slack-channel-configuration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"channelId" => channelId,
"channelRoleArn" => channelRoleArn,
"notifyOnCaseSeverity" => notifyOnCaseSeverity,
"teamId" => teamId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_account_alias()
delete_account_alias(params::Dict{String,<:Any})
Deletes an alias for an Amazon Web Services account ID. The alias appears in the Amazon Web
Services Support App page of the Amazon Web Services Support Center. The alias also appears
in Slack messages from the Amazon Web Services Support App.
"""
function delete_account_alias(; aws_config::AbstractAWSConfig=global_aws_config())
return support_app(
"POST",
"/control/delete-account-alias";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_account_alias(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return support_app(
"POST",
"/control/delete-account-alias",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_slack_channel_configuration(channel_id, team_id)
delete_slack_channel_configuration(channel_id, team_id, params::Dict{String,<:Any})
Deletes a Slack channel configuration from your Amazon Web Services account. This operation
doesn't delete your Slack channel.
# Arguments
- `channel_id`: The channel ID in Slack. This ID identifies a channel within a Slack
workspace.
- `team_id`: The team ID in Slack. This ID uniquely identifies a Slack workspace, such as
T012ABCDEFG.
"""
function delete_slack_channel_configuration(
channelId, teamId; aws_config::AbstractAWSConfig=global_aws_config()
)
return support_app(
"POST",
"/control/delete-slack-channel-configuration",
Dict{String,Any}("channelId" => channelId, "teamId" => teamId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_slack_channel_configuration(
channelId,
teamId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return support_app(
"POST",
"/control/delete-slack-channel-configuration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("channelId" => channelId, "teamId" => teamId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_slack_workspace_configuration(team_id)
delete_slack_workspace_configuration(team_id, params::Dict{String,<:Any})
Deletes a Slack workspace configuration from your Amazon Web Services account. This
operation doesn't delete your Slack workspace.
# Arguments
- `team_id`: The team ID in Slack. This ID uniquely identifies a Slack workspace, such as
T012ABCDEFG.
"""
function delete_slack_workspace_configuration(
teamId; aws_config::AbstractAWSConfig=global_aws_config()
)
return support_app(
"POST",
"/control/delete-slack-workspace-configuration",
Dict{String,Any}("teamId" => teamId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_slack_workspace_configuration(
teamId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return support_app(
"POST",
"/control/delete-slack-workspace-configuration",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("teamId" => teamId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_account_alias()
get_account_alias(params::Dict{String,<:Any})
Retrieves the alias from an Amazon Web Services account ID. The alias appears in the Amazon
Web Services Support App page of the Amazon Web Services Support Center. The alias also
appears in Slack messages from the Amazon Web Services Support App.
"""
function get_account_alias(; aws_config::AbstractAWSConfig=global_aws_config())
return support_app(
"POST",
"/control/get-account-alias";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_account_alias(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return support_app(
"POST",
"/control/get-account-alias",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_slack_channel_configurations()
list_slack_channel_configurations(params::Dict{String,<:Any})
Lists the Slack channel configurations for an Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: If the results of a search are large, the API only returns a portion of
the results and includes a nextToken pagination token in the response. To retrieve the next
batch of results, reissue the search request and include the returned token. When the API
returns the last set of results, the response doesn't include a pagination token value.
"""
function list_slack_channel_configurations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return support_app(
"POST",
"/control/list-slack-channel-configurations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_slack_channel_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return support_app(
"POST",
"/control/list-slack-channel-configurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_slack_workspace_configurations()
list_slack_workspace_configurations(params::Dict{String,<:Any})
Lists the Slack workspace configurations for an Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: If the results of a search are large, the API only returns a portion of
the results and includes a nextToken pagination token in the response. To retrieve the next
batch of results, reissue the search request and include the returned token. When the API
returns the last set of results, the response doesn't include a pagination token value.
"""
function list_slack_workspace_configurations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return support_app(
"POST",
"/control/list-slack-workspace-configurations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_slack_workspace_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return support_app(
"POST",
"/control/list-slack-workspace-configurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_account_alias(account_alias)
put_account_alias(account_alias, params::Dict{String,<:Any})
Creates or updates an individual alias for each Amazon Web Services account ID. The alias
appears in the Amazon Web Services Support App page of the Amazon Web Services Support
Center. The alias also appears in Slack messages from the Amazon Web Services Support App.
# Arguments
- `account_alias`: An alias or short name for an Amazon Web Services account.
"""
function put_account_alias(accountAlias; aws_config::AbstractAWSConfig=global_aws_config())
return support_app(
"POST",
"/control/put-account-alias",
Dict{String,Any}("accountAlias" => accountAlias);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_account_alias(
accountAlias,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return support_app(
"POST",
"/control/put-account-alias",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("accountAlias" => accountAlias), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_slack_workspace_for_organization(team_id)
register_slack_workspace_for_organization(team_id, params::Dict{String,<:Any})
Registers a Slack workspace for your Amazon Web Services account. To call this API, your
account must be part of an organization in Organizations. If you're the management account
and you want to register Slack workspaces for your organization, you must complete the
following tasks: Sign in to the Amazon Web Services Support Center and authorize the
Slack workspaces where you want your organization to have access to. See Authorize a Slack
workspace in the Amazon Web Services Support User Guide. Call the
RegisterSlackWorkspaceForOrganization API to authorize each Slack workspace for the
organization. After the management account authorizes the Slack workspace, member
accounts can call this API to authorize the same Slack workspace for their individual
accounts. Member accounts don't need to authorize the Slack workspace manually through the
Amazon Web Services Support Center. To use the Amazon Web Services Support App, each
account must then complete the following tasks: Create an Identity and Access Management
(IAM) role with the required permission. For more information, see Managing access to the
Amazon Web Services Support App. Configure a Slack channel to use the Amazon Web Services
Support App for support cases for that account. For more information, see Configuring a
Slack channel.
# Arguments
- `team_id`: The team ID in Slack. This ID uniquely identifies a Slack workspace, such as
T012ABCDEFG. Specify the Slack workspace that you want to use for your organization.
"""
function register_slack_workspace_for_organization(
teamId; aws_config::AbstractAWSConfig=global_aws_config()
)
return support_app(
"POST",
"/control/register-slack-workspace-for-organization",
Dict{String,Any}("teamId" => teamId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_slack_workspace_for_organization(
teamId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return support_app(
"POST",
"/control/register-slack-workspace-for-organization",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("teamId" => teamId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_slack_channel_configuration(channel_id, team_id)
update_slack_channel_configuration(channel_id, team_id, params::Dict{String,<:Any})
Updates the configuration for a Slack channel, such as case update notifications.
# Arguments
- `channel_id`: The channel ID in Slack. This ID identifies a channel within a Slack
workspace.
- `team_id`: The team ID in Slack. This ID uniquely identifies a Slack workspace, such as
T012ABCDEFG.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"channelName"`: The Slack channel name that you want to update.
- `"channelRoleArn"`: The Amazon Resource Name (ARN) of an IAM role that you want to use to
perform operations on Amazon Web Services. For more information, see Managing access to the
Amazon Web Services Support App in the Amazon Web Services Support User Guide.
- `"notifyOnAddCorrespondenceToCase"`: Whether you want to get notified when a support case
has a new correspondence.
- `"notifyOnCaseSeverity"`: The case severity for a support case that you want to receive
notifications. If you specify high or all, at least one of the following parameters must be
true: notifyOnAddCorrespondenceToCase notifyOnCreateOrReopenCase
notifyOnResolveCase If you specify none, any of the following parameters that you
specify in your request must be false: notifyOnAddCorrespondenceToCase
notifyOnCreateOrReopenCase notifyOnResolveCase If you don't specify these
parameters in your request, the Amazon Web Services Support App uses the current values by
default.
- `"notifyOnCreateOrReopenCase"`: Whether you want to get notified when a support case is
created or reopened.
- `"notifyOnResolveCase"`: Whether you want to get notified when a support case is resolved.
"""
function update_slack_channel_configuration(
channelId, teamId; aws_config::AbstractAWSConfig=global_aws_config()
)
return support_app(
"POST",
"/control/update-slack-channel-configuration",
Dict{String,Any}("channelId" => channelId, "teamId" => teamId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_slack_channel_configuration(
channelId,
teamId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return support_app(
"POST",
"/control/update-slack-channel-configuration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("channelId" => channelId, "teamId" => teamId),
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 | 117781 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: swf
using AWS.Compat
using AWS.UUIDs
"""
count_closed_workflow_executions(domain)
count_closed_workflow_executions(domain, params::Dict{String,<:Any})
Returns the number of closed workflow executions within the given domain that meet the
specified filtering criteria. This operation is eventually consistent. The results are
best effort and may not exactly reflect recent updates and changes. Access Control You
can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action. Constrain the
following parameters by using a Condition element with the appropriate keys.
tagFilter.tag: String constraint. The key is swf:tagFilter.tag. typeFilter.name: String
constraint. The key is swf:typeFilter.name. typeFilter.version: String constraint. The
key is swf:typeFilter.version. If the caller doesn't have sufficient permissions to
invoke the action, or the parameter values fall outside the specified constraints, the
action fails. The associated event attribute's cause parameter is set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage
Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
# Arguments
- `domain`: The name of the domain containing the workflow executions to count.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"closeStatusFilter"`: If specified, only workflow executions that match this close
status are counted. This filter has an affect only if executionStatus is specified as
CLOSED. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually
exclusive. You can specify at most one of these in a request.
- `"closeTimeFilter"`: If specified, only workflow executions that meet the close time
criteria of the filter are counted. startTimeFilter and closeTimeFilter are mutually
exclusive. You must specify one of these in a request but not both.
- `"executionFilter"`: If specified, only workflow executions matching the WorkflowId in
the filter are counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are
mutually exclusive. You can specify at most one of these in a request.
- `"startTimeFilter"`: If specified, only workflow executions that meet the start time
criteria of the filter are counted. startTimeFilter and closeTimeFilter are mutually
exclusive. You must specify one of these in a request but not both.
- `"tagFilter"`: If specified, only executions that have a tag that matches the filter are
counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually
exclusive. You can specify at most one of these in a request.
- `"typeFilter"`: If specified, indicates the type of the workflow executions to be
counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually
exclusive. You can specify at most one of these in a request.
"""
function count_closed_workflow_executions(
domain; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"CountClosedWorkflowExecutions",
Dict{String,Any}("domain" => domain);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function count_closed_workflow_executions(
domain, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"CountClosedWorkflowExecutions",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("domain" => domain), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
count_open_workflow_executions(domain, start_time_filter)
count_open_workflow_executions(domain, start_time_filter, params::Dict{String,<:Any})
Returns the number of open workflow executions within the given domain that meet the
specified filtering criteria. This operation is eventually consistent. The results are
best effort and may not exactly reflect recent updates and changes. Access Control You
can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action. Constrain the
following parameters by using a Condition element with the appropriate keys.
tagFilter.tag: String constraint. The key is swf:tagFilter.tag. typeFilter.name: String
constraint. The key is swf:typeFilter.name. typeFilter.version: String constraint. The
key is swf:typeFilter.version. If the caller doesn't have sufficient permissions to
invoke the action, or the parameter values fall outside the specified constraints, the
action fails. The associated event attribute's cause parameter is set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage
Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
# Arguments
- `domain`: The name of the domain containing the workflow executions to count.
- `start_time_filter`: Specifies the start time criteria that workflow executions must meet
in order to be counted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"executionFilter"`: If specified, only workflow executions matching the WorkflowId in
the filter are counted. executionFilter, typeFilter and tagFilter are mutually exclusive.
You can specify at most one of these in a request.
- `"tagFilter"`: If specified, only executions that have a tag that matches the filter are
counted. executionFilter, typeFilter and tagFilter are mutually exclusive. You can
specify at most one of these in a request.
- `"typeFilter"`: Specifies the type of the workflow executions to be counted.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most
one of these in a request.
"""
function count_open_workflow_executions(
domain, startTimeFilter; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"CountOpenWorkflowExecutions",
Dict{String,Any}("domain" => domain, "startTimeFilter" => startTimeFilter);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function count_open_workflow_executions(
domain,
startTimeFilter,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return swf(
"CountOpenWorkflowExecutions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("domain" => domain, "startTimeFilter" => startTimeFilter),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
count_pending_activity_tasks(domain, task_list)
count_pending_activity_tasks(domain, task_list, params::Dict{String,<:Any})
Returns the estimated number of activity tasks in the specified task list. The count
returned is an approximation and isn't guaranteed to be exact. If you specify a task list
that no activity task was ever scheduled in then 0 is returned. Access Control You can
use IAM policies to control this action's access to Amazon SWF resources as follows: Use
a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action. Constrain the
taskList.name parameter by using a Condition element with the swf:taskList.name key to
allow the action to access only certain task lists. If the caller doesn't have sufficient
permissions to invoke the action, or the parameter values fall outside the specified
constraints, the action fails. The associated event attribute's cause parameter is set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage
Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
# Arguments
- `domain`: The name of the domain that contains the task list.
- `task_list`: The name of the task list.
"""
function count_pending_activity_tasks(
domain, taskList; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"CountPendingActivityTasks",
Dict{String,Any}("domain" => domain, "taskList" => taskList);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function count_pending_activity_tasks(
domain,
taskList,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return swf(
"CountPendingActivityTasks",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("domain" => domain, "taskList" => taskList), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
count_pending_decision_tasks(domain, task_list)
count_pending_decision_tasks(domain, task_list, params::Dict{String,<:Any})
Returns the estimated number of decision tasks in the specified task list. The count
returned is an approximation and isn't guaranteed to be exact. If you specify a task list
that no decision task was ever scheduled in then 0 is returned. Access Control You can
use IAM policies to control this action's access to Amazon SWF resources as follows: Use
a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action. Constrain the
taskList.name parameter by using a Condition element with the swf:taskList.name key to
allow the action to access only certain task lists. If the caller doesn't have sufficient
permissions to invoke the action, or the parameter values fall outside the specified
constraints, the action fails. The associated event attribute's cause parameter is set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage
Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
# Arguments
- `domain`: The name of the domain that contains the task list.
- `task_list`: The name of the task list.
"""
function count_pending_decision_tasks(
domain, taskList; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"CountPendingDecisionTasks",
Dict{String,Any}("domain" => domain, "taskList" => taskList);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function count_pending_decision_tasks(
domain,
taskList,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return swf(
"CountPendingDecisionTasks",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("domain" => domain, "taskList" => taskList), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_activity_type(activity_type, domain)
delete_activity_type(activity_type, domain, params::Dict{String,<:Any})
Deletes the specified activity type. Note: Prior to deletion, activity types must first be
deprecated. After an activity type has been deleted, you cannot schedule new activities
of that type. Activities that started before the type was deleted will continue to run.
Access Control You can use IAM policies to control this action's access to Amazon SWF
resources as follows: Use a Resource element with the domain name to limit the action to
only specified domains. Use an Action element to allow or deny permission to call this
action. Constrain the following parameters by using a Condition element with the
appropriate keys. activityType.name: String constraint. The key is
swf:activityType.name. activityType.version: String constraint. The key is
swf:activityType.version. If the caller doesn't have sufficient permissions to invoke
the action, or the parameter values fall outside the specified constraints, the action
fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED.
For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF
Workflows in the Amazon SWF Developer Guide.
# Arguments
- `activity_type`: The activity type to delete.
- `domain`: The name of the domain in which the activity type is registered.
"""
function delete_activity_type(
activityType, domain; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"DeleteActivityType",
Dict{String,Any}("activityType" => activityType, "domain" => domain);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_activity_type(
activityType,
domain,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return swf(
"DeleteActivityType",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("activityType" => activityType, "domain" => domain),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_workflow_type(domain, workflow_type)
delete_workflow_type(domain, workflow_type, params::Dict{String,<:Any})
Deletes the specified workflow type. Note: Prior to deletion, workflow types must first be
deprecated. After a workflow type has been deleted, you cannot create new executions of
that type. Executions that started before the type was deleted will continue to run.
Access Control You can use IAM policies to control this action's access to Amazon SWF
resources as follows: Use a Resource element with the domain name to limit the action to
only specified domains. Use an Action element to allow or deny permission to call this
action. Constrain the following parameters by using a Condition element with the
appropriate keys. workflowType.name: String constraint. The key is
swf:workflowType.name. workflowType.version: String constraint. The key is
swf:workflowType.version. If the caller doesn't have sufficient permissions to invoke
the action, or the parameter values fall outside the specified constraints, the action
fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED.
For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF
Workflows in the Amazon SWF Developer Guide.
# Arguments
- `domain`: The name of the domain in which the workflow type is registered.
- `workflow_type`: The workflow type to delete.
"""
function delete_workflow_type(
domain, workflowType; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"DeleteWorkflowType",
Dict{String,Any}("domain" => domain, "workflowType" => workflowType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_workflow_type(
domain,
workflowType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return swf(
"DeleteWorkflowType",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("domain" => domain, "workflowType" => workflowType),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deprecate_activity_type(activity_type, domain)
deprecate_activity_type(activity_type, domain, params::Dict{String,<:Any})
Deprecates the specified activity type. After an activity type has been deprecated, you
cannot create new tasks of that activity type. Tasks of this type that were scheduled
before the type was deprecated continue to run. Access Control You can use IAM policies
to control this action's access to Amazon SWF resources as follows: Use a Resource
element with the domain name to limit the action to only specified domains. Use an Action
element to allow or deny permission to call this action. Constrain the following
parameters by using a Condition element with the appropriate keys. activityType.name:
String constraint. The key is swf:activityType.name. activityType.version: String
constraint. The key is swf:activityType.version. If the caller doesn't have sufficient
permissions to invoke the action, or the parameter values fall outside the specified
constraints, the action fails. The associated event attribute's cause parameter is set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage
Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
# Arguments
- `activity_type`: The activity type to deprecate.
- `domain`: The name of the domain in which the activity type is registered.
"""
function deprecate_activity_type(
activityType, domain; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"DeprecateActivityType",
Dict{String,Any}("activityType" => activityType, "domain" => domain);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deprecate_activity_type(
activityType,
domain,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return swf(
"DeprecateActivityType",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("activityType" => activityType, "domain" => domain),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deprecate_domain(name)
deprecate_domain(name, params::Dict{String,<:Any})
Deprecates the specified domain. After a domain has been deprecated it cannot be used to
create new workflow executions or register new types. However, you can still use visibility
actions on this domain. Deprecating a domain also deprecates all activity and workflow
types registered in the domain. Executions that were started before the domain was
deprecated continues to run. This operation is eventually consistent. The results are best
effort and may not exactly reflect recent updates and changes. Access Control You can
use IAM policies to control this action's access to Amazon SWF resources as follows: Use
a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action. You cannot use an
IAM policy to constrain this action's parameters. If the caller doesn't have sufficient
permissions to invoke the action, or the parameter values fall outside the specified
constraints, the action fails. The associated event attribute's cause parameter is set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage
Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
# Arguments
- `name`: The name of the domain to deprecate.
"""
function deprecate_domain(name; aws_config::AbstractAWSConfig=global_aws_config())
return swf(
"DeprecateDomain",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deprecate_domain(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"DeprecateDomain",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deprecate_workflow_type(domain, workflow_type)
deprecate_workflow_type(domain, workflow_type, params::Dict{String,<:Any})
Deprecates the specified workflow type. After a workflow type has been deprecated, you
cannot create new executions of that type. Executions that were started before the type was
deprecated continues to run. A deprecated workflow type may still be used when calling
visibility actions. This operation is eventually consistent. The results are best effort
and may not exactly reflect recent updates and changes. Access Control You can use IAM
policies to control this action's access to Amazon SWF resources as follows: Use a
Resource element with the domain name to limit the action to only specified domains. Use
an Action element to allow or deny permission to call this action. Constrain the
following parameters by using a Condition element with the appropriate keys.
workflowType.name: String constraint. The key is swf:workflowType.name.
workflowType.version: String constraint. The key is swf:workflowType.version. If the
caller doesn't have sufficient permissions to invoke the action, or the parameter values
fall outside the specified constraints, the action fails. The associated event attribute's
cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies,
see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
# Arguments
- `domain`: The name of the domain in which the workflow type is registered.
- `workflow_type`: The workflow type to deprecate.
"""
function deprecate_workflow_type(
domain, workflowType; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"DeprecateWorkflowType",
Dict{String,Any}("domain" => domain, "workflowType" => workflowType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deprecate_workflow_type(
domain,
workflowType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return swf(
"DeprecateWorkflowType",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("domain" => domain, "workflowType" => workflowType),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_activity_type(activity_type, domain)
describe_activity_type(activity_type, domain, params::Dict{String,<:Any})
Returns information about the specified activity type. This includes configuration settings
provided when the type was registered and other general information about the type. Access
Control You can use IAM policies to control this action's access to Amazon SWF resources
as follows: Use a Resource element with the domain name to limit the action to only
specified domains. Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate
keys. activityType.name: String constraint. The key is swf:activityType.name.
activityType.version: String constraint. The key is swf:activityType.version. If the
caller doesn't have sufficient permissions to invoke the action, or the parameter values
fall outside the specified constraints, the action fails. The associated event attribute's
cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies,
see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
# Arguments
- `activity_type`: The activity type to get information about. Activity types are
identified by the name and version that were supplied when the activity was registered.
- `domain`: The name of the domain in which the activity type is registered.
"""
function describe_activity_type(
activityType, domain; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"DescribeActivityType",
Dict{String,Any}("activityType" => activityType, "domain" => domain);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_activity_type(
activityType,
domain,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return swf(
"DescribeActivityType",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("activityType" => activityType, "domain" => domain),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_domain(name)
describe_domain(name, params::Dict{String,<:Any})
Returns information about the specified domain, including description and status. Access
Control You can use IAM policies to control this action's access to Amazon SWF resources
as follows: Use a Resource element with the domain name to limit the action to only
specified domains. Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters. If the caller
doesn't have sufficient permissions to invoke the action, or the parameter values fall
outside the specified constraints, the action fails. The associated event attribute's cause
parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see
Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
# Arguments
- `name`: The name of the domain to describe.
"""
function describe_domain(name; aws_config::AbstractAWSConfig=global_aws_config())
return swf(
"DescribeDomain",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_domain(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"DescribeDomain",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_workflow_execution(domain, execution)
describe_workflow_execution(domain, execution, params::Dict{String,<:Any})
Returns information about the specified workflow execution including its type and some
statistics. This operation is eventually consistent. The results are best effort and may
not exactly reflect recent updates and changes. Access Control You can use IAM policies
to control this action's access to Amazon SWF resources as follows: Use a Resource
element with the domain name to limit the action to only specified domains. Use an Action
element to allow or deny permission to call this action. You cannot use an IAM policy to
constrain this action's parameters. If the caller doesn't have sufficient permissions to
invoke the action, or the parameter values fall outside the specified constraints, the
action fails. The associated event attribute's cause parameter is set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage
Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
# Arguments
- `domain`: The name of the domain containing the workflow execution.
- `execution`: The workflow execution to describe.
"""
function describe_workflow_execution(
domain, execution; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"DescribeWorkflowExecution",
Dict{String,Any}("domain" => domain, "execution" => execution);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_workflow_execution(
domain,
execution,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return swf(
"DescribeWorkflowExecution",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("domain" => domain, "execution" => execution),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_workflow_type(domain, workflow_type)
describe_workflow_type(domain, workflow_type, params::Dict{String,<:Any})
Returns information about the specified workflow type. This includes configuration settings
specified when the type was registered and other information such as creation date, current
status, etc. Access Control You can use IAM policies to control this action's access to
Amazon SWF resources as follows: Use a Resource element with the domain name to limit the
action to only specified domains. Use an Action element to allow or deny permission to
call this action. Constrain the following parameters by using a Condition element with
the appropriate keys. workflowType.name: String constraint. The key is
swf:workflowType.name. workflowType.version: String constraint. The key is
swf:workflowType.version. If the caller doesn't have sufficient permissions to invoke
the action, or the parameter values fall outside the specified constraints, the action
fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED.
For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF
Workflows in the Amazon SWF Developer Guide.
# Arguments
- `domain`: The name of the domain in which this workflow type is registered.
- `workflow_type`: The workflow type to describe.
"""
function describe_workflow_type(
domain, workflowType; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"DescribeWorkflowType",
Dict{String,Any}("domain" => domain, "workflowType" => workflowType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_workflow_type(
domain,
workflowType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return swf(
"DescribeWorkflowType",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("domain" => domain, "workflowType" => workflowType),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_workflow_execution_history(domain, execution)
get_workflow_execution_history(domain, execution, params::Dict{String,<:Any})
Returns the history of the specified workflow execution. The results may be split into
multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken
returned by the initial call. This operation is eventually consistent. The results are
best effort and may not exactly reflect recent updates and changes. Access Control You
can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action. You cannot use an
IAM policy to constrain this action's parameters. If the caller doesn't have sufficient
permissions to invoke the action, or the parameter values fall outside the specified
constraints, the action fails. The associated event attribute's cause parameter is set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage
Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
# Arguments
- `domain`: The name of the domain containing the workflow execution.
- `execution`: Specifies the workflow execution for which to return the history.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maximumPageSize"`: The maximum number of results that are returned per call. Use
nextPageToken to obtain further pages of results.
- `"nextPageToken"`: If NextPageToken is returned there are more results available. The
value of NextPageToken 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
a 400 error: \"Specified token has exceeded its maximum lifetime\". The configured
maximumPageSize determines how many results can be returned in a single call.
- `"reverseOrder"`: When set to true, returns the events in reverse order. By default the
results are returned in ascending order of the eventTimeStamp of the events.
"""
function get_workflow_execution_history(
domain, execution; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"GetWorkflowExecutionHistory",
Dict{String,Any}("domain" => domain, "execution" => execution);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_workflow_execution_history(
domain,
execution,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return swf(
"GetWorkflowExecutionHistory",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("domain" => domain, "execution" => execution),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_activity_types(domain, registration_status)
list_activity_types(domain, registration_status, params::Dict{String,<:Any})
Returns information about all activities registered in the specified domain that match the
specified name and registration status. The result includes information like creation date,
current status of the activity, etc. The results may be split into multiple pages. To
retrieve subsequent pages, make the call again using the nextPageToken returned by the
initial call. Access Control You can use IAM policies to control this action's access to
Amazon SWF resources as follows: Use a Resource element with the domain name to limit the
action to only specified domains. Use an Action element to allow or deny permission to
call this action. You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter
values fall outside the specified constraints, the action fails. The associated event
attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM
policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF
Developer Guide.
# Arguments
- `domain`: The name of the domain in which the activity types have been registered.
- `registration_status`: Specifies the registration status of the activity types to list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maximumPageSize"`: The maximum number of results that are returned per call. Use
nextPageToken to obtain further pages of results.
- `"name"`: If specified, only lists the activity types that have this name.
- `"nextPageToken"`: If NextPageToken is returned there are more results available. The
value of NextPageToken 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
a 400 error: \"Specified token has exceeded its maximum lifetime\". The configured
maximumPageSize determines how many results can be returned in a single call.
- `"reverseOrder"`: When set to true, returns the results in reverse order. By default, the
results are returned in ascending alphabetical order by name of the activity types.
"""
function list_activity_types(
domain, registrationStatus; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"ListActivityTypes",
Dict{String,Any}("domain" => domain, "registrationStatus" => registrationStatus);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_activity_types(
domain,
registrationStatus,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return swf(
"ListActivityTypes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"domain" => domain, "registrationStatus" => registrationStatus
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_closed_workflow_executions(domain)
list_closed_workflow_executions(domain, params::Dict{String,<:Any})
Returns a list of closed workflow executions in the specified domain that meet the
filtering criteria. The results may be split into multiple pages. To retrieve subsequent
pages, make the call again using the nextPageToken returned by the initial call. This
operation is eventually consistent. The results are best effort and may not exactly reflect
recent updates and changes. Access Control You can use IAM policies to control this
action's access to Amazon SWF resources as follows: Use a Resource element with the
domain name to limit the action to only specified domains. Use an Action element to allow
or deny permission to call this action. Constrain the following parameters by using a
Condition element with the appropriate keys. tagFilter.tag: String constraint. The key
is swf:tagFilter.tag. typeFilter.name: String constraint. The key is
swf:typeFilter.name. typeFilter.version: String constraint. The key is
swf:typeFilter.version. If the caller doesn't have sufficient permissions to invoke the
action, or the parameter values fall outside the specified constraints, the action fails.
The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For
details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in
the Amazon SWF Developer Guide.
# Arguments
- `domain`: The name of the domain that contains the workflow executions to list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"closeStatusFilter"`: If specified, only workflow executions that match this close
status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow
executions are listed. closeStatusFilter, executionFilter, typeFilter and tagFilter are
mutually exclusive. You can specify at most one of these in a request.
- `"closeTimeFilter"`: If specified, the workflow executions are included in the returned
results based on whether their close times are within the range specified by this filter.
Also, if this parameter is specified, the returned results are ordered by their close
times. startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one
of these in a request but not both.
- `"executionFilter"`: If specified, only workflow executions matching the workflow ID
specified in the filter are returned. closeStatusFilter, executionFilter, typeFilter and
tagFilter are mutually exclusive. You can specify at most one of these in a request.
- `"maximumPageSize"`: The maximum number of results that are returned per call. Use
nextPageToken to obtain further pages of results.
- `"nextPageToken"`: If NextPageToken is returned there are more results available. The
value of NextPageToken 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
a 400 error: \"Specified token has exceeded its maximum lifetime\". The configured
maximumPageSize determines how many results can be returned in a single call.
- `"reverseOrder"`: When set to true, returns the results in reverse order. By default the
results are returned in descending order of the start or the close time of the executions.
- `"startTimeFilter"`: If specified, the workflow executions are included in the returned
results based on whether their start times are within the range specified by this filter.
Also, if this parameter is specified, the returned results are ordered by their start
times. startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one
of these in a request but not both.
- `"tagFilter"`: If specified, only executions that have the matching tag are listed.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You
can specify at most one of these in a request.
- `"typeFilter"`: If specified, only executions of the type specified in the filter are
returned. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually
exclusive. You can specify at most one of these in a request.
"""
function list_closed_workflow_executions(
domain; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"ListClosedWorkflowExecutions",
Dict{String,Any}("domain" => domain);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_closed_workflow_executions(
domain, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"ListClosedWorkflowExecutions",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("domain" => domain), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_domains(registration_status)
list_domains(registration_status, params::Dict{String,<:Any})
Returns the list of domains registered in the account. The results may be split into
multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken
returned by the initial call. This operation is eventually consistent. The results are
best effort and may not exactly reflect recent updates and changes. Access Control You
can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified domains.
The element must be set to arn:aws:swf::AccountID:domain/*, where AccountID is the account
ID, with no dashes. Use an Action element to allow or deny permission to call this
action. You cannot use an IAM policy to constrain this action's parameters. If the
caller doesn't have sufficient permissions to invoke the action, or the parameter values
fall outside the specified constraints, the action fails. The associated event attribute's
cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies,
see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
# Arguments
- `registration_status`: Specifies the registration status of the domains to list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maximumPageSize"`: The maximum number of results that are returned per call. Use
nextPageToken to obtain further pages of results.
- `"nextPageToken"`: If NextPageToken is returned there are more results available. The
value of NextPageToken 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
a 400 error: \"Specified token has exceeded its maximum lifetime\". The configured
maximumPageSize determines how many results can be returned in a single call.
- `"reverseOrder"`: When set to true, returns the results in reverse order. By default, the
results are returned in ascending alphabetical order by name of the domains.
"""
function list_domains(registrationStatus; aws_config::AbstractAWSConfig=global_aws_config())
return swf(
"ListDomains",
Dict{String,Any}("registrationStatus" => registrationStatus);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_domains(
registrationStatus,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return swf(
"ListDomains",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("registrationStatus" => registrationStatus), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_open_workflow_executions(domain, start_time_filter)
list_open_workflow_executions(domain, start_time_filter, params::Dict{String,<:Any})
Returns a list of open workflow executions in the specified domain that meet the filtering
criteria. The results may be split into multiple pages. To retrieve subsequent pages, make
the call again using the nextPageToken returned by the initial call. This operation is
eventually consistent. The results are best effort and may not exactly reflect recent
updates and changes. Access Control You can use IAM policies to control this action's
access to Amazon SWF resources as follows: Use a Resource element with the domain name to
limit the action to only specified domains. Use an Action element to allow or deny
permission to call this action. Constrain the following parameters by using a Condition
element with the appropriate keys. tagFilter.tag: String constraint. The key is
swf:tagFilter.tag. typeFilter.name: String constraint. The key is swf:typeFilter.name.
typeFilter.version: String constraint. The key is swf:typeFilter.version. If the
caller doesn't have sufficient permissions to invoke the action, or the parameter values
fall outside the specified constraints, the action fails. The associated event attribute's
cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies,
see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
# Arguments
- `domain`: The name of the domain that contains the workflow executions to list.
- `start_time_filter`: Workflow executions are included in the returned results based on
whether their start times are within the range specified by this filter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"executionFilter"`: If specified, only workflow executions matching the workflow ID
specified in the filter are returned. executionFilter, typeFilter and tagFilter are
mutually exclusive. You can specify at most one of these in a request.
- `"maximumPageSize"`: The maximum number of results that are returned per call. Use
nextPageToken to obtain further pages of results.
- `"nextPageToken"`: If NextPageToken is returned there are more results available. The
value of NextPageToken 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
a 400 error: \"Specified token has exceeded its maximum lifetime\". The configured
maximumPageSize determines how many results can be returned in a single call.
- `"reverseOrder"`: When set to true, returns the results in reverse order. By default the
results are returned in descending order of the start time of the executions.
- `"tagFilter"`: If specified, only executions that have the matching tag are listed.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most
one of these in a request.
- `"typeFilter"`: If specified, only executions of the type specified in the filter are
returned. executionFilter, typeFilter and tagFilter are mutually exclusive. You can
specify at most one of these in a request.
"""
function list_open_workflow_executions(
domain, startTimeFilter; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"ListOpenWorkflowExecutions",
Dict{String,Any}("domain" => domain, "startTimeFilter" => startTimeFilter);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_open_workflow_executions(
domain,
startTimeFilter,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return swf(
"ListOpenWorkflowExecutions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("domain" => domain, "startTimeFilter" => startTimeFilter),
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 tags for a given domain.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) for the Amazon SWF domain.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"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 swf(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_workflow_types(domain, registration_status)
list_workflow_types(domain, registration_status, params::Dict{String,<:Any})
Returns information about workflow types in the specified domain. The results may be split
into multiple pages that can be retrieved by making the call repeatedly. Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as
follows: Use a Resource element with the domain name to limit the action to only
specified domains. Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters. If the caller
doesn't have sufficient permissions to invoke the action, or the parameter values fall
outside the specified constraints, the action fails. The associated event attribute's cause
parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see
Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
# Arguments
- `domain`: The name of the domain in which the workflow types have been registered.
- `registration_status`: Specifies the registration status of the workflow types to list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maximumPageSize"`: The maximum number of results that are returned per call. Use
nextPageToken to obtain further pages of results.
- `"name"`: If specified, lists the workflow type with this name.
- `"nextPageToken"`: If NextPageToken is returned there are more results available. The
value of NextPageToken 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
a 400 error: \"Specified token has exceeded its maximum lifetime\". The configured
maximumPageSize determines how many results can be returned in a single call.
- `"reverseOrder"`: When set to true, returns the results in reverse order. By default the
results are returned in ascending alphabetical order of the name of the workflow types.
"""
function list_workflow_types(
domain, registrationStatus; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"ListWorkflowTypes",
Dict{String,Any}("domain" => domain, "registrationStatus" => registrationStatus);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_workflow_types(
domain,
registrationStatus,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return swf(
"ListWorkflowTypes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"domain" => domain, "registrationStatus" => registrationStatus
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
poll_for_activity_task(domain, task_list)
poll_for_activity_task(domain, task_list, params::Dict{String,<:Any})
Used by workers to get an ActivityTask from the specified activity taskList. This initiates
a long poll, where the service holds the HTTP connection open and responds as soon as a
task becomes available. The maximum time the service holds on to the request before
responding is 60 seconds. If no task is available within 60 seconds, the poll returns an
empty result. An empty result, in this context, means that an ActivityTask is returned, but
that the value of taskToken is an empty string. If a task is returned, the worker should
use its type to identify and process it correctly. Workers should set their client side
socket timeout to at least 70 seconds (10 seconds higher than the maximum time service may
hold the poll request). Access Control You can use IAM policies to control this action's
access to Amazon SWF resources as follows: Use a Resource element with the domain name to
limit the action to only specified domains. Use an Action element to allow or deny
permission to call this action. Constrain the taskList.name parameter by using a
Condition element with the swf:taskList.name key to allow the action to access only certain
task lists. If the caller doesn't have sufficient permissions to invoke the action, or
the parameter values fall outside the specified constraints, the action fails. The
associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details
and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the
Amazon SWF Developer Guide.
# Arguments
- `domain`: The name of the domain that contains the task lists being polled.
- `task_list`: Specifies the task list to poll for activity tasks. The specified string
must not start or end with whitespace. It must not contain a : (colon), / (slash), |
(vertical bar), or any control characters (u0000-u001f | u007f-u009f). Also, it must not be
the literal string arn.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"identity"`: Identity of the worker making the request, recorded in the
ActivityTaskStarted event in the workflow history. This enables diagnostic tracing when
problems arise. The form of this identity is user defined.
"""
function poll_for_activity_task(
domain, taskList; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"PollForActivityTask",
Dict{String,Any}("domain" => domain, "taskList" => taskList);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function poll_for_activity_task(
domain,
taskList,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return swf(
"PollForActivityTask",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("domain" => domain, "taskList" => taskList), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
poll_for_decision_task(domain, task_list)
poll_for_decision_task(domain, task_list, params::Dict{String,<:Any})
Used by deciders to get a DecisionTask from the specified decision taskList. A decision
task may be returned for any open workflow execution that is using the specified task list.
The task includes a paginated view of the history of the workflow execution. The decider
should use the workflow type and the history to determine how to properly handle the task.
This action initiates a long poll, where the service holds the HTTP connection open and
responds as soon a task becomes available. If no decision task is available in the
specified task list before the timeout of 60 seconds expires, an empty result is returned.
An empty result, in this context, means that a DecisionTask is returned, but that the value
of taskToken is an empty string. Deciders should set their client side socket timeout to
at least 70 seconds (10 seconds higher than the timeout). Because the number of workflow
history events for a single workflow execution might be very large, the result returned
might be split up across a number of pages. To retrieve subsequent pages, make additional
calls to PollForDecisionTask using the nextPageToken returned by the initial call. Note
that you do not call GetWorkflowExecutionHistory with this nextPageToken. Instead, call
PollForDecisionTask again. Access Control You can use IAM policies to control this
action's access to Amazon SWF resources as follows: Use a Resource element with the
domain name to limit the action to only specified domains. Use an Action element to allow
or deny permission to call this action. Constrain the taskList.name parameter by using a
Condition element with the swf:taskList.name key to allow the action to access only certain
task lists. If the caller doesn't have sufficient permissions to invoke the action, or
the parameter values fall outside the specified constraints, the action fails. The
associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details
and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the
Amazon SWF Developer Guide.
# Arguments
- `domain`: The name of the domain containing the task lists to poll.
- `task_list`: Specifies the task list to poll for decision tasks. The specified string
must not contain a : (colon), / (slash), | (vertical bar), or any control characters
(u0000-u001f | u007f-u009f). Also, it must not be the literal string arn.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"identity"`: Identity of the decider making the request, which is recorded in the
DecisionTaskStarted event in the workflow history. This enables diagnostic tracing when
problems arise. The form of this identity is user defined.
- `"maximumPageSize"`: The maximum number of results that are returned per call. Use
nextPageToken to obtain further pages of results. This is an upper limit only; the actual
number of results returned per call may be fewer than the specified maximum.
- `"nextPageToken"`: If NextPageToken is returned there are more results available. The
value of NextPageToken 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
a 400 error: \"Specified token has exceeded its maximum lifetime\". The configured
maximumPageSize determines how many results can be returned in a single call. The
nextPageToken returned by this action cannot be used with GetWorkflowExecutionHistory to
get the next page. You must call PollForDecisionTask again (with the nextPageToken) to
retrieve the next page of history records. Calling PollForDecisionTask with a nextPageToken
doesn't return a new decision task.
- `"reverseOrder"`: When set to true, returns the events in reverse order. By default the
results are returned in ascending order of the eventTimestamp of the events.
- `"startAtPreviousStartedEvent"`: When set to true, returns the events with eventTimestamp
greater than or equal to eventTimestamp of the most recent DecisionTaskStarted event. By
default, this parameter is set to false.
"""
function poll_for_decision_task(
domain, taskList; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"PollForDecisionTask",
Dict{String,Any}("domain" => domain, "taskList" => taskList);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function poll_for_decision_task(
domain,
taskList,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return swf(
"PollForDecisionTask",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("domain" => domain, "taskList" => taskList), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
record_activity_task_heartbeat(task_token)
record_activity_task_heartbeat(task_token, params::Dict{String,<:Any})
Used by activity workers to report to the service that the ActivityTask represented by the
specified taskToken is still making progress. The worker can also specify details of the
progress, for example percent complete, using the details parameter. This action can also
be used by the worker as a mechanism to check if cancellation is being requested for the
activity task. If a cancellation is being attempted for the specified task, then the
boolean cancelRequested flag returned by the service is set to true. This action resets the
taskHeartbeatTimeout clock. The taskHeartbeatTimeout is specified in RegisterActivityType.
This action doesn't in itself create an event in the workflow execution history. However,
if the task times out, the workflow execution history contains a ActivityTaskTimedOut event
that contains the information from the last heartbeat generated by the activity worker.
The taskStartToCloseTimeout of an activity type is the maximum duration of an activity
task, regardless of the number of RecordActivityTaskHeartbeat requests received. The
taskStartToCloseTimeout is also specified in RegisterActivityType. This operation is only
useful for long-lived activities to report liveliness of the task and to determine if a
cancellation is being attempted. If the cancelRequested flag returns true, a cancellation
is being attempted. If the worker can cancel the activity, it should respond with
RespondActivityTaskCanceled. Otherwise, it should ignore the cancellation request. Access
Control You can use IAM policies to control this action's access to Amazon SWF resources
as follows: Use a Resource element with the domain name to limit the action to only
specified domains. Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters. If the caller
doesn't have sufficient permissions to invoke the action, or the parameter values fall
outside the specified constraints, the action fails. The associated event attribute's cause
parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see
Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
# Arguments
- `task_token`: The taskToken of the ActivityTask. taskToken is generated by the service
and should be treated as an opaque value. If the task is passed to another process, its
taskToken must also be passed. This enables it to provide its progress and respond with
results.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"details"`: If specified, contains details about the progress of the task.
"""
function record_activity_task_heartbeat(
taskToken; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"RecordActivityTaskHeartbeat",
Dict{String,Any}("taskToken" => taskToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function record_activity_task_heartbeat(
taskToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return swf(
"RecordActivityTaskHeartbeat",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("taskToken" => taskToken), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_activity_type(domain, name, version)
register_activity_type(domain, name, version, params::Dict{String,<:Any})
Registers a new activity type along with its configuration settings in the specified
domain. A TypeAlreadyExists fault is returned if the type already exists in the domain.
You cannot change any configuration settings of the type after its registration, and it
must be registered as a new version. Access Control You can use IAM policies to control
this action's access to Amazon SWF resources as follows: Use a Resource element with the
domain name to limit the action to only specified domains. Use an Action element to allow
or deny permission to call this action. Constrain the following parameters by using a
Condition element with the appropriate keys. defaultTaskList.name: String constraint.
The key is swf:defaultTaskList.name. name: String constraint. The key is swf:name.
version: String constraint. The key is swf:version. If the caller doesn't have
sufficient permissions to invoke the action, or the parameter values fall outside the
specified constraints, the action fails. The associated event attribute's cause parameter
is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to
Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
# Arguments
- `domain`: The name of the domain in which this activity is to be registered.
- `name`: The name of the activity type within the domain. The specified string must not
contain a : (colon), / (slash), | (vertical bar), or any control characters (u0000-u001f |
u007f-u009f). Also, it must not be the literal string arn.
- `version`: The version of the activity type. The activity type consists of the name and
version, the combination of which must be unique within the domain. The specified string
must not contain a : (colon), / (slash), | (vertical bar), or any control characters
(u0000-u001f | u007f-u009f). Also, it must not be the literal string arn.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"defaultTaskHeartbeatTimeout"`: If set, specifies the default maximum time before which
a worker processing a task of this type must report progress by calling
RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically
timed out. This default can be overridden when scheduling an activity task using the
ScheduleActivityTask Decision. If the activity worker subsequently attempts to record a
heartbeat or returns a result, the activity worker receives an UnknownResource fault. In
this case, Amazon SWF no longer considers the activity task to be valid; the activity
worker should clean up the activity task. The duration is specified in seconds, an integer
greater than or equal to 0. You can use NONE to specify unlimited duration.
- `"defaultTaskList"`: If set, specifies the default task list to use for scheduling tasks
of this activity type. This default task list is used if a task list isn't provided when a
task is scheduled through the ScheduleActivityTask Decision.
- `"defaultTaskPriority"`: The default task priority to assign to the activity type. If not
assigned, then 0 is used. Valid values are integers that range from Java's
Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task
Priority in the in the Amazon SWF Developer Guide..
- `"defaultTaskScheduleToCloseTimeout"`: If set, specifies the default maximum duration for
a task of this activity type. This default can be overridden when scheduling an activity
task using the ScheduleActivityTask Decision. The duration is specified in seconds, an
integer greater than or equal to 0. You can use NONE to specify unlimited duration.
- `"defaultTaskScheduleToStartTimeout"`: If set, specifies the default maximum duration
that a task of this activity type can wait before being assigned to a worker. This default
can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.
The duration is specified in seconds, an integer greater than or equal to 0. You can use
NONE to specify unlimited duration.
- `"defaultTaskStartToCloseTimeout"`: If set, specifies the default maximum duration that a
worker can take to process tasks of this activity type. This default can be overridden when
scheduling an activity task using the ScheduleActivityTask Decision. The duration is
specified in seconds, an integer greater than or equal to 0. You can use NONE to specify
unlimited duration.
- `"description"`: A textual description of the activity type.
"""
function register_activity_type(
domain, name, version; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"RegisterActivityType",
Dict{String,Any}("domain" => domain, "name" => name, "version" => version);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_activity_type(
domain,
name,
version,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return swf(
"RegisterActivityType",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("domain" => domain, "name" => name, "version" => version),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_domain(name, workflow_execution_retention_period_in_days)
register_domain(name, workflow_execution_retention_period_in_days, params::Dict{String,<:Any})
Registers a new domain. Access Control You can use IAM policies to control this action's
access to Amazon SWF resources as follows: You cannot use an IAM policy to control domain
access for this action. The name of the domain being registered is available as the
resource of this action. Use an Action element to allow or deny permission to call this
action. You cannot use an IAM policy to constrain this action's parameters. If the
caller doesn't have sufficient permissions to invoke the action, or the parameter values
fall outside the specified constraints, the action fails. The associated event attribute's
cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies,
see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
# Arguments
- `name`: Name of the domain to register. The name must be unique in the region that the
domain is registered in. The specified string must not start or end with whitespace. It
must not contain a : (colon), / (slash), | (vertical bar), or any control characters
(u0000-u001f | u007f-u009f). Also, it must not be the literal string arn.
- `workflow_execution_retention_period_in_days`: The duration (in days) that records and
histories of workflow executions on the domain should be kept by the service. After the
retention period, the workflow execution isn't available in the results of visibility
calls. If you pass the value NONE or 0 (zero), then the workflow execution history isn't
retained. As soon as the workflow execution completes, the execution record and its history
are deleted. The maximum workflow execution retention period is 90 days. For more
information about Amazon SWF service limits, see: Amazon SWF Service Limits in the Amazon
SWF Developer Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A text description of the domain.
- `"tags"`: Tags to be added when registering a domain. Tags may only contain unicode
letters, digits, whitespace, or these symbols: _ . : / = + - @.
"""
function register_domain(
name,
workflowExecutionRetentionPeriodInDays;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return swf(
"RegisterDomain",
Dict{String,Any}(
"name" => name,
"workflowExecutionRetentionPeriodInDays" =>
workflowExecutionRetentionPeriodInDays,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_domain(
name,
workflowExecutionRetentionPeriodInDays,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return swf(
"RegisterDomain",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name,
"workflowExecutionRetentionPeriodInDays" =>
workflowExecutionRetentionPeriodInDays,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_workflow_type(domain, name, version)
register_workflow_type(domain, name, version, params::Dict{String,<:Any})
Registers a new workflow type and its configuration settings in the specified domain. The
retention period for the workflow history is set by the RegisterDomain action. If the type
already exists, then a TypeAlreadyExists fault is returned. You cannot change the
configuration settings of a workflow type once it is registered and it must be registered
as a new version. Access Control You can use IAM policies to control this action's
access to Amazon SWF resources as follows: Use a Resource element with the domain name to
limit the action to only specified domains. Use an Action element to allow or deny
permission to call this action. Constrain the following parameters by using a Condition
element with the appropriate keys. defaultTaskList.name: String constraint. The key is
swf:defaultTaskList.name. name: String constraint. The key is swf:name. version:
String constraint. The key is swf:version. If the caller doesn't have sufficient
permissions to invoke the action, or the parameter values fall outside the specified
constraints, the action fails. The associated event attribute's cause parameter is set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage
Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
# Arguments
- `domain`: The name of the domain in which to register the workflow type.
- `name`: The name of the workflow type. The specified string must not contain a : (colon),
/ (slash), | (vertical bar), or any control characters (u0000-u001f | u007f-u009f). Also,
it must not be the literal string arn.
- `version`: The version of the workflow type. The workflow type consists of the name and
version, the combination of which must be unique within the domain. To get a list of all
currently registered workflow types, use the ListWorkflowTypes action. The specified
string must not contain a : (colon), / (slash), | (vertical bar), or any control characters
(u0000-u001f | u007f-u009f). Also, it must not be the literal string arn.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"defaultChildPolicy"`: If set, specifies the default policy to use for the child
workflow executions when a workflow execution of this type is terminated, by calling the
TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can
be overridden when starting a workflow execution using the StartWorkflowExecution action or
the StartChildWorkflowExecution Decision. The supported child policies are: TERMINATE
– The child executions are terminated. REQUEST_CANCEL – A request to cancel is
attempted for each child execution by recording a WorkflowExecutionCancelRequested event in
its history. It is up to the decider to take appropriate actions when it receives an
execution history with this event. ABANDON – No action is taken. The child executions
continue to run.
- `"defaultExecutionStartToCloseTimeout"`: If set, specifies the default maximum duration
for executions of this workflow type. You can override this default when starting an
execution through the StartWorkflowExecution Action or StartChildWorkflowExecution
Decision. The duration is specified in seconds; an integer greater than or equal to 0.
Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of
\"NONE\" for defaultExecutionStartToCloseTimeout; there is a one-year max limit on the time
that a workflow execution can run. Exceeding this limit always causes the workflow
execution to time out.
- `"defaultLambdaRole"`: The default IAM role attached to this workflow type. Executions
of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an
IAM role when you start this workflow type, the default Lambda role is attached to the
execution. For more information, see
https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon
SWF Developer Guide.
- `"defaultTaskList"`: If set, specifies the default task list to use for scheduling
decision tasks for executions of this workflow type. This default is used only if a task
list isn't provided when starting the execution through the StartWorkflowExecution Action
or StartChildWorkflowExecution Decision.
- `"defaultTaskPriority"`: The default task priority to assign to the workflow type. If not
assigned, then 0 is used. Valid values are integers that range from Java's
Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task
Priority in the Amazon SWF Developer Guide.
- `"defaultTaskStartToCloseTimeout"`: If set, specifies the default maximum duration of
decision tasks for this workflow type. This default can be overridden when starting a
workflow execution using the StartWorkflowExecution action or the
StartChildWorkflowExecution Decision. The duration is specified in seconds, an integer
greater than or equal to 0. You can use NONE to specify unlimited duration.
- `"description"`: Textual description of the workflow type.
"""
function register_workflow_type(
domain, name, version; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"RegisterWorkflowType",
Dict{String,Any}("domain" => domain, "name" => name, "version" => version);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_workflow_type(
domain,
name,
version,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return swf(
"RegisterWorkflowType",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("domain" => domain, "name" => name, "version" => version),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
request_cancel_workflow_execution(domain, workflow_id)
request_cancel_workflow_execution(domain, workflow_id, params::Dict{String,<:Any})
Records a WorkflowExecutionCancelRequested event in the currently running workflow
execution identified by the given domain, workflowId, and runId. This logically requests
the cancellation of the workflow execution as a whole. It is up to the decider to take
appropriate actions when it receives an execution history with this event. If the runId
isn't specified, the WorkflowExecutionCancelRequested event is recorded in the history of
the current open workflow execution with the specified workflowId in the domain. Because
this action allows the workflow to properly clean up and gracefully close, it should be
used instead of TerminateWorkflowExecution when possible. Access Control You can use IAM
policies to control this action's access to Amazon SWF resources as follows: Use a
Resource element with the domain name to limit the action to only specified domains. Use
an Action element to allow or deny permission to call this action. You cannot use an IAM
policy to constrain this action's parameters. If the caller doesn't have sufficient
permissions to invoke the action, or the parameter values fall outside the specified
constraints, the action fails. The associated event attribute's cause parameter is set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage
Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
# Arguments
- `domain`: The name of the domain containing the workflow execution to cancel.
- `workflow_id`: The workflowId of the workflow execution to cancel.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"runId"`: The runId of the workflow execution to cancel.
"""
function request_cancel_workflow_execution(
domain, workflowId; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"RequestCancelWorkflowExecution",
Dict{String,Any}("domain" => domain, "workflowId" => workflowId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function request_cancel_workflow_execution(
domain,
workflowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return swf(
"RequestCancelWorkflowExecution",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("domain" => domain, "workflowId" => workflowId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
respond_activity_task_canceled(task_token)
respond_activity_task_canceled(task_token, params::Dict{String,<:Any})
Used by workers to tell the service that the ActivityTask identified by the taskToken was
successfully canceled. Additional details can be provided using the details argument. These
details (if provided) appear in the ActivityTaskCanceled event added to the workflow
history. Only use this operation if the canceled flag of a RecordActivityTaskHeartbeat
request returns true and if the activity can be safely undone or abandoned. A task is
considered open from the time that it is scheduled until it is closed. Therefore a task is
reported as open while a worker is processing it. A task is closed after it has been
specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled,
RespondActivityTaskFailed, or the task has timed out. Access Control You can use IAM
policies to control this action's access to Amazon SWF resources as follows: Use a
Resource element with the domain name to limit the action to only specified domains. Use
an Action element to allow or deny permission to call this action. You cannot use an IAM
policy to constrain this action's parameters. If the caller doesn't have sufficient
permissions to invoke the action, or the parameter values fall outside the specified
constraints, the action fails. The associated event attribute's cause parameter is set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage
Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
# Arguments
- `task_token`: The taskToken of the ActivityTask. taskToken is generated by the service
and should be treated as an opaque value. If the task is passed to another process, its
taskToken must also be passed. This enables it to provide its progress and respond with
results.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"details"`: Information about the cancellation.
"""
function respond_activity_task_canceled(
taskToken; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"RespondActivityTaskCanceled",
Dict{String,Any}("taskToken" => taskToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function respond_activity_task_canceled(
taskToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return swf(
"RespondActivityTaskCanceled",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("taskToken" => taskToken), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
respond_activity_task_completed(task_token)
respond_activity_task_completed(task_token, params::Dict{String,<:Any})
Used by workers to tell the service that the ActivityTask identified by the taskToken
completed successfully with a result (if provided). The result appears in the
ActivityTaskCompleted event in the workflow history. If the requested task doesn't
complete successfully, use RespondActivityTaskFailed instead. If the worker finds that the
task is canceled through the canceled flag returned by RecordActivityTaskHeartbeat, it
should cancel the task, clean up and then call RespondActivityTaskCanceled. A task is
considered open from the time that it is scheduled until it is closed. Therefore a task is
reported as open while a worker is processing it. A task is closed after it has been
specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled,
RespondActivityTaskFailed, or the task has timed out. Access Control You can use IAM
policies to control this action's access to Amazon SWF resources as follows: Use a
Resource element with the domain name to limit the action to only specified domains. Use
an Action element to allow or deny permission to call this action. You cannot use an IAM
policy to constrain this action's parameters. If the caller doesn't have sufficient
permissions to invoke the action, or the parameter values fall outside the specified
constraints, the action fails. The associated event attribute's cause parameter is set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage
Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
# Arguments
- `task_token`: The taskToken of the ActivityTask. taskToken is generated by the service
and should be treated as an opaque value. If the task is passed to another process, its
taskToken must also be passed. This enables it to provide its progress and respond with
results.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"result"`: The result of the activity task. It is a free form string that is
implementation specific.
"""
function respond_activity_task_completed(
taskToken; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"RespondActivityTaskCompleted",
Dict{String,Any}("taskToken" => taskToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function respond_activity_task_completed(
taskToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return swf(
"RespondActivityTaskCompleted",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("taskToken" => taskToken), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
respond_activity_task_failed(task_token)
respond_activity_task_failed(task_token, params::Dict{String,<:Any})
Used by workers to tell the service that the ActivityTask identified by the taskToken has
failed with reason (if specified). The reason and details appear in the ActivityTaskFailed
event added to the workflow history. A task is considered open from the time that it is
scheduled until it is closed. Therefore a task is reported as open while a worker is
processing it. A task is closed after it has been specified in a call to
RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or
the task has timed out. Access Control You can use IAM policies to control this action's
access to Amazon SWF resources as follows: Use a Resource element with the domain name to
limit the action to only specified domains. Use an Action element to allow or deny
permission to call this action. You cannot use an IAM policy to constrain this action's
parameters. If the caller doesn't have sufficient permissions to invoke the action, or
the parameter values fall outside the specified constraints, the action fails. The
associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details
and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the
Amazon SWF Developer Guide.
# Arguments
- `task_token`: The taskToken of the ActivityTask. taskToken is generated by the service
and should be treated as an opaque value. If the task is passed to another process, its
taskToken must also be passed. This enables it to provide its progress and respond with
results.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"details"`: Detailed information about the failure.
- `"reason"`: Description of the error that may assist in diagnostics.
"""
function respond_activity_task_failed(
taskToken; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"RespondActivityTaskFailed",
Dict{String,Any}("taskToken" => taskToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function respond_activity_task_failed(
taskToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return swf(
"RespondActivityTaskFailed",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("taskToken" => taskToken), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
respond_decision_task_completed(task_token)
respond_decision_task_completed(task_token, params::Dict{String,<:Any})
Used by deciders to tell the service that the DecisionTask identified by the taskToken has
successfully completed. The decisions argument specifies the list of decisions made while
processing the task. A DecisionTaskCompleted event is added to the workflow history. The
executionContext specified is attached to the event in the workflow execution history.
Access Control If an IAM policy grants permission to use RespondDecisionTaskCompleted, it
can express permissions for the list of decisions in the decisions parameter. Each of the
decisions has one or more parameters, much like a regular API call. To allow for policies
to be as readable as possible, you can express permissions on decisions as if they were
actual API calls, including applying conditions to some parameters. For more information,
see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
# Arguments
- `task_token`: The taskToken from the DecisionTask. taskToken is generated by the
service and should be treated as an opaque value. If the task is passed to another process,
its taskToken must also be passed. This enables it to provide its progress and respond with
results.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"decisions"`: The list of decisions (possibly empty) made by the decider while
processing this decision task. See the docs for the Decision structure for details.
- `"executionContext"`: User defined context to add to workflow execution.
- `"taskList"`: The task list to use for the future decision tasks of this workflow
execution. This list overrides the original task list you specified while starting the
workflow execution.
- `"taskListScheduleToStartTimeout"`: Specifies a timeout (in seconds) for the task list
override. When this parameter is missing, the task list override is permanent. This
parameter makes it possible to temporarily override the task list. If a decision task
scheduled on the override task list is not started within the timeout, the decision task
will time out. Amazon SWF will revert the override and schedule a new decision task to the
original task list. If a decision task scheduled on the override task list is started
within the timeout, but not completed within the start-to-close timeout, Amazon SWF will
also revert the override and schedule a new decision task to the original task list.
"""
function respond_decision_task_completed(
taskToken; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"RespondDecisionTaskCompleted",
Dict{String,Any}("taskToken" => taskToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function respond_decision_task_completed(
taskToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return swf(
"RespondDecisionTaskCompleted",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("taskToken" => taskToken), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
signal_workflow_execution(domain, signal_name, workflow_id)
signal_workflow_execution(domain, signal_name, workflow_id, params::Dict{String,<:Any})
Records a WorkflowExecutionSignaled event in the workflow execution history and creates a
decision task for the workflow execution identified by the given domain, workflowId and
runId. The event is recorded with the specified user defined signalName and input (if
provided). If a runId isn't specified, then the WorkflowExecutionSignaled event is
recorded in the history of the current open workflow with the matching workflowId in the
domain. If the specified workflow execution isn't open, this method fails with
UnknownResource. Access Control You can use IAM policies to control this action's access
to Amazon SWF resources as follows: Use a Resource element with the domain name to limit
the action to only specified domains. Use an Action element to allow or deny permission
to call this action. You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter
values fall outside the specified constraints, the action fails. The associated event
attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM
policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF
Developer Guide.
# Arguments
- `domain`: The name of the domain containing the workflow execution to signal.
- `signal_name`: The name of the signal. This name must be meaningful to the target
workflow.
- `workflow_id`: The workflowId of the workflow execution to signal.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"input"`: Data to attach to the WorkflowExecutionSignaled event in the target workflow
execution's history.
- `"runId"`: The runId of the workflow execution to signal.
"""
function signal_workflow_execution(
domain, signalName, workflowId; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"SignalWorkflowExecution",
Dict{String,Any}(
"domain" => domain, "signalName" => signalName, "workflowId" => workflowId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function signal_workflow_execution(
domain,
signalName,
workflowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return swf(
"SignalWorkflowExecution",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"domain" => domain,
"signalName" => signalName,
"workflowId" => workflowId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_workflow_execution(domain, workflow_id, workflow_type)
start_workflow_execution(domain, workflow_id, workflow_type, params::Dict{String,<:Any})
Starts an execution of the workflow type in the specified domain using the provided
workflowId and input data. This action returns the newly started workflow execution.
Access Control You can use IAM policies to control this action's access to Amazon SWF
resources as follows: Use a Resource element with the domain name to limit the action to
only specified domains. Use an Action element to allow or deny permission to call this
action. Constrain the following parameters by using a Condition element with the
appropriate keys. tagList.member.0: The key is swf:tagList.member.0.
tagList.member.1: The key is swf:tagList.member.1. tagList.member.2: The key is
swf:tagList.member.2. tagList.member.3: The key is swf:tagList.member.3.
tagList.member.4: The key is swf:tagList.member.4. taskList: String constraint. The key
is swf:taskList.name. workflowType.name: String constraint. The key is
swf:workflowType.name. workflowType.version: String constraint. The key is
swf:workflowType.version. If the caller doesn't have sufficient permissions to invoke
the action, or the parameter values fall outside the specified constraints, the action
fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED.
For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF
Workflows in the Amazon SWF Developer Guide.
# Arguments
- `domain`: The name of the domain in which the workflow execution is created. The
specified string must not contain a : (colon), / (slash), | (vertical bar), or any control
characters (u0000-u001f | u007f-u009f). Also, it must not be the literal string arn.
- `workflow_id`: The user defined identifier associated with the workflow execution. You
can use this to associate a custom identifier with the workflow execution. You may specify
the same identifier if a workflow execution is logically a restart of a previous execution.
You cannot have two open workflow executions with the same workflowId at the same time
within the same domain. The specified string must not contain a : (colon), / (slash), |
(vertical bar), or any control characters (u0000-u001f | u007f-u009f). Also, it must not be
the literal string arn.
- `workflow_type`: The type of the workflow to start.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"childPolicy"`: If set, specifies the policy to use for the child workflow executions of
this workflow execution if it is terminated, by calling the TerminateWorkflowExecution
action explicitly or due to an expired timeout. This policy overrides the default child
policy specified when registering the workflow type using RegisterWorkflowType. The
supported child policies are: TERMINATE – The child executions are terminated.
REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take
appropriate actions when it receives an execution history with this event. ABANDON –
No action is taken. The child executions continue to run. A child policy for this
workflow execution must be specified either as a default for the workflow type or through
this parameter. If neither this parameter is set nor a default child policy was specified
at registration time then a fault is returned.
- `"executionStartToCloseTimeout"`: The total duration for this workflow execution. This
overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow
type. The duration is specified in seconds; an integer greater than or equal to 0.
Exceeding this limit causes the workflow execution to time out. Unlike some of the other
timeout parameters in Amazon SWF, you cannot specify a value of \"NONE\" for this timeout;
there is a one-year max limit on the time that a workflow execution can run. An execution
start-to-close timeout must be specified either through this parameter or as a default when
the workflow type is registered. If neither this parameter nor a default execution
start-to-close timeout is specified, a fault is returned.
- `"input"`: The input for the workflow execution. This is a free form string which should
be meaningful to the workflow you are starting. This input is made available to the new
workflow execution in the WorkflowExecutionStarted history event.
- `"lambdaRole"`: The IAM role to attach to this workflow execution. Executions of this
workflow type need IAM roles to invoke Lambda functions. If you don't attach an IAM role,
any attempt to schedule a Lambda task fails. This results in a ScheduleLambdaFunctionFailed
history event. For more information, see
https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon
SWF Developer Guide.
- `"tagList"`: The list of tags to associate with the workflow execution. You can specify a
maximum of 5 tags. You can list workflow executions with a specific tag by calling
ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.
- `"taskList"`: The task list to use for the decision tasks generated for this workflow
execution. This overrides the defaultTaskList specified when registering the workflow type.
A task list for this workflow execution must be specified either as a default for the
workflow type or through this parameter. If neither this parameter is set nor a default
task list was specified at registration time then a fault is returned. The specified
string must not contain a : (colon), / (slash), | (vertical bar), or any control characters
(u0000-u001f | u007f-u009f). Also, it must not be the literal string arn.
- `"taskPriority"`: The task priority to use for this workflow execution. This overrides
any default priority that was assigned when the workflow type was registered. If not set,
then the default task priority for the workflow type is used. Valid values are integers
that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647).
Higher numbers indicate higher priority. For more information about setting task priority,
see Setting Task Priority in the Amazon SWF Developer Guide.
- `"taskStartToCloseTimeout"`: Specifies the maximum duration of decision tasks for this
workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified
when registering the workflow type using RegisterWorkflowType. The duration is specified in
seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited
duration. A task start-to-close timeout for this workflow execution must be specified
either as a default for the workflow type or through this parameter. If neither this
parameter is set nor a default task start-to-close timeout was specified at registration
time then a fault is returned.
"""
function start_workflow_execution(
domain, workflowId, workflowType; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"StartWorkflowExecution",
Dict{String,Any}(
"domain" => domain, "workflowId" => workflowId, "workflowType" => workflowType
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_workflow_execution(
domain,
workflowId,
workflowType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return swf(
"StartWorkflowExecution",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"domain" => domain,
"workflowId" => workflowId,
"workflowType" => workflowType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Add a tag to a Amazon SWF domain. Amazon SWF supports a maximum of 50 tags per resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) for the Amazon SWF domain.
- `tags`: The list of tags to add to a domain. Tags may only contain unicode letters,
digits, whitespace, or these symbols: _ . : / = + - @.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return swf(
"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 swf(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("resourceArn" => resourceArn, "tags" => tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
terminate_workflow_execution(domain, workflow_id)
terminate_workflow_execution(domain, workflow_id, params::Dict{String,<:Any})
Records a WorkflowExecutionTerminated event and forces closure of the workflow execution
identified by the given domain, runId, and workflowId. The child policy, registered with
the workflow type or specified when starting this execution, is applied to any open child
workflow executions of this workflow execution. If the identified workflow execution was
in progress, it is terminated immediately. If a runId isn't specified, then the
WorkflowExecutionTerminated event is recorded in the history of the current open workflow
with the matching workflowId in the domain. You should consider using
RequestCancelWorkflowExecution action instead because it allows the workflow to gracefully
close while TerminateWorkflowExecution doesn't. Access Control You can use IAM policies
to control this action's access to Amazon SWF resources as follows: Use a Resource
element with the domain name to limit the action to only specified domains. Use an Action
element to allow or deny permission to call this action. You cannot use an IAM policy to
constrain this action's parameters. If the caller doesn't have sufficient permissions to
invoke the action, or the parameter values fall outside the specified constraints, the
action fails. The associated event attribute's cause parameter is set to
OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage
Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
# Arguments
- `domain`: The domain of the workflow execution to terminate.
- `workflow_id`: The workflowId of the workflow execution to terminate.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"childPolicy"`: If set, specifies the policy to use for the child workflow executions of
the workflow execution being terminated. This policy overrides the child policy specified
for the workflow execution at registration time or when starting the execution. The
supported child policies are: TERMINATE – The child executions are terminated.
REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take
appropriate actions when it receives an execution history with this event. ABANDON –
No action is taken. The child executions continue to run. A child policy for this
workflow execution must be specified either as a default for the workflow type or through
this parameter. If neither this parameter is set nor a default child policy was specified
at registration time then a fault is returned.
- `"details"`: Details for terminating the workflow execution.
- `"reason"`: A descriptive reason for terminating the workflow execution.
- `"runId"`: The runId of the workflow execution to terminate.
"""
function terminate_workflow_execution(
domain, workflowId; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"TerminateWorkflowExecution",
Dict{String,Any}("domain" => domain, "workflowId" => workflowId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function terminate_workflow_execution(
domain,
workflowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return swf(
"TerminateWorkflowExecution",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("domain" => domain, "workflowId" => workflowId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
undeprecate_activity_type(activity_type, domain)
undeprecate_activity_type(activity_type, domain, params::Dict{String,<:Any})
Undeprecates a previously deprecated activity type. After an activity type has been
undeprecated, you can create new tasks of that activity type. This operation is eventually
consistent. The results are best effort and may not exactly reflect recent updates and
changes. Access Control You can use IAM policies to control this action's access to
Amazon SWF resources as follows: Use a Resource element with the domain name to limit the
action to only specified domains. Use an Action element to allow or deny permission to
call this action. Constrain the following parameters by using a Condition element with
the appropriate keys. activityType.name: String constraint. The key is
swf:activityType.name. activityType.version: String constraint. The key is
swf:activityType.version. If the caller doesn't have sufficient permissions to invoke
the action, or the parameter values fall outside the specified constraints, the action
fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED.
For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF
Workflows in the Amazon SWF Developer Guide.
# Arguments
- `activity_type`: The activity type to undeprecate.
- `domain`: The name of the domain of the deprecated activity type.
"""
function undeprecate_activity_type(
activityType, domain; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"UndeprecateActivityType",
Dict{String,Any}("activityType" => activityType, "domain" => domain);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function undeprecate_activity_type(
activityType,
domain,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return swf(
"UndeprecateActivityType",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("activityType" => activityType, "domain" => domain),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
undeprecate_domain(name)
undeprecate_domain(name, params::Dict{String,<:Any})
Undeprecates a previously deprecated domain. After a domain has been undeprecated it can be
used to create new workflow executions or register new types. This operation is eventually
consistent. The results are best effort and may not exactly reflect recent updates and
changes. Access Control You can use IAM policies to control this action's access to
Amazon SWF resources as follows: Use a Resource element with the domain name to limit the
action to only specified domains. Use an Action element to allow or deny permission to
call this action. You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter
values fall outside the specified constraints, the action fails. The associated event
attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM
policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF
Developer Guide.
# Arguments
- `name`: The name of the domain of the deprecated workflow type.
"""
function undeprecate_domain(name; aws_config::AbstractAWSConfig=global_aws_config())
return swf(
"UndeprecateDomain",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function undeprecate_domain(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"UndeprecateDomain",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
undeprecate_workflow_type(domain, workflow_type)
undeprecate_workflow_type(domain, workflow_type, params::Dict{String,<:Any})
Undeprecates a previously deprecated workflow type. After a workflow type has been
undeprecated, you can create new executions of that type. This operation is eventually
consistent. The results are best effort and may not exactly reflect recent updates and
changes. Access Control You can use IAM policies to control this action's access to
Amazon SWF resources as follows: Use a Resource element with the domain name to limit the
action to only specified domains. Use an Action element to allow or deny permission to
call this action. Constrain the following parameters by using a Condition element with
the appropriate keys. workflowType.name: String constraint. The key is
swf:workflowType.name. workflowType.version: String constraint. The key is
swf:workflowType.version. If the caller doesn't have sufficient permissions to invoke
the action, or the parameter values fall outside the specified constraints, the action
fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED.
For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF
Workflows in the Amazon SWF Developer Guide.
# Arguments
- `domain`: The name of the domain of the deprecated workflow type.
- `workflow_type`: The name of the domain of the deprecated workflow type.
"""
function undeprecate_workflow_type(
domain, workflowType; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"UndeprecateWorkflowType",
Dict{String,Any}("domain" => domain, "workflowType" => workflowType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function undeprecate_workflow_type(
domain,
workflowType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return swf(
"UndeprecateWorkflowType",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("domain" => domain, "workflowType" => workflowType),
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 a tag from a Amazon SWF domain.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) for the Amazon SWF domain.
- `tag_keys`: The list of tags to remove from the Amazon SWF domain.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return swf(
"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 swf(
"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 | 36484 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: synthetics
using AWS.Compat
using AWS.UUIDs
"""
associate_resource(resource_arn, group_identifier)
associate_resource(resource_arn, group_identifier, params::Dict{String,<:Any})
Associates a canary with a group. Using groups can help you with managing and automating
your canaries, and you can also view aggregated run results and statistics for all canaries
in a group. You must run this operation in the Region where the canary exists.
# Arguments
- `resource_arn`: The ARN of the canary that you want to associate with the specified group.
- `group_identifier`: Specifies the group. You can specify the group name, the ARN, or the
group ID as the GroupIdentifier.
"""
function associate_resource(
ResourceArn, groupIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return synthetics(
"PATCH",
"/group/$(groupIdentifier)/associate",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_resource(
ResourceArn,
groupIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return synthetics(
"PATCH",
"/group/$(groupIdentifier)/associate",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_canary(artifact_s3_location, code, execution_role_arn, name, runtime_version, schedule)
create_canary(artifact_s3_location, code, execution_role_arn, name, runtime_version, schedule, params::Dict{String,<:Any})
Creates a canary. Canaries are scripts that monitor your endpoints and APIs from the
outside-in. Canaries help you check the availability and latency of your web services and
troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and
metrics. You can set up a canary to run continuously or just once. Do not use CreateCanary
to modify an existing canary. Use UpdateCanary instead. To create canaries, you must have
the CloudWatchSyntheticsFullAccess policy. If you are creating a new IAM role for the
canary, you also need the iam:CreateRole, iam:CreatePolicy and iam:AttachRolePolicy
permissions. For more information, see Necessary Roles and Permissions. Do not include
secrets or proprietary information in your canary names. The canary name makes up part of
the Amazon Resource Name (ARN) for the canary, and the ARN is included in outbound calls
over the internet. For more information, see Security Considerations for Synthetics
Canaries.
# Arguments
- `artifact_s3_location`: The location in Amazon S3 where Synthetics stores artifacts from
the test runs of this canary. Artifacts include the log file, screenshots, and HAR files.
The name of the S3 bucket can't include a period (.).
- `code`: A structure that includes the entry point from which the canary should start
running your script. If the script is stored in an S3 bucket, the bucket name, key, and
version are also included.
- `execution_role_arn`: The ARN of the IAM role to be used to run the canary. This role
must already exist, and must include lambda.amazonaws.com as a principal in the trust
policy. The role must also have the following permissions: s3:PutObject
s3:GetBucketLocation s3:ListAllMyBuckets cloudwatch:PutMetricData
logs:CreateLogGroup logs:CreateLogStream logs:PutLogEvents
- `name`: The name for this canary. Be sure to give it a descriptive name that
distinguishes it from other canaries in your account. Do not include secrets or proprietary
information in your canary names. The canary name makes up part of the canary ARN, and the
ARN is included in outbound calls over the internet. For more information, see Security
Considerations for Synthetics Canaries.
- `runtime_version`: Specifies the runtime version to use for the canary. For a list of
valid runtime versions and more information about runtime versions, see Canary Runtime
Versions.
- `schedule`: A structure that contains information about how often the canary is to run
and when these test runs are to stop.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ArtifactConfig"`: A structure that contains the configuration for canary artifacts,
including the encryption-at-rest settings for artifacts that the canary uploads to Amazon
S3.
- `"FailureRetentionPeriodInDays"`: The number of days to retain data about failed runs of
this canary. If you omit this field, the default of 31 days is used. The valid range is 1
to 455 days.
- `"RunConfig"`: A structure that contains the configuration for individual canary runs,
such as timeout value and environment variables. The environment variables keys and values
are not encrypted. Do not store sensitive information in this field.
- `"SuccessRetentionPeriodInDays"`: The number of days to retain data about successful runs
of this canary. If you omit this field, the default of 31 days is used. The valid range is
1 to 455 days.
- `"Tags"`: A list of key-value pairs to associate with the canary. You can associate as
many as 50 tags with a canary. 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 the resources that have certain tag values.
- `"VpcConfig"`: If this canary is to test an endpoint in a VPC, this structure contains
information about the subnet and security groups of the VPC endpoint. For more information,
see Running a Canary in a VPC.
"""
function create_canary(
ArtifactS3Location,
Code,
ExecutionRoleArn,
Name,
RuntimeVersion,
Schedule;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return synthetics(
"POST",
"/canary",
Dict{String,Any}(
"ArtifactS3Location" => ArtifactS3Location,
"Code" => Code,
"ExecutionRoleArn" => ExecutionRoleArn,
"Name" => Name,
"RuntimeVersion" => RuntimeVersion,
"Schedule" => Schedule,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_canary(
ArtifactS3Location,
Code,
ExecutionRoleArn,
Name,
RuntimeVersion,
Schedule,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return synthetics(
"POST",
"/canary",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ArtifactS3Location" => ArtifactS3Location,
"Code" => Code,
"ExecutionRoleArn" => ExecutionRoleArn,
"Name" => Name,
"RuntimeVersion" => RuntimeVersion,
"Schedule" => Schedule,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_group(name)
create_group(name, params::Dict{String,<:Any})
Creates a group which you can use to associate canaries with each other, including
cross-Region canaries. Using groups can help you with managing and automating your
canaries, and you can also view aggregated run results and statistics for all canaries in a
group. Groups are global resources. When you create a group, it is replicated across
Amazon Web Services Regions, and you can view it and add canaries to it from any Region.
Although the group ARN format reflects the Region name where it was created, a group is not
constrained to any Region. This means that you can put canaries from multiple Regions into
the same group, and then use that group to view and manage all of those canaries in a
single view. Groups are supported in all Regions except the Regions that are disabled by
default. For more information about these Regions, see Enabling a Region. Each group can
contain as many as 10 canaries. You can have as many as 20 groups in your account. Any
single canary can be a member of up to 10 groups.
# Arguments
- `name`: The name for the group. It can include any Unicode characters. The names for all
groups in your account, across all Regions, must be unique.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: A list of key-value pairs to associate with the group. You can associate as
many as 50 tags with a group. 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 the resources that have certain tag values.
"""
function create_group(Name; aws_config::AbstractAWSConfig=global_aws_config())
return synthetics(
"POST",
"/group",
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 synthetics(
"POST",
"/group",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_canary(name)
delete_canary(name, params::Dict{String,<:Any})
Permanently deletes the specified canary. If you specify DeleteLambda to true, CloudWatch
Synthetics also deletes the Lambda functions and layers that are used by the canary. Other
resources used and created by the canary are not automatically deleted. After you delete a
canary that you do not intend to use again, you should also delete the following: The
CloudWatch alarms created for this canary. These alarms have a name of
Synthetics-SharpDrop-Alarm-MyCanaryName . Amazon S3 objects and buckets, such as the
canary's artifact location. IAM roles created for the canary. If they were created in the
console, these roles have the name role/service-role/CloudWatchSyntheticsRole-MyCanaryName
. CloudWatch Logs log groups created for the canary. These logs groups have the name
/aws/lambda/cwsyn-MyCanaryName . Before you delete a canary, you might want to use
GetCanary to display the information about this canary. Make note of the information
returned by this operation so that you can delete these resources after you delete the
canary.
# Arguments
- `name`: The name of the canary that you want to delete. To find the names of your
canaries, use DescribeCanaries.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"deleteLambda"`: Specifies whether to also delete the Lambda functions and layers used
by this canary. The default is false. Type: Boolean
"""
function delete_canary(name; aws_config::AbstractAWSConfig=global_aws_config())
return synthetics(
"DELETE", "/canary/$(name)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_canary(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return synthetics(
"DELETE",
"/canary/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_group(group_identifier)
delete_group(group_identifier, params::Dict{String,<:Any})
Deletes a group. The group doesn't need to be empty to be deleted. If there are canaries in
the group, they are not deleted when you delete the group. Groups are a global resource
that appear in all Regions, but the request to delete a group must be made from its home
Region. You can find the home Region of a group within its ARN.
# Arguments
- `group_identifier`: Specifies which group to delete. You can specify the group name, the
ARN, or the group ID as the GroupIdentifier.
"""
function delete_group(groupIdentifier; aws_config::AbstractAWSConfig=global_aws_config())
return synthetics(
"DELETE",
"/group/$(groupIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_group(
groupIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return synthetics(
"DELETE",
"/group/$(groupIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_canaries()
describe_canaries(params::Dict{String,<:Any})
This operation returns a list of the canaries in your account, along with full details
about each canary. This operation supports resource-level authorization using an IAM policy
and the Names parameter. If you specify the Names parameter, the operation is successful
only if you have authorization to view all the canaries that you specify in your request.
If you do not have permission to view any of the canaries, the request fails with a 403
response. You are required to use the Names parameter if you are logged on to a user or
role that has an IAM policy that restricts which canaries that you are allowed to view. For
more information, see Limiting a user to viewing specific canaries.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Specify this parameter to limit how many canaries are returned each time
you use the DescribeCanaries operation. If you omit this parameter, the default of 100 is
used.
- `"Names"`: Use this parameter to return only canaries that match the names that you
specify here. You can specify as many as five canary names. If you specify this parameter,
the operation is successful only if you have authorization to view all the canaries that
you specify in your request. If you do not have permission to view any of the canaries, the
request fails with a 403 response. You are required to use this parameter if you are logged
on to a user or role that has an IAM policy that restricts which canaries that you are
allowed to view. For more information, see Limiting a user to viewing specific canaries.
- `"NextToken"`: A token that indicates that there is more data available. You can use this
token in a subsequent operation to retrieve the next set of results.
"""
function describe_canaries(; aws_config::AbstractAWSConfig=global_aws_config())
return synthetics(
"POST", "/canaries"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_canaries(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return synthetics(
"POST", "/canaries", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_canaries_last_run()
describe_canaries_last_run(params::Dict{String,<:Any})
Use this operation to see information from the most recent run of each canary that you have
created. This operation supports resource-level authorization using an IAM policy and the
Names parameter. If you specify the Names parameter, the operation is successful only if
you have authorization to view all the canaries that you specify in your request. If you do
not have permission to view any of the canaries, the request fails with a 403 response. You
are required to use the Names parameter if you are logged on to a user or role that has an
IAM policy that restricts which canaries that you are allowed to view. For more
information, see Limiting a user to viewing specific canaries.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Specify this parameter to limit how many runs are returned each time you
use the DescribeLastRun operation. If you omit this parameter, the default of 100 is used.
- `"Names"`: Use this parameter to return only canaries that match the names that you
specify here. You can specify as many as five canary names. If you specify this parameter,
the operation is successful only if you have authorization to view all the canaries that
you specify in your request. If you do not have permission to view any of the canaries, the
request fails with a 403 response. You are required to use the Names parameter if you are
logged on to a user or role that has an IAM policy that restricts which canaries that you
are allowed to view. For more information, see Limiting a user to viewing specific
canaries.
- `"NextToken"`: A token that indicates that there is more data available. You can use this
token in a subsequent DescribeCanariesLastRun operation to retrieve the next set of results.
"""
function describe_canaries_last_run(; aws_config::AbstractAWSConfig=global_aws_config())
return synthetics(
"POST", "/canaries/last-run"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_canaries_last_run(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return synthetics(
"POST",
"/canaries/last-run",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_runtime_versions()
describe_runtime_versions(params::Dict{String,<:Any})
Returns a list of Synthetics canary runtime versions. For more information, see Canary
Runtime Versions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Specify this parameter to limit how many runs are returned each time you
use the DescribeRuntimeVersions operation. If you omit this parameter, the default of 100
is used.
- `"NextToken"`: A token that indicates that there is more data available. You can use this
token in a subsequent DescribeRuntimeVersions operation to retrieve the next set of results.
"""
function describe_runtime_versions(; aws_config::AbstractAWSConfig=global_aws_config())
return synthetics(
"POST", "/runtime-versions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_runtime_versions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return synthetics(
"POST",
"/runtime-versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_resource(resource_arn, group_identifier)
disassociate_resource(resource_arn, group_identifier, params::Dict{String,<:Any})
Removes a canary from a group. You must run this operation in the Region where the canary
exists.
# Arguments
- `resource_arn`: The ARN of the canary that you want to remove from the specified group.
- `group_identifier`: Specifies the group. You can specify the group name, the ARN, or the
group ID as the GroupIdentifier.
"""
function disassociate_resource(
ResourceArn, groupIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return synthetics(
"PATCH",
"/group/$(groupIdentifier)/disassociate",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_resource(
ResourceArn,
groupIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return synthetics(
"PATCH",
"/group/$(groupIdentifier)/disassociate",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_canary(name)
get_canary(name, params::Dict{String,<:Any})
Retrieves complete information about one canary. You must specify the name of the canary
that you want. To get a list of canaries and their names, use DescribeCanaries.
# Arguments
- `name`: The name of the canary that you want details for.
"""
function get_canary(name; aws_config::AbstractAWSConfig=global_aws_config())
return synthetics(
"GET", "/canary/$(name)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_canary(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return synthetics(
"GET",
"/canary/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_canary_runs(name)
get_canary_runs(name, params::Dict{String,<:Any})
Retrieves a list of runs for a specified canary.
# Arguments
- `name`: The name of the canary that you want to see runs for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Specify this parameter to limit how many runs are returned each time you
use the GetCanaryRuns operation. If you omit this parameter, the default of 100 is used.
- `"NextToken"`: A token that indicates that there is more data available. You can use this
token in a subsequent GetCanaryRuns operation to retrieve the next set of results.
"""
function get_canary_runs(name; aws_config::AbstractAWSConfig=global_aws_config())
return synthetics(
"POST",
"/canary/$(name)/runs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_canary_runs(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return synthetics(
"POST",
"/canary/$(name)/runs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_group(group_identifier)
get_group(group_identifier, params::Dict{String,<:Any})
Returns information about one group. Groups are a global resource, so you can use this
operation from any Region.
# Arguments
- `group_identifier`: Specifies the group to return information for. You can specify the
group name, the ARN, or the group ID as the GroupIdentifier.
"""
function get_group(groupIdentifier; aws_config::AbstractAWSConfig=global_aws_config())
return synthetics(
"GET",
"/group/$(groupIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_group(
groupIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return synthetics(
"GET",
"/group/$(groupIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_associated_groups(resource_arn)
list_associated_groups(resource_arn, params::Dict{String,<:Any})
Returns a list of the groups that the specified canary is associated with. The canary that
you specify must be in the current Region.
# Arguments
- `resource_arn`: The ARN of the canary that you want to view groups for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Specify this parameter to limit how many groups are returned each time
you use the ListAssociatedGroups operation. If you omit this parameter, the default of 20
is used.
- `"NextToken"`: A token that indicates that there is more data available. You can use this
token in a subsequent operation to retrieve the next set of results.
"""
function list_associated_groups(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return synthetics(
"POST",
"/resource/$(resourceArn)/groups";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_associated_groups(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return synthetics(
"POST",
"/resource/$(resourceArn)/groups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_group_resources(group_identifier)
list_group_resources(group_identifier, params::Dict{String,<:Any})
This operation returns a list of the ARNs of the canaries that are associated with the
specified group.
# Arguments
- `group_identifier`: Specifies the group to return information for. You can specify the
group name, the ARN, or the group ID as the GroupIdentifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Specify this parameter to limit how many canary ARNs are returned each
time you use the ListGroupResources operation. If you omit this parameter, the default of
20 is used.
- `"NextToken"`: A token that indicates that there is more data available. You can use this
token in a subsequent operation to retrieve the next set of results.
"""
function list_group_resources(
groupIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return synthetics(
"POST",
"/group/$(groupIdentifier)/resources";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_group_resources(
groupIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return synthetics(
"POST",
"/group/$(groupIdentifier)/resources",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_groups()
list_groups(params::Dict{String,<:Any})
Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs.
The groups from all Regions are returned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Specify this parameter to limit how many groups are returned each time
you use the ListGroups operation. If you omit this parameter, the default of 20 is used.
- `"NextToken"`: A token that indicates that there is more data available. You can use this
token in a subsequent operation to retrieve the next set of results.
"""
function list_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return synthetics(
"POST", "/groups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return synthetics(
"POST", "/groups", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Displays the tags associated with a canary or group.
# Arguments
- `resource_arn`: The ARN of the canary or group that you want to view tags for. The ARN
format of a canary is arn:aws:synthetics:Region:account-id:canary:canary-name . The ARN
format of a group is arn:aws:synthetics:Region:account-id:group:group-name
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return synthetics(
"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 synthetics(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_canary(name)
start_canary(name, params::Dict{String,<:Any})
Use this operation to run a canary that has already been created. The frequency of the
canary runs is determined by the value of the canary's Schedule. To see a canary's
schedule, use GetCanary.
# Arguments
- `name`: The name of the canary that you want to run. To find canary names, use
DescribeCanaries.
"""
function start_canary(name; aws_config::AbstractAWSConfig=global_aws_config())
return synthetics(
"POST",
"/canary/$(name)/start";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_canary(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return synthetics(
"POST",
"/canary/$(name)/start",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_canary(name)
stop_canary(name, params::Dict{String,<:Any})
Stops the canary to prevent all future runs. If the canary is currently running,the run
that is in progress completes on its own, publishes metrics, and uploads artifacts, but it
is not recorded in Synthetics as a completed run. You can use StartCanary to start it
running again with the canary’s current schedule at any point in the future.
# Arguments
- `name`: The name of the canary that you want to stop. To find the names of your canaries,
use ListCanaries.
"""
function stop_canary(name; aws_config::AbstractAWSConfig=global_aws_config())
return synthetics(
"POST",
"/canary/$(name)/stop";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_canary(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return synthetics(
"POST",
"/canary/$(name)/stop",
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})
Assigns one or more tags (key-value pairs) to the specified canary or group. 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 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 canary or group.
# Arguments
- `tags`: The list of key-value pairs to associate with the resource.
- `resource_arn`: The ARN of the canary or group that you're adding tags to. The ARN format
of a canary is arn:aws:synthetics:Region:account-id:canary:canary-name . The ARN format of
a group is arn:aws:synthetics:Region:account-id:group:group-name
"""
function tag_resource(Tags, resourceArn; aws_config::AbstractAWSConfig=global_aws_config())
return synthetics(
"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 synthetics(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Tags" => Tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes one or more tags from the specified resource.
# Arguments
- `resource_arn`: The ARN of the canary or group that you're removing tags from. The ARN
format of a canary is arn:aws:synthetics:Region:account-id:canary:canary-name . The ARN
format of a group is arn:aws:synthetics:Region:account-id:group:group-name
- `tag_keys`: The list of tag keys to remove from the resource.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return synthetics(
"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 synthetics(
"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_canary(name)
update_canary(name, params::Dict{String,<:Any})
Updates the configuration of a canary that has already been created. You can't use this
operation to update the tags of an existing canary. To change the tags of an existing
canary, use TagResource.
# Arguments
- `name`: The name of the canary that you want to update. To find the names of your
canaries, use DescribeCanaries. You cannot change the name of a canary that has already
been created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ArtifactConfig"`: A structure that contains the configuration for canary artifacts,
including the encryption-at-rest settings for artifacts that the canary uploads to Amazon
S3.
- `"ArtifactS3Location"`: The location in Amazon S3 where Synthetics stores artifacts from
the test runs of this canary. Artifacts include the log file, screenshots, and HAR files.
The name of the S3 bucket can't include a period (.).
- `"Code"`: A structure that includes the entry point from which the canary should start
running your script. If the script is stored in an S3 bucket, the bucket name, key, and
version are also included.
- `"ExecutionRoleArn"`: The ARN of the IAM role to be used to run the canary. This role
must already exist, and must include lambda.amazonaws.com as a principal in the trust
policy. The role must also have the following permissions: s3:PutObject
s3:GetBucketLocation s3:ListAllMyBuckets cloudwatch:PutMetricData
logs:CreateLogGroup logs:CreateLogStream logs:CreateLogStream
- `"FailureRetentionPeriodInDays"`: The number of days to retain data about failed runs of
this canary.
- `"RunConfig"`: A structure that contains the timeout value that is used for each
individual run of the canary. The environment variables keys and values are not encrypted.
Do not store sensitive information in this field.
- `"RuntimeVersion"`: Specifies the runtime version to use for the canary. For a list of
valid runtime versions and for more information about runtime versions, see Canary Runtime
Versions.
- `"Schedule"`: A structure that contains information about how often the canary is to run,
and when these runs are to stop.
- `"SuccessRetentionPeriodInDays"`: The number of days to retain data about successful runs
of this canary.
- `"VisualReference"`: Defines the screenshots to use as the baseline for comparisons
during visual monitoring comparisons during future runs of this canary. If you omit this
parameter, no changes are made to any baseline screenshots that the canary might be using
already. Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2
runtime or later. For more information, see Visual monitoring and Visual monitoring
blueprint
- `"VpcConfig"`: If this canary is to test an endpoint in a VPC, this structure contains
information about the subnet and security groups of the VPC endpoint. For more information,
see Running a Canary in a VPC.
"""
function update_canary(name; aws_config::AbstractAWSConfig=global_aws_config())
return synthetics(
"PATCH", "/canary/$(name)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function update_canary(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return synthetics(
"PATCH",
"/canary/$(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 | 16789 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: taxsettings
using AWS.Compat
using AWS.UUIDs
"""
batch_delete_tax_registration(account_ids)
batch_delete_tax_registration(account_ids, params::Dict{String,<:Any})
Deletes tax registration for multiple accounts in batch. This can be used to delete tax
registrations for up to five accounts in one batch. This API operation can't be used to
delete your tax registration in Brazil. Use the Payment preferences page in the Billing and
Cost Management console instead.
# Arguments
- `account_ids`: List of unique account identifiers.
"""
function batch_delete_tax_registration(
accountIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return taxsettings(
"POST",
"/BatchDeleteTaxRegistration",
Dict{String,Any}("accountIds" => accountIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_delete_tax_registration(
accountIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return taxsettings(
"POST",
"/BatchDeleteTaxRegistration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("accountIds" => accountIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_put_tax_registration(account_ids, tax_registration_entry)
batch_put_tax_registration(account_ids, tax_registration_entry, params::Dict{String,<:Any})
Adds or updates tax registration for multiple accounts in batch. This can be used to add or
update tax registrations for up to five accounts in one batch. You can't set a TRN if
there's a pending TRN. You'll need to delete the pending TRN first. To call this API
operation for specific countries, see the following country-specific requirements.
Bangladesh You must specify the tax registration certificate document in the
taxRegistrationDocuments field of the VerificationDetails object. Brazil You must
complete the tax registration process in the Payment preferences page in the Billing and
Cost Management console. After your TRN and billing address are verified, you can call this
API operation. For Amazon Web Services accounts created through Organizations, you can
call this API operation when you don't have a billing address. Georgia The valid
personType values are Physical Person and Business. Kenya You must specify the
personType in the kenyaAdditionalInfo field of the additionalTaxInformation object. If
the personType is Physical Person, you must specify the tax registration certificate
document in the taxRegistrationDocuments field of the VerificationDetails object.
Malaysia If you use this operation to set a tax registration number (TRN) in Malaysia,
only resellers with a valid sales and service tax (SST) number are required to provide tax
registration information. By using this API operation to set a TRN in Malaysia, Amazon
Web Services will regard you as self-declaring that you're an authorized business reseller
registered with the Royal Malaysia Customs Department (RMCD) and have a valid SST number.
Amazon Web Services reserves the right to seek additional information and/or take other
actions to support your self-declaration as appropriate. If you're not a reseller of
Amazon Web Services, we don't recommend that you use this operation to set the TRN in
Malaysia. Only use this API operation to upload the TRNs for accounts through which
you're reselling Amazon Web Services. Amazon Web Services is currently registered under
the following service tax codes. You must include at least one of the service tax codes in
the service tax code strings to declare yourself as an authorized registered business
reseller. Taxable service and service tax codes: Consultancy - 9907061674 Training or
coaching service - 9907071685 IT service - 9907101676 Digital services and electronic
medium - 9907121690 Nepal The sector valid values are Business and Individual.
Saudi Arabia For address, you must specify addressLine3. South Korea You must
specify the certifiedEmailId and legalName in the TaxRegistrationEntry object. Use Korean
characters for legalName. You must specify the businessRepresentativeName,
itemOfBusiness, and lineOfBusiness in the southKoreaAdditionalInfo field of the
additionalTaxInformation object. Use Korean characters for these fields. You must specify
the tax registration certificate document in the taxRegistrationDocuments field of the
VerificationDetails object. For the address object, use Korean characters for
addressLine1, addressLine2 city, postalCode, and stateOrRegion. Spain You must
specify the registrationType in the spainAdditionalInfo field of the
additionalTaxInformation object. If the registrationType is Local, you must specify the
tax registration certificate document in the taxRegistrationDocuments field of the
VerificationDetails object. Turkey You must specify the sector in the
taxRegistrationEntry object. If your sector is Business, Individual, or Government:
Specify the taxOffice. If your sector is Individual, don't enter this value. (Optional)
Specify the kepEmailId. If your sector is Individual, don't enter this value. Note: In
the Tax Settings page of the Billing console, Government appears as Public institutions
If your sector is Business and you're subject to KDV tax, you must specify your industry
in the industries field. For address, you must specify districtOrCounty. Ukraine
The sector valid values are Business and Individual.
# Arguments
- `account_ids`: List of unique account identifiers.
- `tax_registration_entry`: Your TRN information that will be stored to the accounts
mentioned in putEntries.
"""
function batch_put_tax_registration(
accountIds, taxRegistrationEntry; aws_config::AbstractAWSConfig=global_aws_config()
)
return taxsettings(
"POST",
"/BatchPutTaxRegistration",
Dict{String,Any}(
"accountIds" => accountIds, "taxRegistrationEntry" => taxRegistrationEntry
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_put_tax_registration(
accountIds,
taxRegistrationEntry,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return taxsettings(
"POST",
"/BatchPutTaxRegistration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"accountIds" => accountIds,
"taxRegistrationEntry" => taxRegistrationEntry,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_tax_registration()
delete_tax_registration(params::Dict{String,<:Any})
Deletes tax registration for a single account. This API operation can't be used to delete
your tax registration in Brazil. Use the Payment preferences page in the Billing and Cost
Management console instead.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountId"`: Unique account identifier for the TRN information that needs to be
deleted. If this isn't passed, the account ID corresponding to the credentials of the API
caller will be used for this parameter.
"""
function delete_tax_registration(; aws_config::AbstractAWSConfig=global_aws_config())
return taxsettings(
"POST",
"/DeleteTaxRegistration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_tax_registration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return taxsettings(
"POST",
"/DeleteTaxRegistration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_tax_registration()
get_tax_registration(params::Dict{String,<:Any})
Retrieves tax registration for a single account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountId"`: Your unique account identifier.
"""
function get_tax_registration(; aws_config::AbstractAWSConfig=global_aws_config())
return taxsettings(
"POST",
"/GetTaxRegistration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_tax_registration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return taxsettings(
"POST",
"/GetTaxRegistration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_tax_registration_document(destination_s3_location, tax_document_metadata)
get_tax_registration_document(destination_s3_location, tax_document_metadata, params::Dict{String,<:Any})
Downloads your tax documents to the Amazon S3 bucket that you specify in your request.
# Arguments
- `destination_s3_location`: The Amazon S3 bucket that you specify to download your tax
documents to.
- `tax_document_metadata`: The metadata for your tax document.
"""
function get_tax_registration_document(
destinationS3Location,
taxDocumentMetadata;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return taxsettings(
"POST",
"/GetTaxRegistrationDocument",
Dict{String,Any}(
"destinationS3Location" => destinationS3Location,
"taxDocumentMetadata" => taxDocumentMetadata,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_tax_registration_document(
destinationS3Location,
taxDocumentMetadata,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return taxsettings(
"POST",
"/GetTaxRegistrationDocument",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"destinationS3Location" => destinationS3Location,
"taxDocumentMetadata" => taxDocumentMetadata,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tax_registrations()
list_tax_registrations(params::Dict{String,<:Any})
Retrieves the tax registration of accounts listed in a consolidated billing family. This
can be used to retrieve up to 100 accounts' tax registrations in one call (default 50).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Number of accountDetails results you want in one response.
- `"nextToken"`: The token to retrieve the next set of results.
"""
function list_tax_registrations(; aws_config::AbstractAWSConfig=global_aws_config())
return taxsettings(
"POST",
"/ListTaxRegistrations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tax_registrations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return taxsettings(
"POST",
"/ListTaxRegistrations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_tax_registration(tax_registration_entry)
put_tax_registration(tax_registration_entry, params::Dict{String,<:Any})
Adds or updates tax registration for a single account. You can't set a TRN if there's a
pending TRN. You'll need to delete the pending TRN first. To call this API operation for
specific countries, see the following country-specific requirements. Bangladesh You
must specify the tax registration certificate document in the taxRegistrationDocuments
field of the VerificationDetails object. Brazil You must complete the tax
registration process in the Payment preferences page in the Billing and Cost Management
console. After your TRN and billing address are verified, you can call this API operation.
For Amazon Web Services accounts created through Organizations, you can call this API
operation when you don't have a billing address. Georgia The valid personType values
are Physical Person and Business. Kenya You must specify the personType in the
kenyaAdditionalInfo field of the additionalTaxInformation object. If the personType is
Physical Person, you must specify the tax registration certificate document in the
taxRegistrationDocuments field of the VerificationDetails object. Malaysia If you use
this operation to set a tax registration number (TRN) in Malaysia, only resellers with a
valid sales and service tax (SST) number are required to provide tax registration
information. By using this API operation to set a TRN in Malaysia, Amazon Web Services
will regard you as self-declaring that you're an authorized business reseller registered
with the Royal Malaysia Customs Department (RMCD) and have a valid SST number. Amazon Web
Services reserves the right to seek additional information and/or take other actions to
support your self-declaration as appropriate. If you're not a reseller of Amazon Web
Services, we don't recommend that you use this operation to set the TRN in Malaysia. Only
use this API operation to upload the TRNs for accounts through which you're reselling
Amazon Web Services. Amazon Web Services is currently registered under the following
service tax codes. You must include at least one of the service tax codes in the service
tax code strings to declare yourself as an authorized registered business reseller. Taxable
service and service tax codes: Consultancy - 9907061674 Training or coaching service -
9907071685 IT service - 9907101676 Digital services and electronic medium - 9907121690
Nepal The sector valid values are Business and Individual. Saudi Arabia For
address, you must specify addressLine3. South Korea You must specify the
certifiedEmailId and legalName in the TaxRegistrationEntry object. Use Korean characters
for legalName. You must specify the businessRepresentativeName, itemOfBusiness, and
lineOfBusiness in the southKoreaAdditionalInfo field of the additionalTaxInformation
object. Use Korean characters for these fields. You must specify the tax registration
certificate document in the taxRegistrationDocuments field of the VerificationDetails
object. For the address object, use Korean characters for addressLine1, addressLine2
city, postalCode, and stateOrRegion. Spain You must specify the registrationType in
the spainAdditionalInfo field of the additionalTaxInformation object. If the
registrationType is Local, you must specify the tax registration certificate document in
the taxRegistrationDocuments field of the VerificationDetails object. Turkey You must
specify the sector in the taxRegistrationEntry object. If your sector is Business,
Individual, or Government: Specify the taxOffice. If your sector is Individual, don't
enter this value. (Optional) Specify the kepEmailId. If your sector is Individual, don't
enter this value. Note: In the Tax Settings page of the Billing console, Government
appears as Public institutions If your sector is Business and you're subject to KDV
tax, you must specify your industry in the industries field. For address, you must
specify districtOrCounty. Ukraine The sector valid values are Business and
Individual.
# Arguments
- `tax_registration_entry`: Your TRN information that will be stored to the account
mentioned in accountId.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountId"`: Your unique account identifier.
"""
function put_tax_registration(
taxRegistrationEntry; aws_config::AbstractAWSConfig=global_aws_config()
)
return taxsettings(
"POST",
"/PutTaxRegistration",
Dict{String,Any}("taxRegistrationEntry" => taxRegistrationEntry);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_tax_registration(
taxRegistrationEntry,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return taxsettings(
"POST",
"/PutTaxRegistration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("taxRegistrationEntry" => taxRegistrationEntry),
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 | 53732 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: textract
using AWS.Compat
using AWS.UUIDs
"""
analyze_document(document, feature_types)
analyze_document(document, feature_types, params::Dict{String,<:Any})
Analyzes an input document for relationships between detected items. The types of
information returned are as follows: Form data (key-value pairs). The related
information is returned in two Block objects, each of type KEY_VALUE_SET: a KEY Block
object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and
value. Name: is the key. Ana Silva Carolina is the value. Table and table cell data. A
TABLE Block object contains information about a detected table. A CELL Block object is
returned for each cell in a table. Lines and words of text. A LINE Block object contains
one or more WORD Block objects. All lines and words that are detected in the document are
returned (including text that doesn't have a relationship with the value of FeatureTypes).
Signatures. A SIGNATURE Block object contains the location information of a signature in
a document. If used in conjunction with forms or tables, a signature can be given a
Key-Value pairing or be detected in the cell of a table. Query. A QUERY Block object
contains the query text, alias and link to the associated Query results block object.
Query Result. A QUERY_RESULT Block object contains the answer to the query and an ID that
connects it to the query asked. This Block also contains a confidence score. Selection
elements such as check boxes and option buttons (radio buttons) can be detected in form
data and in tables. A SELECTION_ELEMENT Block object contains information about a selection
element, including the selection status. You can choose which type of analysis to perform
by specifying the FeatureTypes list. The output is returned in a list of Block objects.
AnalyzeDocument is a synchronous operation. To analyze documents asynchronously, use
StartDocumentAnalysis. For more information, see Document Text Analysis.
# Arguments
- `document`: The input document as base64-encoded bytes or an Amazon S3 object. If you use
the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document
must be an image in JPEG, PNG, PDF, or TIFF format. If you're using an AWS SDK to call
Amazon Textract, you might not need to base64-encode image bytes that are passed using the
Bytes field.
- `feature_types`: A list of the types of analysis to perform. Add TABLES to the list to
return information about the tables that are detected in the input document. Add FORMS to
return detected form data. Add SIGNATURES to return the locations of detected signatures.
Add LAYOUT to the list to return information about the layout of the document. All lines
and words detected in the document are included in the response (including text that isn't
related to the value of FeatureTypes).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AdaptersConfig"`: Specifies the adapter to be used when analyzing a document.
- `"HumanLoopConfig"`: Sets the configuration for the human in the loop workflow for
analyzing documents.
- `"QueriesConfig"`: Contains Queries and the alias for those Queries, as determined by the
input.
"""
function analyze_document(
Document, FeatureTypes; aws_config::AbstractAWSConfig=global_aws_config()
)
return textract(
"AnalyzeDocument",
Dict{String,Any}("Document" => Document, "FeatureTypes" => FeatureTypes);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function analyze_document(
Document,
FeatureTypes,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return textract(
"AnalyzeDocument",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Document" => Document, "FeatureTypes" => FeatureTypes),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
analyze_expense(document)
analyze_expense(document, params::Dict{String,<:Any})
AnalyzeExpense synchronously analyzes an input document for financially related
relationships between text. Information is returned as ExpenseDocuments and seperated as
follows: LineItemGroups- A data set containing LineItems which store information about
the lines of text, such as an item purchased and its price on a receipt. SummaryFields-
Contains all other information a receipt, such as header information or the vendors name.
# Arguments
- `document`:
"""
function analyze_expense(Document; aws_config::AbstractAWSConfig=global_aws_config())
return textract(
"AnalyzeExpense",
Dict{String,Any}("Document" => Document);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function analyze_expense(
Document,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return textract(
"AnalyzeExpense",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Document" => Document), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
analyze_id(document_pages)
analyze_id(document_pages, params::Dict{String,<:Any})
Analyzes identity documents for relevant information. This information is extracted and
returned as IdentityDocumentFields, which records both the normalized field and value of
the extracted text. Unlike other Amazon Textract operations, AnalyzeID doesn't return any
Geometry data.
# Arguments
- `document_pages`: The document being passed to AnalyzeID.
"""
function analyze_id(DocumentPages; aws_config::AbstractAWSConfig=global_aws_config())
return textract(
"AnalyzeID",
Dict{String,Any}("DocumentPages" => DocumentPages);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function analyze_id(
DocumentPages,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return textract(
"AnalyzeID",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DocumentPages" => DocumentPages), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_adapter(adapter_name, feature_types)
create_adapter(adapter_name, feature_types, params::Dict{String,<:Any})
Creates an adapter, which can be fine-tuned for enhanced performance on user provided
documents. Takes an AdapterName and FeatureType. Currently the only supported feature type
is QUERIES. You can also provide a Description, Tags, and a ClientRequestToken. You can
choose whether or not the adapter should be AutoUpdated with the AutoUpdate argument. By
default, AutoUpdate is set to DISABLED.
# Arguments
- `adapter_name`: The name to be assigned to the adapter being created.
- `feature_types`: The type of feature that the adapter is being trained on. Currrenly,
supported feature types are: QUERIES
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AutoUpdate"`: Controls whether or not the adapter should automatically update.
- `"ClientRequestToken"`: Idempotent token is used to recognize the request. If the same
token is used with multiple CreateAdapter requests, the same session is returned. This
token is employed to avoid unintentionally creating the same session multiple times.
- `"Description"`: The description to be assigned to the adapter being created.
- `"Tags"`: A list of tags to be added to the adapter.
"""
function create_adapter(
AdapterName, FeatureTypes; aws_config::AbstractAWSConfig=global_aws_config()
)
return textract(
"CreateAdapter",
Dict{String,Any}(
"AdapterName" => AdapterName,
"FeatureTypes" => FeatureTypes,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_adapter(
AdapterName,
FeatureTypes,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return textract(
"CreateAdapter",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AdapterName" => AdapterName,
"FeatureTypes" => FeatureTypes,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_adapter_version(adapter_id, dataset_config, output_config)
create_adapter_version(adapter_id, dataset_config, output_config, params::Dict{String,<:Any})
Creates a new version of an adapter. Operates on a provided AdapterId and a specified
dataset provided via the DatasetConfig argument. Requires that you specify an Amazon S3
bucket with the OutputConfig argument. You can provide an optional KMSKeyId, an optional
ClientRequestToken, and optional tags.
# Arguments
- `adapter_id`: A string containing a unique ID for the adapter that will receive a new
version.
- `dataset_config`: Specifies a dataset used to train a new adapter version. Takes a
ManifestS3Object as the value.
- `output_config`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: Idempotent token is used to recognize the request. If the same
token is used with multiple CreateAdapterVersion requests, the same session is returned.
This token is employed to avoid unintentionally creating the same session multiple times.
- `"KMSKeyId"`: The identifier for your AWS Key Management Service key (AWS KMS key). Used
to encrypt your documents.
- `"Tags"`: A set of tags (key-value pairs) that you want to attach to the adapter version.
"""
function create_adapter_version(
AdapterId,
DatasetConfig,
OutputConfig;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return textract(
"CreateAdapterVersion",
Dict{String,Any}(
"AdapterId" => AdapterId,
"DatasetConfig" => DatasetConfig,
"OutputConfig" => OutputConfig,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_adapter_version(
AdapterId,
DatasetConfig,
OutputConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return textract(
"CreateAdapterVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AdapterId" => AdapterId,
"DatasetConfig" => DatasetConfig,
"OutputConfig" => OutputConfig,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_adapter(adapter_id)
delete_adapter(adapter_id, params::Dict{String,<:Any})
Deletes an Amazon Textract adapter. Takes an AdapterId and deletes the adapter specified by
the ID.
# Arguments
- `adapter_id`: A string containing a unique ID for the adapter to be deleted.
"""
function delete_adapter(AdapterId; aws_config::AbstractAWSConfig=global_aws_config())
return textract(
"DeleteAdapter",
Dict{String,Any}("AdapterId" => AdapterId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_adapter(
AdapterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return textract(
"DeleteAdapter",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AdapterId" => AdapterId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_adapter_version(adapter_id, adapter_version)
delete_adapter_version(adapter_id, adapter_version, params::Dict{String,<:Any})
Deletes an Amazon Textract adapter version. Requires that you specify both an AdapterId and
a AdapterVersion. Deletes the adapter version specified by the AdapterId and the
AdapterVersion.
# Arguments
- `adapter_id`: A string containing a unique ID for the adapter version that will be
deleted.
- `adapter_version`: Specifies the adapter version to be deleted.
"""
function delete_adapter_version(
AdapterId, AdapterVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return textract(
"DeleteAdapterVersion",
Dict{String,Any}("AdapterId" => AdapterId, "AdapterVersion" => AdapterVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_adapter_version(
AdapterId,
AdapterVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return textract(
"DeleteAdapterVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AdapterId" => AdapterId, "AdapterVersion" => AdapterVersion
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detect_document_text(document)
detect_document_text(document, params::Dict{String,<:Any})
Detects text in the input document. Amazon Textract can detect lines of text and the words
that make up a line of text. The input document must be in one of the following image
formats: JPEG, PNG, PDF, or TIFF. DetectDocumentText returns the detected text in an array
of Block objects. Each document page has as an associated Block of type PAGE. Each PAGE
Block object is the parent of LINE Block objects that represent the lines of detected text
on a page. A LINE Block object is a parent for each word that makes up the line. Words are
represented by Block objects of type WORD. DetectDocumentText is a synchronous operation.
To analyze documents asynchronously, use StartDocumentTextDetection. For more information,
see Document Text Detection.
# Arguments
- `document`: The input document as base64-encoded bytes or an Amazon S3 object. If you use
the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document
must be an image in JPEG or PNG format. If you're using an AWS SDK to call Amazon Textract,
you might not need to base64-encode image bytes that are passed using the Bytes field.
"""
function detect_document_text(Document; aws_config::AbstractAWSConfig=global_aws_config())
return textract(
"DetectDocumentText",
Dict{String,Any}("Document" => Document);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detect_document_text(
Document,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return textract(
"DetectDocumentText",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Document" => Document), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_adapter(adapter_id)
get_adapter(adapter_id, params::Dict{String,<:Any})
Gets configuration information for an adapter specified by an AdapterId, returning
information on AdapterName, Description, CreationTime, AutoUpdate status, and FeatureTypes.
# Arguments
- `adapter_id`: A string containing a unique ID for the adapter.
"""
function get_adapter(AdapterId; aws_config::AbstractAWSConfig=global_aws_config())
return textract(
"GetAdapter",
Dict{String,Any}("AdapterId" => AdapterId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_adapter(
AdapterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return textract(
"GetAdapter",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AdapterId" => AdapterId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_adapter_version(adapter_id, adapter_version)
get_adapter_version(adapter_id, adapter_version, params::Dict{String,<:Any})
Gets configuration information for the specified adapter version, including: AdapterId,
AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig, KMSKeyId, OutputConfig,
Tags and EvaluationMetrics.
# Arguments
- `adapter_id`: A string specifying a unique ID for the adapter version you want to
retrieve information for.
- `adapter_version`: A string specifying the adapter version you want to retrieve
information for.
"""
function get_adapter_version(
AdapterId, AdapterVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return textract(
"GetAdapterVersion",
Dict{String,Any}("AdapterId" => AdapterId, "AdapterVersion" => AdapterVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_adapter_version(
AdapterId,
AdapterVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return textract(
"GetAdapterVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AdapterId" => AdapterId, "AdapterVersion" => AdapterVersion
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_document_analysis(job_id)
get_document_analysis(job_id, params::Dict{String,<:Any})
Gets the results for an Amazon Textract asynchronous operation that analyzes text in a
document. You start asynchronous text analysis by calling StartDocumentAnalysis, which
returns a job identifier (JobId). When the text analysis operation finishes, Amazon
Textract publishes a completion status to the Amazon Simple Notification Service (Amazon
SNS) topic that's registered in the initial call to StartDocumentAnalysis. To get the
results of the text-detection operation, first check that the status value published to the
Amazon SNS topic is SUCCEEDED. If so, call GetDocumentAnalysis, and pass the job identifier
(JobId) from the initial call to StartDocumentAnalysis. GetDocumentAnalysis returns an
array of Block objects. The following types of information are returned: Form data
(key-value pairs). The related information is returned in two Block objects, each of type
KEY_VALUE_SET: a KEY Block object and a VALUE Block object. For example, Name: Ana Silva
Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value.
Table and table cell data. A TABLE Block object contains information about a detected
table. A CELL Block object is returned for each cell in a table. Lines and words of text.
A LINE Block object contains one or more WORD Block objects. All lines and words that are
detected in the document are returned (including text that doesn't have a relationship with
the value of the StartDocumentAnalysis FeatureTypes input parameter). Query. A QUERY
Block object contains the query text, alias and link to the associated Query results block
object. Query Results. A QUERY_RESULT Block object contains the answer to the query and
an ID that connects it to the query asked. This Block also contains a confidence score.
While processing a document with queries, look out for INVALID_REQUEST_PARAMETERS output.
This indicates that either the per page query limit has been exceeded or that the operation
is trying to query a page in the document which doesn’t exist. Selection elements such
as check boxes and option buttons (radio buttons) can be detected in form data and in
tables. A SELECTION_ELEMENT Block object contains information about a selection element,
including the selection status. Use the MaxResults parameter to limit the number of blocks
that are returned. If there are more results than specified in MaxResults, the value of
NextToken in the operation response contains a pagination token for getting the next set of
results. To get the next page of results, call GetDocumentAnalysis, and populate the
NextToken request parameter with the token value that's returned from the previous call to
GetDocumentAnalysis. For more information, see Document Text Analysis.
# Arguments
- `job_id`: A unique identifier for the text-detection job. The JobId is returned from
StartDocumentAnalysis. A JobId value is only valid for 7 days.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to return per paginated call. The largest
value that you can specify is 1,000. If you specify a value greater than 1,000, a maximum
of 1,000 results is returned. The default value is 1,000.
- `"NextToken"`: If the previous response was incomplete (because there are more blocks to
retrieve), Amazon Textract returns a pagination token in the response. You can use this
pagination token to retrieve the next set of blocks.
"""
function get_document_analysis(JobId; aws_config::AbstractAWSConfig=global_aws_config())
return textract(
"GetDocumentAnalysis",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_document_analysis(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return textract(
"GetDocumentAnalysis",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_document_text_detection(job_id)
get_document_text_detection(job_id, params::Dict{String,<:Any})
Gets the results for an Amazon Textract asynchronous operation that detects text in a
document. Amazon Textract can detect lines of text and the words that make up a line of
text. You start asynchronous text detection by calling StartDocumentTextDetection, which
returns a job identifier (JobId). When the text detection operation finishes, Amazon
Textract publishes a completion status to the Amazon Simple Notification Service (Amazon
SNS) topic that's registered in the initial call to StartDocumentTextDetection. To get the
results of the text-detection operation, first check that the status value published to the
Amazon SNS topic is SUCCEEDED. If so, call GetDocumentTextDetection, and pass the job
identifier (JobId) from the initial call to StartDocumentTextDetection.
GetDocumentTextDetection returns an array of Block objects. Each document page has as an
associated Block of type PAGE. Each PAGE Block object is the parent of LINE Block objects
that represent the lines of detected text on a page. A LINE Block object is a parent for
each word that makes up the line. Words are represented by Block objects of type WORD. Use
the MaxResults parameter to limit the number of blocks that are returned. If there are more
results than specified in MaxResults, the value of NextToken in the operation response
contains a pagination token for getting the next set of results. To get the next page of
results, call GetDocumentTextDetection, and populate the NextToken request parameter with
the token value that's returned from the previous call to GetDocumentTextDetection. For
more information, see Document Text Detection.
# Arguments
- `job_id`: A unique identifier for the text detection job. The JobId is returned from
StartDocumentTextDetection. A JobId value is only valid for 7 days.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to return per paginated call. The largest
value you can specify is 1,000. If you specify a value greater than 1,000, a maximum of
1,000 results is returned. The default value is 1,000.
- `"NextToken"`: If the previous response was incomplete (because there are more blocks to
retrieve), Amazon Textract returns a pagination token in the response. You can use this
pagination token to retrieve the next set of blocks.
"""
function get_document_text_detection(
JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return textract(
"GetDocumentTextDetection",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_document_text_detection(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return textract(
"GetDocumentTextDetection",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_expense_analysis(job_id)
get_expense_analysis(job_id, params::Dict{String,<:Any})
Gets the results for an Amazon Textract asynchronous operation that analyzes invoices and
receipts. Amazon Textract finds contact information, items purchased, and vendor name, from
input invoices and receipts. You start asynchronous invoice/receipt analysis by calling
StartExpenseAnalysis, which returns a job identifier (JobId). Upon completion of the
invoice/receipt analysis, Amazon Textract publishes the completion status to the Amazon
Simple Notification Service (Amazon SNS) topic. This topic must be registered in the
initial call to StartExpenseAnalysis. To get the results of the invoice/receipt analysis
operation, first ensure that the status value published to the Amazon SNS topic is
SUCCEEDED. If so, call GetExpenseAnalysis, and pass the job identifier (JobId) from the
initial call to StartExpenseAnalysis. Use the MaxResults parameter to limit the number of
blocks that are returned. If there are more results than specified in MaxResults, the value
of NextToken in the operation response contains a pagination token for getting the next set
of results. To get the next page of results, call GetExpenseAnalysis, and populate the
NextToken request parameter with the token value that's returned from the previous call to
GetExpenseAnalysis. For more information, see Analyzing Invoices and Receipts.
# Arguments
- `job_id`: A unique identifier for the text detection job. The JobId is returned from
StartExpenseAnalysis. A JobId value is only valid for 7 days.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to return per paginated call. The largest
value you can specify is 20. If you specify a value greater than 20, a maximum of 20
results is returned. The default value is 20.
- `"NextToken"`: If the previous response was incomplete (because there are more blocks to
retrieve), Amazon Textract returns a pagination token in the response. You can use this
pagination token to retrieve the next set of blocks.
"""
function get_expense_analysis(JobId; aws_config::AbstractAWSConfig=global_aws_config())
return textract(
"GetExpenseAnalysis",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_expense_analysis(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return textract(
"GetExpenseAnalysis",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_lending_analysis(job_id)
get_lending_analysis(job_id, params::Dict{String,<:Any})
Gets the results for an Amazon Textract asynchronous operation that analyzes text in a
lending document. You start asynchronous text analysis by calling StartLendingAnalysis,
which returns a job identifier (JobId). When the text analysis operation finishes, Amazon
Textract publishes a completion status to the Amazon Simple Notification Service (Amazon
SNS) topic that's registered in the initial call to StartLendingAnalysis. To get the
results of the text analysis operation, first check that the status value published to the
Amazon SNS topic is SUCCEEDED. If so, call GetLendingAnalysis, and pass the job identifier
(JobId) from the initial call to StartLendingAnalysis.
# Arguments
- `job_id`: A unique identifier for the lending or text-detection job. The JobId is
returned from StartLendingAnalysis. A JobId value is only valid for 7 days.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to return per paginated call. The largest
value that you can specify is 30. If you specify a value greater than 30, a maximum of 30
results is returned. The default value is 30.
- `"NextToken"`: If the previous response was incomplete, Amazon Textract returns a
pagination token in the response. You can use this pagination token to retrieve the next
set of lending results.
"""
function get_lending_analysis(JobId; aws_config::AbstractAWSConfig=global_aws_config())
return textract(
"GetLendingAnalysis",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_lending_analysis(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return textract(
"GetLendingAnalysis",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_lending_analysis_summary(job_id)
get_lending_analysis_summary(job_id, params::Dict{String,<:Any})
Gets summarized results for the StartLendingAnalysis operation, which analyzes text in a
lending document. The returned summary consists of information about documents grouped
together by a common document type. Information like detected signatures, page numbers, and
split documents is returned with respect to the type of grouped document. You start
asynchronous text analysis by calling StartLendingAnalysis, which returns a job identifier
(JobId). When the text analysis operation finishes, Amazon Textract publishes a completion
status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in
the initial call to StartLendingAnalysis. To get the results of the text analysis
operation, first check that the status value published to the Amazon SNS topic is
SUCCEEDED. If so, call GetLendingAnalysisSummary, and pass the job identifier (JobId) from
the initial call to StartLendingAnalysis.
# Arguments
- `job_id`: A unique identifier for the lending or text-detection job. The JobId is
returned from StartLendingAnalysis. A JobId value is only valid for 7 days.
"""
function get_lending_analysis_summary(
JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return textract(
"GetLendingAnalysisSummary",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_lending_analysis_summary(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return textract(
"GetLendingAnalysisSummary",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_adapter_versions()
list_adapter_versions(params::Dict{String,<:Any})
List all version of an adapter that meet the specified filtration criteria.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AdapterId"`: A string containing a unique ID for the adapter to match for when listing
adapter versions.
- `"AfterCreationTime"`: Specifies the lower bound for the ListAdapterVersions operation.
Ensures ListAdapterVersions returns only adapter versions created after the specified
creation time.
- `"BeforeCreationTime"`: Specifies the upper bound for the ListAdapterVersions operation.
Ensures ListAdapterVersions returns only adapter versions created after the specified
creation time.
- `"MaxResults"`: The maximum number of results to return when listing adapter versions.
- `"NextToken"`: Identifies the next page of results to return when listing adapter
versions.
"""
function list_adapter_versions(; aws_config::AbstractAWSConfig=global_aws_config())
return textract(
"ListAdapterVersions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_adapter_versions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return textract(
"ListAdapterVersions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_adapters()
list_adapters(params::Dict{String,<:Any})
Lists all adapters that match the specified filtration criteria.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AfterCreationTime"`: Specifies the lower bound for the ListAdapters operation. Ensures
ListAdapters returns only adapters created after the specified creation time.
- `"BeforeCreationTime"`: Specifies the upper bound for the ListAdapters operation. Ensures
ListAdapters returns only adapters created before the specified creation time.
- `"MaxResults"`: The maximum number of results to return when listing adapters.
- `"NextToken"`: Identifies the next page of results to return when listing adapters.
"""
function list_adapters(; aws_config::AbstractAWSConfig=global_aws_config())
return textract("ListAdapters"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_adapters(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return textract(
"ListAdapters", 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 for an Amazon Textract resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) that specifies the resource to list tags
for.
"""
function list_tags_for_resource(
ResourceARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return textract(
"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 textract(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceARN" => ResourceARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_document_analysis(document_location, feature_types)
start_document_analysis(document_location, feature_types, params::Dict{String,<:Any})
Starts the asynchronous analysis of an input document for relationships between detected
items such as key-value pairs, tables, and selection elements. StartDocumentAnalysis can
analyze text in documents that are in JPEG, PNG, TIFF, and PDF format. The documents are
stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file
name of the document. StartDocumentAnalysis returns a job identifier (JobId) that you use
to get the results of the operation. When text analysis is finished, Amazon Textract
publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic
that you specify in NotificationChannel. To get the results of the text analysis operation,
first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so,
call GetDocumentAnalysis, and pass the job identifier (JobId) from the initial call to
StartDocumentAnalysis. For more information, see Document Text Analysis.
# Arguments
- `document_location`: The location of the document to be processed.
- `feature_types`: A list of the types of analysis to perform. Add TABLES to the list to
return information about the tables that are detected in the input document. Add FORMS to
return detected form data. To perform both types of analysis, add TABLES and FORMS to
FeatureTypes. All lines and words detected in the document are included in the response
(including text that isn't related to the value of FeatureTypes).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AdaptersConfig"`: Specifies the adapter to be used when analyzing a document.
- `"ClientRequestToken"`: The idempotent token that you use to identify the start request.
If you use the same token with multiple StartDocumentAnalysis requests, the same JobId is
returned. Use ClientRequestToken to prevent the same job from being accidentally started
more than once. For more information, see Calling Amazon Textract Asynchronous Operations.
- `"JobTag"`: An identifier that you specify that's included in the completion notification
published to the Amazon SNS topic. For example, you can use JobTag to identify the type of
document that the completion notification corresponds to (such as a tax form or a receipt).
- `"KMSKeyId"`: The KMS key used to encrypt the inference results. This can be in either
Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for
server-side encryption of the objects in the customer bucket. When this parameter is not
enabled, the result will be encrypted server side,using SSE-S3.
- `"NotificationChannel"`: The Amazon SNS topic ARN that you want Amazon Textract to
publish the completion status of the operation to.
- `"OutputConfig"`: Sets if the output will go to a customer defined bucket. By default,
Amazon Textract will save the results internally to be accessed by the GetDocumentAnalysis
operation.
- `"QueriesConfig"`:
"""
function start_document_analysis(
DocumentLocation, FeatureTypes; aws_config::AbstractAWSConfig=global_aws_config()
)
return textract(
"StartDocumentAnalysis",
Dict{String,Any}(
"DocumentLocation" => DocumentLocation, "FeatureTypes" => FeatureTypes
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_document_analysis(
DocumentLocation,
FeatureTypes,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return textract(
"StartDocumentAnalysis",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DocumentLocation" => DocumentLocation, "FeatureTypes" => FeatureTypes
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_document_text_detection(document_location)
start_document_text_detection(document_location, params::Dict{String,<:Any})
Starts the asynchronous detection of text in a document. Amazon Textract can detect lines
of text and the words that make up a line of text. StartDocumentTextDetection can analyze
text in documents that are in JPEG, PNG, TIFF, and PDF format. The documents are stored in
an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the
document. StartTextDetection returns a job identifier (JobId) that you use to get the
results of the operation. When text detection is finished, Amazon Textract publishes a
completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you
specify in NotificationChannel. To get the results of the text detection operation, first
check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call
GetDocumentTextDetection, and pass the job identifier (JobId) from the initial call to
StartDocumentTextDetection. For more information, see Document Text Detection.
# Arguments
- `document_location`: The location of the document to be processed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: The idempotent token that's used to identify the start request.
If you use the same token with multiple StartDocumentTextDetection requests, the same JobId
is returned. Use ClientRequestToken to prevent the same job from being accidentally started
more than once. For more information, see Calling Amazon Textract Asynchronous Operations.
- `"JobTag"`: An identifier that you specify that's included in the completion notification
published to the Amazon SNS topic. For example, you can use JobTag to identify the type of
document that the completion notification corresponds to (such as a tax form or a receipt).
- `"KMSKeyId"`: The KMS key used to encrypt the inference results. This can be in either
Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for
server-side encryption of the objects in the customer bucket. When this parameter is not
enabled, the result will be encrypted server side,using SSE-S3.
- `"NotificationChannel"`: The Amazon SNS topic ARN that you want Amazon Textract to
publish the completion status of the operation to.
- `"OutputConfig"`: Sets if the output will go to a customer defined bucket. By default
Amazon Textract will save the results internally to be accessed with the
GetDocumentTextDetection operation.
"""
function start_document_text_detection(
DocumentLocation; aws_config::AbstractAWSConfig=global_aws_config()
)
return textract(
"StartDocumentTextDetection",
Dict{String,Any}("DocumentLocation" => DocumentLocation);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_document_text_detection(
DocumentLocation,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return textract(
"StartDocumentTextDetection",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("DocumentLocation" => DocumentLocation), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_expense_analysis(document_location)
start_expense_analysis(document_location, params::Dict{String,<:Any})
Starts the asynchronous analysis of invoices or receipts for data like contact information,
items purchased, and vendor names. StartExpenseAnalysis can analyze text in documents that
are in JPEG, PNG, and PDF format. The documents must be stored in an Amazon S3 bucket. Use
the DocumentLocation parameter to specify the name of your S3 bucket and the name of the
document in that bucket. StartExpenseAnalysis returns a job identifier (JobId) that you
will provide to GetExpenseAnalysis to retrieve the results of the operation. When the
analysis of the input invoices/receipts is finished, Amazon Textract publishes a completion
status to the Amazon Simple Notification Service (Amazon SNS) topic that you provide to the
NotificationChannel. To obtain the results of the invoice and receipt analysis operation,
ensure that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call
GetExpenseAnalysis, and pass the job identifier (JobId) that was returned by your call to
StartExpenseAnalysis. For more information, see Analyzing Invoices and Receipts.
# Arguments
- `document_location`: The location of the document to be processed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: The idempotent token that's used to identify the start request.
If you use the same token with multiple StartDocumentTextDetection requests, the same JobId
is returned. Use ClientRequestToken to prevent the same job from being accidentally started
more than once. For more information, see Calling Amazon Textract Asynchronous Operations
- `"JobTag"`: An identifier you specify that's included in the completion notification
published to the Amazon SNS topic. For example, you can use JobTag to identify the type of
document that the completion notification corresponds to (such as a tax form or a receipt).
- `"KMSKeyId"`: The KMS key used to encrypt the inference results. This can be in either
Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for
server-side encryption of the objects in the customer bucket. When this parameter is not
enabled, the result will be encrypted server side,using SSE-S3.
- `"NotificationChannel"`: The Amazon SNS topic ARN that you want Amazon Textract to
publish the completion status of the operation to.
- `"OutputConfig"`: Sets if the output will go to a customer defined bucket. By default,
Amazon Textract will save the results internally to be accessed by the GetExpenseAnalysis
operation.
"""
function start_expense_analysis(
DocumentLocation; aws_config::AbstractAWSConfig=global_aws_config()
)
return textract(
"StartExpenseAnalysis",
Dict{String,Any}("DocumentLocation" => DocumentLocation);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_expense_analysis(
DocumentLocation,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return textract(
"StartExpenseAnalysis",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("DocumentLocation" => DocumentLocation), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_lending_analysis(document_location)
start_lending_analysis(document_location, params::Dict{String,<:Any})
Starts the classification and analysis of an input document. StartLendingAnalysis initiates
the classification and analysis of a packet of lending documents. StartLendingAnalysis
operates on a document file located in an Amazon S3 bucket. StartLendingAnalysis can
analyze text in documents that are in one of the following formats: JPEG, PNG, TIFF, PDF.
Use DocumentLocation to specify the bucket name and the file name of the document.
StartLendingAnalysis returns a job identifier (JobId) that you use to get the results of
the operation. When the text analysis is finished, Amazon Textract publishes a completion
status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in
NotificationChannel. To get the results of the text analysis operation, first check that
the status value published to the Amazon SNS topic is SUCCEEDED. If the status is SUCCEEDED
you can call either GetLendingAnalysis or GetLendingAnalysisSummary and provide the JobId
to obtain the results of the analysis. If using OutputConfig to specify an Amazon S3
bucket, the output will be contained within the specified prefix in a directory labeled
with the job-id. In the directory there are 3 sub-directories: detailedResponse
(contains the GetLendingAnalysis response) summaryResponse (for the
GetLendingAnalysisSummary response) splitDocuments (documents split across logical
boundaries)
# Arguments
- `document_location`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: The idempotent token that you use to identify the start request.
If you use the same token with multiple StartLendingAnalysis requests, the same JobId is
returned. Use ClientRequestToken to prevent the same job from being accidentally started
more than once. For more information, see Calling Amazon Textract Asynchronous Operations.
- `"JobTag"`: An identifier that you specify to be included in the completion notification
published to the Amazon SNS topic. For example, you can use JobTag to identify the type of
document that the completion notification corresponds to (such as a tax form or a receipt).
- `"KMSKeyId"`: The KMS key used to encrypt the inference results. This can be in either
Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for
server-side encryption of the objects in the customer bucket. When this parameter is not
enabled, the result will be encrypted server side, using SSE-S3.
- `"NotificationChannel"`:
- `"OutputConfig"`:
"""
function start_lending_analysis(
DocumentLocation; aws_config::AbstractAWSConfig=global_aws_config()
)
return textract(
"StartLendingAnalysis",
Dict{String,Any}("DocumentLocation" => DocumentLocation);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_lending_analysis(
DocumentLocation,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return textract(
"StartLendingAnalysis",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("DocumentLocation" => DocumentLocation), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds one or more tags to the specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) that specifies the resource to be tagged.
- `tags`: A set of tags (key-value pairs) that you want to assign to the resource.
"""
function tag_resource(ResourceARN, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return textract(
"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 textract(
"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 any tags with the specified keys from the specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) that specifies the resource to be untagged.
- `tag_keys`: Specifies the tags to be removed from the resource specified by the
ResourceARN.
"""
function untag_resource(
ResourceARN, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return textract(
"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 textract(
"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_adapter(adapter_id)
update_adapter(adapter_id, params::Dict{String,<:Any})
Update the configuration for an adapter. FeatureTypes configurations cannot be updated. At
least one new parameter must be specified as an argument.
# Arguments
- `adapter_id`: A string containing a unique ID for the adapter that will be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AdapterName"`: The new name to be applied to the adapter.
- `"AutoUpdate"`: The new auto-update status to be applied to the adapter.
- `"Description"`: The new description to be applied to the adapter.
"""
function update_adapter(AdapterId; aws_config::AbstractAWSConfig=global_aws_config())
return textract(
"UpdateAdapter",
Dict{String,Any}("AdapterId" => AdapterId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_adapter(
AdapterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return textract(
"UpdateAdapter",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AdapterId" => AdapterId), 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 | 15910 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: timestream_influxdb
using AWS.Compat
using AWS.UUIDs
"""
create_db_instance(allocated_storage, db_instance_type, name, password, vpc_security_group_ids, vpc_subnet_ids)
create_db_instance(allocated_storage, db_instance_type, name, password, vpc_security_group_ids, vpc_subnet_ids, params::Dict{String,<:Any})
Creates a new Timestream for InfluxDB DB instance.
# Arguments
- `allocated_storage`: The amount of storage to allocate for your DB storage type in GiB
(gibibytes).
- `db_instance_type`: The Timestream for InfluxDB DB instance type to run InfluxDB on.
- `name`: The name that uniquely identifies the DB instance when interacting with the
Amazon Timestream for InfluxDB API and CLI commands. This name will also be a prefix
included in the endpoint. DB instance names must be unique per customer and per region.
- `password`: The password of the initial admin user created in InfluxDB. This password
will allow you to access the InfluxDB UI to perform various administrative tasks and also
use the InfluxDB CLI to create an operator token. These attributes will be stored in a
Secret created in AWS SecretManager in your account.
- `vpc_security_group_ids`: A list of VPC security group IDs to associate with the DB
instance.
- `vpc_subnet_ids`: A list of VPC subnet IDs to associate with the DB instance. Provide at
least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ
standby.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"bucket"`: The name of the initial InfluxDB bucket. All InfluxDB data is stored in a
bucket. A bucket combines the concept of a database and a retention period (the duration of
time that each data point persists). A bucket belongs to an organization.
- `"dbParameterGroupIdentifier"`: The id of the DB parameter group to assign to your DB
instance. DB parameter groups specify how the database is configured. For example, DB
parameter groups can specify the limit for query concurrency.
- `"dbStorageType"`: The Timestream for InfluxDB DB storage type to read and write InfluxDB
data. You can choose between 3 different types of provisioned Influx IOPS included storage
according to your workloads requirements: Influx IO Included 3000 IOPS Influx IO
Included 12000 IOPS Influx IO Included 16000 IOPS
- `"deploymentType"`: Specifies whether the DB instance will be deployed as a standalone
instance or with a Multi-AZ standby for high availability.
- `"logDeliveryConfiguration"`: Configuration for sending InfluxDB engine logs to a
specified S3 bucket.
- `"organization"`: The name of the initial organization for the initial admin user in
InfluxDB. An InfluxDB organization is a workspace for a group of users.
- `"publiclyAccessible"`: Configures the DB instance with a public IP to facilitate access.
- `"tags"`: A list of key-value pairs to associate with the DB instance.
- `"username"`: The username of the initial admin user created in InfluxDB. Must start with
a letter and can't end with a hyphen or contain two consecutive hyphens. For example,
my-user1. This username will allow you to access the InfluxDB UI to perform various
administrative tasks and also use the InfluxDB CLI to create an operator token. These
attributes will be stored in a Secret created in Amazon Secrets Manager in your account.
"""
function create_db_instance(
allocatedStorage,
dbInstanceType,
name,
password,
vpcSecurityGroupIds,
vpcSubnetIds;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return timestream_influxdb(
"CreateDbInstance",
Dict{String,Any}(
"allocatedStorage" => allocatedStorage,
"dbInstanceType" => dbInstanceType,
"name" => name,
"password" => password,
"vpcSecurityGroupIds" => vpcSecurityGroupIds,
"vpcSubnetIds" => vpcSubnetIds,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_db_instance(
allocatedStorage,
dbInstanceType,
name,
password,
vpcSecurityGroupIds,
vpcSubnetIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return timestream_influxdb(
"CreateDbInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"allocatedStorage" => allocatedStorage,
"dbInstanceType" => dbInstanceType,
"name" => name,
"password" => password,
"vpcSecurityGroupIds" => vpcSecurityGroupIds,
"vpcSubnetIds" => vpcSubnetIds,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_db_parameter_group(name)
create_db_parameter_group(name, params::Dict{String,<:Any})
Creates a new Timestream for InfluxDB DB parameter group to associate with DB instances.
# Arguments
- `name`: The name of the DB parameter group. The name must be unique per customer and per
region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A description of the DB parameter group.
- `"parameters"`: A list of the parameters that comprise the DB parameter group.
- `"tags"`: A list of key-value pairs to associate with the DB parameter group.
"""
function create_db_parameter_group(name; aws_config::AbstractAWSConfig=global_aws_config())
return timestream_influxdb(
"CreateDbParameterGroup",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_db_parameter_group(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return timestream_influxdb(
"CreateDbParameterGroup",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_db_instance(identifier)
delete_db_instance(identifier, params::Dict{String,<:Any})
Deletes a Timestream for InfluxDB DB instance.
# Arguments
- `identifier`: The id of the DB instance.
"""
function delete_db_instance(identifier; aws_config::AbstractAWSConfig=global_aws_config())
return timestream_influxdb(
"DeleteDbInstance",
Dict{String,Any}("identifier" => identifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_db_instance(
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return timestream_influxdb(
"DeleteDbInstance",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("identifier" => identifier), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_db_instance(identifier)
get_db_instance(identifier, params::Dict{String,<:Any})
Returns a Timestream for InfluxDB DB instance.
# Arguments
- `identifier`: The id of the DB instance.
"""
function get_db_instance(identifier; aws_config::AbstractAWSConfig=global_aws_config())
return timestream_influxdb(
"GetDbInstance",
Dict{String,Any}("identifier" => identifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_db_instance(
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return timestream_influxdb(
"GetDbInstance",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("identifier" => identifier), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_db_parameter_group(identifier)
get_db_parameter_group(identifier, params::Dict{String,<:Any})
Returns a Timestream for InfluxDB DB parameter group.
# Arguments
- `identifier`: The id of the DB parameter group.
"""
function get_db_parameter_group(
identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return timestream_influxdb(
"GetDbParameterGroup",
Dict{String,Any}("identifier" => identifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_db_parameter_group(
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return timestream_influxdb(
"GetDbParameterGroup",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("identifier" => identifier), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_db_instances()
list_db_instances(params::Dict{String,<:Any})
Returns a list of Timestream for InfluxDB DB instances.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of items to return in the output. If the total number
of items available is more than the value specified, a NextToken is provided in the output.
To resume pagination, provide the NextToken value as argument of a subsequent API
invocation.
- `"nextToken"`: The pagination token. To resume pagination, provide the NextToken value as
argument of a subsequent API invocation.
"""
function list_db_instances(; aws_config::AbstractAWSConfig=global_aws_config())
return timestream_influxdb(
"ListDbInstances"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_db_instances(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return timestream_influxdb(
"ListDbInstances", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_db_parameter_groups()
list_db_parameter_groups(params::Dict{String,<:Any})
Returns a list of Timestream for InfluxDB DB parameter groups.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of items to return in the output. If the total number
of items available is more than the value specified, a NextToken is provided in the output.
To resume pagination, provide the NextToken value as argument of a subsequent API
invocation.
- `"nextToken"`: The pagination token. To resume pagination, provide the NextToken value as
argument of a subsequent API invocation.
"""
function list_db_parameter_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return timestream_influxdb(
"ListDbParameterGroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_db_parameter_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return timestream_influxdb(
"ListDbParameterGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
A list of tags applied to the resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the tagged resource.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return timestream_influxdb(
"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 timestream_influxdb(
"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})
Tags are composed of a Key/Value pairs. You can use tags to categorize and track your
Timestream for InfluxDB resources.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the tagged resource.
- `tags`: A list of tags used to categorize and track resources.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return timestream_influxdb(
"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 timestream_influxdb(
"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 tag from the specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the tagged resource.
- `tag_keys`: The keys used to identify the tags.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return timestream_influxdb(
"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 timestream_influxdb(
"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_db_instance(identifier)
update_db_instance(identifier, params::Dict{String,<:Any})
Updates a Timestream for InfluxDB DB instance.
# Arguments
- `identifier`: The id of the DB instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"dbParameterGroupIdentifier"`: The id of the DB parameter group to assign to your DB
instance. DB parameter groups specify how the database is configured. For example, DB
parameter groups can specify the limit for query concurrency.
- `"logDeliveryConfiguration"`: Configuration for sending InfluxDB engine logs to send to
specified S3 bucket.
"""
function update_db_instance(identifier; aws_config::AbstractAWSConfig=global_aws_config())
return timestream_influxdb(
"UpdateDbInstance",
Dict{String,Any}("identifier" => identifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_db_instance(
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return timestream_influxdb(
"UpdateDbInstance",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("identifier" => identifier), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 26630 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: timestream_query
using AWS.Compat
using AWS.UUIDs
"""
cancel_query(query_id)
cancel_query(query_id, params::Dict{String,<:Any})
Cancels a query that has been issued. Cancellation is provided only if the query has not
completed running before the cancellation request was issued. Because cancellation is an
idempotent operation, subsequent cancellation requests will return a CancellationMessage,
indicating that the query has already been canceled. See code sample for details.
# Arguments
- `query_id`: The ID of the query that needs to be cancelled. QueryID is returned as part
of the query result.
"""
function cancel_query(QueryId; aws_config::AbstractAWSConfig=global_aws_config())
return timestream_query(
"CancelQuery",
Dict{String,Any}("QueryId" => QueryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_query(
QueryId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return timestream_query(
"CancelQuery",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("QueryId" => QueryId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_scheduled_query(error_report_configuration, name, notification_configuration, query_string, schedule_configuration, scheduled_query_execution_role_arn)
create_scheduled_query(error_report_configuration, name, notification_configuration, query_string, schedule_configuration, scheduled_query_execution_role_arn, params::Dict{String,<:Any})
Create a scheduled query that will be run on your behalf at the configured schedule.
Timestream assumes the execution role provided as part of the
ScheduledQueryExecutionRoleArn parameter to run the query. You can use the
NotificationConfiguration parameter to configure notification for your scheduled query
operations.
# Arguments
- `error_report_configuration`: Configuration for error reporting. Error reports will be
generated when a problem is encountered when writing the query results.
- `name`: Name of the scheduled query.
- `notification_configuration`: Notification configuration for the scheduled query. A
notification is sent by Timestream when a query run finishes, when the state is updated or
when you delete it.
- `query_string`: The query string to run. Parameter names can be specified in the query
string @ character followed by an identifier. The named Parameter @scheduled_runtime is
reserved and can be used in the query to get the time at which the query is scheduled to
run. The timestamp calculated according to the ScheduleConfiguration parameter, will be the
value of @scheduled_runtime paramater for each query run. For example, consider an instance
of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the
@scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when
invoking the query.
- `schedule_configuration`: The schedule configuration for the query.
- `scheduled_query_execution_role_arn`: The ARN for the IAM role that Timestream will
assume when running the scheduled query.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Using a ClientToken makes the call to CreateScheduledQuery idempotent,
in other words, making the same request repeatedly will produce the same result. Making
multiple identical CreateScheduledQuery requests has the same effect as making a single
request. If CreateScheduledQuery is called without a ClientToken, the Query SDK
generates a ClientToken on your behalf. After 8 hours, any request with the same
ClientToken is treated as a new request.
- `"KmsKeyId"`: The Amazon KMS key used to encrypt the scheduled query resource, at-rest.
If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with
a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias
name, or alias ARN. When using an alias name, prefix the name with alias/ If
ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to
encrypt the error report at rest.
- `"Tags"`: A list of key-value pairs to label the scheduled query.
- `"TargetConfiguration"`: Configuration used for writing the result of a query.
"""
function create_scheduled_query(
ErrorReportConfiguration,
Name,
NotificationConfiguration,
QueryString,
ScheduleConfiguration,
ScheduledQueryExecutionRoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return timestream_query(
"CreateScheduledQuery",
Dict{String,Any}(
"ErrorReportConfiguration" => ErrorReportConfiguration,
"Name" => Name,
"NotificationConfiguration" => NotificationConfiguration,
"QueryString" => QueryString,
"ScheduleConfiguration" => ScheduleConfiguration,
"ScheduledQueryExecutionRoleArn" => ScheduledQueryExecutionRoleArn,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_scheduled_query(
ErrorReportConfiguration,
Name,
NotificationConfiguration,
QueryString,
ScheduleConfiguration,
ScheduledQueryExecutionRoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return timestream_query(
"CreateScheduledQuery",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ErrorReportConfiguration" => ErrorReportConfiguration,
"Name" => Name,
"NotificationConfiguration" => NotificationConfiguration,
"QueryString" => QueryString,
"ScheduleConfiguration" => ScheduleConfiguration,
"ScheduledQueryExecutionRoleArn" => ScheduledQueryExecutionRoleArn,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_scheduled_query(scheduled_query_arn)
delete_scheduled_query(scheduled_query_arn, params::Dict{String,<:Any})
Deletes a given scheduled query. This is an irreversible operation.
# Arguments
- `scheduled_query_arn`: The ARN of the scheduled query.
"""
function delete_scheduled_query(
ScheduledQueryArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return timestream_query(
"DeleteScheduledQuery",
Dict{String,Any}("ScheduledQueryArn" => ScheduledQueryArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_scheduled_query(
ScheduledQueryArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return timestream_query(
"DeleteScheduledQuery",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ScheduledQueryArn" => ScheduledQueryArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_account_settings()
describe_account_settings(params::Dict{String,<:Any})
Describes the settings for your account that include the query pricing model and the
configured maximum TCUs the service can use for your query workload. You're charged only
for the duration of compute units used for your workloads.
"""
function describe_account_settings(; aws_config::AbstractAWSConfig=global_aws_config())
return timestream_query(
"DescribeAccountSettings"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_account_settings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return timestream_query(
"DescribeAccountSettings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_endpoints()
describe_endpoints(params::Dict{String,<:Any})
DescribeEndpoints returns a list of available endpoints to make Timestream API calls
against. This API is available through both Write and Query. Because the Timestream SDKs
are designed to transparently work with the service’s architecture, including the
management and mapping of the service endpoints, it is not recommended that you use this
API unless: You are using VPC endpoints (Amazon Web Services PrivateLink) with Timestream
Your application uses a programming language that does not yet have SDK support You
require better control over the client-side implementation For detailed information on
how and when to use and implement DescribeEndpoints, see The Endpoint Discovery Pattern.
"""
function describe_endpoints(; aws_config::AbstractAWSConfig=global_aws_config())
return timestream_query(
"DescribeEndpoints"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_endpoints(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return timestream_query(
"DescribeEndpoints", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_scheduled_query(scheduled_query_arn)
describe_scheduled_query(scheduled_query_arn, params::Dict{String,<:Any})
Provides detailed information about a scheduled query.
# Arguments
- `scheduled_query_arn`: The ARN of the scheduled query.
"""
function describe_scheduled_query(
ScheduledQueryArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return timestream_query(
"DescribeScheduledQuery",
Dict{String,Any}("ScheduledQueryArn" => ScheduledQueryArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_scheduled_query(
ScheduledQueryArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return timestream_query(
"DescribeScheduledQuery",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ScheduledQueryArn" => ScheduledQueryArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
execute_scheduled_query(invocation_time, scheduled_query_arn)
execute_scheduled_query(invocation_time, scheduled_query_arn, params::Dict{String,<:Any})
You can use this API to run a scheduled query manually.
# Arguments
- `invocation_time`: The timestamp in UTC. Query will be run as if it was invoked at this
timestamp.
- `scheduled_query_arn`: ARN of the scheduled query.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Not used.
"""
function execute_scheduled_query(
InvocationTime, ScheduledQueryArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return timestream_query(
"ExecuteScheduledQuery",
Dict{String,Any}(
"InvocationTime" => InvocationTime,
"ScheduledQueryArn" => ScheduledQueryArn,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function execute_scheduled_query(
InvocationTime,
ScheduledQueryArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return timestream_query(
"ExecuteScheduledQuery",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InvocationTime" => InvocationTime,
"ScheduledQueryArn" => ScheduledQueryArn,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_scheduled_queries()
list_scheduled_queries(params::Dict{String,<:Any})
Gets a list of all scheduled queries in the caller's Amazon account and Region.
ListScheduledQueries is eventually consistent.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of items to return in the output. If the total number
of items available is more than the value specified, a NextToken is provided in the output.
To resume pagination, provide the NextToken value as the argument to the subsequent call to
ListScheduledQueriesRequest.
- `"NextToken"`: A pagination token to resume pagination.
"""
function list_scheduled_queries(; aws_config::AbstractAWSConfig=global_aws_config())
return timestream_query(
"ListScheduledQueries"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_scheduled_queries(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return timestream_query(
"ListScheduledQueries",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
List all tags on a Timestream query resource.
# Arguments
- `resource_arn`: The Timestream 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:
- `"MaxResults"`: The maximum number of tags to return.
- `"NextToken"`: A pagination token to resume pagination.
"""
function list_tags_for_resource(
ResourceARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return timestream_query(
"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 timestream_query(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceARN" => ResourceARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
prepare_query(query_string)
prepare_query(query_string, params::Dict{String,<:Any})
A synchronous operation that allows you to submit a query with parameters to be stored by
Timestream for later running. Timestream only supports using this operation with
ValidateOnly set to true.
# Arguments
- `query_string`: The Timestream query string that you want to use as a prepared statement.
Parameter names can be specified in the query string @ character followed by an identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ValidateOnly"`: By setting this value to true, Timestream will only validate that the
query string is a valid Timestream query, and not store the prepared query for later use.
"""
function prepare_query(QueryString; aws_config::AbstractAWSConfig=global_aws_config())
return timestream_query(
"PrepareQuery",
Dict{String,Any}("QueryString" => QueryString);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function prepare_query(
QueryString,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return timestream_query(
"PrepareQuery",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("QueryString" => QueryString), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
query(query_string)
query(query_string, params::Dict{String,<:Any})
Query is a synchronous operation that enables you to run a query against your Amazon
Timestream data. Query will time out after 60 seconds. You must update the default timeout
in the SDK to support a timeout of 60 seconds. See the code sample for details. Your query
request will fail in the following cases: If you submit a Query request with the same
client token outside of the 5-minute idempotency window. If you submit a Query request
with the same client token, but change other parameters, within the 5-minute idempotency
window. If the size of the row (including the query metadata) exceeds 1 MB, then the
query will fail with the following error message: Query aborted as max page response size
has been exceeded by the output result row If the IAM principal of the query initiator
and the result reader are not the same and/or the query initiator and the result reader do
not have the same query string in the query requests, the query will fail with an Invalid
pagination token error.
# Arguments
- `query_string`: The query to be run by Timestream.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Unique, case-sensitive string of up to 64 ASCII characters specified
when a Query request is made. Providing a ClientToken makes the call to Query idempotent.
This means that running the same query repeatedly will produce the same result. In other
words, making multiple identical Query requests has the same effect as making a single
request. When using ClientToken in a query, note the following: If the Query API is
instantiated without a ClientToken, the Query SDK generates a ClientToken on your behalf.
If the Query invocation only contains the ClientToken but does not include a NextToken,
that invocation of Query is assumed to be a new query run. If the invocation contains
NextToken, that particular invocation is assumed to be a subsequent invocation of a prior
call to the Query API, and a result set is returned. After 4 hours, any request with the
same ClientToken is treated as a new request.
- `"MaxRows"`: The total number of rows to be returned in the Query output. The initial
run of Query with a MaxRows value specified will return the result set of the query in two
cases: The size of the result is less than 1MB. The number of rows in the result set
is less than the value of maxRows. Otherwise, the initial invocation of Query only
returns a NextToken, which can then be used in subsequent calls to fetch the result set. To
resume pagination, provide the NextToken value in the subsequent command. If the row size
is large (e.g. a row has many columns), Timestream may return fewer rows to keep the
response size from exceeding the 1 MB limit. If MaxRows is not provided, Timestream will
send the necessary number of rows to meet the 1 MB limit.
- `"NextToken"`: A pagination token used to return a set of results. When the Query API is
invoked using NextToken, that particular invocation is assumed to be a subsequent
invocation of a prior call to Query, and a result set is returned. However, if the Query
invocation only contains the ClientToken, that invocation of Query is assumed to be a new
query run. Note the following when using NextToken in a query: A pagination token can be
used for up to five Query invocations, OR for a duration of up to 1 hour – whichever
comes first. Using the same NextToken will return the same set of records. To keep
paginating through the result set, you must to use the most recent nextToken. Suppose a
Query invocation returns two NextToken values, TokenA and TokenB. If TokenB is used in a
subsequent Query invocation, then TokenA is invalidated and cannot be reused. To request
a previous result set from a query after pagination has begun, you must re-invoke the Query
API. The latest NextToken should be used to paginate until null is returned, at which
point a new NextToken should be used. If the IAM principal of the query initiator and
the result reader are not the same and/or the query initiator and the result reader do not
have the same query string in the query requests, the query will fail with an Invalid
pagination token error.
"""
function query(QueryString; aws_config::AbstractAWSConfig=global_aws_config())
return timestream_query(
"Query",
Dict{String,Any}("QueryString" => QueryString, "ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function query(
QueryString,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return timestream_query(
"Query",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"QueryString" => QueryString, "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})
Associate a set of tags with a Timestream resource. You can then activate these
user-defined tags so that they appear on the Billing and Cost Management console for cost
allocation tracking.
# Arguments
- `resource_arn`: Identifies the Timestream resource to which tags should be added. This
value is an Amazon Resource Name (ARN).
- `tags`: The tags to be assigned to the Timestream resource.
"""
function tag_resource(ResourceARN, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return timestream_query(
"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 timestream_query(
"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 association of tags from a Timestream query resource.
# Arguments
- `resource_arn`: The Timestream resource that the tags will be removed from. This value is
an Amazon Resource Name (ARN).
- `tag_keys`: A list of tags keys. Existing tags of the resource whose keys are members of
this list will be removed from the Timestream resource.
"""
function untag_resource(
ResourceARN, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return timestream_query(
"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 timestream_query(
"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_account_settings()
update_account_settings(params::Dict{String,<:Any})
Transitions your account to use TCUs for query pricing and modifies the maximum query
compute units that you've configured. If you reduce the value of MaxQueryTCU to a desired
configuration, the new value can take up to 24 hours to be effective. After you've
transitioned your account to use TCUs for query pricing, you can't transition to using
bytes scanned for query pricing.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxQueryTCU"`: The maximum number of compute units the service will use at any point in
time to serve your queries. To run queries, you must set a minimum capacity of 4 TCU. You
can set the maximum number of TCU in multiples of 4, for example, 4, 8, 16, 32, and so on.
The maximum value supported for MaxQueryTCU is 1000. To request an increase to this soft
limit, contact Amazon Web Services Support. For information about the default quota for
maxQueryTCU, see Default quotas.
- `"QueryPricingModel"`: The pricing model for queries in an account.
"""
function update_account_settings(; aws_config::AbstractAWSConfig=global_aws_config())
return timestream_query(
"UpdateAccountSettings"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function update_account_settings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return timestream_query(
"UpdateAccountSettings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_scheduled_query(scheduled_query_arn, state)
update_scheduled_query(scheduled_query_arn, state, params::Dict{String,<:Any})
Update a scheduled query.
# Arguments
- `scheduled_query_arn`: ARN of the scheuled query.
- `state`: State of the scheduled query.
"""
function update_scheduled_query(
ScheduledQueryArn, State; aws_config::AbstractAWSConfig=global_aws_config()
)
return timestream_query(
"UpdateScheduledQuery",
Dict{String,Any}("ScheduledQueryArn" => ScheduledQueryArn, "State" => State);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_scheduled_query(
ScheduledQueryArn,
State,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return timestream_query(
"UpdateScheduledQuery",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ScheduledQueryArn" => ScheduledQueryArn, "State" => 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 | 29995 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: timestream_write
using AWS.Compat
using AWS.UUIDs
"""
create_batch_load_task(data_source_configuration, report_configuration, target_database_name, target_table_name)
create_batch_load_task(data_source_configuration, report_configuration, target_database_name, target_table_name, params::Dict{String,<:Any})
Creates a new Timestream batch load task. A batch load task processes data from a CSV
source in an S3 location and writes to a Timestream table. A mapping from source to target
is defined in a batch load task. Errors and events are written to a report at an S3
location. For the report, if the KMS key is not specified, the report will be encrypted
with an S3 managed key when SSE_S3 is the option. Otherwise an error is thrown. For more
information, see Amazon Web Services managed keys. Service quotas apply. For details, see
code sample.
# Arguments
- `data_source_configuration`: Defines configuration details about the data source for a
batch load task.
- `report_configuration`:
- `target_database_name`: Target Timestream database for a batch load task.
- `target_table_name`: Target Timestream table for a batch load task.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`:
- `"DataModelConfiguration"`:
- `"RecordVersion"`:
"""
function create_batch_load_task(
DataSourceConfiguration,
ReportConfiguration,
TargetDatabaseName,
TargetTableName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return timestream_write(
"CreateBatchLoadTask",
Dict{String,Any}(
"DataSourceConfiguration" => DataSourceConfiguration,
"ReportConfiguration" => ReportConfiguration,
"TargetDatabaseName" => TargetDatabaseName,
"TargetTableName" => TargetTableName,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_batch_load_task(
DataSourceConfiguration,
ReportConfiguration,
TargetDatabaseName,
TargetTableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return timestream_write(
"CreateBatchLoadTask",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DataSourceConfiguration" => DataSourceConfiguration,
"ReportConfiguration" => ReportConfiguration,
"TargetDatabaseName" => TargetDatabaseName,
"TargetTableName" => TargetTableName,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_database(database_name)
create_database(database_name, params::Dict{String,<:Any})
Creates a new Timestream database. If the KMS key is not specified, the database will be
encrypted with a Timestream managed KMS key located in your account. For more information,
see Amazon Web Services managed keys. Service quotas apply. For details, see code sample.
# Arguments
- `database_name`: The name of the Timestream database.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"KmsKeyId"`: The KMS key for the database. If the KMS key is not specified, the database
will be encrypted with a Timestream managed KMS key located in your account. For more
information, see Amazon Web Services managed keys.
- `"Tags"`: A list of key-value pairs to label the table.
"""
function create_database(DatabaseName; aws_config::AbstractAWSConfig=global_aws_config())
return timestream_write(
"CreateDatabase",
Dict{String,Any}("DatabaseName" => DatabaseName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_database(
DatabaseName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return timestream_write(
"CreateDatabase",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DatabaseName" => DatabaseName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_table(database_name, table_name)
create_table(database_name, table_name, params::Dict{String,<:Any})
Adds a new table to an existing database in your account. In an Amazon Web Services
account, table names must be at least unique within each Region if they are in the same
database. You might have identical table names in the same Region if the tables are in
separate databases. While creating the table, you must specify the table name, database
name, and the retention properties. Service quotas apply. See code sample for details.
# Arguments
- `database_name`: The name of the Timestream database.
- `table_name`: The name of the Timestream table.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MagneticStoreWriteProperties"`: Contains properties to set on the table when enabling
magnetic store writes.
- `"RetentionProperties"`: The duration for which your time-series data must be stored in
the memory store and the magnetic store.
- `"Schema"`: The schema of the table.
- `"Tags"`: A list of key-value pairs to label the table.
"""
function create_table(
DatabaseName, TableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return timestream_write(
"CreateTable",
Dict{String,Any}("DatabaseName" => DatabaseName, "TableName" => TableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_table(
DatabaseName,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return timestream_write(
"CreateTable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DatabaseName" => DatabaseName, "TableName" => TableName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_database(database_name)
delete_database(database_name, params::Dict{String,<:Any})
Deletes a given Timestream database. This is an irreversible operation. After a database is
deleted, the time-series data from its tables cannot be recovered. All tables in the
database must be deleted first, or a ValidationException error will be thrown. Due to the
nature of distributed retries, the operation can return either success or a
ResourceNotFoundException. Clients should consider them equivalent. See code sample for
details.
# Arguments
- `database_name`: The name of the Timestream database to be deleted.
"""
function delete_database(DatabaseName; aws_config::AbstractAWSConfig=global_aws_config())
return timestream_write(
"DeleteDatabase",
Dict{String,Any}("DatabaseName" => DatabaseName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_database(
DatabaseName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return timestream_write(
"DeleteDatabase",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DatabaseName" => DatabaseName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_table(database_name, table_name)
delete_table(database_name, table_name, params::Dict{String,<:Any})
Deletes a given Timestream table. This is an irreversible operation. After a Timestream
database table is deleted, the time-series data stored in the table cannot be recovered.
Due to the nature of distributed retries, the operation can return either success or a
ResourceNotFoundException. Clients should consider them equivalent. See code sample for
details.
# Arguments
- `database_name`: The name of the database where the Timestream database is to be deleted.
- `table_name`: The name of the Timestream table to be deleted.
"""
function delete_table(
DatabaseName, TableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return timestream_write(
"DeleteTable",
Dict{String,Any}("DatabaseName" => DatabaseName, "TableName" => TableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_table(
DatabaseName,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return timestream_write(
"DeleteTable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DatabaseName" => DatabaseName, "TableName" => TableName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_batch_load_task(task_id)
describe_batch_load_task(task_id, params::Dict{String,<:Any})
Returns information about the batch load task, including configurations, mappings,
progress, and other details. Service quotas apply. See code sample for details.
# Arguments
- `task_id`: The ID of the batch load task.
"""
function describe_batch_load_task(TaskId; aws_config::AbstractAWSConfig=global_aws_config())
return timestream_write(
"DescribeBatchLoadTask",
Dict{String,Any}("TaskId" => TaskId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_batch_load_task(
TaskId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return timestream_write(
"DescribeBatchLoadTask",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("TaskId" => TaskId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_database(database_name)
describe_database(database_name, params::Dict{String,<:Any})
Returns information about the database, including the database name, time that the database
was created, and the total number of tables found within the database. Service quotas
apply. See code sample for details.
# Arguments
- `database_name`: The name of the Timestream database.
"""
function describe_database(DatabaseName; aws_config::AbstractAWSConfig=global_aws_config())
return timestream_write(
"DescribeDatabase",
Dict{String,Any}("DatabaseName" => DatabaseName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_database(
DatabaseName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return timestream_write(
"DescribeDatabase",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DatabaseName" => DatabaseName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_endpoints()
describe_endpoints(params::Dict{String,<:Any})
Returns a list of available endpoints to make Timestream API calls against. This API
operation is available through both the Write and Query APIs. Because the Timestream SDKs
are designed to transparently work with the service’s architecture, including the
management and mapping of the service endpoints, we don't recommend that you use this API
operation unless: You are using VPC endpoints (Amazon Web Services PrivateLink) with
Timestream Your application uses a programming language that does not yet have SDK
support You require better control over the client-side implementation For detailed
information on how and when to use and implement DescribeEndpoints, see The Endpoint
Discovery Pattern.
"""
function describe_endpoints(; aws_config::AbstractAWSConfig=global_aws_config())
return timestream_write(
"DescribeEndpoints"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_endpoints(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return timestream_write(
"DescribeEndpoints", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_table(database_name, table_name)
describe_table(database_name, table_name, params::Dict{String,<:Any})
Returns information about the table, including the table name, database name, retention
duration of the memory store and the magnetic store. Service quotas apply. See code sample
for details.
# Arguments
- `database_name`: The name of the Timestream database.
- `table_name`: The name of the Timestream table.
"""
function describe_table(
DatabaseName, TableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return timestream_write(
"DescribeTable",
Dict{String,Any}("DatabaseName" => DatabaseName, "TableName" => TableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_table(
DatabaseName,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return timestream_write(
"DescribeTable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DatabaseName" => DatabaseName, "TableName" => TableName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_batch_load_tasks()
list_batch_load_tasks(params::Dict{String,<:Any})
Provides a list of batch load tasks, along with the name, status, when the task is
resumable until, and other details. See code sample for details.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The total number of items to return in the output. If the total number of
items available is more than the value specified, a NextToken is provided in the output. To
resume pagination, provide the NextToken value as argument of a subsequent API invocation.
- `"NextToken"`: A token to specify where to start paginating. This is the NextToken from a
previously truncated response.
- `"TaskStatus"`: Status of the batch load task.
"""
function list_batch_load_tasks(; aws_config::AbstractAWSConfig=global_aws_config())
return timestream_write(
"ListBatchLoadTasks"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_batch_load_tasks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return timestream_write(
"ListBatchLoadTasks", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_databases()
list_databases(params::Dict{String,<:Any})
Returns a list of your Timestream databases. Service quotas apply. See code sample for
details.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The total number of items to return in the output. If the total number of
items available is more than the value specified, a NextToken is provided in the output. To
resume pagination, provide the NextToken value as argument of a subsequent API invocation.
- `"NextToken"`: The pagination token. To resume pagination, provide the NextToken value as
argument of a subsequent API invocation.
"""
function list_databases(; aws_config::AbstractAWSConfig=global_aws_config())
return timestream_write(
"ListDatabases"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_databases(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return timestream_write(
"ListDatabases", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tables()
list_tables(params::Dict{String,<:Any})
Provides a list of tables, along with the name, status, and retention properties of each
table. See code sample for details.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DatabaseName"`: The name of the Timestream database.
- `"MaxResults"`: The total number of items to return in the output. If the total number of
items available is more than the value specified, a NextToken is provided in the output. To
resume pagination, provide the NextToken value as argument of a subsequent API invocation.
- `"NextToken"`: The pagination token. To resume pagination, provide the NextToken value as
argument of a subsequent API invocation.
"""
function list_tables(; aws_config::AbstractAWSConfig=global_aws_config())
return timestream_write(
"ListTables"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_tables(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return timestream_write(
"ListTables", 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 Timestream resource.
# Arguments
- `resource_arn`: The Timestream resource with tags to be listed. This value is an Amazon
Resource Name (ARN).
"""
function list_tags_for_resource(
ResourceARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return timestream_write(
"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 timestream_write(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceARN" => ResourceARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
resume_batch_load_task(task_id)
resume_batch_load_task(task_id, params::Dict{String,<:Any})
# Arguments
- `task_id`: The ID of the batch load task to resume.
"""
function resume_batch_load_task(TaskId; aws_config::AbstractAWSConfig=global_aws_config())
return timestream_write(
"ResumeBatchLoadTask",
Dict{String,Any}("TaskId" => TaskId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function resume_batch_load_task(
TaskId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return timestream_write(
"ResumeBatchLoadTask",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("TaskId" => TaskId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Associates a set of tags with a Timestream resource. You can then activate these
user-defined tags so that they appear on the Billing and Cost Management console for cost
allocation tracking.
# Arguments
- `resource_arn`: Identifies the Timestream resource to which tags should be added. This
value is an Amazon Resource Name (ARN).
- `tags`: The tags to be assigned to the Timestream resource.
"""
function tag_resource(ResourceARN, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return timestream_write(
"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 timestream_write(
"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 association of tags from a Timestream resource.
# Arguments
- `resource_arn`: The Timestream resource that the tags will be removed from. This value
is an Amazon Resource Name (ARN).
- `tag_keys`: A list of tags keys. Existing tags of the resource whose keys are members of
this list will be removed from the Timestream resource.
"""
function untag_resource(
ResourceARN, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return timestream_write(
"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 timestream_write(
"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_database(database_name, kms_key_id)
update_database(database_name, kms_key_id, params::Dict{String,<:Any})
Modifies the KMS key for an existing database. While updating the database, you must
specify the database name and the identifier of the new KMS key to be used (KmsKeyId). If
there are any concurrent UpdateDatabase requests, first writer wins. See code sample for
details.
# Arguments
- `database_name`: The name of the database.
- `kms_key_id`: The identifier of the new KMS key (KmsKeyId) to be used to encrypt the
data stored in the database. If the KmsKeyId currently registered with the database is the
same as the KmsKeyId in the request, there will not be any update. You can specify the
KmsKeyId using any of the following: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key
ARN: arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias
name: alias/ExampleAlias Alias ARN:
arn:aws:kms:us-east-1:111122223333:alias/ExampleAlias
"""
function update_database(
DatabaseName, KmsKeyId; aws_config::AbstractAWSConfig=global_aws_config()
)
return timestream_write(
"UpdateDatabase",
Dict{String,Any}("DatabaseName" => DatabaseName, "KmsKeyId" => KmsKeyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_database(
DatabaseName,
KmsKeyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return timestream_write(
"UpdateDatabase",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DatabaseName" => DatabaseName, "KmsKeyId" => KmsKeyId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_table(database_name, table_name)
update_table(database_name, table_name, params::Dict{String,<:Any})
Modifies the retention duration of the memory store and magnetic store for your Timestream
table. Note that the change in retention duration takes effect immediately. For example, if
the retention period of the memory store was initially set to 2 hours and then changed to
24 hours, the memory store will be capable of holding 24 hours of data, but will be
populated with 24 hours of data 22 hours after this change was made. Timestream does not
retrieve data from the magnetic store to populate the memory store. See code sample for
details.
# Arguments
- `database_name`: The name of the Timestream database.
- `table_name`: The name of the Timestream table.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MagneticStoreWriteProperties"`: Contains properties to set on the table when enabling
magnetic store writes.
- `"RetentionProperties"`: The retention duration of the memory store and the magnetic
store.
- `"Schema"`: The schema of the table.
"""
function update_table(
DatabaseName, TableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return timestream_write(
"UpdateTable",
Dict{String,Any}("DatabaseName" => DatabaseName, "TableName" => TableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_table(
DatabaseName,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return timestream_write(
"UpdateTable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DatabaseName" => DatabaseName, "TableName" => TableName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
write_records(database_name, records, table_name)
write_records(database_name, records, table_name, params::Dict{String,<:Any})
Enables you to write your time-series data into Timestream. You can specify a single data
point or a batch of data points to be inserted into the system. Timestream offers you a
flexible schema that auto detects the column names and data types for your Timestream
tables based on the dimension names and data types of the data points you specify when
invoking writes into the database. Timestream supports eventual consistency read
semantics. This means that when you query data immediately after writing a batch of data
into Timestream, the query results might not reflect the results of a recently completed
write operation. The results may also include some stale data. If you repeat the query
request after a short time, the results should return the latest data. Service quotas
apply. See code sample for details. Upserts You can use the Version parameter in a
WriteRecords request to update data points. Timestream tracks a version number with each
record. Version defaults to 1 when it's not specified for the record in the request.
Timestream updates an existing record’s measure value along with its Version when it
receives a write request with a higher Version number for that record. When it receives an
update request where the measure value is the same as that of the existing record,
Timestream still updates Version, if it is greater than the existing value of Version. You
can update a data point as many times as desired, as long as the value of Version
continuously increases. For example, suppose you write a new record without indicating
Version in the request. Timestream stores this record, and set Version to 1. Now, suppose
you try to update this record with a WriteRecords request of the same record with a
different measure value but, like before, do not provide Version. In this case, Timestream
will reject this update with a RejectedRecordsException since the updated record’s
version is not greater than the existing value of Version. However, if you were to resend
the update request with Version set to 2, Timestream would then succeed in updating the
record’s value, and the Version would be set to 2. Next, suppose you sent a WriteRecords
request with this same record and an identical measure value, but with Version set to 3. In
this case, Timestream would only update Version to 3. Any further updates would need to
send a version number greater than 3, or the update requests would receive a
RejectedRecordsException.
# Arguments
- `database_name`: The name of the Timestream database.
- `records`: An array of records that contain the unique measure, dimension, time, and
version attributes for each time-series data point.
- `table_name`: The name of the Timestream table.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CommonAttributes"`: A record that contains the common measure, dimension, time, and
version attributes shared across all the records in the request. The measure and dimension
attributes specified will be merged with the measure and dimension attributes in the
records object when the data is written into Timestream. Dimensions may not overlap, or a
ValidationException will be thrown. In other words, a record must contain dimensions with
unique names.
"""
function write_records(
DatabaseName, Records, TableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return timestream_write(
"WriteRecords",
Dict{String,Any}(
"DatabaseName" => DatabaseName, "Records" => Records, "TableName" => TableName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function write_records(
DatabaseName,
Records,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return timestream_write(
"WriteRecords",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatabaseName" => DatabaseName,
"Records" => Records,
"TableName" => TableName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
|
[
"MIT"
] | 1.92.0 | 319ade7f8fc88243369e119859a7d3a3e7e7f267 | code | 44689 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: tnb
using AWS.Compat
using AWS.UUIDs
"""
cancel_sol_network_operation(ns_lcm_op_occ_id)
cancel_sol_network_operation(ns_lcm_op_occ_id, params::Dict{String,<:Any})
Cancels a network operation. A network operation is any operation that is done to your
network, such as network instance instantiation or termination.
# Arguments
- `ns_lcm_op_occ_id`: The identifier of the network operation.
"""
function cancel_sol_network_operation(
nsLcmOpOccId; aws_config::AbstractAWSConfig=global_aws_config()
)
return tnb(
"POST",
"/sol/nslcm/v1/ns_lcm_op_occs/$(nsLcmOpOccId)/cancel";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_sol_network_operation(
nsLcmOpOccId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return tnb(
"POST",
"/sol/nslcm/v1/ns_lcm_op_occs/$(nsLcmOpOccId)/cancel",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_sol_function_package()
create_sol_function_package(params::Dict{String,<:Any})
Creates a function package. A function package is a .zip file in CSAR (Cloud Service
Archive) format that contains a network function (an ETSI standard telecommunication
application) and function package descriptor that uses the TOSCA standard to describe how
the network functions should run on your network. For more information, see Function
packages in the Amazon Web Services Telco Network Builder User Guide. Creating a function
package is the first step for creating a network in AWS TNB. This request creates an empty
container with an ID. The next step is to upload the actual CSAR zip file into that empty
container. To upload function package content, see PutSolFunctionPackageContent.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: A tag is a label that you assign to an Amazon Web Services resource. Each tag
consists of a key and an optional value. You can use tags to search and filter your
resources or track your Amazon Web Services costs.
"""
function create_sol_function_package(; aws_config::AbstractAWSConfig=global_aws_config())
return tnb(
"POST",
"/sol/vnfpkgm/v1/vnf_packages";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_sol_function_package(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return tnb(
"POST",
"/sol/vnfpkgm/v1/vnf_packages",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_sol_network_instance(ns_name, nsd_info_id)
create_sol_network_instance(ns_name, nsd_info_id, params::Dict{String,<:Any})
Creates a network instance. A network instance is a single network created in Amazon Web
Services TNB that can be deployed and on which life-cycle operations (like terminate,
update, and delete) can be performed. Creating a network instance is the third step after
creating a network package. For more information about network instances, Network instances
in the Amazon Web Services Telco Network Builder User Guide. Once you create a network
instance, you can instantiate it. To instantiate a network, see
InstantiateSolNetworkInstance.
# Arguments
- `ns_name`: Network instance name.
- `nsd_info_id`: ID for network service descriptor.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nsDescription"`: Network instance description.
- `"tags"`: A tag is a label that you assign to an Amazon Web Services resource. Each tag
consists of a key and an optional value. You can use tags to search and filter your
resources or track your Amazon Web Services costs.
"""
function create_sol_network_instance(
nsName, nsdInfoId; aws_config::AbstractAWSConfig=global_aws_config()
)
return tnb(
"POST",
"/sol/nslcm/v1/ns_instances",
Dict{String,Any}("nsName" => nsName, "nsdInfoId" => nsdInfoId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_sol_network_instance(
nsName,
nsdInfoId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return tnb(
"POST",
"/sol/nslcm/v1/ns_instances",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("nsName" => nsName, "nsdInfoId" => nsdInfoId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_sol_network_package()
create_sol_network_package(params::Dict{String,<:Any})
Creates a network package. A network package is a .zip file in CSAR (Cloud Service Archive)
format defines the function packages you want to deploy and the Amazon Web Services
infrastructure you want to deploy them on. For more information, see Network instances in
the Amazon Web Services Telco Network Builder User Guide. A network package consists of a
network service descriptor (NSD) file (required) and any additional files (optional), such
as scripts specific to your needs. For example, if you have multiple function packages in
your network package, you can use the NSD to define which network functions should run in
certain VPCs, subnets, or EKS clusters. This request creates an empty network package
container with an ID. Once you create a network package, you can upload the network package
content using PutSolNetworkPackageContent.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: A tag is a label that you assign to an Amazon Web Services resource. Each tag
consists of a key and an optional value. You can use tags to search and filter your
resources or track your Amazon Web Services costs.
"""
function create_sol_network_package(; aws_config::AbstractAWSConfig=global_aws_config())
return tnb(
"POST",
"/sol/nsd/v1/ns_descriptors";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_sol_network_package(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return tnb(
"POST",
"/sol/nsd/v1/ns_descriptors",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_sol_function_package(vnf_pkg_id)
delete_sol_function_package(vnf_pkg_id, params::Dict{String,<:Any})
Deletes a function package. A function package is a .zip file in CSAR (Cloud Service
Archive) format that contains a network function (an ETSI standard telecommunication
application) and function package descriptor that uses the TOSCA standard to describe how
the network functions should run on your network. To delete a function package, the package
must be in a disabled state. To disable a function package, see UpdateSolFunctionPackage.
# Arguments
- `vnf_pkg_id`: ID of the function package.
"""
function delete_sol_function_package(
vnfPkgId; aws_config::AbstractAWSConfig=global_aws_config()
)
return tnb(
"DELETE",
"/sol/vnfpkgm/v1/vnf_packages/$(vnfPkgId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_sol_function_package(
vnfPkgId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return tnb(
"DELETE",
"/sol/vnfpkgm/v1/vnf_packages/$(vnfPkgId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_sol_network_instance(ns_instance_id)
delete_sol_network_instance(ns_instance_id, params::Dict{String,<:Any})
Deletes a network instance. A network instance is a single network created in Amazon Web
Services TNB that can be deployed and on which life-cycle operations (like terminate,
update, and delete) can be performed. To delete a network instance, the instance must be in
a stopped or terminated state. To terminate a network instance, see
TerminateSolNetworkInstance.
# Arguments
- `ns_instance_id`: Network instance ID.
"""
function delete_sol_network_instance(
nsInstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return tnb(
"DELETE",
"/sol/nslcm/v1/ns_instances/$(nsInstanceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_sol_network_instance(
nsInstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return tnb(
"DELETE",
"/sol/nslcm/v1/ns_instances/$(nsInstanceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_sol_network_package(nsd_info_id)
delete_sol_network_package(nsd_info_id, params::Dict{String,<:Any})
Deletes network package. A network package is a .zip file in CSAR (Cloud Service Archive)
format defines the function packages you want to deploy and the Amazon Web Services
infrastructure you want to deploy them on. To delete a network package, the package must be
in a disable state. To disable a network package, see UpdateSolNetworkPackage.
# Arguments
- `nsd_info_id`: ID of the network service descriptor in the network package.
"""
function delete_sol_network_package(
nsdInfoId; aws_config::AbstractAWSConfig=global_aws_config()
)
return tnb(
"DELETE",
"/sol/nsd/v1/ns_descriptors/$(nsdInfoId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_sol_network_package(
nsdInfoId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return tnb(
"DELETE",
"/sol/nsd/v1/ns_descriptors/$(nsdInfoId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_sol_function_instance(vnf_instance_id)
get_sol_function_instance(vnf_instance_id, params::Dict{String,<:Any})
Gets the details of a network function instance, including the instantation state and
metadata from the function package descriptor in the network function package. A network
function instance is a function in a function package .
# Arguments
- `vnf_instance_id`: ID of the network function.
"""
function get_sol_function_instance(
vnfInstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return tnb(
"GET",
"/sol/vnflcm/v1/vnf_instances/$(vnfInstanceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_sol_function_instance(
vnfInstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return tnb(
"GET",
"/sol/vnflcm/v1/vnf_instances/$(vnfInstanceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_sol_function_package(vnf_pkg_id)
get_sol_function_package(vnf_pkg_id, params::Dict{String,<:Any})
Gets the details of an individual function package, such as the operational state and
whether the package is in use. A function package is a .zip file in CSAR (Cloud Service
Archive) format that contains a network function (an ETSI standard telecommunication
application) and function package descriptor that uses the TOSCA standard to describe how
the network functions should run on your network..
# Arguments
- `vnf_pkg_id`: ID of the function package.
"""
function get_sol_function_package(
vnfPkgId; aws_config::AbstractAWSConfig=global_aws_config()
)
return tnb(
"GET",
"/sol/vnfpkgm/v1/vnf_packages/$(vnfPkgId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_sol_function_package(
vnfPkgId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return tnb(
"GET",
"/sol/vnfpkgm/v1/vnf_packages/$(vnfPkgId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_sol_function_package_content(accept, vnf_pkg_id)
get_sol_function_package_content(accept, vnf_pkg_id, params::Dict{String,<:Any})
Gets the contents of a function package. A function package is a .zip file in CSAR (Cloud
Service Archive) format that contains a network function (an ETSI standard
telecommunication application) and function package descriptor that uses the TOSCA standard
to describe how the network functions should run on your network.
# Arguments
- `accept`: The format of the package that you want to download from the function packages.
- `vnf_pkg_id`: ID of the function package.
"""
function get_sol_function_package_content(
Accept, vnfPkgId; aws_config::AbstractAWSConfig=global_aws_config()
)
return tnb(
"GET",
"/sol/vnfpkgm/v1/vnf_packages/$(vnfPkgId)/package_content",
Dict{String,Any}("headers" => Dict{String,Any}("Accept" => Accept));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_sol_function_package_content(
Accept,
vnfPkgId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return tnb(
"GET",
"/sol/vnfpkgm/v1/vnf_packages/$(vnfPkgId)/package_content",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("headers" => Dict{String,Any}("Accept" => Accept)),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_sol_function_package_descriptor(accept, vnf_pkg_id)
get_sol_function_package_descriptor(accept, vnf_pkg_id, params::Dict{String,<:Any})
Gets a function package descriptor in a function package. A function package descriptor is
a .yaml file in a function package that uses the TOSCA standard to describe how the network
function in the function package should run on your network. A function package is a .zip
file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI
standard telecommunication application) and function package descriptor that uses the TOSCA
standard to describe how the network functions should run on your network.
# Arguments
- `accept`: Indicates which content types, expressed as MIME types, the client is able to
understand.
- `vnf_pkg_id`: ID of the function package.
"""
function get_sol_function_package_descriptor(
Accept, vnfPkgId; aws_config::AbstractAWSConfig=global_aws_config()
)
return tnb(
"GET",
"/sol/vnfpkgm/v1/vnf_packages/$(vnfPkgId)/vnfd",
Dict{String,Any}("headers" => Dict{String,Any}("Accept" => Accept));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_sol_function_package_descriptor(
Accept,
vnfPkgId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return tnb(
"GET",
"/sol/vnfpkgm/v1/vnf_packages/$(vnfPkgId)/vnfd",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("headers" => Dict{String,Any}("Accept" => Accept)),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_sol_network_instance(ns_instance_id)
get_sol_network_instance(ns_instance_id, params::Dict{String,<:Any})
Gets the details of the network instance. A network instance is a single network created in
Amazon Web Services TNB that can be deployed and on which life-cycle operations (like
terminate, update, and delete) can be performed.
# Arguments
- `ns_instance_id`: ID of the network instance.
"""
function get_sol_network_instance(
nsInstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return tnb(
"GET",
"/sol/nslcm/v1/ns_instances/$(nsInstanceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_sol_network_instance(
nsInstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return tnb(
"GET",
"/sol/nslcm/v1/ns_instances/$(nsInstanceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_sol_network_operation(ns_lcm_op_occ_id)
get_sol_network_operation(ns_lcm_op_occ_id, params::Dict{String,<:Any})
Gets the details of a network operation, including the tasks involved in the network
operation and the status of the tasks. A network operation is any operation that is done to
your network, such as network instance instantiation or termination.
# Arguments
- `ns_lcm_op_occ_id`: The identifier of the network operation.
"""
function get_sol_network_operation(
nsLcmOpOccId; aws_config::AbstractAWSConfig=global_aws_config()
)
return tnb(
"GET",
"/sol/nslcm/v1/ns_lcm_op_occs/$(nsLcmOpOccId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_sol_network_operation(
nsLcmOpOccId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return tnb(
"GET",
"/sol/nslcm/v1/ns_lcm_op_occs/$(nsLcmOpOccId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_sol_network_package(nsd_info_id)
get_sol_network_package(nsd_info_id, params::Dict{String,<:Any})
Gets the details of a network package. A network package is a .zip file in CSAR (Cloud
Service Archive) format defines the function packages you want to deploy and the Amazon Web
Services infrastructure you want to deploy them on.
# Arguments
- `nsd_info_id`: ID of the network service descriptor in the network package.
"""
function get_sol_network_package(
nsdInfoId; aws_config::AbstractAWSConfig=global_aws_config()
)
return tnb(
"GET",
"/sol/nsd/v1/ns_descriptors/$(nsdInfoId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_sol_network_package(
nsdInfoId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return tnb(
"GET",
"/sol/nsd/v1/ns_descriptors/$(nsdInfoId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_sol_network_package_content(accept, nsd_info_id)
get_sol_network_package_content(accept, nsd_info_id, params::Dict{String,<:Any})
Gets the contents of a network package. A network package is a .zip file in CSAR (Cloud
Service Archive) format defines the function packages you want to deploy and the Amazon Web
Services infrastructure you want to deploy them on.
# Arguments
- `accept`: The format of the package you want to download from the network package.
- `nsd_info_id`: ID of the network service descriptor in the network package.
"""
function get_sol_network_package_content(
Accept, nsdInfoId; aws_config::AbstractAWSConfig=global_aws_config()
)
return tnb(
"GET",
"/sol/nsd/v1/ns_descriptors/$(nsdInfoId)/nsd_content",
Dict{String,Any}("headers" => Dict{String,Any}("Accept" => Accept));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_sol_network_package_content(
Accept,
nsdInfoId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return tnb(
"GET",
"/sol/nsd/v1/ns_descriptors/$(nsdInfoId)/nsd_content",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("headers" => Dict{String,Any}("Accept" => Accept)),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_sol_network_package_descriptor(nsd_info_id)
get_sol_network_package_descriptor(nsd_info_id, params::Dict{String,<:Any})
Gets the content of the network service descriptor. A network service descriptor is a .yaml
file in a network package that uses the TOSCA standard to describe the network functions
you want to deploy and the Amazon Web Services infrastructure you want to deploy the
network functions on.
# Arguments
- `nsd_info_id`: ID of the network service descriptor in the network package.
"""
function get_sol_network_package_descriptor(
nsdInfoId; aws_config::AbstractAWSConfig=global_aws_config()
)
return tnb(
"GET",
"/sol/nsd/v1/ns_descriptors/$(nsdInfoId)/nsd";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_sol_network_package_descriptor(
nsdInfoId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return tnb(
"GET",
"/sol/nsd/v1/ns_descriptors/$(nsdInfoId)/nsd",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
instantiate_sol_network_instance(ns_instance_id)
instantiate_sol_network_instance(ns_instance_id, params::Dict{String,<:Any})
Instantiates a network instance. A network instance is a single network created in Amazon
Web Services TNB that can be deployed and on which life-cycle operations (like terminate,
update, and delete) can be performed. Before you can instantiate a network instance, you
have to create a network instance. For more information, see CreateSolNetworkInstance.
# Arguments
- `ns_instance_id`: ID of the network instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"additionalParamsForNs"`: Provides values for the configurable properties.
- `"dry_run"`: 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.
- `"tags"`: A tag is a label that you assign to an Amazon Web Services resource. Each tag
consists of a key and an optional value. When you use this API, the tags are transferred to
the network operation that is created. Use tags to search and filter your resources or
track your Amazon Web Services costs.
"""
function instantiate_sol_network_instance(
nsInstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return tnb(
"POST",
"/sol/nslcm/v1/ns_instances/$(nsInstanceId)/instantiate";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function instantiate_sol_network_instance(
nsInstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return tnb(
"POST",
"/sol/nslcm/v1/ns_instances/$(nsInstanceId)/instantiate",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_sol_function_instances()
list_sol_function_instances(params::Dict{String,<:Any})
Lists network function instances. A network function instance is a function in a function
package .
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max_results"`: The maximum number of results to include in the response.
- `"nextpage_opaque_marker"`: The token for the next page of results.
"""
function list_sol_function_instances(; aws_config::AbstractAWSConfig=global_aws_config())
return tnb(
"GET",
"/sol/vnflcm/v1/vnf_instances";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_sol_function_instances(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return tnb(
"GET",
"/sol/vnflcm/v1/vnf_instances",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_sol_function_packages()
list_sol_function_packages(params::Dict{String,<:Any})
Lists information about function packages. A function package is a .zip file in CSAR (Cloud
Service Archive) format that contains a network function (an ETSI standard
telecommunication application) and function package descriptor that uses the TOSCA standard
to describe how the network functions should run on your network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max_results"`: The maximum number of results to include in the response.
- `"nextpage_opaque_marker"`: The token for the next page of results.
"""
function list_sol_function_packages(; aws_config::AbstractAWSConfig=global_aws_config())
return tnb(
"GET",
"/sol/vnfpkgm/v1/vnf_packages";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_sol_function_packages(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return tnb(
"GET",
"/sol/vnfpkgm/v1/vnf_packages",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_sol_network_instances()
list_sol_network_instances(params::Dict{String,<:Any})
Lists your network instances. A network instance is a single network created in Amazon Web
Services TNB that can be deployed and on which life-cycle operations (like terminate,
update, and delete) can be performed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max_results"`: The maximum number of results to include in the response.
- `"nextpage_opaque_marker"`: The token for the next page of results.
"""
function list_sol_network_instances(; aws_config::AbstractAWSConfig=global_aws_config())
return tnb(
"GET",
"/sol/nslcm/v1/ns_instances";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_sol_network_instances(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return tnb(
"GET",
"/sol/nslcm/v1/ns_instances",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_sol_network_operations()
list_sol_network_operations(params::Dict{String,<:Any})
Lists details for a network operation, including when the operation started and the status
of the operation. A network operation is any operation that is done to your network, such
as network instance instantiation or termination.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max_results"`: The maximum number of results to include in the response.
- `"nextpage_opaque_marker"`: The token for the next page of results.
"""
function list_sol_network_operations(; aws_config::AbstractAWSConfig=global_aws_config())
return tnb(
"GET",
"/sol/nslcm/v1/ns_lcm_op_occs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_sol_network_operations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return tnb(
"GET",
"/sol/nslcm/v1/ns_lcm_op_occs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_sol_network_packages()
list_sol_network_packages(params::Dict{String,<:Any})
Lists network packages. A network package is a .zip file in CSAR (Cloud Service Archive)
format defines the function packages you want to deploy and the Amazon Web Services
infrastructure you want to deploy them on.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max_results"`: The maximum number of results to include in the response.
- `"nextpage_opaque_marker"`: The token for the next page of results.
"""
function list_sol_network_packages(; aws_config::AbstractAWSConfig=global_aws_config())
return tnb(
"GET",
"/sol/nsd/v1/ns_descriptors";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_sol_network_packages(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return tnb(
"GET",
"/sol/nsd/v1/ns_descriptors",
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 AWS TNB resources.
# Arguments
- `resource_arn`: Resource ARN.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return tnb(
"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 tnb(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_sol_function_package_content(file, vnf_pkg_id)
put_sol_function_package_content(file, vnf_pkg_id, params::Dict{String,<:Any})
Uploads the contents of a function package. A function package is a .zip file in CSAR
(Cloud Service Archive) format that contains a network function (an ETSI standard
telecommunication application) and function package descriptor that uses the TOSCA standard
to describe how the network functions should run on your network.
# Arguments
- `file`: Function package file.
- `vnf_pkg_id`: Function package ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Content-Type"`: Function package content type.
"""
function put_sol_function_package_content(
file, vnfPkgId; aws_config::AbstractAWSConfig=global_aws_config()
)
return tnb(
"PUT",
"/sol/vnfpkgm/v1/vnf_packages/$(vnfPkgId)/package_content",
Dict{String,Any}("file" => file);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_sol_function_package_content(
file,
vnfPkgId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return tnb(
"PUT",
"/sol/vnfpkgm/v1/vnf_packages/$(vnfPkgId)/package_content",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("file" => file), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_sol_network_package_content(file, nsd_info_id)
put_sol_network_package_content(file, nsd_info_id, params::Dict{String,<:Any})
Uploads the contents of a network package. A network package is a .zip file in CSAR (Cloud
Service Archive) format defines the function packages you want to deploy and the Amazon Web
Services infrastructure you want to deploy them on.
# Arguments
- `file`: Network package file.
- `nsd_info_id`: Network service descriptor info ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Content-Type"`: Network package content type.
"""
function put_sol_network_package_content(
file, nsdInfoId; aws_config::AbstractAWSConfig=global_aws_config()
)
return tnb(
"PUT",
"/sol/nsd/v1/ns_descriptors/$(nsdInfoId)/nsd_content",
Dict{String,Any}("file" => file);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_sol_network_package_content(
file,
nsdInfoId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return tnb(
"PUT",
"/sol/nsd/v1/ns_descriptors/$(nsdInfoId)/nsd_content",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("file" => file), 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 AWS TNB resource. A tag is a label that you assign to an Amazon Web Services
resource. Each tag consists of a key and an optional value. You can use tags to search and
filter your resources or track your Amazon Web Services costs.
# Arguments
- `resource_arn`: Resource ARN.
- `tags`: A tag is a label that you assign to an Amazon Web Services resource. Each tag
consists of a key and an optional value. You can use tags to search and filter your
resources or track your Amazon Web Services costs.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return tnb(
"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 tnb(
"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_sol_network_instance(ns_instance_id)
terminate_sol_network_instance(ns_instance_id, params::Dict{String,<:Any})
Terminates a network instance. A network instance is a single network created in Amazon Web
Services TNB that can be deployed and on which life-cycle operations (like terminate,
update, and delete) can be performed. You must terminate a network instance before you can
delete it.
# Arguments
- `ns_instance_id`: ID of the network instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: A tag is a label that you assign to an Amazon Web Services resource. Each tag
consists of a key and an optional value. When you use this API, the tags are transferred to
the network operation that is created. Use tags to search and filter your resources or
track your Amazon Web Services costs.
"""
function terminate_sol_network_instance(
nsInstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return tnb(
"POST",
"/sol/nslcm/v1/ns_instances/$(nsInstanceId)/terminate";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function terminate_sol_network_instance(
nsInstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return tnb(
"POST",
"/sol/nslcm/v1/ns_instances/$(nsInstanceId)/terminate",
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 an AWS TNB resource. A tag is a label that you assign to an Amazon Web Services
resource. Each tag consists of a key and an optional value. You can use tags to search and
filter your resources or track your Amazon Web Services costs.
# Arguments
- `resource_arn`: Resource ARN.
- `tag_keys`: Tag keys.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return tnb(
"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 tnb(
"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_sol_function_package(operational_state, vnf_pkg_id)
update_sol_function_package(operational_state, vnf_pkg_id, params::Dict{String,<:Any})
Updates the operational state of function package. A function package is a .zip file in
CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard
telecommunication application) and function package descriptor that uses the TOSCA standard
to describe how the network functions should run on your network.
# Arguments
- `operational_state`: Operational state of the function package.
- `vnf_pkg_id`: ID of the function package.
"""
function update_sol_function_package(
operationalState, vnfPkgId; aws_config::AbstractAWSConfig=global_aws_config()
)
return tnb(
"PATCH",
"/sol/vnfpkgm/v1/vnf_packages/$(vnfPkgId)",
Dict{String,Any}("operationalState" => operationalState);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_sol_function_package(
operationalState,
vnfPkgId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return tnb(
"PATCH",
"/sol/vnfpkgm/v1/vnf_packages/$(vnfPkgId)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("operationalState" => operationalState), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_sol_network_instance(ns_instance_id, update_type)
update_sol_network_instance(ns_instance_id, update_type, params::Dict{String,<:Any})
Update a network instance. A network instance is a single network created in Amazon Web
Services TNB that can be deployed and on which life-cycle operations (like terminate,
update, and delete) can be performed.
# Arguments
- `ns_instance_id`: ID of the network instance.
- `update_type`: The type of update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"modifyVnfInfoData"`: Identifies the network function information parameters and/or the
configurable properties of the network function to be modified.
- `"tags"`: A tag is a label that you assign to an Amazon Web Services resource. Each tag
consists of a key and an optional value. When you use this API, the tags are transferred to
the network operation that is created. Use tags to search and filter your resources or
track your Amazon Web Services costs.
"""
function update_sol_network_instance(
nsInstanceId, updateType; aws_config::AbstractAWSConfig=global_aws_config()
)
return tnb(
"POST",
"/sol/nslcm/v1/ns_instances/$(nsInstanceId)/update",
Dict{String,Any}("updateType" => updateType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_sol_network_instance(
nsInstanceId,
updateType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return tnb(
"POST",
"/sol/nslcm/v1/ns_instances/$(nsInstanceId)/update",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("updateType" => updateType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_sol_network_package(nsd_info_id, nsd_operational_state)
update_sol_network_package(nsd_info_id, nsd_operational_state, params::Dict{String,<:Any})
Updates the operational state of a network package. A network package is a .zip file in
CSAR (Cloud Service Archive) format defines the function packages you want to deploy and
the Amazon Web Services infrastructure you want to deploy them on. A network service
descriptor is a .yaml file in a network package that uses the TOSCA standard to describe
the network functions you want to deploy and the Amazon Web Services infrastructure you
want to deploy the network functions on.
# Arguments
- `nsd_info_id`: ID of the network service descriptor in the network package.
- `nsd_operational_state`: Operational state of the network service descriptor in the
network package.
"""
function update_sol_network_package(
nsdInfoId, nsdOperationalState; aws_config::AbstractAWSConfig=global_aws_config()
)
return tnb(
"PATCH",
"/sol/nsd/v1/ns_descriptors/$(nsdInfoId)",
Dict{String,Any}("nsdOperationalState" => nsdOperationalState);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_sol_network_package(
nsdInfoId,
nsdOperationalState,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return tnb(
"PATCH",
"/sol/nsd/v1/ns_descriptors/$(nsdInfoId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("nsdOperationalState" => nsdOperationalState),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
validate_sol_function_package_content(file, vnf_pkg_id)
validate_sol_function_package_content(file, vnf_pkg_id, params::Dict{String,<:Any})
Validates function package content. This can be used as a dry run before uploading function
package content with PutSolFunctionPackageContent. A function package is a .zip file in
CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard
telecommunication application) and function package descriptor that uses the TOSCA standard
to describe how the network functions should run on your network.
# Arguments
- `file`: Function package file.
- `vnf_pkg_id`: Function package ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Content-Type"`: Function package content type.
"""
function validate_sol_function_package_content(
file, vnfPkgId; aws_config::AbstractAWSConfig=global_aws_config()
)
return tnb(
"PUT",
"/sol/vnfpkgm/v1/vnf_packages/$(vnfPkgId)/package_content/validate",
Dict{String,Any}("file" => file);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function validate_sol_function_package_content(
file,
vnfPkgId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return tnb(
"PUT",
"/sol/vnfpkgm/v1/vnf_packages/$(vnfPkgId)/package_content/validate",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("file" => file), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
validate_sol_network_package_content(file, nsd_info_id)
validate_sol_network_package_content(file, nsd_info_id, params::Dict{String,<:Any})
Validates network package content. This can be used as a dry run before uploading network
package content with PutSolNetworkPackageContent. A network package is a .zip file in CSAR
(Cloud Service Archive) format defines the function packages you want to deploy and the
Amazon Web Services infrastructure you want to deploy them on.
# Arguments
- `file`: Network package file.
- `nsd_info_id`: Network service descriptor file.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Content-Type"`: Network package content type.
"""
function validate_sol_network_package_content(
file, nsdInfoId; aws_config::AbstractAWSConfig=global_aws_config()
)
return tnb(
"PUT",
"/sol/nsd/v1/ns_descriptors/$(nsdInfoId)/nsd_content/validate",
Dict{String,Any}("file" => file);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function validate_sol_network_package_content(
file,
nsdInfoId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return tnb(
"PUT",
"/sol/nsd/v1/ns_descriptors/$(nsdInfoId)/nsd_content/validate",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("file" => file), 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 | 116392 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: transcribe
using AWS.Compat
using AWS.UUIDs
"""
create_call_analytics_category(category_name, rules)
create_call_analytics_category(category_name, rules, params::Dict{String,<:Any})
Creates a new Call Analytics category. All categories are automatically applied to your
Call Analytics transcriptions. Note that in order to apply categories to your
transcriptions, you must create them before submitting your transcription request, as
categories cannot be applied retroactively. When creating a new category, you can use the
InputType parameter to label the category as a POST_CALL or a REAL_TIME category. POST_CALL
categories can only be applied to post-call transcriptions and REAL_TIME categories can
only be applied to real-time transcriptions. If you do not include InputType, your category
is created as a POST_CALL category by default. Call Analytics categories are composed of
rules. For each category, you must create between 1 and 20 rules. Rules can include these
parameters: , , , and . To update an existing category, see . To learn more about Call
Analytics categories, see Creating categories for post-call transcriptions and Creating
categories for real-time transcriptions.
# Arguments
- `category_name`: A unique name, chosen by you, for your Call Analytics category. It's
helpful to use a detailed naming system that will make sense to you in the future. For
example, it's better to use sentiment-positive-last30seconds for a category over a generic
name like test-category. Category names are case sensitive.
- `rules`: Rules define a Call Analytics category. When creating a new category, you must
create between 1 and 20 rules for that category. For each rule, you specify a filter you
want applied to the attributes of a call. For example, you can choose a sentiment filter
that detects if a customer's sentiment was positive during the last 30 seconds of the call.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InputType"`: Choose whether you want to create a real-time or a post-call category for
your Call Analytics transcription. Specifying POST_CALL assigns your category to post-call
transcriptions; categories with this input type cannot be applied to streaming (real-time)
transcriptions. Specifying REAL_TIME assigns your category to streaming transcriptions;
categories with this input type cannot be applied to post-call transcriptions. If you do
not include InputType, your category is created as a post-call category by default.
"""
function create_call_analytics_category(
CategoryName, Rules; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"CreateCallAnalyticsCategory",
Dict{String,Any}("CategoryName" => CategoryName, "Rules" => Rules);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_call_analytics_category(
CategoryName,
Rules,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"CreateCallAnalyticsCategory",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CategoryName" => CategoryName, "Rules" => Rules),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_language_model(base_model_name, input_data_config, language_code, model_name)
create_language_model(base_model_name, input_data_config, language_code, model_name, params::Dict{String,<:Any})
Creates a new custom language model. When creating a new custom language model, you must
specify: If you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband (audio
sample rates under 16,000 Hz) base model The location of your training and tuning files
(this must be an Amazon S3 URI) The language of your model A unique name for your model
# Arguments
- `base_model_name`: The Amazon Transcribe standard language model, or base model, used to
create your custom language model. Amazon Transcribe offers two options for base models:
Wideband and Narrowband. If the audio you want to transcribe has a sample rate of 16,000 Hz
or greater, choose WideBand. To transcribe audio with a sample rate less than 16,000 Hz,
choose NarrowBand.
- `input_data_config`: Contains the Amazon S3 location of the training data you want to use
to create a new custom language model, and permissions to access this location. When using
InputDataConfig, you must include these sub-parameters: S3Uri, which is the Amazon S3
location of your training data, and DataAccessRoleArn, which is the Amazon Resource Name
(ARN) of the role that has permission to access your specified Amazon S3 location. You can
optionally include TuningDataS3Uri, which is the Amazon S3 location of your tuning data. If
you specify different Amazon S3 locations for training and tuning data, the ARN you use
must have permissions to access both locations.
- `language_code`: The language code that represents the language of your model. Each
custom language model must contain terms in only one language, and the language you select
for your custom language model must match the language of your training and tuning data.
For a list of supported languages and their associated language codes, refer to the
Supported languages table. Note that US English (en-US) is the only language supported with
Amazon Transcribe Medical. A custom language model can only be used to transcribe files in
the same language as the model. For example, if you create a custom language model using US
English (en-US), you can only apply this model to files that contain English audio.
- `model_name`: A unique name, chosen by you, for your custom language model. This name is
case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services
account. If you try to create a new custom language model with the same name as an existing
custom language model, you get a ConflictException error.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: Adds one or more custom tags, each in the form of a key:value pair, to a new
custom language model at the time you create this new model. To learn more about using tags
with Amazon Transcribe, refer to Tagging resources.
"""
function create_language_model(
BaseModelName,
InputDataConfig,
LanguageCode,
ModelName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"CreateLanguageModel",
Dict{String,Any}(
"BaseModelName" => BaseModelName,
"InputDataConfig" => InputDataConfig,
"LanguageCode" => LanguageCode,
"ModelName" => ModelName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_language_model(
BaseModelName,
InputDataConfig,
LanguageCode,
ModelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"CreateLanguageModel",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"BaseModelName" => BaseModelName,
"InputDataConfig" => InputDataConfig,
"LanguageCode" => LanguageCode,
"ModelName" => ModelName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_medical_vocabulary(language_code, vocabulary_file_uri, vocabulary_name)
create_medical_vocabulary(language_code, vocabulary_file_uri, vocabulary_name, params::Dict{String,<:Any})
Creates a new custom medical vocabulary. Before creating a new custom medical vocabulary,
you must first upload a text file that contains your vocabulary table into an Amazon S3
bucket. Note that this differs from , where you can include a list of terms within your
request using the Phrases flag; CreateMedicalVocabulary does not support the Phrases flag
and only accepts vocabularies in table format. Each language has a character set that
contains all allowed characters for that specific language. If you use unsupported
characters, your custom vocabulary request fails. Refer to Character Sets for Custom
Vocabularies to get the character set for your language. For more information, see Custom
vocabularies.
# Arguments
- `language_code`: The language code that represents the language of the entries in your
custom vocabulary. US English (en-US) is the only language supported with Amazon Transcribe
Medical.
- `vocabulary_file_uri`: The Amazon S3 location (URI) of the text file that contains your
custom medical vocabulary. The URI must be in the same Amazon Web Services Region as the
resource you're calling. Here's an example URI path:
s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt
- `vocabulary_name`: A unique name, chosen by you, for your new custom medical vocabulary.
This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web
Services account. If you try to create a new custom medical vocabulary with the same name
as an existing custom medical vocabulary, you get a ConflictException error.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: Adds one or more custom tags, each in the form of a key:value pair, to a new
custom medical vocabulary at the time you create this new custom vocabulary. To learn more
about using tags with Amazon Transcribe, refer to Tagging resources.
"""
function create_medical_vocabulary(
LanguageCode,
VocabularyFileUri,
VocabularyName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"CreateMedicalVocabulary",
Dict{String,Any}(
"LanguageCode" => LanguageCode,
"VocabularyFileUri" => VocabularyFileUri,
"VocabularyName" => VocabularyName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_medical_vocabulary(
LanguageCode,
VocabularyFileUri,
VocabularyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"CreateMedicalVocabulary",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LanguageCode" => LanguageCode,
"VocabularyFileUri" => VocabularyFileUri,
"VocabularyName" => VocabularyName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_vocabulary(language_code, vocabulary_name)
create_vocabulary(language_code, vocabulary_name, params::Dict{String,<:Any})
Creates a new custom vocabulary. When creating a new custom vocabulary, you can either
upload a text file that contains your new entries, phrases, and terms into an Amazon S3
bucket and include the URI in your request. Or you can include a list of terms directly in
your request using the Phrases flag. Each language has a character set that contains all
allowed characters for that specific language. If you use unsupported characters, your
custom vocabulary request fails. Refer to Character Sets for Custom Vocabularies to get the
character set for your language. For more information, see Custom vocabularies.
# Arguments
- `language_code`: The language code that represents the language of the entries in your
custom vocabulary. Each custom vocabulary must contain terms in only one language. A custom
vocabulary can only be used to transcribe files in the same language as the custom
vocabulary. For example, if you create a custom vocabulary using US English (en-US), you
can only apply this custom vocabulary to files that contain English audio. For a list of
supported languages and their associated language codes, refer to the Supported languages
table.
- `vocabulary_name`: A unique name, chosen by you, for your new custom vocabulary. This
name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web
Services account. If you try to create a new custom vocabulary with the same name as an
existing custom vocabulary, you get a ConflictException error.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataAccessRoleArn"`: The Amazon Resource Name (ARN) of an IAM role that has permissions
to access the Amazon S3 bucket that contains your input files (in this case, your custom
vocabulary). If the role that you specify doesn’t have the appropriate permissions to
access the specified Amazon S3 location, your request fails. IAM role ARNs have the format
arn:partition:iam::account:role/role-name-with-path. For example:
arn:aws:iam::111122223333:role/Admin. For more information, see IAM ARNs.
- `"Phrases"`: Use this parameter if you want to create your custom vocabulary by including
all desired terms, as comma-separated values, within your request. The other option for
creating your custom vocabulary is to save your entries in a text file and upload them to
an Amazon S3 bucket, then specify the location of your file using the VocabularyFileUri
parameter. Note that if you include Phrases in your request, you cannot use
VocabularyFileUri; you must choose one or the other. Each language has a character set that
contains all allowed characters for that specific language. If you use unsupported
characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom
Vocabularies to get the character set for your language.
- `"Tags"`: Adds one or more custom tags, each in the form of a key:value pair, to a new
custom vocabulary at the time you create this new custom vocabulary. To learn more about
using tags with Amazon Transcribe, refer to Tagging resources.
- `"VocabularyFileUri"`: The Amazon S3 location of the text file that contains your custom
vocabulary. The URI must be located in the same Amazon Web Services Region as the resource
you're calling. Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt Note
that if you include VocabularyFileUri in your request, you cannot use the Phrases flag; you
must choose one or the other.
"""
function create_vocabulary(
LanguageCode, VocabularyName; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"CreateVocabulary",
Dict{String,Any}(
"LanguageCode" => LanguageCode, "VocabularyName" => VocabularyName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_vocabulary(
LanguageCode,
VocabularyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"CreateVocabulary",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LanguageCode" => LanguageCode, "VocabularyName" => VocabularyName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_vocabulary_filter(language_code, vocabulary_filter_name)
create_vocabulary_filter(language_code, vocabulary_filter_name, params::Dict{String,<:Any})
Creates a new custom vocabulary filter. You can use custom vocabulary filters to mask,
delete, or flag specific words from your transcript. Custom vocabulary filters are commonly
used to mask profanity in transcripts. Each language has a character set that contains all
allowed characters for that specific language. If you use unsupported characters, your
custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to
get the character set for your language. For more information, see Vocabulary filtering.
# Arguments
- `language_code`: The language code that represents the language of the entries in your
vocabulary filter. Each custom vocabulary filter must contain terms in only one language. A
custom vocabulary filter can only be used to transcribe files in the same language as the
filter. For example, if you create a custom vocabulary filter using US English (en-US), you
can only apply this filter to files that contain English audio. For a list of supported
languages and their associated language codes, refer to the Supported languages table.
- `vocabulary_filter_name`: A unique name, chosen by you, for your new custom vocabulary
filter. This name is case sensitive, cannot contain spaces, and must be unique within an
Amazon Web Services account. If you try to create a new custom vocabulary filter with the
same name as an existing custom vocabulary filter, you get a ConflictException error.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataAccessRoleArn"`: The Amazon Resource Name (ARN) of an IAM role that has permissions
to access the Amazon S3 bucket that contains your input files (in this case, your custom
vocabulary filter). If the role that you specify doesn’t have the appropriate permissions
to access the specified Amazon S3 location, your request fails. IAM role ARNs have the
format arn:partition:iam::account:role/role-name-with-path. For example:
arn:aws:iam::111122223333:role/Admin. For more information, see IAM ARNs.
- `"Tags"`: Adds one or more custom tags, each in the form of a key:value pair, to a new
custom vocabulary filter at the time you create this new vocabulary filter. To learn more
about using tags with Amazon Transcribe, refer to Tagging resources.
- `"VocabularyFilterFileUri"`: The Amazon S3 location of the text file that contains your
custom vocabulary filter terms. The URI must be located in the same Amazon Web Services
Region as the resource you're calling. Here's an example URI path:
s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt Note that if you include
VocabularyFilterFileUri in your request, you cannot use Words; you must choose one or the
other.
- `"Words"`: Use this parameter if you want to create your custom vocabulary filter by
including all desired terms, as comma-separated values, within your request. The other
option for creating your vocabulary filter is to save your entries in a text file and
upload them to an Amazon S3 bucket, then specify the location of your file using the
VocabularyFilterFileUri parameter. Note that if you include Words in your request, you
cannot use VocabularyFilterFileUri; you must choose one or the other. Each language has a
character set that contains all allowed characters for that specific language. If you use
unsupported characters, your custom vocabulary filter request fails. Refer to Character
Sets for Custom Vocabularies to get the character set for your language.
"""
function create_vocabulary_filter(
LanguageCode, VocabularyFilterName; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"CreateVocabularyFilter",
Dict{String,Any}(
"LanguageCode" => LanguageCode, "VocabularyFilterName" => VocabularyFilterName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_vocabulary_filter(
LanguageCode,
VocabularyFilterName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"CreateVocabularyFilter",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LanguageCode" => LanguageCode,
"VocabularyFilterName" => VocabularyFilterName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_call_analytics_category(category_name)
delete_call_analytics_category(category_name, params::Dict{String,<:Any})
Deletes a Call Analytics category. To use this operation, specify the name of the category
you want to delete using CategoryName. Category names are case sensitive.
# Arguments
- `category_name`: The name of the Call Analytics category you want to delete. Category
names are case sensitive.
"""
function delete_call_analytics_category(
CategoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"DeleteCallAnalyticsCategory",
Dict{String,Any}("CategoryName" => CategoryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_call_analytics_category(
CategoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"DeleteCallAnalyticsCategory",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("CategoryName" => CategoryName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_call_analytics_job(call_analytics_job_name)
delete_call_analytics_job(call_analytics_job_name, params::Dict{String,<:Any})
Deletes a Call Analytics job. To use this operation, specify the name of the job you want
to delete using CallAnalyticsJobName. Job names are case sensitive.
# Arguments
- `call_analytics_job_name`: The name of the Call Analytics job you want to delete. Job
names are case sensitive.
"""
function delete_call_analytics_job(
CallAnalyticsJobName; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"DeleteCallAnalyticsJob",
Dict{String,Any}("CallAnalyticsJobName" => CallAnalyticsJobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_call_analytics_job(
CallAnalyticsJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"DeleteCallAnalyticsJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CallAnalyticsJobName" => CallAnalyticsJobName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_language_model(model_name)
delete_language_model(model_name, params::Dict{String,<:Any})
Deletes a custom language model. To use this operation, specify the name of the language
model you want to delete using ModelName. custom language model names are case sensitive.
# Arguments
- `model_name`: The name of the custom language model you want to delete. Model names are
case sensitive.
"""
function delete_language_model(ModelName; aws_config::AbstractAWSConfig=global_aws_config())
return transcribe(
"DeleteLanguageModel",
Dict{String,Any}("ModelName" => ModelName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_language_model(
ModelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"DeleteLanguageModel",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ModelName" => ModelName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_medical_scribe_job(medical_scribe_job_name)
delete_medical_scribe_job(medical_scribe_job_name, params::Dict{String,<:Any})
Deletes a Medical Scribe job. To use this operation, specify the name of the job you want
to delete using MedicalScribeJobName. Job names are case sensitive.
# Arguments
- `medical_scribe_job_name`: The name of the Medical Scribe job you want to delete. Job
names are case sensitive.
"""
function delete_medical_scribe_job(
MedicalScribeJobName; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"DeleteMedicalScribeJob",
Dict{String,Any}("MedicalScribeJobName" => MedicalScribeJobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_medical_scribe_job(
MedicalScribeJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"DeleteMedicalScribeJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("MedicalScribeJobName" => MedicalScribeJobName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_medical_transcription_job(medical_transcription_job_name)
delete_medical_transcription_job(medical_transcription_job_name, params::Dict{String,<:Any})
Deletes a medical transcription job. To use this operation, specify the name of the job you
want to delete using MedicalTranscriptionJobName. Job names are case sensitive.
# Arguments
- `medical_transcription_job_name`: The name of the medical transcription job you want to
delete. Job names are case sensitive.
"""
function delete_medical_transcription_job(
MedicalTranscriptionJobName; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"DeleteMedicalTranscriptionJob",
Dict{String,Any}("MedicalTranscriptionJobName" => MedicalTranscriptionJobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_medical_transcription_job(
MedicalTranscriptionJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"DeleteMedicalTranscriptionJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MedicalTranscriptionJobName" => MedicalTranscriptionJobName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_medical_vocabulary(vocabulary_name)
delete_medical_vocabulary(vocabulary_name, params::Dict{String,<:Any})
Deletes a custom medical vocabulary. To use this operation, specify the name of the custom
vocabulary you want to delete using VocabularyName. Custom vocabulary names are case
sensitive.
# Arguments
- `vocabulary_name`: The name of the custom medical vocabulary you want to delete. Custom
medical vocabulary names are case sensitive.
"""
function delete_medical_vocabulary(
VocabularyName; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"DeleteMedicalVocabulary",
Dict{String,Any}("VocabularyName" => VocabularyName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_medical_vocabulary(
VocabularyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"DeleteMedicalVocabulary",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("VocabularyName" => VocabularyName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_transcription_job(transcription_job_name)
delete_transcription_job(transcription_job_name, params::Dict{String,<:Any})
Deletes a transcription job. To use this operation, specify the name of the job you want to
delete using TranscriptionJobName. Job names are case sensitive.
# Arguments
- `transcription_job_name`: The name of the transcription job you want to delete. Job names
are case sensitive.
"""
function delete_transcription_job(
TranscriptionJobName; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"DeleteTranscriptionJob",
Dict{String,Any}("TranscriptionJobName" => TranscriptionJobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_transcription_job(
TranscriptionJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"DeleteTranscriptionJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("TranscriptionJobName" => TranscriptionJobName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_vocabulary(vocabulary_name)
delete_vocabulary(vocabulary_name, params::Dict{String,<:Any})
Deletes a custom vocabulary. To use this operation, specify the name of the custom
vocabulary you want to delete using VocabularyName. Custom vocabulary names are case
sensitive.
# Arguments
- `vocabulary_name`: The name of the custom vocabulary you want to delete. Custom
vocabulary names are case sensitive.
"""
function delete_vocabulary(
VocabularyName; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"DeleteVocabulary",
Dict{String,Any}("VocabularyName" => VocabularyName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_vocabulary(
VocabularyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"DeleteVocabulary",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("VocabularyName" => VocabularyName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_vocabulary_filter(vocabulary_filter_name)
delete_vocabulary_filter(vocabulary_filter_name, params::Dict{String,<:Any})
Deletes a custom vocabulary filter. To use this operation, specify the name of the custom
vocabulary filter you want to delete using VocabularyFilterName. Custom vocabulary filter
names are case sensitive.
# Arguments
- `vocabulary_filter_name`: The name of the custom vocabulary filter you want to delete.
Custom vocabulary filter names are case sensitive.
"""
function delete_vocabulary_filter(
VocabularyFilterName; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"DeleteVocabularyFilter",
Dict{String,Any}("VocabularyFilterName" => VocabularyFilterName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_vocabulary_filter(
VocabularyFilterName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"DeleteVocabularyFilter",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("VocabularyFilterName" => VocabularyFilterName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_language_model(model_name)
describe_language_model(model_name, params::Dict{String,<:Any})
Provides information about the specified custom language model. This operation also shows
if the base language model that you used to create your custom language model has been
updated. If Amazon Transcribe has updated the base model, you can create a new custom
language model using the updated base model. If you tried to create a new custom language
model and the request wasn't successful, you can use DescribeLanguageModel to help identify
the reason for this failure.
# Arguments
- `model_name`: The name of the custom language model you want information about. Model
names are case sensitive.
"""
function describe_language_model(
ModelName; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"DescribeLanguageModel",
Dict{String,Any}("ModelName" => ModelName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_language_model(
ModelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"DescribeLanguageModel",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ModelName" => ModelName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_call_analytics_category(category_name)
get_call_analytics_category(category_name, params::Dict{String,<:Any})
Provides information about the specified Call Analytics category. To get a list of your
Call Analytics categories, use the operation.
# Arguments
- `category_name`: The name of the Call Analytics category you want information about.
Category names are case sensitive.
"""
function get_call_analytics_category(
CategoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"GetCallAnalyticsCategory",
Dict{String,Any}("CategoryName" => CategoryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_call_analytics_category(
CategoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"GetCallAnalyticsCategory",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("CategoryName" => CategoryName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_call_analytics_job(call_analytics_job_name)
get_call_analytics_job(call_analytics_job_name, params::Dict{String,<:Any})
Provides information about the specified Call Analytics job. To view the job's status,
refer to CallAnalyticsJobStatus. If the status is COMPLETED, the job is finished. You can
find your completed transcript at the URI specified in TranscriptFileUri. If the status is
FAILED, FailureReason provides details on why your transcription job failed. If you enabled
personally identifiable information (PII) redaction, the redacted transcript appears at the
location specified in RedactedTranscriptFileUri. If you chose to redact the audio in your
media file, you can find your redacted media file at the location specified in
RedactedMediaFileUri. To get a list of your Call Analytics jobs, use the operation.
# Arguments
- `call_analytics_job_name`: The name of the Call Analytics job you want information about.
Job names are case sensitive.
"""
function get_call_analytics_job(
CallAnalyticsJobName; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"GetCallAnalyticsJob",
Dict{String,Any}("CallAnalyticsJobName" => CallAnalyticsJobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_call_analytics_job(
CallAnalyticsJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"GetCallAnalyticsJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CallAnalyticsJobName" => CallAnalyticsJobName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_medical_scribe_job(medical_scribe_job_name)
get_medical_scribe_job(medical_scribe_job_name, params::Dict{String,<:Any})
Provides information about the specified Medical Scribe job. To view the status of the
specified medical transcription job, check the MedicalScribeJobStatus field. If the status
is COMPLETED, the job is finished. You can find the results at the location specified in
MedicalScribeOutput. If the status is FAILED, FailureReason provides details on why your
Medical Scribe job failed. To get a list of your Medical Scribe jobs, use the operation.
# Arguments
- `medical_scribe_job_name`: The name of the Medical Scribe job you want information about.
Job names are case sensitive.
"""
function get_medical_scribe_job(
MedicalScribeJobName; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"GetMedicalScribeJob",
Dict{String,Any}("MedicalScribeJobName" => MedicalScribeJobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_medical_scribe_job(
MedicalScribeJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"GetMedicalScribeJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("MedicalScribeJobName" => MedicalScribeJobName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_medical_transcription_job(medical_transcription_job_name)
get_medical_transcription_job(medical_transcription_job_name, params::Dict{String,<:Any})
Provides information about the specified medical transcription job. To view the status of
the specified medical transcription job, check the TranscriptionJobStatus field. If the
status is COMPLETED, the job is finished. You can find the results at the location
specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on
why your transcription job failed. To get a list of your medical transcription jobs, use
the operation.
# Arguments
- `medical_transcription_job_name`: The name of the medical transcription job you want
information about. Job names are case sensitive.
"""
function get_medical_transcription_job(
MedicalTranscriptionJobName; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"GetMedicalTranscriptionJob",
Dict{String,Any}("MedicalTranscriptionJobName" => MedicalTranscriptionJobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_medical_transcription_job(
MedicalTranscriptionJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"GetMedicalTranscriptionJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MedicalTranscriptionJobName" => MedicalTranscriptionJobName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_medical_vocabulary(vocabulary_name)
get_medical_vocabulary(vocabulary_name, params::Dict{String,<:Any})
Provides information about the specified custom medical vocabulary. To view the status of
the specified custom medical vocabulary, check the VocabularyState field. If the status is
READY, your custom vocabulary is available to use. If the status is FAILED, FailureReason
provides details on why your vocabulary failed. To get a list of your custom medical
vocabularies, use the operation.
# Arguments
- `vocabulary_name`: The name of the custom medical vocabulary you want information about.
Custom medical vocabulary names are case sensitive.
"""
function get_medical_vocabulary(
VocabularyName; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"GetMedicalVocabulary",
Dict{String,Any}("VocabularyName" => VocabularyName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_medical_vocabulary(
VocabularyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"GetMedicalVocabulary",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("VocabularyName" => VocabularyName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_transcription_job(transcription_job_name)
get_transcription_job(transcription_job_name, params::Dict{String,<:Any})
Provides information about the specified transcription job. To view the status of the
specified transcription job, check the TranscriptionJobStatus field. If the status is
COMPLETED, the job is finished. You can find the results at the location specified in
TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your
transcription job failed. If you enabled content redaction, the redacted transcript can be
found at the location specified in RedactedTranscriptFileUri. To get a list of your
transcription jobs, use the operation.
# Arguments
- `transcription_job_name`: The name of the transcription job you want information about.
Job names are case sensitive.
"""
function get_transcription_job(
TranscriptionJobName; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"GetTranscriptionJob",
Dict{String,Any}("TranscriptionJobName" => TranscriptionJobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_transcription_job(
TranscriptionJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"GetTranscriptionJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("TranscriptionJobName" => TranscriptionJobName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_vocabulary(vocabulary_name)
get_vocabulary(vocabulary_name, params::Dict{String,<:Any})
Provides information about the specified custom vocabulary. To view the status of the
specified custom vocabulary, check the VocabularyState field. If the status is READY, your
custom vocabulary is available to use. If the status is FAILED, FailureReason provides
details on why your custom vocabulary failed. To get a list of your custom vocabularies,
use the operation.
# Arguments
- `vocabulary_name`: The name of the custom vocabulary you want information about. Custom
vocabulary names are case sensitive.
"""
function get_vocabulary(VocabularyName; aws_config::AbstractAWSConfig=global_aws_config())
return transcribe(
"GetVocabulary",
Dict{String,Any}("VocabularyName" => VocabularyName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_vocabulary(
VocabularyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"GetVocabulary",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("VocabularyName" => VocabularyName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_vocabulary_filter(vocabulary_filter_name)
get_vocabulary_filter(vocabulary_filter_name, params::Dict{String,<:Any})
Provides information about the specified custom vocabulary filter. To get a list of your
custom vocabulary filters, use the operation.
# Arguments
- `vocabulary_filter_name`: The name of the custom vocabulary filter you want information
about. Custom vocabulary filter names are case sensitive.
"""
function get_vocabulary_filter(
VocabularyFilterName; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"GetVocabularyFilter",
Dict{String,Any}("VocabularyFilterName" => VocabularyFilterName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_vocabulary_filter(
VocabularyFilterName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"GetVocabularyFilter",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("VocabularyFilterName" => VocabularyFilterName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_call_analytics_categories()
list_call_analytics_categories(params::Dict{String,<:Any})
Provides a list of Call Analytics categories, including all rules that make up each
category. To get detailed information about a specific Call Analytics category, use the
operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of Call Analytics categories to return in each page of
results. If there are fewer results than the value that you specify, only the actual
results are returned. If you do not specify a value, a default of 5 is used.
- `"NextToken"`: If your ListCallAnalyticsCategories request returns more results than can
be displayed, NextToken is displayed in the response with an associated string. To get the
next page of results, copy this string and repeat your request, including NextToken with
the value of the copied string. Repeat as needed to view all your results.
"""
function list_call_analytics_categories(; aws_config::AbstractAWSConfig=global_aws_config())
return transcribe(
"ListCallAnalyticsCategories";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_call_analytics_categories(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"ListCallAnalyticsCategories",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_call_analytics_jobs()
list_call_analytics_jobs(params::Dict{String,<:Any})
Provides a list of Call Analytics jobs that match the specified criteria. If no criteria
are specified, all Call Analytics jobs are returned. To get detailed information about a
specific Call Analytics job, use the operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"JobNameContains"`: Returns only the Call Analytics jobs that contain the specified
string. The search is not case sensitive.
- `"MaxResults"`: The maximum number of Call Analytics jobs to return in each page of
results. If there are fewer results than the value that you specify, only the actual
results are returned. If you do not specify a value, a default of 5 is used.
- `"NextToken"`: If your ListCallAnalyticsJobs request returns more results than can be
displayed, NextToken is displayed in the response with an associated string. To get the
next page of results, copy this string and repeat your request, including NextToken with
the value of the copied string. Repeat as needed to view all your results.
- `"Status"`: Returns only Call Analytics jobs with the specified status. Jobs are ordered
by creation date, with the newest job first. If you do not include Status, all Call
Analytics jobs are returned.
"""
function list_call_analytics_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return transcribe(
"ListCallAnalyticsJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_call_analytics_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"ListCallAnalyticsJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_language_models()
list_language_models(params::Dict{String,<:Any})
Provides a list of custom language models that match the specified criteria. If no criteria
are specified, all custom language models are returned. To get detailed information about a
specific custom language model, use the operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of custom language models to return in each page of
results. If there are fewer results than the value that you specify, only the actual
results are returned. If you do not specify a value, a default of 5 is used.
- `"NameContains"`: Returns only the custom language models that contain the specified
string. The search is not case sensitive.
- `"NextToken"`: If your ListLanguageModels request returns more results than can be
displayed, NextToken is displayed in the response with an associated string. To get the
next page of results, copy this string and repeat your request, including NextToken with
the value of the copied string. Repeat as needed to view all your results.
- `"StatusEquals"`: Returns only custom language models with the specified status. Language
models are ordered by creation date, with the newest model first. If you do not include
StatusEquals, all custom language models are returned.
"""
function list_language_models(; aws_config::AbstractAWSConfig=global_aws_config())
return transcribe(
"ListLanguageModels"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_language_models(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"ListLanguageModels", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_medical_scribe_jobs()
list_medical_scribe_jobs(params::Dict{String,<:Any})
Provides a list of Medical Scribe jobs that match the specified criteria. If no criteria
are specified, all Medical Scribe jobs are returned. To get detailed information about a
specific Medical Scribe job, use the operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"JobNameContains"`: Returns only the Medical Scribe jobs that contain the specified
string. The search is not case sensitive.
- `"MaxResults"`: The maximum number of Medical Scribe jobs to return in each page of
results. If there are fewer results than the value that you specify, only the actual
results are returned. If you do not specify a value, a default of 5 is used.
- `"NextToken"`: If your ListMedicalScribeJobs request returns more results than can be
displayed, NextToken is displayed in the response with an associated string. To get the
next page of results, copy this string and repeat your request, including NextToken with
the value of the copied string. Repeat as needed to view all your results.
- `"Status"`: Returns only Medical Scribe jobs with the specified status. Jobs are ordered
by creation date, with the newest job first. If you do not include Status, all Medical
Scribe jobs are returned.
"""
function list_medical_scribe_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return transcribe(
"ListMedicalScribeJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_medical_scribe_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"ListMedicalScribeJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_medical_transcription_jobs()
list_medical_transcription_jobs(params::Dict{String,<:Any})
Provides a list of medical transcription jobs that match the specified criteria. If no
criteria are specified, all medical transcription jobs are returned. To get detailed
information about a specific medical transcription job, use the operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"JobNameContains"`: Returns only the medical transcription jobs that contain the
specified string. The search is not case sensitive.
- `"MaxResults"`: The maximum number of medical transcription jobs to return in each page
of results. If there are fewer results than the value that you specify, only the actual
results are returned. If you do not specify a value, a default of 5 is used.
- `"NextToken"`: If your ListMedicalTranscriptionJobs request returns more results than can
be displayed, NextToken is displayed in the response with an associated string. To get the
next page of results, copy this string and repeat your request, including NextToken with
the value of the copied string. Repeat as needed to view all your results.
- `"Status"`: Returns only medical transcription jobs with the specified status. Jobs are
ordered by creation date, with the newest job first. If you do not include Status, all
medical transcription jobs are returned.
"""
function list_medical_transcription_jobs(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"ListMedicalTranscriptionJobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_medical_transcription_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"ListMedicalTranscriptionJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_medical_vocabularies()
list_medical_vocabularies(params::Dict{String,<:Any})
Provides a list of custom medical vocabularies that match the specified criteria. If no
criteria are specified, all custom medical vocabularies are returned. To get detailed
information about a specific custom medical vocabulary, use the operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of custom medical vocabularies to return in each page
of results. If there are fewer results than the value that you specify, only the actual
results are returned. If you do not specify a value, a default of 5 is used.
- `"NameContains"`: Returns only the custom medical vocabularies that contain the specified
string. The search is not case sensitive.
- `"NextToken"`: If your ListMedicalVocabularies request returns more results than can be
displayed, NextToken is displayed in the response with an associated string. To get the
next page of results, copy this string and repeat your request, including NextToken with
the value of the copied string. Repeat as needed to view all your results.
- `"StateEquals"`: Returns only custom medical vocabularies with the specified state.
Custom vocabularies are ordered by creation date, with the newest vocabulary first. If you
do not include StateEquals, all custom medical vocabularies are returned.
"""
function list_medical_vocabularies(; aws_config::AbstractAWSConfig=global_aws_config())
return transcribe(
"ListMedicalVocabularies"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_medical_vocabularies(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"ListMedicalVocabularies",
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 specified transcription job, vocabulary, model, or
resource. To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
# Arguments
- `resource_arn`: Returns a list of all tags associated with the specified Amazon Resource
Name (ARN). ARNs have the format
arn:partition:service:region:account-id:resource-type/resource-id. For example,
arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name. Valid
values for resource-type are: transcription-job, medical-transcription-job, vocabulary,
medical-vocabulary, vocabulary-filter, and language-model.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"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 transcribe(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_transcription_jobs()
list_transcription_jobs(params::Dict{String,<:Any})
Provides a list of transcription jobs that match the specified criteria. If no criteria are
specified, all transcription jobs are returned. To get detailed information about a
specific transcription job, use the operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"JobNameContains"`: Returns only the transcription jobs that contain the specified
string. The search is not case sensitive.
- `"MaxResults"`: The maximum number of transcription jobs to return in each page of
results. If there are fewer results than the value that you specify, only the actual
results are returned. If you do not specify a value, a default of 5 is used.
- `"NextToken"`: If your ListTranscriptionJobs request returns more results than can be
displayed, NextToken is displayed in the response with an associated string. To get the
next page of results, copy this string and repeat your request, including NextToken with
the value of the copied string. Repeat as needed to view all your results.
- `"Status"`: Returns only transcription jobs with the specified status. Jobs are ordered
by creation date, with the newest job first. If you do not include Status, all
transcription jobs are returned.
"""
function list_transcription_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return transcribe(
"ListTranscriptionJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_transcription_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"ListTranscriptionJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_vocabularies()
list_vocabularies(params::Dict{String,<:Any})
Provides a list of custom vocabularies that match the specified criteria. If no criteria
are specified, all custom vocabularies are returned. To get detailed information about a
specific custom vocabulary, use the operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of custom vocabularies to return in each page of
results. If there are fewer results than the value that you specify, only the actual
results are returned. If you do not specify a value, a default of 5 is used.
- `"NameContains"`: Returns only the custom vocabularies that contain the specified string.
The search is not case sensitive.
- `"NextToken"`: If your ListVocabularies request returns more results than can be
displayed, NextToken is displayed in the response with an associated string. To get the
next page of results, copy this string and repeat your request, including NextToken with
the value of the copied string. Repeat as needed to view all your results.
- `"StateEquals"`: Returns only custom vocabularies with the specified state. Vocabularies
are ordered by creation date, with the newest vocabulary first. If you do not include
StateEquals, all custom medical vocabularies are returned.
"""
function list_vocabularies(; aws_config::AbstractAWSConfig=global_aws_config())
return transcribe(
"ListVocabularies"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_vocabularies(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"ListVocabularies", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_vocabulary_filters()
list_vocabulary_filters(params::Dict{String,<:Any})
Provides a list of custom vocabulary filters that match the specified criteria. If no
criteria are specified, all custom vocabularies are returned. To get detailed information
about a specific custom vocabulary filter, use the operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of custom vocabulary filters to return in each page of
results. If there are fewer results than the value that you specify, only the actual
results are returned. If you do not specify a value, a default of 5 is used.
- `"NameContains"`: Returns only the custom vocabulary filters that contain the specified
string. The search is not case sensitive.
- `"NextToken"`: If your ListVocabularyFilters request returns more results than can be
displayed, NextToken is displayed in the response with an associated string. To get the
next page of results, copy this string and repeat your request, including NextToken with
the value of the copied string. Repeat as needed to view all your results.
"""
function list_vocabulary_filters(; aws_config::AbstractAWSConfig=global_aws_config())
return transcribe(
"ListVocabularyFilters"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_vocabulary_filters(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"ListVocabularyFilters",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_call_analytics_job(call_analytics_job_name, media)
start_call_analytics_job(call_analytics_job_name, media, params::Dict{String,<:Any})
Transcribes the audio from a customer service call and applies any additional Request
Parameters you choose to include in your request. In addition to many standard
transcription features, Call Analytics provides you with call characteristics, call
summarization, speaker sentiment, and optional redaction of your text transcript and your
audio file. You can also apply custom categories to flag specified conditions. To learn
more about these features and insights, refer to Analyzing call center audio with Call
Analytics. If you want to apply categories to your Call Analytics job, you must create them
before submitting your job request. Categories cannot be retroactively applied to a job. To
create a new category, use the operation. To learn more about Call Analytics categories,
see Creating categories for post-call transcriptions and Creating categories for real-time
transcriptions. To make a StartCallAnalyticsJob request, you must first upload your media
file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file
using the Media parameter. Note that job queuing is enabled by default for Call Analytics
jobs. You must include the following parameters in your StartCallAnalyticsJob request:
region: The Amazon Web Services Region where you are making your request. For a list of
Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe
endpoints and quotas. CallAnalyticsJobName: A custom name that you create for your
transcription job that's unique within your Amazon Web Services account.
DataAccessRoleArn: The Amazon Resource Name (ARN) of an IAM role that has permissions to
access the Amazon S3 bucket that contains your input files. Media (MediaFileUri or
RedactedMediaFileUri): The Amazon S3 location of your media file. With Call Analytics,
you can redact the audio contained in your media file by including RedactedMediaFileUri,
instead of MediaFileUri, to specify the location of your input audio. If you choose to
redact your audio, you can find your redacted media at the location specified in the
RedactedMediaFileUri field of your response.
# Arguments
- `call_analytics_job_name`: A unique name, chosen by you, for your Call Analytics job.
This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web
Services account. If you try to create a new job with the same name as an existing job, you
get a ConflictException error.
- `media`: Describes the Amazon S3 location of the media file you want to use in your Call
Analytics request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ChannelDefinitions"`: Makes it possible to specify which speaker is on which channel.
For example, if your agent is the first participant to speak, you would set ChannelId to 0
(to indicate the first channel) and ParticipantRole to AGENT (to indicate that it's the
agent speaking).
- `"DataAccessRoleArn"`: The Amazon Resource Name (ARN) of an IAM role that has permissions
to access the Amazon S3 bucket that contains your input files. If the role that you specify
doesn’t have the appropriate permissions to access the specified Amazon S3 location, your
request fails. IAM role ARNs have the format
arn:partition:iam::account:role/role-name-with-path. For example:
arn:aws:iam::111122223333:role/Admin. For more information, see IAM ARNs.
- `"OutputEncryptionKMSKeyId"`: The KMS key you want to use to encrypt your Call Analytics
output. If using a key located in the current Amazon Web Services account, you can specify
your KMS key in one of four ways: Use the KMS key ID itself. For example,
1234abcd-12ab-34cd-56ef-1234567890ab. Use an alias for the KMS key ID. For example,
alias/ExampleAlias. Use the Amazon Resource Name (ARN) for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. Use the ARN for
the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias. If
using a key located in a different Amazon Web Services account than the current Amazon Web
Services account, you can specify your KMS key in one of two ways: Use the ARN for the
KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. Use the ARN for
the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias. If you
do not specify an encryption key, your output is encrypted with the default Amazon S3 key
(SSE-S3). If you specify a KMS key to encrypt your output, you must also specify an output
location using the OutputLocation parameter. Note that the role making the request must
have permission to use the specified KMS key.
- `"OutputLocation"`: The Amazon S3 location where you want your Call Analytics
transcription output stored. You can use any of the following formats to specify the output
location: s3://DOC-EXAMPLE-BUCKET s3://DOC-EXAMPLE-BUCKET/my-output-folder/
s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json Unless you specify a
file name (option 3), the name of your output file has a default value that matches the
name you specified for your transcription job using the CallAnalyticsJobName parameter. You
can specify a KMS key to encrypt your output using the OutputEncryptionKMSKeyId parameter.
If you do not specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for
server-side encryption. If you do not specify OutputLocation, your transcript is placed in
a service-managed Amazon S3 bucket and you are provided with a URI to access your
transcript.
- `"Settings"`: Specify additional optional settings in your request, including content
redaction; allows you to apply custom language models, vocabulary filters, and custom
vocabularies to your Call Analytics job.
"""
function start_call_analytics_job(
CallAnalyticsJobName, Media; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"StartCallAnalyticsJob",
Dict{String,Any}("CallAnalyticsJobName" => CallAnalyticsJobName, "Media" => Media);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_call_analytics_job(
CallAnalyticsJobName,
Media,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"StartCallAnalyticsJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CallAnalyticsJobName" => CallAnalyticsJobName, "Media" => Media
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_medical_scribe_job(data_access_role_arn, media, medical_scribe_job_name, output_bucket_name, settings)
start_medical_scribe_job(data_access_role_arn, media, medical_scribe_job_name, output_bucket_name, settings, params::Dict{String,<:Any})
Transcribes patient-clinician conversations and generates clinical notes. Amazon Web
Services HealthScribe automatically provides rich conversation transcripts, identifies
speaker roles, classifies dialogues, extracts medical terms, and generates preliminary
clinical notes. To learn more about these features, refer to Amazon Web Services
HealthScribe. To make a StartMedicalScribeJob request, you must first upload your media
file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file
using the Media parameter. You must include the following parameters in your
StartMedicalTranscriptionJob request: DataAccessRoleArn: The ARN of an IAM role with the
these minimum permissions: read permission on input file Amazon S3 bucket specified in
Media, write permission on the Amazon S3 bucket specified in OutputBucketName, and full
permissions on the KMS key specified in OutputEncryptionKMSKeyId (if set). The role should
also allow transcribe.amazonaws.com to assume it. Media (MediaFileUri): The Amazon S3
location of your media file. MedicalScribeJobName: A custom name you create for your
MedicalScribe job that is unique within your Amazon Web Services account.
OutputBucketName: The Amazon S3 bucket where you want your output files stored.
Settings: A MedicalScribeSettings obect that must set exactly one of ShowSpeakerLabels or
ChannelIdentification to true. If ShowSpeakerLabels is true, MaxSpeakerLabels must also be
set. ChannelDefinitions: A MedicalScribeChannelDefinitions array should be set if and
only if the ChannelIdentification value of Settings is set to true.
# Arguments
- `data_access_role_arn`: The Amazon Resource Name (ARN) of an IAM role that has
permissions to access the Amazon S3 bucket that contains your input files, write to the
output bucket, and use your KMS key if supplied. If the role that you specify doesn’t
have the appropriate permissions your request fails. IAM role ARNs have the format
arn:partition:iam::account:role/role-name-with-path. For example:
arn:aws:iam::111122223333:role/Admin. For more information, see IAM ARNs.
- `media`:
- `medical_scribe_job_name`: A unique name, chosen by you, for your Medical Scribe job.
This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web
Services account. If you try to create a new job with the same name as an existing job, you
get a ConflictException error.
- `output_bucket_name`: The name of the Amazon S3 bucket where you want your Medical Scribe
output stored. Do not include the S3:// prefix of the specified bucket. Note that the role
specified in the DataAccessRoleArn request parameter must have permission to use the
specified location. You can change Amazon S3 permissions using the Amazon Web Services
Management Console. See also Permissions Required for IAM User Roles.
- `settings`: Makes it possible to control how your Medical Scribe job is processed using a
MedicalScribeSettings object. Specify ChannelIdentification if ChannelDefinitions are set.
Enabled ShowSpeakerLabels if ChannelIdentification and ChannelDefinitions are not set. One
and only one of ChannelIdentification and ShowSpeakerLabels must be set. If
ShowSpeakerLabels is set, MaxSpeakerLabels must also be set. Use Settings to specify a
vocabulary or vocabulary filter or both using VocabularyName, VocabularyFilterName.
VocabularyFilterMethod must be specified if VocabularyFilterName is set.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ChannelDefinitions"`: Makes it possible to specify which speaker is on which channel.
For example, if the clinician is the first participant to speak, you would set ChannelId of
the first ChannelDefinition in the list to 0 (to indicate the first channel) and
ParticipantRole to CLINICIAN (to indicate that it's the clinician speaking). Then you would
set the ChannelId of the second ChannelDefinition in the list to 1 (to indicate the second
channel) and ParticipantRole to PATIENT (to indicate that it's the patient speaking).
- `"KMSEncryptionContext"`: A map of plain text, non-secret key:value pairs, known as
encryption context pairs, that provide an added layer of security for your data. For more
information, see KMS encryption context and Asymmetric keys in KMS.
- `"OutputEncryptionKMSKeyId"`: The KMS key you want to use to encrypt your Medical Scribe
output. If using a key located in the current Amazon Web Services account, you can specify
your KMS key in one of four ways: Use the KMS key ID itself. For example,
1234abcd-12ab-34cd-56ef-1234567890ab. Use an alias for the KMS key ID. For example,
alias/ExampleAlias. Use the Amazon Resource Name (ARN) for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. Use the ARN for
the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias. If
using a key located in a different Amazon Web Services account than the current Amazon Web
Services account, you can specify your KMS key in one of two ways: Use the ARN for the
KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. Use the ARN for
the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias. If you
do not specify an encryption key, your output is encrypted with the default Amazon S3 key
(SSE-S3). Note that the role specified in the DataAccessRoleArn request parameter must have
permission to use the specified KMS key.
- `"Tags"`: Adds one or more custom tags, each in the form of a key:value pair, to the
Medica Scribe job. To learn more about using tags with Amazon Transcribe, refer to Tagging
resources.
"""
function start_medical_scribe_job(
DataAccessRoleArn,
Media,
MedicalScribeJobName,
OutputBucketName,
Settings;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"StartMedicalScribeJob",
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"Media" => Media,
"MedicalScribeJobName" => MedicalScribeJobName,
"OutputBucketName" => OutputBucketName,
"Settings" => Settings,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_medical_scribe_job(
DataAccessRoleArn,
Media,
MedicalScribeJobName,
OutputBucketName,
Settings,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"StartMedicalScribeJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"Media" => Media,
"MedicalScribeJobName" => MedicalScribeJobName,
"OutputBucketName" => OutputBucketName,
"Settings" => Settings,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_medical_transcription_job(language_code, media, medical_transcription_job_name, output_bucket_name, specialty, type)
start_medical_transcription_job(language_code, media, medical_transcription_job_name, output_bucket_name, specialty, type, params::Dict{String,<:Any})
Transcribes the audio from a medical dictation or conversation and applies any additional
Request Parameters you choose to include in your request. In addition to many standard
transcription features, Amazon Transcribe Medical provides you with a robust medical
vocabulary and, optionally, content identification, which adds flags to personal health
information (PHI). To learn more about these features, refer to How Amazon Transcribe
Medical works. To make a StartMedicalTranscriptionJob request, you must first upload your
media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the
file using the Media parameter. You must include the following parameters in your
StartMedicalTranscriptionJob request: region: The Amazon Web Services Region where you
are making your request. For a list of Amazon Web Services Regions supported with Amazon
Transcribe, refer to Amazon Transcribe endpoints and quotas.
MedicalTranscriptionJobName: A custom name you create for your transcription job that is
unique within your Amazon Web Services account. Media (MediaFileUri): The Amazon S3
location of your media file. LanguageCode: This must be en-US. OutputBucketName: The
Amazon S3 bucket where you want your transcript stored. If you want your output stored in a
sub-folder of this bucket, you must also include OutputKey. Specialty: This must be
PRIMARYCARE. Type: Choose whether your audio is a conversation or a dictation.
# Arguments
- `language_code`: The language code that represents the language spoken in the input media
file. US English (en-US) is the only valid value for medical transcription jobs. Any other
value you enter for language code results in a BadRequestException error.
- `media`:
- `medical_transcription_job_name`: A unique name, chosen by you, for your medical
transcription job. The name that you specify is also used as the default name of your
transcription output file. If you want to specify a different name for your transcription
output, use the OutputKey parameter. This name is case sensitive, cannot contain spaces,
and must be unique within an Amazon Web Services account. If you try to create a new job
with the same name as an existing job, you get a ConflictException error.
- `output_bucket_name`: The name of the Amazon S3 bucket where you want your medical
transcription output stored. Do not include the S3:// prefix of the specified bucket. If
you want your output to go to a sub-folder of this bucket, specify it using the OutputKey
parameter; OutputBucketName only accepts the name of a bucket. For example, if you want
your output stored in S3://DOC-EXAMPLE-BUCKET, set OutputBucketName to DOC-EXAMPLE-BUCKET.
However, if you want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set
OutputBucketName to DOC-EXAMPLE-BUCKET and OutputKey to test-files/. Note that Amazon
Transcribe must have permission to use the specified location. You can change Amazon S3
permissions using the Amazon Web Services Management Console. See also Permissions Required
for IAM User Roles.
- `specialty`: Specify the predominant medical specialty represented in your media. For
batch transcriptions, PRIMARYCARE is the only valid value. If you require additional
specialties, refer to .
- `type`: Specify whether your input media contains only one person (DICTATION) or contains
a conversation between two people (CONVERSATION). For example, DICTATION could be used for
a medical professional wanting to transcribe voice memos; CONVERSATION could be used for
transcribing the doctor-patient dialogue during the patient's office visit.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ContentIdentificationType"`: Labels all personal health information (PHI) identified in
your transcript. For more information, see Identifying personal health information (PHI) in
a transcription.
- `"KMSEncryptionContext"`: A map of plain text, non-secret key:value pairs, known as
encryption context pairs, that provide an added layer of security for your data. For more
information, see KMS encryption context and Asymmetric keys in KMS.
- `"MediaFormat"`: Specify the format of your input media file.
- `"MediaSampleRateHertz"`: The sample rate, in hertz, of the audio track in your input
media file. If you do not specify the media sample rate, Amazon Transcribe Medical
determines it for you. If you specify the sample rate, it must match the rate detected by
Amazon Transcribe Medical; if there's a mismatch between the value that you specify and the
value detected, your job fails. Therefore, in most cases, it's advised to omit
MediaSampleRateHertz and let Amazon Transcribe Medical determine the sample rate.
- `"OutputEncryptionKMSKeyId"`: The KMS key you want to use to encrypt your medical
transcription output. If using a key located in the current Amazon Web Services account,
you can specify your KMS key in one of four ways: Use the KMS key ID itself. For example,
1234abcd-12ab-34cd-56ef-1234567890ab. Use an alias for the KMS key ID. For example,
alias/ExampleAlias. Use the Amazon Resource Name (ARN) for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. Use the ARN for
the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias. If
using a key located in a different Amazon Web Services account than the current Amazon Web
Services account, you can specify your KMS key in one of two ways: Use the ARN for the
KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. Use the ARN for
the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias. If you
do not specify an encryption key, your output is encrypted with the default Amazon S3 key
(SSE-S3). If you specify a KMS key to encrypt your output, you must also specify an output
location using the OutputLocation parameter. Note that the role making the request must
have permission to use the specified KMS key.
- `"OutputKey"`: Use in combination with OutputBucketName to specify the output location of
your transcript and, optionally, a unique name for your output file. The default name for
your transcription output is the same as the name you specified for your medical
transcription job (MedicalTranscriptionJobName). Here are some examples of how you can use
OutputKey: If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and
'my-transcript.json' as the OutputKey, your transcription output path is
s3://DOC-EXAMPLE-BUCKET/my-transcript.json. If you specify 'my-first-transcription' as
the MedicalTranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and
'my-transcript' as the OutputKey, your transcription output path is
s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json. If you specify
'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'test-files/my-transcript.json' as the
OutputKey, your transcription output path is
s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json. If you specify
'my-first-transcription' as the MedicalTranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the
OutputBucketName, and 'test-files/my-transcript' as the OutputKey, your transcription
output path is
s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json. If you
specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for
you.
- `"Settings"`: Specify additional optional settings in your request, including channel
identification, alternative transcriptions, and speaker partitioning. You can use that to
apply custom vocabularies to your transcription job.
- `"Tags"`: Adds one or more custom tags, each in the form of a key:value pair, to a new
medical transcription job at the time you start this new job. To learn more about using
tags with Amazon Transcribe, refer to Tagging resources.
"""
function start_medical_transcription_job(
LanguageCode,
Media,
MedicalTranscriptionJobName,
OutputBucketName,
Specialty,
Type;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"StartMedicalTranscriptionJob",
Dict{String,Any}(
"LanguageCode" => LanguageCode,
"Media" => Media,
"MedicalTranscriptionJobName" => MedicalTranscriptionJobName,
"OutputBucketName" => OutputBucketName,
"Specialty" => Specialty,
"Type" => Type,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_medical_transcription_job(
LanguageCode,
Media,
MedicalTranscriptionJobName,
OutputBucketName,
Specialty,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"StartMedicalTranscriptionJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LanguageCode" => LanguageCode,
"Media" => Media,
"MedicalTranscriptionJobName" => MedicalTranscriptionJobName,
"OutputBucketName" => OutputBucketName,
"Specialty" => Specialty,
"Type" => Type,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_transcription_job(media, transcription_job_name)
start_transcription_job(media, transcription_job_name, params::Dict{String,<:Any})
Transcribes the audio from a media file and applies any additional Request Parameters you
choose to include in your request. To make a StartTranscriptionJob request, you must first
upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3
location of the file using the Media parameter. You must include the following parameters
in your StartTranscriptionJob request: region: The Amazon Web Services Region where you
are making your request. For a list of Amazon Web Services Regions supported with Amazon
Transcribe, refer to Amazon Transcribe endpoints and quotas. TranscriptionJobName: A
custom name you create for your transcription job that is unique within your Amazon Web
Services account. Media (MediaFileUri): The Amazon S3 location of your media file. One
of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages: If you know the language
of your media file, specify it using the LanguageCode parameter; you can find all valid
language codes in the Supported languages table. If you do not know the languages spoken in
your media, use either IdentifyLanguage or IdentifyMultipleLanguages and let Amazon
Transcribe identify the languages for you.
# Arguments
- `media`: Describes the Amazon S3 location of the media file you want to use in your
request.
- `transcription_job_name`: A unique name, chosen by you, for your transcription job. The
name that you specify is also used as the default name of your transcription output file.
If you want to specify a different name for your transcription output, use the OutputKey
parameter. This name is case sensitive, cannot contain spaces, and must be unique within an
Amazon Web Services account. If you try to create a new job with the same name as an
existing job, you get a ConflictException error.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ContentRedaction"`: Makes it possible to redact or flag specified personally
identifiable information (PII) in your transcript. If you use ContentRedaction, you must
also include the sub-parameters: RedactionOutput and RedactionType. You can optionally
include PiiEntityTypes to choose which types of PII you want to redact. If you do not
include PiiEntityTypes in your request, all PII is redacted.
- `"IdentifyLanguage"`: Enables automatic language identification in your transcription job
request. Use this parameter if your media file contains only one language. If your media
contains multiple languages, use IdentifyMultipleLanguages instead. If you include
IdentifyLanguage, you can optionally include a list of language codes, using
LanguageOptions, that you think may be present in your media file. Including
LanguageOptions restricts IdentifyLanguage to only the language options that you specify,
which can improve transcription accuracy. If you want to apply a custom language model, a
custom vocabulary, or a custom vocabulary filter to your automatic language identification
request, include LanguageIdSettings with the relevant sub-parameters (VocabularyName,
LanguageModelName, and VocabularyFilterName). If you include LanguageIdSettings, also
include LanguageOptions. Note that you must include one of LanguageCode, IdentifyLanguage,
or IdentifyMultipleLanguages in your request. If you include more than one of these
parameters, your transcription job fails.
- `"IdentifyMultipleLanguages"`: Enables automatic multi-language identification in your
transcription job request. Use this parameter if your media file contains more than one
language. If your media contains only one language, use IdentifyLanguage instead. If you
include IdentifyMultipleLanguages, you can optionally include a list of language codes,
using LanguageOptions, that you think may be present in your media file. Including
LanguageOptions restricts IdentifyLanguage to only the language options that you specify,
which can improve transcription accuracy. If you want to apply a custom vocabulary or a
custom vocabulary filter to your automatic language identification request, include
LanguageIdSettings with the relevant sub-parameters (VocabularyName and
VocabularyFilterName). If you include LanguageIdSettings, also include LanguageOptions.
Note that you must include one of LanguageCode, IdentifyLanguage, or
IdentifyMultipleLanguages in your request. If you include more than one of these
parameters, your transcription job fails.
- `"JobExecutionSettings"`: Makes it possible to control how your transcription job is
processed. Currently, the only JobExecutionSettings modification you can choose is enabling
job queueing using the AllowDeferredExecution sub-parameter. If you include
JobExecutionSettings in your request, you must also include the sub-parameters:
AllowDeferredExecution and DataAccessRoleArn.
- `"KMSEncryptionContext"`: A map of plain text, non-secret key:value pairs, known as
encryption context pairs, that provide an added layer of security for your data. For more
information, see KMS encryption context and Asymmetric keys in KMS.
- `"LanguageCode"`: The language code that represents the language spoken in the input
media file. If you're unsure of the language spoken in your media file, consider using
IdentifyLanguage or IdentifyMultipleLanguages to enable automatic language identification.
Note that you must include one of LanguageCode, IdentifyLanguage, or
IdentifyMultipleLanguages in your request. If you include more than one of these
parameters, your transcription job fails. For a list of supported languages and their
associated language codes, refer to the Supported languages table. To transcribe speech in
Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000
Hz or higher.
- `"LanguageIdSettings"`: If using automatic language identification in your request and
you want to apply a custom language model, a custom vocabulary, or a custom vocabulary
filter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName,
LanguageModelName, and VocabularyFilterName). Note that multi-language identification
(IdentifyMultipleLanguages) doesn't support custom language models. LanguageIdSettings
supports two to five language codes. Each language code you include can have an associated
custom language model, custom vocabulary, and custom vocabulary filter. The language codes
that you specify must match the languages of the associated custom language models, custom
vocabularies, and custom vocabulary filters. It's recommended that you include
LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect
is identified. For example, if you specify a custom vocabulary that is in en-US but Amazon
Transcribe determines that the language spoken in your media is en-AU, your custom
vocabulary is not applied to your transcription. If you include LanguageOptions and include
en-US as the only English language dialect, your custom vocabulary is applied to your
transcription. If you want to include a custom language model with your request but do not
want to use automatic language identification, use instead the parameter with the
LanguageModelName sub-parameter. If you want to include a custom vocabulary or a custom
vocabulary filter (or both) with your request but do not want to use automatic language
identification, use instead the parameter with the VocabularyName or VocabularyFilterName
(or both) sub-parameter.
- `"LanguageOptions"`: You can specify two or more language codes that represent the
languages you think may be present in your media. Including more than five is not
recommended. If you're unsure what languages are present, do not include this parameter. If
you include LanguageOptions in your request, you must also include IdentifyLanguage. For
more information, refer to Supported languages. To transcribe speech in Modern Standard
Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher.
- `"MediaFormat"`: Specify the format of your input media file.
- `"MediaSampleRateHertz"`: The sample rate, in hertz, of the audio track in your input
media file. If you do not specify the media sample rate, Amazon Transcribe determines it
for you. If you specify the sample rate, it must match the rate detected by Amazon
Transcribe. If there's a mismatch between the value that you specify and the value
detected, your job fails. In most cases, you can omit MediaSampleRateHertz and let Amazon
Transcribe determine the sample rate.
- `"ModelSettings"`: Specify the custom language model you want to include with your
transcription job. If you include ModelSettings in your request, you must include the
LanguageModelName sub-parameter. For more information, see Custom language models.
- `"OutputBucketName"`: The name of the Amazon S3 bucket where you want your transcription
output stored. Do not include the S3:// prefix of the specified bucket. If you want your
output to go to a sub-folder of this bucket, specify it using the OutputKey parameter;
OutputBucketName only accepts the name of a bucket. For example, if you want your output
stored in S3://DOC-EXAMPLE-BUCKET, set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if
you want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to
DOC-EXAMPLE-BUCKET and OutputKey to test-files/. Note that Amazon Transcribe must have
permission to use the specified location. You can change Amazon S3 permissions using the
Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.
If you do not specify OutputBucketName, your transcript is placed in a service-managed
Amazon S3 bucket and you are provided with a URI to access your transcript.
- `"OutputEncryptionKMSKeyId"`: The KMS key you want to use to encrypt your transcription
output. If using a key located in the current Amazon Web Services account, you can specify
your KMS key in one of four ways: Use the KMS key ID itself. For example,
1234abcd-12ab-34cd-56ef-1234567890ab. Use an alias for the KMS key ID. For example,
alias/ExampleAlias. Use the Amazon Resource Name (ARN) for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. Use the ARN for
the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias. If
using a key located in a different Amazon Web Services account than the current Amazon Web
Services account, you can specify your KMS key in one of two ways: Use the ARN for the
KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. Use the ARN for
the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias. If you
do not specify an encryption key, your output is encrypted with the default Amazon S3 key
(SSE-S3). If you specify a KMS key to encrypt your output, you must also specify an output
location using the OutputLocation parameter. Note that the role making the request must
have permission to use the specified KMS key.
- `"OutputKey"`: Use in combination with OutputBucketName to specify the output location of
your transcript and, optionally, a unique name for your output file. The default name for
your transcription output is the same as the name you specified for your transcription job
(TranscriptionJobName). Here are some examples of how you can use OutputKey: If you
specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'my-transcript.json' as the
OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json.
If you specify 'my-first-transcription' as the TranscriptionJobName, 'DOC-EXAMPLE-BUCKET'
as the OutputBucketName, and 'my-transcript' as the OutputKey, your transcription output
path is s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json. If you specify
'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'test-files/my-transcript.json' as the
OutputKey, your transcription output path is
s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json. If you specify
'my-first-transcription' as the TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the
OutputBucketName, and 'test-files/my-transcript' as the OutputKey, your transcription
output path is
s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json. If you
specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for
you.
- `"Settings"`: Specify additional optional settings in your request, including channel
identification, alternative transcriptions, speaker partitioning. You can use that to apply
custom vocabularies and vocabulary filters. If you want to include a custom vocabulary or a
custom vocabulary filter (or both) with your request but do not want to use automatic
language identification, use Settings with the VocabularyName or VocabularyFilterName (or
both) sub-parameter. If you're using automatic language identification with your request
and want to include a custom language model, a custom vocabulary, or a custom vocabulary
filter, use instead the parameter with the LanguageModelName, VocabularyName or
VocabularyFilterName sub-parameters.
- `"Subtitles"`: Produces subtitle files for your input media. You can specify WebVTT
(*.vtt) and SubRip (*.srt) formats.
- `"Tags"`: Adds one or more custom tags, each in the form of a key:value pair, to a new
transcription job at the time you start this new job. To learn more about using tags with
Amazon Transcribe, refer to Tagging resources.
- `"ToxicityDetection"`: Enables toxic speech detection in your transcript. If you include
ToxicityDetection in your request, you must also include ToxicityCategories. For
information on the types of toxic speech Amazon Transcribe can detect, see Detecting toxic
speech.
"""
function start_transcription_job(
Media, TranscriptionJobName; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"StartTranscriptionJob",
Dict{String,Any}("Media" => Media, "TranscriptionJobName" => TranscriptionJobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_transcription_job(
Media,
TranscriptionJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"StartTranscriptionJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Media" => Media, "TranscriptionJobName" => TranscriptionJobName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds one or more custom tags, each in the form of a key:value pair, to the specified
resource. To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource you want to tag. ARNs have
the format arn:partition:service:region:account-id:resource-type/resource-id. For example,
arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name. Valid
values for resource-type are: transcription-job, medical-transcription-job, vocabulary,
medical-vocabulary, vocabulary-filter, and language-model.
- `tags`: Adds one or more custom tags, each in the form of a key:value pair, to the
specified resource. To learn more about using tags with Amazon Transcribe, refer to Tagging
resources.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return transcribe(
"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 transcribe(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes the specified tags from the specified Amazon Transcribe resource. If you include
UntagResource in your request, you must also include ResourceArn and TagKeys.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want
to remove tags from. ARNs have the format
arn:partition:service:region:account-id:resource-type/resource-id. For example,
arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name. Valid
values for resource-type are: transcription-job, medical-transcription-job, vocabulary,
medical-vocabulary, vocabulary-filter, and language-model.
- `tag_keys`: Removes the specified tag keys from the specified Amazon Transcribe resource.
"""
function untag_resource(
ResourceArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"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 transcribe(
"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_call_analytics_category(category_name, rules)
update_call_analytics_category(category_name, rules, params::Dict{String,<:Any})
Updates the specified Call Analytics category with new rules. Note that the
UpdateCallAnalyticsCategory operation overwrites all existing rules contained in the
specified category. You cannot append additional rules onto an existing category. To create
a new category, see .
# Arguments
- `category_name`: The name of the Call Analytics category you want to update. Category
names are case sensitive.
- `rules`: The rules used for the updated Call Analytics category. The rules you provide in
this field replace the ones that are currently being used in the specified category.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InputType"`: Choose whether you want to update a real-time or a post-call category. The
input type you specify must match the input type specified when the category was created.
For example, if you created a category with the POST_CALL input type, you must use
POST_CALL as the input type when updating this category.
"""
function update_call_analytics_category(
CategoryName, Rules; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"UpdateCallAnalyticsCategory",
Dict{String,Any}("CategoryName" => CategoryName, "Rules" => Rules);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_call_analytics_category(
CategoryName,
Rules,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"UpdateCallAnalyticsCategory",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CategoryName" => CategoryName, "Rules" => Rules),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_medical_vocabulary(language_code, vocabulary_file_uri, vocabulary_name)
update_medical_vocabulary(language_code, vocabulary_file_uri, vocabulary_name, params::Dict{String,<:Any})
Updates an existing custom medical vocabulary with new values. This operation overwrites
all existing information with your new values; you cannot append new terms onto an existing
custom vocabulary.
# Arguments
- `language_code`: The language code that represents the language of the entries in the
custom vocabulary you want to update. US English (en-US) is the only language supported
with Amazon Transcribe Medical.
- `vocabulary_file_uri`: The Amazon S3 location of the text file that contains your custom
medical vocabulary. The URI must be located in the same Amazon Web Services Region as the
resource you're calling. Here's an example URI path:
s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt
- `vocabulary_name`: The name of the custom medical vocabulary you want to update. Custom
medical vocabulary names are case sensitive.
"""
function update_medical_vocabulary(
LanguageCode,
VocabularyFileUri,
VocabularyName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"UpdateMedicalVocabulary",
Dict{String,Any}(
"LanguageCode" => LanguageCode,
"VocabularyFileUri" => VocabularyFileUri,
"VocabularyName" => VocabularyName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_medical_vocabulary(
LanguageCode,
VocabularyFileUri,
VocabularyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"UpdateMedicalVocabulary",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LanguageCode" => LanguageCode,
"VocabularyFileUri" => VocabularyFileUri,
"VocabularyName" => VocabularyName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_vocabulary(language_code, vocabulary_name)
update_vocabulary(language_code, vocabulary_name, params::Dict{String,<:Any})
Updates an existing custom vocabulary with new values. This operation overwrites all
existing information with your new values; you cannot append new terms onto an existing
custom vocabulary.
# Arguments
- `language_code`: The language code that represents the language of the entries in the
custom vocabulary you want to update. Each custom vocabulary must contain terms in only one
language. A custom vocabulary can only be used to transcribe files in the same language as
the custom vocabulary. For example, if you create a custom vocabulary using US English
(en-US), you can only apply this custom vocabulary to files that contain English audio. For
a list of supported languages and their associated language codes, refer to the Supported
languages table.
- `vocabulary_name`: The name of the custom vocabulary you want to update. Custom
vocabulary names are case sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataAccessRoleArn"`: The Amazon Resource Name (ARN) of an IAM role that has permissions
to access the Amazon S3 bucket that contains your input files (in this case, your custom
vocabulary). If the role that you specify doesn’t have the appropriate permissions to
access the specified Amazon S3 location, your request fails. IAM role ARNs have the format
arn:partition:iam::account:role/role-name-with-path. For example:
arn:aws:iam::111122223333:role/Admin. For more information, see IAM ARNs.
- `"Phrases"`: Use this parameter if you want to update your custom vocabulary by including
all desired terms, as comma-separated values, within your request. The other option for
updating your custom vocabulary is to save your entries in a text file and upload them to
an Amazon S3 bucket, then specify the location of your file using the VocabularyFileUri
parameter. Note that if you include Phrases in your request, you cannot use
VocabularyFileUri; you must choose one or the other. Each language has a character set that
contains all allowed characters for that specific language. If you use unsupported
characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom
Vocabularies to get the character set for your language.
- `"VocabularyFileUri"`: The Amazon S3 location of the text file that contains your custom
vocabulary. The URI must be located in the same Amazon Web Services Region as the resource
you're calling. Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt Note
that if you include VocabularyFileUri in your request, you cannot use the Phrases flag; you
must choose one or the other.
"""
function update_vocabulary(
LanguageCode, VocabularyName; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"UpdateVocabulary",
Dict{String,Any}(
"LanguageCode" => LanguageCode, "VocabularyName" => VocabularyName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_vocabulary(
LanguageCode,
VocabularyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"UpdateVocabulary",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LanguageCode" => LanguageCode, "VocabularyName" => VocabularyName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_vocabulary_filter(vocabulary_filter_name)
update_vocabulary_filter(vocabulary_filter_name, params::Dict{String,<:Any})
Updates an existing custom vocabulary filter with a new list of words. The new list you
provide overwrites all previous entries; you cannot append new terms onto an existing
custom vocabulary filter.
# Arguments
- `vocabulary_filter_name`: The name of the custom vocabulary filter you want to update.
Custom vocabulary filter names are case sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataAccessRoleArn"`: The Amazon Resource Name (ARN) of an IAM role that has permissions
to access the Amazon S3 bucket that contains your input files (in this case, your custom
vocabulary filter). If the role that you specify doesn’t have the appropriate permissions
to access the specified Amazon S3 location, your request fails. IAM role ARNs have the
format arn:partition:iam::account:role/role-name-with-path. For example:
arn:aws:iam::111122223333:role/Admin. For more information, see IAM ARNs.
- `"VocabularyFilterFileUri"`: The Amazon S3 location of the text file that contains your
custom vocabulary filter terms. The URI must be located in the same Amazon Web Services
Region as the resource you're calling. Here's an example URI path:
s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt Note that if you include
VocabularyFilterFileUri in your request, you cannot use Words; you must choose one or the
other.
- `"Words"`: Use this parameter if you want to update your custom vocabulary filter by
including all desired terms, as comma-separated values, within your request. The other
option for updating your vocabulary filter is to save your entries in a text file and
upload them to an Amazon S3 bucket, then specify the location of your file using the
VocabularyFilterFileUri parameter. Note that if you include Words in your request, you
cannot use VocabularyFilterFileUri; you must choose one or the other. Each language has a
character set that contains all allowed characters for that specific language. If you use
unsupported characters, your custom vocabulary filter request fails. Refer to Character
Sets for Custom Vocabularies to get the character set for your language.
"""
function update_vocabulary_filter(
VocabularyFilterName; aws_config::AbstractAWSConfig=global_aws_config()
)
return transcribe(
"UpdateVocabularyFilter",
Dict{String,Any}("VocabularyFilterName" => VocabularyFilterName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_vocabulary_filter(
VocabularyFilterName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transcribe(
"UpdateVocabularyFilter",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("VocabularyFilterName" => VocabularyFilterName),
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 | 135177 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: transfer
using AWS.Compat
using AWS.UUIDs
"""
create_access(external_id, role, server_id)
create_access(external_id, role, server_id, params::Dict{String,<:Any})
Used by administrators to choose which groups in the directory should have access to upload
and download files over the enabled protocols using Transfer Family. For example, a
Microsoft Active Directory might contain 50,000 users, but only a small fraction might need
the ability to transfer files to the server. An administrator can use CreateAccess to limit
the access to the correct set of users who need this ability.
# Arguments
- `external_id`: A unique identifier that is required to identify specific groups within
your directory. The users of the group that you associate have access to your Amazon S3 or
Amazon EFS resources over the enabled protocols using Transfer Family. If you know the
group name, you can view the SID values by running the following command using Windows
PowerShell. Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * |
Select SamAccountName,ObjectSid In that command, replace YourGroupName with the name of
your Active Directory group. The regular expression used to validate this parameter is a
string of characters consisting of uppercase and lowercase alphanumeric characters with no
spaces. You can also include underscores or any of the following characters: =,.@:/-
- `role`: The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role
that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The
policies attached to this role determine the level of access that you want to provide your
users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file
system. The IAM role should also contain a trust relationship that allows the server to
access your resources when servicing your users' transfer requests.
- `server_id`: A system-assigned unique identifier for a server instance. This is the
specific server that you added your user to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"HomeDirectory"`: The landing directory (folder) for a user when they log in to the
server using the client. A HomeDirectory example is /bucket_name/home/mydirectory. The
HomeDirectory parameter is only used if HomeDirectoryType is set to PATH.
- `"HomeDirectoryMappings"`: Logical directory mappings that specify what Amazon S3 or
Amazon EFS paths and keys should be visible to your user and how you want to make them
visible. You must specify the Entry and Target pair, where Entry shows how the path is made
visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a
target, it is displayed as is. You also must ensure that your Identity and Access
Management (IAM) role provides access to paths in Target. This value can be set only when
HomeDirectoryType is set to LOGICAL. The following is an Entry and Target pair example. [
{ \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ] In most
cases, you can use this value instead of the session policy to lock down your user to the
designated home directory (\"chroot\"). To do this, you can set Entry to / and set Target
to the HomeDirectory parameter value. The following is an Entry and Target pair example for
chroot. [ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]
- `"HomeDirectoryType"`: The type of landing directory (folder) that you want your users'
home directory to be when they log in to the server. If you set it to PATH, the user will
see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol
clients. If you set it to LOGICAL, you need to provide mappings in the
HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to
your users. If HomeDirectoryType is LOGICAL, you must provide mappings, using the
HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is PATH, you
provide an absolute path using the HomeDirectory parameter. You cannot have both
HomeDirectory and HomeDirectoryMappings in your template.
- `"Policy"`: A session policy for your user so that you can use the same Identity and
Access Management (IAM) role across multiple users. This policy scopes down a user's access
to portions of their Amazon S3 bucket. Variables that you can use inside this policy
include {Transfer:UserName}, {Transfer:HomeDirectory}, and {Transfer:HomeBucket}. This
policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use
session policies. For session policies, Transfer Family stores the policy as a JSON blob,
instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob
and pass it in the Policy argument. For an example of a session policy, see Example session
policy. For more information, see AssumeRole in the Security Token Service API Reference.
- `"PosixProfile"`:
"""
function create_access(
ExternalId, Role, ServerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"CreateAccess",
Dict{String,Any}(
"ExternalId" => ExternalId, "Role" => Role, "ServerId" => ServerId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_access(
ExternalId,
Role,
ServerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"CreateAccess",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ExternalId" => ExternalId, "Role" => Role, "ServerId" => ServerId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_agreement(access_role, base_directory, local_profile_id, partner_profile_id, server_id)
create_agreement(access_role, base_directory, local_profile_id, partner_profile_id, server_id, params::Dict{String,<:Any})
Creates an agreement. An agreement is a bilateral trading partner agreement, or
partnership, between an Transfer Family server and an AS2 process. The agreement defines
the file and message transfer relationship between the server and the AS2 process. To
define an agreement, Transfer Family combines a server, local profile, partner profile,
certificate, and other attributes. The partner is identified with the PartnerProfileId, and
the AS2 process is identified with the LocalProfileId.
# Arguments
- `access_role`: Connectors are used to send files using either the AS2 or SFTP protocol.
For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access
Management role to use. For AS2 connectors With AS2, you can send files by calling
StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We
use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt,
parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store
the MDN when we receive them from the partner, and write a final JSON file containing
relevant metadata of the transmission. So, the AccessRole needs to provide read and write
access to the parent directory of the file location used in the StartFileTransfer request.
Additionally, you need to provide read and write access to the parent directory of the
files that you intend to send with StartFileTransfer. If you are using Basic authentication
for your AS2 connector, the access role requires the secretsmanager:GetSecretValue
permission for the secret. If the secret is encrypted using a customer-managed key instead
of the Amazon Web Services managed key in Secrets Manager, then the role also needs the
kms:Decrypt permission for that key. For SFTP connectors Make sure that the access role
provides read and write access to the parent directory of the file location that's used in
the StartFileTransfer request. Additionally, make sure that the role provides
secretsmanager:GetSecretValue permission to Secrets Manager.
- `base_directory`: The landing directory (folder) for files transferred by using the AS2
protocol. A BaseDirectory example is /DOC-EXAMPLE-BUCKET/home/mydirectory.
- `local_profile_id`: A unique identifier for the AS2 local profile.
- `partner_profile_id`: A unique identifier for the partner profile used in the agreement.
- `server_id`: A system-assigned unique identifier for a server instance. This is the
specific server that the agreement uses.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A name or short description to identify the agreement.
- `"Status"`: The status of the agreement. The agreement can be either ACTIVE or INACTIVE.
- `"Tags"`: Key-value pairs that can be used to group and search for agreements.
"""
function create_agreement(
AccessRole,
BaseDirectory,
LocalProfileId,
PartnerProfileId,
ServerId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"CreateAgreement",
Dict{String,Any}(
"AccessRole" => AccessRole,
"BaseDirectory" => BaseDirectory,
"LocalProfileId" => LocalProfileId,
"PartnerProfileId" => PartnerProfileId,
"ServerId" => ServerId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_agreement(
AccessRole,
BaseDirectory,
LocalProfileId,
PartnerProfileId,
ServerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"CreateAgreement",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AccessRole" => AccessRole,
"BaseDirectory" => BaseDirectory,
"LocalProfileId" => LocalProfileId,
"PartnerProfileId" => PartnerProfileId,
"ServerId" => ServerId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_connector(access_role, url)
create_connector(access_role, url, params::Dict{String,<:Any})
Creates the connector, which captures the parameters for a connection for the AS2 or SFTP
protocol. For AS2, the connector is required for sending files to an externally hosted AS2
server. For SFTP, the connector is required when sending files to an SFTP server or
receiving files from an SFTP server. For more details about connectors, see Configure AS2
connectors and Create SFTP connectors. You must specify exactly one configuration object:
either for AS2 (As2Config) or SFTP (SftpConfig).
# Arguments
- `access_role`: Connectors are used to send files using either the AS2 or SFTP protocol.
For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access
Management role to use. For AS2 connectors With AS2, you can send files by calling
StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We
use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt,
parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store
the MDN when we receive them from the partner, and write a final JSON file containing
relevant metadata of the transmission. So, the AccessRole needs to provide read and write
access to the parent directory of the file location used in the StartFileTransfer request.
Additionally, you need to provide read and write access to the parent directory of the
files that you intend to send with StartFileTransfer. If you are using Basic authentication
for your AS2 connector, the access role requires the secretsmanager:GetSecretValue
permission for the secret. If the secret is encrypted using a customer-managed key instead
of the Amazon Web Services managed key in Secrets Manager, then the role also needs the
kms:Decrypt permission for that key. For SFTP connectors Make sure that the access role
provides read and write access to the parent directory of the file location that's used in
the StartFileTransfer request. Additionally, make sure that the role provides
secretsmanager:GetSecretValue permission to Secrets Manager.
- `url`: The URL of the partner's AS2 or SFTP endpoint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"As2Config"`: A structure that contains the parameters for an AS2 connector object.
- `"LoggingRole"`: The Amazon Resource Name (ARN) of the Identity and Access Management
(IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When
set, you can view connector activity in your CloudWatch logs.
- `"SecurityPolicyName"`: Specifies the name of the security policy for the connector.
- `"SftpConfig"`: A structure that contains the parameters for an SFTP connector object.
- `"Tags"`: Key-value pairs that can be used to group and search for connectors. Tags are
metadata attached to connectors for any purpose.
"""
function create_connector(
AccessRole, Url; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"CreateConnector",
Dict{String,Any}("AccessRole" => AccessRole, "Url" => Url);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_connector(
AccessRole,
Url,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"CreateConnector",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("AccessRole" => AccessRole, "Url" => Url), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_profile(as2_id, profile_type)
create_profile(as2_id, profile_type, params::Dict{String,<:Any})
Creates the local or partner profile to use for AS2 transfers.
# Arguments
- `as2_id`: The As2Id is the AS2-name, as defined in the RFC 4130. For inbound transfers,
this is the AS2-From header for the AS2 messages sent from the partner. For outbound
connectors, this is the AS2-To header for the AS2 messages sent to the partner using the
StartFileTransfer API operation. This ID cannot include spaces.
- `profile_type`: Determines the type of profile to create: Specify LOCAL to create a
local profile. A local profile represents the AS2-enabled Transfer Family server
organization or party. Specify PARTNER to create a partner profile. A partner profile
represents a remote organization, external to Transfer Family.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CertificateIds"`: An array of identifiers for the imported certificates. You use this
identifier for working with profiles and partner profiles.
- `"Tags"`: Key-value pairs that can be used to group and search for AS2 profiles.
"""
function create_profile(
As2Id, ProfileType; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"CreateProfile",
Dict{String,Any}("As2Id" => As2Id, "ProfileType" => ProfileType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_profile(
As2Id,
ProfileType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"CreateProfile",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("As2Id" => As2Id, "ProfileType" => ProfileType),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_server()
create_server(params::Dict{String,<:Any})
Instantiates an auto-scaling virtual server based on the selected file transfer protocol in
Amazon Web Services. When you make updates to your file transfer protocol-enabled server or
when you work with users, use the service-generated ServerId property that is assigned to
the newly created server.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Certificate"`: The Amazon Resource Name (ARN) of the Certificate Manager (ACM)
certificate. Required when Protocols is set to FTPS. To request a new public certificate,
see Request a public certificate in the Certificate Manager User Guide. To import an
existing certificate into ACM, see Importing certificates into ACM in the Certificate
Manager User Guide. To request a private certificate to use FTPS through private IP
addresses, see Request a private certificate in the Certificate Manager User Guide.
Certificates with the following cryptographic algorithms and key sizes are supported:
2048-bit RSA (RSA_2048) 4096-bit RSA (RSA_4096) Elliptic Prime Curve 256 bit
(EC_prime256v1) Elliptic Prime Curve 384 bit (EC_secp384r1) Elliptic Prime Curve 521
bit (EC_secp521r1) The certificate must be a valid SSL/TLS X.509 version 3 certificate
with FQDN or IP address specified and information about the issuer.
- `"Domain"`: The domain of the storage system that is used for file transfers. There are
two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File
System (Amazon EFS). The default value is S3. After the server is created, the domain
cannot be changed.
- `"EndpointDetails"`: The virtual private cloud (VPC) endpoint settings that are
configured for your server. When you host your endpoint within your VPC, you can make your
endpoint accessible only to resources within your VPC, or you can attach Elastic IP
addresses and make your endpoint accessible to clients over the internet. Your VPC's
default security groups are automatically assigned to your endpoint.
- `"EndpointType"`: The type of endpoint that you want your server to use. You can choose
to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC.
With an endpoint that is hosted in a VPC, you can restrict access to your server and
resources only within your VPC or choose to make it internet facing by attaching Elastic IP
addresses directly to it. After May 19, 2021, you won't be able to create a server using
EndpointType=VPC_ENDPOINT in your Amazon Web Services account if your account hasn't
already done so before May 19, 2021. If you have already created servers with
EndpointType=VPC_ENDPOINT in your Amazon Web Services account on or before May 19, 2021,
you will not be affected. After this date, use EndpointType=VPC. For more information, see
https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vp
c-endpoint. It is recommended that you use VPC as the EndpointType. With this endpoint
type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP
included) with your server's endpoint and use VPC security groups to restrict traffic by
the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.
- `"HostKey"`: The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server.
You can add multiple host keys, in case you want to rotate keys, or have a set of active
keys that use different algorithms. Use the following command to generate an RSA 2048 bit
key with no passphrase: ssh-keygen -t rsa -b 2048 -N \"\" -m PEM -f my-new-server-key. Use
a minimum value of 2048 for the -b option. You can create a stronger key by using 3072 or
4096. Use the following command to generate an ECDSA 256 bit key with no passphrase:
ssh-keygen -t ecdsa -b 256 -N \"\" -m PEM -f my-new-server-key. Valid values for the -b
option for ECDSA are 256, 384, and 521. Use the following command to generate an ED25519
key with no passphrase: ssh-keygen -t ed25519 -N \"\" -f my-new-server-key. For all of
these commands, you can replace my-new-server-key with a string of your choice. If you
aren't planning to migrate existing users from an existing SFTP-enabled server to a new
server, don't update the host key. Accidentally changing a server's host key can be
disruptive. For more information, see Manage host keys for your SFTP-enabled server in the
Transfer Family User Guide.
- `"IdentityProviderDetails"`: Required when IdentityProviderType is set to
AWS_DIRECTORY_SERVICE, Amazon Web Services_LAMBDA or API_GATEWAY. Accepts an array
containing all of the information required to use a directory in AWS_DIRECTORY_SERVICE or
invoke a customer-supplied authentication API, including the API Gateway URL. Not required
when IdentityProviderType is set to SERVICE_MANAGED.
- `"IdentityProviderType"`: The mode of authentication for a server. The default value is
SERVICE_MANAGED, which allows you to store and access user credentials within the Transfer
Family service. Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in
Directory Service for Microsoft Active Directory or Microsoft Active Directory in your
on-premises environment or in Amazon Web Services using AD Connector. This option also
requires you to provide a Directory ID by using the IdentityProviderDetails parameter. Use
the API_GATEWAY value to integrate with an identity provider of your choosing. The
API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call for
authentication by using the IdentityProviderDetails parameter. Use the AWS_LAMBDA value to
directly use an Lambda function as your identity provider. If you choose this value, you
must specify the ARN for the Lambda function in the Function parameter for the
IdentityProviderDetails data type.
- `"LoggingRole"`: The Amazon Resource Name (ARN) of the Identity and Access Management
(IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or
Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.
- `"PostAuthenticationLoginBanner"`: Specifies a string to display when users connect to a
server. This string is displayed after the user authenticates. The SFTP protocol does not
support post-authentication display banners.
- `"PreAuthenticationLoginBanner"`: Specifies a string to display when users connect to a
server. This string is displayed before the user authenticates. For example, the following
banner displays details about using the system: This system is for the use of authorized
users only. Individuals using this computer system without authority, or in excess of their
authority, are subject to having all of their activities on this system monitored and
recorded by system personnel.
- `"ProtocolDetails"`: The protocol settings that are configured for your server. To
indicate passive mode (for FTP and FTPS protocols), use the PassiveIp parameter. Enter a
single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or
load balancer. To ignore the error that is generated when the client attempts to use the
SETSTAT command on a file that you are uploading to an Amazon S3 bucket, use the
SetStatOption parameter. To have the Transfer Family server ignore the SETSTAT command and
upload files without needing to make any changes to your SFTP client, set the value to
ENABLE_NO_OP. If you set the SetStatOption parameter to ENABLE_NO_OP, Transfer Family
generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client
is making a SETSTAT call. To determine whether your Transfer Family server resumes
recent, negotiated sessions through a unique session ID, use the TlsSessionResumptionMode
parameter. As2Transports indicates the transport method for the AS2 messages. Currently,
only HTTP is supported.
- `"Protocols"`: Specifies the file transfer protocol or protocols over which your file
transfer protocol client can connect to your server's endpoint. The available protocols
are: SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH FTPS
(File Transfer Protocol Secure): File transfer with TLS encryption FTP (File Transfer
Protocol): Unencrypted file transfer AS2 (Applicability Statement 2): used for
transporting structured business-to-business data If you select FTPS, you must choose
a certificate stored in Certificate Manager (ACM) which is used to identify your server
when clients connect to it over FTPS. If Protocol includes either FTP or FTPS, then the
EndpointType must be VPC and the IdentityProviderType must be either AWS_DIRECTORY_SERVICE,
AWS_LAMBDA, or API_GATEWAY. If Protocol includes FTP, then AddressAllocationIds cannot be
associated. If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and
the IdentityProviderType can be set any of the supported identity types: SERVICE_MANAGED,
AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY. If Protocol includes AS2, then the
EndpointType must be VPC, and domain must be Amazon S3.
- `"S3StorageOptions"`: Specifies whether or not performance for your Amazon S3 directories
is optimized. This is disabled by default. By default, home directory mappings have a TYPE
of DIRECTORY. If you enable this option, you would then need to explicitly set the
HomeDirectoryMapEntry Type to FILE if you want a mapping to have a file target.
- `"SecurityPolicyName"`: Specifies the name of the security policy for the server.
- `"StructuredLogDestinations"`: Specifies the log groups to which your server logs are
sent. To specify a log group, you must provide the ARN for an existing log group. In this
case, the format of the log group is as follows:
arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:* For example,
arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:* If you have previously
specified a log group for a server, you can clear it, and in effect turn off structured
logging, by providing an empty value for this parameter in an update-server call. For
example: update-server --server-id s-1234567890abcdef0 --structured-log-destinations
- `"Tags"`: Key-value pairs that can be used to group and search for servers.
- `"WorkflowDetails"`: Specifies the workflow ID for the workflow to assign and the
execution role that's used for executing the workflow. In addition to a workflow to execute
when a file is uploaded completely, WorkflowDetails can also contain a workflow ID (and
execution role) for a workflow to execute on partial upload. A partial upload occurs when
the server session disconnects while the file is still being uploaded.
"""
function create_server(; aws_config::AbstractAWSConfig=global_aws_config())
return transfer("CreateServer"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function create_server(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"CreateServer", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
create_user(role, server_id, user_name)
create_user(role, server_id, user_name, params::Dict{String,<:Any})
Creates a user and associates them with an existing file transfer protocol-enabled server.
You can only create and associate users with servers that have the IdentityProviderType set
to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the
home directory, store the user's public key, and assign the user's Identity and Access
Management (IAM) role. You can also optionally add a session policy, and assign metadata
with tags that can be used to group and search for users.
# Arguments
- `role`: The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role
that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The
policies attached to this role determine the level of access that you want to provide your
users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file
system. The IAM role should also contain a trust relationship that allows the server to
access your resources when servicing your users' transfer requests.
- `server_id`: A system-assigned unique identifier for a server instance. This is the
specific server that you added your user to.
- `user_name`: A unique string that identifies a user and is associated with a ServerId.
This user name must be a minimum of 3 and a maximum of 100 characters long. The following
are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen '-', period '.', and at sign
'@'. The user name can't start with a hyphen, period, or at sign.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"HomeDirectory"`: The landing directory (folder) for a user when they log in to the
server using the client. A HomeDirectory example is /bucket_name/home/mydirectory. The
HomeDirectory parameter is only used if HomeDirectoryType is set to PATH.
- `"HomeDirectoryMappings"`: Logical directory mappings that specify what Amazon S3 or
Amazon EFS paths and keys should be visible to your user and how you want to make them
visible. You must specify the Entry and Target pair, where Entry shows how the path is made
visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a
target, it is displayed as is. You also must ensure that your Identity and Access
Management (IAM) role provides access to paths in Target. This value can be set only when
HomeDirectoryType is set to LOGICAL. The following is an Entry and Target pair example. [
{ \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ] In most
cases, you can use this value instead of the session policy to lock your user down to the
designated home directory (\"chroot\"). To do this, you can set Entry to / and set Target
to the value the user should see for their home directory when they log in. The following
is an Entry and Target pair example for chroot. [ { \"Entry\": \"/\", \"Target\":
\"/bucket_name/home/mydirectory\" } ]
- `"HomeDirectoryType"`: The type of landing directory (folder) that you want your users'
home directory to be when they log in to the server. If you set it to PATH, the user will
see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol
clients. If you set it to LOGICAL, you need to provide mappings in the
HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to
your users. If HomeDirectoryType is LOGICAL, you must provide mappings, using the
HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is PATH, you
provide an absolute path using the HomeDirectory parameter. You cannot have both
HomeDirectory and HomeDirectoryMappings in your template.
- `"Policy"`: A session policy for your user so that you can use the same Identity and
Access Management (IAM) role across multiple users. This policy scopes down a user's access
to portions of their Amazon S3 bucket. Variables that you can use inside this policy
include {Transfer:UserName}, {Transfer:HomeDirectory}, and {Transfer:HomeBucket}. This
policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use
session policies. For session policies, Transfer Family stores the policy as a JSON blob,
instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob
and pass it in the Policy argument. For an example of a session policy, see Example session
policy. For more information, see AssumeRole in the Amazon Web Services Security Token
Service API Reference.
- `"PosixProfile"`: Specifies the full POSIX identity, including user ID (Uid), group ID
(Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to
your Amazon EFS file systems. The POSIX permissions that are set on files and directories
in Amazon EFS determine the level of access your users get when transferring files into and
out of your Amazon EFS file systems.
- `"SshPublicKeyBody"`: The public portion of the Secure Shell (SSH) key used to
authenticate the user to the server. The three standard SSH public key format elements are
<key type>, <body base64>, and an optional <comment>, with spaces between
each element. Transfer Family accepts RSA, ECDSA, and ED25519 keys. For RSA keys, the key
type is ssh-rsa. For ED25519 keys, the key type is ssh-ed25519. For ECDSA keys, the key
type is either ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending
on the size of the key you generated.
- `"Tags"`: Key-value pairs that can be used to group and search for users. Tags are
metadata attached to users for any purpose.
"""
function create_user(
Role, ServerId, UserName; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"CreateUser",
Dict{String,Any}("Role" => Role, "ServerId" => ServerId, "UserName" => UserName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_user(
Role,
ServerId,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"CreateUser",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Role" => Role, "ServerId" => ServerId, "UserName" => UserName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_workflow(steps)
create_workflow(steps, params::Dict{String,<:Any})
Allows you to create a workflow with specified steps and step details the workflow invokes
after file transfer completes. After creating a workflow, you can associate the workflow
created with any transfer servers by specifying the workflow-details field in CreateServer
and UpdateServer operations.
# Arguments
- `steps`: Specifies the details for the steps that are in the specified workflow. The
TYPE specifies which of the following actions is being taken for this step. COPY -
Copy the file to another location. CUSTOM - Perform a custom step with an Lambda
function target. DECRYPT - Decrypt a file that was encrypted before it was uploaded.
DELETE - Delete the file. TAG - Add a tag to the file. Currently, copying and
tagging are supported only on S3. For file location, you specify either the Amazon S3
bucket and key, or the Amazon EFS file system ID and path.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A textual description for the workflow.
- `"OnExceptionSteps"`: Specifies the steps (actions) to take if errors are encountered
during execution of the workflow. For custom steps, the Lambda function needs to send
FAILURE to the call back API to kick off the exception steps. Additionally, if the Lambda
does not send SUCCESS before it times out, the exception steps are executed.
- `"Tags"`: Key-value pairs that can be used to group and search for workflows. Tags are
metadata attached to workflows for any purpose.
"""
function create_workflow(Steps; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"CreateWorkflow",
Dict{String,Any}("Steps" => Steps);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_workflow(
Steps, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"CreateWorkflow",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Steps" => Steps), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_access(external_id, server_id)
delete_access(external_id, server_id, params::Dict{String,<:Any})
Allows you to delete the access specified in the ServerID and ExternalID parameters.
# Arguments
- `external_id`: A unique identifier that is required to identify specific groups within
your directory. The users of the group that you associate have access to your Amazon S3 or
Amazon EFS resources over the enabled protocols using Transfer Family. If you know the
group name, you can view the SID values by running the following command using Windows
PowerShell. Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * |
Select SamAccountName,ObjectSid In that command, replace YourGroupName with the name of
your Active Directory group. The regular expression used to validate this parameter is a
string of characters consisting of uppercase and lowercase alphanumeric characters with no
spaces. You can also include underscores or any of the following characters: =,.@:/-
- `server_id`: A system-assigned unique identifier for a server that has this user assigned.
"""
function delete_access(
ExternalId, ServerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"DeleteAccess",
Dict{String,Any}("ExternalId" => ExternalId, "ServerId" => ServerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_access(
ExternalId,
ServerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"DeleteAccess",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ExternalId" => ExternalId, "ServerId" => ServerId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_agreement(agreement_id, server_id)
delete_agreement(agreement_id, server_id, params::Dict{String,<:Any})
Delete the agreement that's specified in the provided AgreementId.
# Arguments
- `agreement_id`: A unique identifier for the agreement. This identifier is returned when
you create an agreement.
- `server_id`: The server identifier associated with the agreement that you are deleting.
"""
function delete_agreement(
AgreementId, ServerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"DeleteAgreement",
Dict{String,Any}("AgreementId" => AgreementId, "ServerId" => ServerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_agreement(
AgreementId,
ServerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"DeleteAgreement",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AgreementId" => AgreementId, "ServerId" => ServerId),
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 certificate that's specified in the CertificateId parameter.
# Arguments
- `certificate_id`: The identifier of the certificate object that you are deleting.
"""
function delete_certificate(
CertificateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"DeleteCertificate",
Dict{String,Any}("CertificateId" => 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 transfer(
"DeleteCertificate",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("CertificateId" => CertificateId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_connector(connector_id)
delete_connector(connector_id, params::Dict{String,<:Any})
Deletes the connector that's specified in the provided ConnectorId.
# Arguments
- `connector_id`: The unique identifier for the connector.
"""
function delete_connector(ConnectorId; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"DeleteConnector",
Dict{String,Any}("ConnectorId" => ConnectorId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_connector(
ConnectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"DeleteConnector",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ConnectorId" => ConnectorId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_host_key(host_key_id, server_id)
delete_host_key(host_key_id, server_id, params::Dict{String,<:Any})
Deletes the host key that's specified in the HostKeyId parameter.
# Arguments
- `host_key_id`: The identifier of the host key that you are deleting.
- `server_id`: The identifier of the server that contains the host key that you are
deleting.
"""
function delete_host_key(
HostKeyId, ServerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"DeleteHostKey",
Dict{String,Any}("HostKeyId" => HostKeyId, "ServerId" => ServerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_host_key(
HostKeyId,
ServerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"DeleteHostKey",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("HostKeyId" => HostKeyId, "ServerId" => ServerId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_profile(profile_id)
delete_profile(profile_id, params::Dict{String,<:Any})
Deletes the profile that's specified in the ProfileId parameter.
# Arguments
- `profile_id`: The identifier of the profile that you are deleting.
"""
function delete_profile(ProfileId; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"DeleteProfile",
Dict{String,Any}("ProfileId" => ProfileId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_profile(
ProfileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"DeleteProfile",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ProfileId" => ProfileId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_server(server_id)
delete_server(server_id, params::Dict{String,<:Any})
Deletes the file transfer protocol-enabled server that you specify. No response returns
from this operation.
# Arguments
- `server_id`: A unique system-assigned identifier for a server instance.
"""
function delete_server(ServerId; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"DeleteServer",
Dict{String,Any}("ServerId" => ServerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_server(
ServerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"DeleteServer",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ServerId" => ServerId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_ssh_public_key(server_id, ssh_public_key_id, user_name)
delete_ssh_public_key(server_id, ssh_public_key_id, user_name, params::Dict{String,<:Any})
Deletes a user's Secure Shell (SSH) public key.
# Arguments
- `server_id`: A system-assigned unique identifier for a file transfer protocol-enabled
server instance that has the user assigned to it.
- `ssh_public_key_id`: A unique identifier used to reference your user's specific SSH key.
- `user_name`: A unique string that identifies a user whose public key is being deleted.
"""
function delete_ssh_public_key(
ServerId, SshPublicKeyId, UserName; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"DeleteSshPublicKey",
Dict{String,Any}(
"ServerId" => ServerId,
"SshPublicKeyId" => SshPublicKeyId,
"UserName" => UserName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_ssh_public_key(
ServerId,
SshPublicKeyId,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"DeleteSshPublicKey",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ServerId" => ServerId,
"SshPublicKeyId" => SshPublicKeyId,
"UserName" => UserName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_user(server_id, user_name)
delete_user(server_id, user_name, params::Dict{String,<:Any})
Deletes the user belonging to a file transfer protocol-enabled server you specify. No
response returns from this operation. When you delete a user from a server, the user's
information is lost.
# Arguments
- `server_id`: A system-assigned unique identifier for a server instance that has the user
assigned to it.
- `user_name`: A unique string that identifies a user that is being deleted from a server.
"""
function delete_user(ServerId, UserName; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"DeleteUser",
Dict{String,Any}("ServerId" => ServerId, "UserName" => UserName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_user(
ServerId,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"DeleteUser",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ServerId" => ServerId, "UserName" => UserName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_workflow(workflow_id)
delete_workflow(workflow_id, params::Dict{String,<:Any})
Deletes the specified workflow.
# Arguments
- `workflow_id`: A unique identifier for the workflow.
"""
function delete_workflow(WorkflowId; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"DeleteWorkflow",
Dict{String,Any}("WorkflowId" => WorkflowId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_workflow(
WorkflowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"DeleteWorkflow",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("WorkflowId" => WorkflowId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_access(external_id, server_id)
describe_access(external_id, server_id, params::Dict{String,<:Any})
Describes the access that is assigned to the specific file transfer protocol-enabled
server, as identified by its ServerId property and its ExternalId. The response from this
call returns the properties of the access that is associated with the ServerId value that
was specified.
# Arguments
- `external_id`: A unique identifier that is required to identify specific groups within
your directory. The users of the group that you associate have access to your Amazon S3 or
Amazon EFS resources over the enabled protocols using Transfer Family. If you know the
group name, you can view the SID values by running the following command using Windows
PowerShell. Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * |
Select SamAccountName,ObjectSid In that command, replace YourGroupName with the name of
your Active Directory group. The regular expression used to validate this parameter is a
string of characters consisting of uppercase and lowercase alphanumeric characters with no
spaces. You can also include underscores or any of the following characters: =,.@:/-
- `server_id`: A system-assigned unique identifier for a server that has this access
assigned.
"""
function describe_access(
ExternalId, ServerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"DescribeAccess",
Dict{String,Any}("ExternalId" => ExternalId, "ServerId" => ServerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_access(
ExternalId,
ServerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"DescribeAccess",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ExternalId" => ExternalId, "ServerId" => ServerId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_agreement(agreement_id, server_id)
describe_agreement(agreement_id, server_id, params::Dict{String,<:Any})
Describes the agreement that's identified by the AgreementId.
# Arguments
- `agreement_id`: A unique identifier for the agreement. This identifier is returned when
you create an agreement.
- `server_id`: The server identifier that's associated with the agreement.
"""
function describe_agreement(
AgreementId, ServerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"DescribeAgreement",
Dict{String,Any}("AgreementId" => AgreementId, "ServerId" => ServerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_agreement(
AgreementId,
ServerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"DescribeAgreement",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AgreementId" => AgreementId, "ServerId" => ServerId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_certificate(certificate_id)
describe_certificate(certificate_id, params::Dict{String,<:Any})
Describes the certificate that's identified by the CertificateId.
# Arguments
- `certificate_id`: An array of identifiers for the imported certificates. You use this
identifier for working with profiles and partner profiles.
"""
function describe_certificate(
CertificateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"DescribeCertificate",
Dict{String,Any}("CertificateId" => 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 transfer(
"DescribeCertificate",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("CertificateId" => CertificateId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_connector(connector_id)
describe_connector(connector_id, params::Dict{String,<:Any})
Describes the connector that's identified by the ConnectorId.
# Arguments
- `connector_id`: The unique identifier for the connector.
"""
function describe_connector(ConnectorId; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"DescribeConnector",
Dict{String,Any}("ConnectorId" => ConnectorId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_connector(
ConnectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"DescribeConnector",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ConnectorId" => ConnectorId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_execution(execution_id, workflow_id)
describe_execution(execution_id, workflow_id, params::Dict{String,<:Any})
You can use DescribeExecution to check the details of the execution of the specified
workflow. This API call only returns details for in-progress workflows. If you provide an
ID for an execution that is not in progress, or if the execution doesn't match the
specified workflow ID, you receive a ResourceNotFound exception.
# Arguments
- `execution_id`: A unique identifier for the execution of a workflow.
- `workflow_id`: A unique identifier for the workflow.
"""
function describe_execution(
ExecutionId, WorkflowId; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"DescribeExecution",
Dict{String,Any}("ExecutionId" => ExecutionId, "WorkflowId" => WorkflowId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_execution(
ExecutionId,
WorkflowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"DescribeExecution",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ExecutionId" => ExecutionId, "WorkflowId" => WorkflowId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_host_key(host_key_id, server_id)
describe_host_key(host_key_id, server_id, params::Dict{String,<:Any})
Returns the details of the host key that's specified by the HostKeyId and ServerId.
# Arguments
- `host_key_id`: The identifier of the host key that you want described.
- `server_id`: The identifier of the server that contains the host key that you want
described.
"""
function describe_host_key(
HostKeyId, ServerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"DescribeHostKey",
Dict{String,Any}("HostKeyId" => HostKeyId, "ServerId" => ServerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_host_key(
HostKeyId,
ServerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"DescribeHostKey",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("HostKeyId" => HostKeyId, "ServerId" => ServerId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_profile(profile_id)
describe_profile(profile_id, params::Dict{String,<:Any})
Returns the details of the profile that's specified by the ProfileId.
# Arguments
- `profile_id`: The identifier of the profile that you want described.
"""
function describe_profile(ProfileId; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"DescribeProfile",
Dict{String,Any}("ProfileId" => ProfileId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_profile(
ProfileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"DescribeProfile",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ProfileId" => ProfileId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_security_policy(security_policy_name)
describe_security_policy(security_policy_name, params::Dict{String,<:Any})
Describes the security policy that is attached to your server or SFTP connector. The
response contains a description of the security policy's properties. For more information
about security policies, see Working with security policies for servers or Working with
security policies for SFTP connectors.
# Arguments
- `security_policy_name`: Specify the text name of the security policy for which you want
the details.
"""
function describe_security_policy(
SecurityPolicyName; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"DescribeSecurityPolicy",
Dict{String,Any}("SecurityPolicyName" => SecurityPolicyName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_security_policy(
SecurityPolicyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"DescribeSecurityPolicy",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("SecurityPolicyName" => SecurityPolicyName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_server(server_id)
describe_server(server_id, params::Dict{String,<:Any})
Describes a file transfer protocol-enabled server that you specify by passing the ServerId
parameter. The response contains a description of a server's properties. When you set
EndpointType to VPC, the response will contain the EndpointDetails.
# Arguments
- `server_id`: A system-assigned unique identifier for a server.
"""
function describe_server(ServerId; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"DescribeServer",
Dict{String,Any}("ServerId" => ServerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_server(
ServerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"DescribeServer",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ServerId" => ServerId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_user(server_id, user_name)
describe_user(server_id, user_name, params::Dict{String,<:Any})
Describes the user assigned to the specific file transfer protocol-enabled server, as
identified by its ServerId property. The response from this call returns the properties of
the user associated with the ServerId value that was specified.
# Arguments
- `server_id`: A system-assigned unique identifier for a server that has this user assigned.
- `user_name`: The name of the user assigned to one or more servers. User names are part of
the sign-in credentials to use the Transfer Family service and perform file transfer tasks.
"""
function describe_user(
ServerId, UserName; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"DescribeUser",
Dict{String,Any}("ServerId" => ServerId, "UserName" => UserName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_user(
ServerId,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"DescribeUser",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ServerId" => ServerId, "UserName" => UserName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_workflow(workflow_id)
describe_workflow(workflow_id, params::Dict{String,<:Any})
Describes the specified workflow.
# Arguments
- `workflow_id`: A unique identifier for the workflow.
"""
function describe_workflow(WorkflowId; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"DescribeWorkflow",
Dict{String,Any}("WorkflowId" => WorkflowId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_workflow(
WorkflowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"DescribeWorkflow",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("WorkflowId" => WorkflowId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
import_certificate(certificate, usage)
import_certificate(certificate, usage, params::Dict{String,<:Any})
Imports the signing and encryption certificates that you need to create local (AS2)
profiles and partner profiles.
# Arguments
- `certificate`: For the CLI, provide a file path for a certificate in URI format. For
example, --certificate file://encryption-cert.pem. Alternatively, you can provide the raw
content. For the SDK, specify the raw content of a certificate file. For example,
--certificate \"`cat encryption-cert.pem`\".
- `usage`: Specifies how this certificate is used. It can be used in the following ways:
SIGNING: For signing AS2 messages ENCRYPTION: For encrypting AS2 messages TLS: For
securing AS2 communications sent over HTTPS
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ActiveDate"`: An optional date that specifies when the certificate becomes active.
- `"CertificateChain"`: An optional list of certificates that make up the chain for the
certificate that's being imported.
- `"Description"`: A short description that helps identify the certificate.
- `"InactiveDate"`: An optional date that specifies when the certificate becomes inactive.
- `"PrivateKey"`: For the CLI, provide a file path for a private key in URI format.For
example, --private-key file://encryption-key.pem. Alternatively, you can provide the raw
content of the private key file. For the SDK, specify the raw content of a private key
file. For example, --private-key \"`cat encryption-key.pem`\"
- `"Tags"`: Key-value pairs that can be used to group and search for certificates.
"""
function import_certificate(
Certificate, Usage; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"ImportCertificate",
Dict{String,Any}("Certificate" => Certificate, "Usage" => Usage);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function import_certificate(
Certificate,
Usage,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"ImportCertificate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Certificate" => Certificate, "Usage" => Usage),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
import_host_key(host_key_body, server_id)
import_host_key(host_key_body, server_id, params::Dict{String,<:Any})
Adds a host key to the server that's specified by the ServerId parameter.
# Arguments
- `host_key_body`: The private key portion of an SSH key pair. Transfer Family accepts RSA,
ECDSA, and ED25519 keys.
- `server_id`: The identifier of the server that contains the host key that you are
importing.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The text description that identifies this host key.
- `"Tags"`: Key-value pairs that can be used to group and search for host keys.
"""
function import_host_key(
HostKeyBody, ServerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"ImportHostKey",
Dict{String,Any}("HostKeyBody" => HostKeyBody, "ServerId" => ServerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function import_host_key(
HostKeyBody,
ServerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"ImportHostKey",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("HostKeyBody" => HostKeyBody, "ServerId" => ServerId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
import_ssh_public_key(server_id, ssh_public_key_body, user_name)
import_ssh_public_key(server_id, ssh_public_key_body, user_name, params::Dict{String,<:Any})
Adds a Secure Shell (SSH) public key to a Transfer Family user identified by a UserName
value assigned to the specific file transfer protocol-enabled server, identified by
ServerId. The response returns the UserName value, the ServerId value, and the name of the
SshPublicKeyId.
# Arguments
- `server_id`: A system-assigned unique identifier for a server.
- `ssh_public_key_body`: The public key portion of an SSH key pair. Transfer Family accepts
RSA, ECDSA, and ED25519 keys.
- `user_name`: The name of the Transfer Family user that is assigned to one or more servers.
"""
function import_ssh_public_key(
ServerId, SshPublicKeyBody, UserName; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"ImportSshPublicKey",
Dict{String,Any}(
"ServerId" => ServerId,
"SshPublicKeyBody" => SshPublicKeyBody,
"UserName" => UserName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function import_ssh_public_key(
ServerId,
SshPublicKeyBody,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"ImportSshPublicKey",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ServerId" => ServerId,
"SshPublicKeyBody" => SshPublicKeyBody,
"UserName" => UserName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_accesses(server_id)
list_accesses(server_id, params::Dict{String,<:Any})
Lists the details for all the accesses you have on your server.
# Arguments
- `server_id`: A system-assigned unique identifier for a server that has users assigned to
it.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Specifies the maximum number of access SIDs to return.
- `"NextToken"`: When you can get additional results from the ListAccesses call, a
NextToken parameter is returned in the output. You can then pass in a subsequent command to
the NextToken parameter to continue listing additional accesses.
"""
function list_accesses(ServerId; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"ListAccesses",
Dict{String,Any}("ServerId" => ServerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_accesses(
ServerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"ListAccesses",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ServerId" => ServerId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_agreements(server_id)
list_agreements(server_id, params::Dict{String,<:Any})
Returns a list of the agreements for the server that's identified by the ServerId that you
supply. If you want to limit the results to a certain number, supply a value for the
MaxResults parameter. If you ran the command previously and received a value for NextToken,
you can supply that value to continue listing agreements from where you left off.
# Arguments
- `server_id`: The identifier of the server for which you want a list of agreements.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of agreements to return.
- `"NextToken"`: When you can get additional results from the ListAgreements call, a
NextToken parameter is returned in the output. You can then pass in a subsequent command to
the NextToken parameter to continue listing additional agreements.
"""
function list_agreements(ServerId; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"ListAgreements",
Dict{String,Any}("ServerId" => ServerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_agreements(
ServerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"ListAgreements",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ServerId" => ServerId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_certificates()
list_certificates(params::Dict{String,<:Any})
Returns a list of the current certificates that have been imported into Transfer Family. If
you want to limit the results to a certain number, supply a value for the MaxResults
parameter. If you ran the command previously and received a value for the NextToken
parameter, you can supply that value to continue listing certificates from where you left
off.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of certificates to return.
- `"NextToken"`: When you can get additional results from the ListCertificates call, a
NextToken parameter is returned in the output. You can then pass in a subsequent command to
the NextToken parameter to continue listing additional certificates.
"""
function list_certificates(; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"ListCertificates"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_certificates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"ListCertificates", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_connectors()
list_connectors(params::Dict{String,<:Any})
Lists the connectors for the specified Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of connectors to return.
- `"NextToken"`: When you can get additional results from the ListConnectors call, a
NextToken parameter is returned in the output. You can then pass in a subsequent command to
the NextToken parameter to continue listing additional connectors.
"""
function list_connectors(; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"ListConnectors"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_connectors(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"ListConnectors", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_executions(workflow_id)
list_executions(workflow_id, params::Dict{String,<:Any})
Lists all in-progress executions for the specified workflow. If the specified workflow ID
cannot be found, ListExecutions returns a ResourceNotFound exception.
# Arguments
- `workflow_id`: A unique identifier for the workflow.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Specifies the maximum number of executions to return.
- `"NextToken"`: ListExecutions returns the NextToken parameter in the output. You can
then pass the NextToken parameter in a subsequent command to continue listing additional
executions. This is useful for pagination, for instance. If you have 100 executions for a
workflow, you might only want to list first 10. If so, call the API by specifying the
max-results: aws transfer list-executions --max-results 10 This returns details for the
first 10 executions, as well as the pointer (NextToken) to the eleventh execution. You can
now call the API again, supplying the NextToken value you received: aws transfer
list-executions --max-results 10 --next-token somePointerReturnedFromPreviousListResult
This call returns the next 10 executions, the 11th through the 20th. You can then repeat
the call until the details for all 100 executions have been returned.
"""
function list_executions(WorkflowId; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"ListExecutions",
Dict{String,Any}("WorkflowId" => WorkflowId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_executions(
WorkflowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"ListExecutions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("WorkflowId" => WorkflowId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_host_keys(server_id)
list_host_keys(server_id, params::Dict{String,<:Any})
Returns a list of host keys for the server that's specified by the ServerId parameter.
# Arguments
- `server_id`: The identifier of the server that contains the host keys that you want to
view.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of host keys to return.
- `"NextToken"`: When there are additional results that were not returned, a NextToken
parameter is returned. You can use that value for a subsequent call to ListHostKeys to
continue listing results.
"""
function list_host_keys(ServerId; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"ListHostKeys",
Dict{String,Any}("ServerId" => ServerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_host_keys(
ServerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"ListHostKeys",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ServerId" => ServerId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_profiles()
list_profiles(params::Dict{String,<:Any})
Returns a list of the profiles for your system. If you want to limit the results to a
certain number, supply a value for the MaxResults parameter. If you ran the command
previously and received a value for NextToken, you can supply that value to continue
listing profiles from where you left off.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of profiles to return.
- `"NextToken"`: When there are additional results that were not returned, a NextToken
parameter is returned. You can use that value for a subsequent call to ListProfiles to
continue listing results.
- `"ProfileType"`: Indicates whether to list only LOCAL type profiles or only PARTNER type
profiles. If not supplied in the request, the command lists all types of profiles.
"""
function list_profiles(; aws_config::AbstractAWSConfig=global_aws_config())
return transfer("ListProfiles"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_profiles(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"ListProfiles", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_security_policies()
list_security_policies(params::Dict{String,<:Any})
Lists the security policies that are attached to your servers and SFTP connectors. For more
information about security policies, see Working with security policies for servers or
Working with security policies for SFTP connectors.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Specifies the number of security policies to return as a response to the
ListSecurityPolicies query.
- `"NextToken"`: When additional results are obtained from the ListSecurityPolicies
command, a NextToken parameter is returned in the output. You can then pass the NextToken
parameter in a subsequent command to continue listing additional security policies.
"""
function list_security_policies(; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"ListSecurityPolicies"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_security_policies(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"ListSecurityPolicies",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_servers()
list_servers(params::Dict{String,<:Any})
Lists the file transfer protocol-enabled servers that are associated with your Amazon Web
Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Specifies the number of servers to return as a response to the
ListServers query.
- `"NextToken"`: When additional results are obtained from the ListServers command, a
NextToken parameter is returned in the output. You can then pass the NextToken parameter in
a subsequent command to continue listing additional servers.
"""
function list_servers(; aws_config::AbstractAWSConfig=global_aws_config())
return transfer("ListServers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_servers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"ListServers", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tags_for_resource(arn)
list_tags_for_resource(arn, params::Dict{String,<:Any})
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The
resource can be a user, server, or role.
# Arguments
- `arn`: Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN
is an identifier for a specific Amazon Web Services resource, such as a server, user, or
role.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Specifies the number of tags to return as a response to the
ListTagsForResource request.
- `"NextToken"`: When you request additional results from the ListTagsForResource
operation, a NextToken parameter is returned in the input. You can then pass in a
subsequent command to the NextToken parameter to continue listing additional tags.
"""
function list_tags_for_resource(Arn; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"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 transfer(
"ListTagsForResource",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Arn" => Arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_users(server_id)
list_users(server_id, params::Dict{String,<:Any})
Lists the users for a file transfer protocol-enabled server that you specify by passing the
ServerId parameter.
# Arguments
- `server_id`: A system-assigned unique identifier for a server that has users assigned to
it.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Specifies the number of users to return as a response to the ListUsers
request.
- `"NextToken"`: If there are additional results from the ListUsers call, a NextToken
parameter is returned in the output. You can then pass the NextToken to a subsequent
ListUsers command, to continue listing additional users.
"""
function list_users(ServerId; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"ListUsers",
Dict{String,Any}("ServerId" => ServerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_users(
ServerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"ListUsers",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ServerId" => ServerId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_workflows()
list_workflows(params::Dict{String,<:Any})
Lists all workflows associated with your Amazon Web Services account for your current
region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Specifies the maximum number of workflows to return.
- `"NextToken"`: ListWorkflows returns the NextToken parameter in the output. You can then
pass the NextToken parameter in a subsequent command to continue listing additional
workflows.
"""
function list_workflows(; aws_config::AbstractAWSConfig=global_aws_config())
return transfer("ListWorkflows"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_workflows(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"ListWorkflows", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
send_workflow_step_state(execution_id, status, token, workflow_id)
send_workflow_step_state(execution_id, status, token, workflow_id, params::Dict{String,<:Any})
Sends a callback for asynchronous custom steps. The ExecutionId, WorkflowId, and Token are
passed to the target resource during execution of a custom step of a workflow. You must
include those with their callback as well as providing a status.
# Arguments
- `execution_id`: A unique identifier for the execution of a workflow.
- `status`: Indicates whether the specified step succeeded or failed.
- `token`: Used to distinguish between multiple callbacks for multiple Lambda steps within
the same execution.
- `workflow_id`: A unique identifier for the workflow.
"""
function send_workflow_step_state(
ExecutionId,
Status,
Token,
WorkflowId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"SendWorkflowStepState",
Dict{String,Any}(
"ExecutionId" => ExecutionId,
"Status" => Status,
"Token" => Token,
"WorkflowId" => WorkflowId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_workflow_step_state(
ExecutionId,
Status,
Token,
WorkflowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"SendWorkflowStepState",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ExecutionId" => ExecutionId,
"Status" => Status,
"Token" => Token,
"WorkflowId" => WorkflowId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_directory_listing(connector_id, output_directory_path, remote_directory_path)
start_directory_listing(connector_id, output_directory_path, remote_directory_path, params::Dict{String,<:Any})
Retrieves a list of the contents of a directory from a remote SFTP server. You specify the
connector ID, the output path, and the remote directory path. You can also specify the
optional MaxItems value to control the maximum number of items that are listed from the
remote directory. This API returns a list of all files and directories in the remote
directory (up to the maximum value), but does not return files or folders in
sub-directories. That is, it only returns a list of files and directories one-level deep.
After you receive the listing file, you can provide the files that you want to transfer to
the RetrieveFilePaths parameter of the StartFileTransfer API call. The naming convention
for the output file is connector-ID-listing-ID.json. The output file contains the
following information: filePath: the complete path of a remote file, relative to the
directory of the listing request for your SFTP connector on the remote server.
modifiedTimestamp: the last time the file was modified, in UTC time format. This field is
optional. If the remote file attributes don't contain a timestamp, it is omitted from the
file listing. size: the size of the file, in bytes. This field is optional. If the
remote file attributes don't contain a file size, it is omitted from the file listing.
path: the complete path of a remote directory, relative to the directory of the listing
request for your SFTP connector on the remote server. truncated: a flag indicating
whether the list output contains all of the items contained in the remote directory or not.
If your Truncated output value is true, you can increase the value provided in the optional
max-items input attribute to be able to list more items (up to the maximum allowed list
size of 10,000 items).
# Arguments
- `connector_id`: The unique identifier for the connector.
- `output_directory_path`: Specifies the path (bucket and prefix) in Amazon S3 storage to
store the results of the directory listing.
- `remote_directory_path`: Specifies the directory on the remote SFTP server for which you
want to list its contents.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxItems"`: An optional parameter where you can specify the maximum number of
file/directory names to retrieve. The default value is 1,000.
"""
function start_directory_listing(
ConnectorId,
OutputDirectoryPath,
RemoteDirectoryPath;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"StartDirectoryListing",
Dict{String,Any}(
"ConnectorId" => ConnectorId,
"OutputDirectoryPath" => OutputDirectoryPath,
"RemoteDirectoryPath" => RemoteDirectoryPath,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_directory_listing(
ConnectorId,
OutputDirectoryPath,
RemoteDirectoryPath,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"StartDirectoryListing",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConnectorId" => ConnectorId,
"OutputDirectoryPath" => OutputDirectoryPath,
"RemoteDirectoryPath" => RemoteDirectoryPath,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_file_transfer(connector_id)
start_file_transfer(connector_id, params::Dict{String,<:Any})
Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP
server. For an AS2 connector, you specify the ConnectorId and one or more SendFilePaths
to identify the files you want to transfer. For an SFTP connector, the file transfer can
be either outbound or inbound. In both cases, you specify the ConnectorId. Depending on the
direction of the transfer, you also specify the following items: If you are transferring
file from a partner's SFTP server to Amazon Web Services storage, you specify one or more
RetrieveFilePaths to identify the files you want to transfer, and a LocalDirectoryPath to
specify the destination folder. If you are transferring file to a partner's SFTP server
from Amazon Web Services storage, you specify one or more SendFilePaths to identify the
files you want to transfer, and a RemoteDirectoryPath to specify the destination folder.
# Arguments
- `connector_id`: The unique identifier for the connector.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LocalDirectoryPath"`: For an inbound transfer, the LocaDirectoryPath specifies the
destination for one or more files that are transferred from the partner's SFTP server.
- `"RemoteDirectoryPath"`: For an outbound transfer, the RemoteDirectoryPath specifies the
destination for one or more files that are transferred to the partner's SFTP server. If you
don't specify a RemoteDirectoryPath, the destination for transferred files is the SFTP
user's home directory.
- `"RetrieveFilePaths"`: One or more source paths for the partner's SFTP server. Each
string represents a source file path for one inbound file transfer.
- `"SendFilePaths"`: One or more source paths for the Amazon S3 storage. Each string
represents a source file path for one outbound file transfer. For example,
DOC-EXAMPLE-BUCKET/myfile.txt . Replace DOC-EXAMPLE-BUCKET with one of your actual
buckets.
"""
function start_file_transfer(ConnectorId; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"StartFileTransfer",
Dict{String,Any}("ConnectorId" => ConnectorId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_file_transfer(
ConnectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"StartFileTransfer",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ConnectorId" => ConnectorId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_server(server_id)
start_server(server_id, params::Dict{String,<:Any})
Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE. It has
no impact on a server that is already ONLINE. An ONLINE server can accept and process file
transfer jobs. The state of STARTING indicates that the server is in an intermediate state,
either not fully able to respond, or not fully online. The values of START_FAILED can
indicate an error condition. No response is returned from this call.
# Arguments
- `server_id`: A system-assigned unique identifier for a server that you start.
"""
function start_server(ServerId; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"StartServer",
Dict{String,Any}("ServerId" => ServerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_server(
ServerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"StartServer",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ServerId" => ServerId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_server(server_id)
stop_server(server_id, params::Dict{String,<:Any})
Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE. An
OFFLINE server cannot accept and process file transfer jobs. Information tied to your
server, such as server and user properties, are not affected by stopping your server.
Stopping the server does not reduce or impact your file transfer protocol endpoint billing;
you must delete the server to stop being billed. The state of STOPPING indicates that the
server is in an intermediate state, either not fully able to respond, or not fully offline.
The values of STOP_FAILED can indicate an error condition. No response is returned from
this call.
# Arguments
- `server_id`: A system-assigned unique identifier for a server that you stopped.
"""
function stop_server(ServerId; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"StopServer",
Dict{String,Any}("ServerId" => ServerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_server(
ServerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"StopServer",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ServerId" => ServerId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(arn, tags)
tag_resource(arn, tags, params::Dict{String,<:Any})
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
Resources are users, servers, roles, and other entities. There is no response returned from
this call.
# Arguments
- `arn`: An Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as
a server, user, or role.
- `tags`: Key-value pairs assigned to ARNs that you can use to group and search for
resources by type. You can attach this metadata to resources (servers, users, workflows,
and so on) for any purpose.
"""
function tag_resource(Arn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"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 transfer(
"TagResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Arn" => Arn, "Tags" => Tags), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
test_connection(connector_id)
test_connection(connector_id, params::Dict{String,<:Any})
Tests whether your SFTP connector is set up successfully. We highly recommend that you call
this operation to test your ability to transfer files between local Amazon Web Services
storage and a trading partner's SFTP server.
# Arguments
- `connector_id`: The unique identifier for the connector.
"""
function test_connection(ConnectorId; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"TestConnection",
Dict{String,Any}("ConnectorId" => ConnectorId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function test_connection(
ConnectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"TestConnection",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ConnectorId" => ConnectorId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
test_identity_provider(server_id, user_name)
test_identity_provider(server_id, user_name, params::Dict{String,<:Any})
If the IdentityProviderType of a file transfer protocol-enabled server is
AWS_DIRECTORY_SERVICE or API_Gateway, tests whether your identity provider is set up
successfully. We highly recommend that you call this operation to test your authentication
method as soon as you create your server. By doing so, you can troubleshoot issues with the
identity provider integration to ensure that your users can successfully use the service.
The ServerId and UserName parameters are required. The ServerProtocol, SourceIp, and
UserPassword are all optional. Note the following: You cannot use TestIdentityProvider
if the IdentityProviderType of your server is SERVICE_MANAGED. TestIdentityProvider does
not work with keys: it only accepts passwords. TestIdentityProvider can test the
password operation for a custom Identity Provider that handles keys and passwords. If
you provide any incorrect values for any parameters, the Response field is empty. If
you provide a server ID for a server that uses service-managed users, you get an error:
An error occurred (InvalidRequestException) when calling the TestIdentityProvider
operation: s-server-ID not configured for external auth If you enter a Server ID for
the --server-id parameter that does not identify an actual Transfer server, you receive the
following error: An error occurred (ResourceNotFoundException) when calling the
TestIdentityProvider operation: Unknown server. It is possible your sever is in a
different region. You can specify a region by adding the following: --region region-code,
such as --region us-east-2 to specify a server in US East (Ohio).
# Arguments
- `server_id`: A system-assigned identifier for a specific server. That server's user
authentication method is tested with a user name and password.
- `user_name`: The name of the account to be tested.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ServerProtocol"`: The type of file transfer protocol to be tested. The available
protocols are: Secure Shell (SSH) File Transfer Protocol (SFTP) File Transfer Protocol
Secure (FTPS) File Transfer Protocol (FTP) Applicability Statement 2 (AS2)
- `"SourceIp"`: The source IP address of the account to be tested.
- `"UserPassword"`: The password of the account to be tested.
"""
function test_identity_provider(
ServerId, UserName; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"TestIdentityProvider",
Dict{String,Any}("ServerId" => ServerId, "UserName" => UserName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function test_identity_provider(
ServerId,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"TestIdentityProvider",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ServerId" => ServerId, "UserName" => UserName),
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})
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).
Resources are users, servers, roles, and other entities. No response is returned from this
call.
# Arguments
- `arn`: The value of the resource that will have the tag removed. An Amazon Resource Name
(ARN) is an identifier for a specific Amazon Web Services resource, such as a server, user,
or role.
- `tag_keys`: TagKeys are key-value pairs assigned to ARNs that can be used to group and
search for resources by type. This metadata can be attached to resources for any purpose.
"""
function untag_resource(Arn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"UntagResource",
Dict{String,Any}("Arn" => Arn, "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 transfer(
"UntagResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Arn" => Arn, "TagKeys" => TagKeys), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_access(external_id, server_id)
update_access(external_id, server_id, params::Dict{String,<:Any})
Allows you to update parameters for the access specified in the ServerID and ExternalID
parameters.
# Arguments
- `external_id`: A unique identifier that is required to identify specific groups within
your directory. The users of the group that you associate have access to your Amazon S3 or
Amazon EFS resources over the enabled protocols using Transfer Family. If you know the
group name, you can view the SID values by running the following command using Windows
PowerShell. Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * |
Select SamAccountName,ObjectSid In that command, replace YourGroupName with the name of
your Active Directory group. The regular expression used to validate this parameter is a
string of characters consisting of uppercase and lowercase alphanumeric characters with no
spaces. You can also include underscores or any of the following characters: =,.@:/-
- `server_id`: A system-assigned unique identifier for a server instance. This is the
specific server that you added your user to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"HomeDirectory"`: The landing directory (folder) for a user when they log in to the
server using the client. A HomeDirectory example is /bucket_name/home/mydirectory. The
HomeDirectory parameter is only used if HomeDirectoryType is set to PATH.
- `"HomeDirectoryMappings"`: Logical directory mappings that specify what Amazon S3 or
Amazon EFS paths and keys should be visible to your user and how you want to make them
visible. You must specify the Entry and Target pair, where Entry shows how the path is made
visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a
target, it is displayed as is. You also must ensure that your Identity and Access
Management (IAM) role provides access to paths in Target. This value can be set only when
HomeDirectoryType is set to LOGICAL. The following is an Entry and Target pair example. [
{ \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ] In most
cases, you can use this value instead of the session policy to lock down your user to the
designated home directory (\"chroot\"). To do this, you can set Entry to / and set Target
to the HomeDirectory parameter value. The following is an Entry and Target pair example for
chroot. [ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]
- `"HomeDirectoryType"`: The type of landing directory (folder) that you want your users'
home directory to be when they log in to the server. If you set it to PATH, the user will
see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol
clients. If you set it to LOGICAL, you need to provide mappings in the
HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to
your users. If HomeDirectoryType is LOGICAL, you must provide mappings, using the
HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is PATH, you
provide an absolute path using the HomeDirectory parameter. You cannot have both
HomeDirectory and HomeDirectoryMappings in your template.
- `"Policy"`: A session policy for your user so that you can use the same Identity and
Access Management (IAM) role across multiple users. This policy scopes down a user's access
to portions of their Amazon S3 bucket. Variables that you can use inside this policy
include {Transfer:UserName}, {Transfer:HomeDirectory}, and {Transfer:HomeBucket}. This
policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use
session policies. For session policies, Transfer Family stores the policy as a JSON blob,
instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob
and pass it in the Policy argument. For an example of a session policy, see Example session
policy. For more information, see AssumeRole in the Amazon Web ServicesSecurity Token
Service API Reference.
- `"PosixProfile"`:
- `"Role"`: The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role
that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The
policies attached to this role determine the level of access that you want to provide your
users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file
system. The IAM role should also contain a trust relationship that allows the server to
access your resources when servicing your users' transfer requests.
"""
function update_access(
ExternalId, ServerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"UpdateAccess",
Dict{String,Any}("ExternalId" => ExternalId, "ServerId" => ServerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_access(
ExternalId,
ServerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"UpdateAccess",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ExternalId" => ExternalId, "ServerId" => ServerId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_agreement(agreement_id, server_id)
update_agreement(agreement_id, server_id, params::Dict{String,<:Any})
Updates some of the parameters for an existing agreement. Provide the AgreementId and the
ServerId for the agreement that you want to update, along with the new values for the
parameters to update.
# Arguments
- `agreement_id`: A unique identifier for the agreement. This identifier is returned when
you create an agreement.
- `server_id`: A system-assigned unique identifier for a server instance. This is the
specific server that the agreement uses.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccessRole"`: Connectors are used to send files using either the AS2 or SFTP protocol.
For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access
Management role to use. For AS2 connectors With AS2, you can send files by calling
StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We
use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt,
parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store
the MDN when we receive them from the partner, and write a final JSON file containing
relevant metadata of the transmission. So, the AccessRole needs to provide read and write
access to the parent directory of the file location used in the StartFileTransfer request.
Additionally, you need to provide read and write access to the parent directory of the
files that you intend to send with StartFileTransfer. If you are using Basic authentication
for your AS2 connector, the access role requires the secretsmanager:GetSecretValue
permission for the secret. If the secret is encrypted using a customer-managed key instead
of the Amazon Web Services managed key in Secrets Manager, then the role also needs the
kms:Decrypt permission for that key. For SFTP connectors Make sure that the access role
provides read and write access to the parent directory of the file location that's used in
the StartFileTransfer request. Additionally, make sure that the role provides
secretsmanager:GetSecretValue permission to Secrets Manager.
- `"BaseDirectory"`: To change the landing directory (folder) for files that are
transferred, provide the bucket folder that you want to use; for example,
/DOC-EXAMPLE-BUCKET/home/mydirectory .
- `"Description"`: To replace the existing description, provide a short description for the
agreement.
- `"LocalProfileId"`: A unique identifier for the AS2 local profile. To change the local
profile identifier, provide a new value here.
- `"PartnerProfileId"`: A unique identifier for the partner profile. To change the partner
profile identifier, provide a new value here.
- `"Status"`: You can update the status for the agreement, either activating an inactive
agreement or the reverse.
"""
function update_agreement(
AgreementId, ServerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"UpdateAgreement",
Dict{String,Any}("AgreementId" => AgreementId, "ServerId" => ServerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_agreement(
AgreementId,
ServerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"UpdateAgreement",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AgreementId" => AgreementId, "ServerId" => ServerId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_certificate(certificate_id)
update_certificate(certificate_id, params::Dict{String,<:Any})
Updates the active and inactive dates for a certificate.
# Arguments
- `certificate_id`: The identifier of the certificate object that you are updating.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ActiveDate"`: An optional date that specifies when the certificate becomes active.
- `"Description"`: A short description to help identify the certificate.
- `"InactiveDate"`: An optional date that specifies when the certificate becomes inactive.
"""
function update_certificate(
CertificateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"UpdateCertificate",
Dict{String,Any}("CertificateId" => CertificateId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_certificate(
CertificateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"UpdateCertificate",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("CertificateId" => CertificateId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_connector(connector_id)
update_connector(connector_id, params::Dict{String,<:Any})
Updates some of the parameters for an existing connector. Provide the ConnectorId for the
connector that you want to update, along with the new values for the parameters to update.
# Arguments
- `connector_id`: The unique identifier for the connector.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccessRole"`: Connectors are used to send files using either the AS2 or SFTP protocol.
For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access
Management role to use. For AS2 connectors With AS2, you can send files by calling
StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We
use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt,
parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store
the MDN when we receive them from the partner, and write a final JSON file containing
relevant metadata of the transmission. So, the AccessRole needs to provide read and write
access to the parent directory of the file location used in the StartFileTransfer request.
Additionally, you need to provide read and write access to the parent directory of the
files that you intend to send with StartFileTransfer. If you are using Basic authentication
for your AS2 connector, the access role requires the secretsmanager:GetSecretValue
permission for the secret. If the secret is encrypted using a customer-managed key instead
of the Amazon Web Services managed key in Secrets Manager, then the role also needs the
kms:Decrypt permission for that key. For SFTP connectors Make sure that the access role
provides read and write access to the parent directory of the file location that's used in
the StartFileTransfer request. Additionally, make sure that the role provides
secretsmanager:GetSecretValue permission to Secrets Manager.
- `"As2Config"`: A structure that contains the parameters for an AS2 connector object.
- `"LoggingRole"`: The Amazon Resource Name (ARN) of the Identity and Access Management
(IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When
set, you can view connector activity in your CloudWatch logs.
- `"SecurityPolicyName"`: Specifies the name of the security policy for the connector.
- `"SftpConfig"`: A structure that contains the parameters for an SFTP connector object.
- `"Url"`: The URL of the partner's AS2 or SFTP endpoint.
"""
function update_connector(ConnectorId; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"UpdateConnector",
Dict{String,Any}("ConnectorId" => ConnectorId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_connector(
ConnectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"UpdateConnector",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ConnectorId" => ConnectorId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_host_key(description, host_key_id, server_id)
update_host_key(description, host_key_id, server_id, params::Dict{String,<:Any})
Updates the description for the host key that's specified by the ServerId and HostKeyId
parameters.
# Arguments
- `description`: An updated description for the host key.
- `host_key_id`: The identifier of the host key that you are updating.
- `server_id`: The identifier of the server that contains the host key that you are
updating.
"""
function update_host_key(
Description, HostKeyId, ServerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"UpdateHostKey",
Dict{String,Any}(
"Description" => Description, "HostKeyId" => HostKeyId, "ServerId" => ServerId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_host_key(
Description,
HostKeyId,
ServerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"UpdateHostKey",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Description" => Description,
"HostKeyId" => HostKeyId,
"ServerId" => ServerId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_profile(profile_id)
update_profile(profile_id, params::Dict{String,<:Any})
Updates some of the parameters for an existing profile. Provide the ProfileId for the
profile that you want to update, along with the new values for the parameters to update.
# Arguments
- `profile_id`: The identifier of the profile object that you are updating.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CertificateIds"`: An array of identifiers for the imported certificates. You use this
identifier for working with profiles and partner profiles.
"""
function update_profile(ProfileId; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"UpdateProfile",
Dict{String,Any}("ProfileId" => ProfileId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_profile(
ProfileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"UpdateProfile",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ProfileId" => ProfileId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_server(server_id)
update_server(server_id, params::Dict{String,<:Any})
Updates the file transfer protocol-enabled server's properties after that server has been
created. The UpdateServer call returns the ServerId of the server you updated.
# Arguments
- `server_id`: A system-assigned unique identifier for a server instance that the Transfer
Family user is assigned to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Certificate"`: The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate
Manager (ACM) certificate. Required when Protocols is set to FTPS. To request a new public
certificate, see Request a public certificate in the Amazon Web ServicesCertificate
Manager User Guide. To import an existing certificate into ACM, see Importing certificates
into ACM in the Amazon Web ServicesCertificate Manager User Guide. To request a private
certificate to use FTPS through private IP addresses, see Request a private certificate in
the Amazon Web ServicesCertificate Manager User Guide. Certificates with the following
cryptographic algorithms and key sizes are supported: 2048-bit RSA (RSA_2048) 4096-bit
RSA (RSA_4096) Elliptic Prime Curve 256 bit (EC_prime256v1) Elliptic Prime Curve 384
bit (EC_secp384r1) Elliptic Prime Curve 521 bit (EC_secp521r1) The certificate must be
a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and
information about the issuer.
- `"EndpointDetails"`: The virtual private cloud (VPC) endpoint settings that are
configured for your server. When you host your endpoint within your VPC, you can make your
endpoint accessible only to resources within your VPC, or you can attach Elastic IP
addresses and make your endpoint accessible to clients over the internet. Your VPC's
default security groups are automatically assigned to your endpoint.
- `"EndpointType"`: The type of endpoint that you want your server to use. You can choose
to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC.
With an endpoint that is hosted in a VPC, you can restrict access to your server and
resources only within your VPC or choose to make it internet facing by attaching Elastic IP
addresses directly to it. After May 19, 2021, you won't be able to create a server using
EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount if your account hasn't already
done so before May 19, 2021. If you have already created servers with
EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount on or before May 19, 2021, you
will not be affected. After this date, use EndpointType=VPC. For more information, see
https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vp
c-endpoint. It is recommended that you use VPC as the EndpointType. With this endpoint
type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP
included) with your server's endpoint and use VPC security groups to restrict traffic by
the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.
- `"HostKey"`: The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server.
You can add multiple host keys, in case you want to rotate keys, or have a set of active
keys that use different algorithms. Use the following command to generate an RSA 2048 bit
key with no passphrase: ssh-keygen -t rsa -b 2048 -N \"\" -m PEM -f my-new-server-key. Use
a minimum value of 2048 for the -b option. You can create a stronger key by using 3072 or
4096. Use the following command to generate an ECDSA 256 bit key with no passphrase:
ssh-keygen -t ecdsa -b 256 -N \"\" -m PEM -f my-new-server-key. Valid values for the -b
option for ECDSA are 256, 384, and 521. Use the following command to generate an ED25519
key with no passphrase: ssh-keygen -t ed25519 -N \"\" -f my-new-server-key. For all of
these commands, you can replace my-new-server-key with a string of your choice. If you
aren't planning to migrate existing users from an existing SFTP-enabled server to a new
server, don't update the host key. Accidentally changing a server's host key can be
disruptive. For more information, see Manage host keys for your SFTP-enabled server in the
Transfer Family User Guide.
- `"IdentityProviderDetails"`: An array containing all of the information required to call
a customer's authentication API method.
- `"LoggingRole"`: The Amazon Resource Name (ARN) of the Identity and Access Management
(IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or
Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.
- `"PostAuthenticationLoginBanner"`: Specifies a string to display when users connect to a
server. This string is displayed after the user authenticates. The SFTP protocol does not
support post-authentication display banners.
- `"PreAuthenticationLoginBanner"`: Specifies a string to display when users connect to a
server. This string is displayed before the user authenticates. For example, the following
banner displays details about using the system: This system is for the use of authorized
users only. Individuals using this computer system without authority, or in excess of their
authority, are subject to having all of their activities on this system monitored and
recorded by system personnel.
- `"ProtocolDetails"`: The protocol settings that are configured for your server. To
indicate passive mode (for FTP and FTPS protocols), use the PassiveIp parameter. Enter a
single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or
load balancer. To ignore the error that is generated when the client attempts to use the
SETSTAT command on a file that you are uploading to an Amazon S3 bucket, use the
SetStatOption parameter. To have the Transfer Family server ignore the SETSTAT command and
upload files without needing to make any changes to your SFTP client, set the value to
ENABLE_NO_OP. If you set the SetStatOption parameter to ENABLE_NO_OP, Transfer Family
generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client
is making a SETSTAT call. To determine whether your Transfer Family server resumes
recent, negotiated sessions through a unique session ID, use the TlsSessionResumptionMode
parameter. As2Transports indicates the transport method for the AS2 messages. Currently,
only HTTP is supported.
- `"Protocols"`: Specifies the file transfer protocol or protocols over which your file
transfer protocol client can connect to your server's endpoint. The available protocols
are: SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH FTPS
(File Transfer Protocol Secure): File transfer with TLS encryption FTP (File Transfer
Protocol): Unencrypted file transfer AS2 (Applicability Statement 2): used for
transporting structured business-to-business data If you select FTPS, you must choose
a certificate stored in Certificate Manager (ACM) which is used to identify your server
when clients connect to it over FTPS. If Protocol includes either FTP or FTPS, then the
EndpointType must be VPC and the IdentityProviderType must be either AWS_DIRECTORY_SERVICE,
AWS_LAMBDA, or API_GATEWAY. If Protocol includes FTP, then AddressAllocationIds cannot be
associated. If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and
the IdentityProviderType can be set any of the supported identity types: SERVICE_MANAGED,
AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY. If Protocol includes AS2, then the
EndpointType must be VPC, and domain must be Amazon S3.
- `"S3StorageOptions"`: Specifies whether or not performance for your Amazon S3 directories
is optimized. This is disabled by default. By default, home directory mappings have a TYPE
of DIRECTORY. If you enable this option, you would then need to explicitly set the
HomeDirectoryMapEntry Type to FILE if you want a mapping to have a file target.
- `"SecurityPolicyName"`: Specifies the name of the security policy for the server.
- `"StructuredLogDestinations"`: Specifies the log groups to which your server logs are
sent. To specify a log group, you must provide the ARN for an existing log group. In this
case, the format of the log group is as follows:
arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:* For example,
arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:* If you have previously
specified a log group for a server, you can clear it, and in effect turn off structured
logging, by providing an empty value for this parameter in an update-server call. For
example: update-server --server-id s-1234567890abcdef0 --structured-log-destinations
- `"WorkflowDetails"`: Specifies the workflow ID for the workflow to assign and the
execution role that's used for executing the workflow. In addition to a workflow to execute
when a file is uploaded completely, WorkflowDetails can also contain a workflow ID (and
execution role) for a workflow to execute on partial upload. A partial upload occurs when
the server session disconnects while the file is still being uploaded. To remove an
associated workflow from a server, you can provide an empty OnUpload object, as in the
following example. aws transfer update-server --server-id s-01234567890abcdef
--workflow-details '{\"OnUpload\":[]}'
"""
function update_server(ServerId; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"UpdateServer",
Dict{String,Any}("ServerId" => ServerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_server(
ServerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"UpdateServer",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ServerId" => ServerId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_user(server_id, user_name)
update_user(server_id, user_name, params::Dict{String,<:Any})
Assigns new properties to a user. Parameters you pass modify any or all of the following:
the home directory, role, and policy for the UserName and ServerId you specify. The
response returns the ServerId and the UserName for the updated user. In the console, you
can select Restricted when you create or update a user. This ensures that the user can't
access anything outside of their home directory. The programmatic way to configure this
behavior is to update the user. Set their HomeDirectoryType to LOGICAL, and specify
HomeDirectoryMappings with Entry as root (/) and Target as their home directory. For
example, if the user's home directory is /test/admin-user, the following command updates
the user so that their configuration in the console shows the Restricted flag as selected.
aws transfer update-user --server-id <server-id> --user-name admin-user
--home-directory-type LOGICAL --home-directory-mappings \"[{\"Entry\":\"/\",
\"Target\":\"/test/admin-user\"}]\"
# Arguments
- `server_id`: A system-assigned unique identifier for a Transfer Family server instance
that the user is assigned to.
- `user_name`: A unique string that identifies a user and is associated with a server as
specified by the ServerId. This user name must be a minimum of 3 and a maximum of 100
characters long. The following are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen
'-', period '.', and at sign '@'. The user name can't start with a hyphen, period, or at
sign.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"HomeDirectory"`: The landing directory (folder) for a user when they log in to the
server using the client. A HomeDirectory example is /bucket_name/home/mydirectory. The
HomeDirectory parameter is only used if HomeDirectoryType is set to PATH.
- `"HomeDirectoryMappings"`: Logical directory mappings that specify what Amazon S3 or
Amazon EFS paths and keys should be visible to your user and how you want to make them
visible. You must specify the Entry and Target pair, where Entry shows how the path is made
visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a
target, it is displayed as is. You also must ensure that your Identity and Access
Management (IAM) role provides access to paths in Target. This value can be set only when
HomeDirectoryType is set to LOGICAL. The following is an Entry and Target pair example. [
{ \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ] In most
cases, you can use this value instead of the session policy to lock down your user to the
designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target
to the HomeDirectory parameter value. The following is an Entry and Target pair example for
chroot. [ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]
- `"HomeDirectoryType"`: The type of landing directory (folder) that you want your users'
home directory to be when they log in to the server. If you set it to PATH, the user will
see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol
clients. If you set it to LOGICAL, you need to provide mappings in the
HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to
your users. If HomeDirectoryType is LOGICAL, you must provide mappings, using the
HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is PATH, you
provide an absolute path using the HomeDirectory parameter. You cannot have both
HomeDirectory and HomeDirectoryMappings in your template.
- `"Policy"`: A session policy for your user so that you can use the same Identity and
Access Management (IAM) role across multiple users. This policy scopes down a user's access
to portions of their Amazon S3 bucket. Variables that you can use inside this policy
include {Transfer:UserName}, {Transfer:HomeDirectory}, and {Transfer:HomeBucket}. This
policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use
session policies. For session policies, Transfer Family stores the policy as a JSON blob,
instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob
and pass it in the Policy argument. For an example of a session policy, see Creating a
session policy. For more information, see AssumeRole in the Amazon Web Services Security
Token Service API Reference.
- `"PosixProfile"`: Specifies the full POSIX identity, including user ID (Uid), group ID
(Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to
your Amazon Elastic File Systems (Amazon EFS). The POSIX permissions that are set on files
and directories in your file system determines the level of access your users get when
transferring files into and out of your Amazon EFS file systems.
- `"Role"`: The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role
that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The
policies attached to this role determine the level of access that you want to provide your
users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file
system. The IAM role should also contain a trust relationship that allows the server to
access your resources when servicing your users' transfer requests.
"""
function update_user(ServerId, UserName; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"UpdateUser",
Dict{String,Any}("ServerId" => ServerId, "UserName" => UserName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_user(
ServerId,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"UpdateUser",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ServerId" => ServerId, "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 | 33500 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: translate
using AWS.Compat
using AWS.UUIDs
"""
create_parallel_data(client_token, name, parallel_data_config)
create_parallel_data(client_token, name, parallel_data_config, params::Dict{String,<:Any})
Creates a parallel data resource in Amazon Translate by importing an input file from Amazon
S3. Parallel data files contain examples that show how you want segments of text to be
translated. By adding parallel data, you can influence the style, tone, and word choice in
your translation output.
# Arguments
- `client_token`: A unique identifier for the request. This token is automatically
generated when you use Amazon Translate through an AWS SDK.
- `name`: A custom name for the parallel data resource in Amazon Translate. You must assign
a name that is unique in the account and region.
- `parallel_data_config`: Specifies the format and S3 location of the parallel data input
file.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A custom description for the parallel data resource in Amazon Translate.
- `"EncryptionKey"`:
- `"Tags"`: Tags to be associated with this resource. A tag is a key-value pair that adds
metadata to a resource. Each tag key for the resource must be unique. For more information,
see Tagging your resources.
"""
function create_parallel_data(
ClientToken, Name, ParallelDataConfig; aws_config::AbstractAWSConfig=global_aws_config()
)
return translate(
"CreateParallelData",
Dict{String,Any}(
"ClientToken" => ClientToken,
"Name" => Name,
"ParallelDataConfig" => ParallelDataConfig,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_parallel_data(
ClientToken,
Name,
ParallelDataConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return translate(
"CreateParallelData",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientToken" => ClientToken,
"Name" => Name,
"ParallelDataConfig" => ParallelDataConfig,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_parallel_data(name)
delete_parallel_data(name, params::Dict{String,<:Any})
Deletes a parallel data resource in Amazon Translate.
# Arguments
- `name`: The name of the parallel data resource that is being deleted.
"""
function delete_parallel_data(Name; aws_config::AbstractAWSConfig=global_aws_config())
return translate(
"DeleteParallelData",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_parallel_data(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return translate(
"DeleteParallelData",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_terminology(name)
delete_terminology(name, params::Dict{String,<:Any})
A synchronous action that deletes a custom terminology.
# Arguments
- `name`: The name of the custom terminology being deleted.
"""
function delete_terminology(Name; aws_config::AbstractAWSConfig=global_aws_config())
return translate(
"DeleteTerminology",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_terminology(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return translate(
"DeleteTerminology",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_text_translation_job(job_id)
describe_text_translation_job(job_id, params::Dict{String,<:Any})
Gets the properties associated with an asynchronous batch translation job including name,
ID, status, source and target languages, input/output S3 buckets, and so on.
# Arguments
- `job_id`: The identifier that Amazon Translate generated for the job. The
StartTextTranslationJob operation returns this identifier in its response.
"""
function describe_text_translation_job(
JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return translate(
"DescribeTextTranslationJob",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_text_translation_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return translate(
"DescribeTextTranslationJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_parallel_data(name)
get_parallel_data(name, params::Dict{String,<:Any})
Provides information about a parallel data resource.
# Arguments
- `name`: The name of the parallel data resource that is being retrieved.
"""
function get_parallel_data(Name; aws_config::AbstractAWSConfig=global_aws_config())
return translate(
"GetParallelData",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_parallel_data(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return translate(
"GetParallelData",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_terminology(name)
get_terminology(name, params::Dict{String,<:Any})
Retrieves a custom terminology.
# Arguments
- `name`: The name of the custom terminology being retrieved.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"TerminologyDataFormat"`: The data format of the custom terminology being retrieved. If
you don't specify this parameter, Amazon Translate returns a file with the same format as
the file that was imported to create the terminology. If you specify this parameter when
you retrieve a multi-directional terminology resource, you must specify the same format as
the input file that was imported to create it. Otherwise, Amazon Translate throws an error.
"""
function get_terminology(Name; aws_config::AbstractAWSConfig=global_aws_config())
return translate(
"GetTerminology",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_terminology(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return translate(
"GetTerminology",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
import_terminology(merge_strategy, name, terminology_data)
import_terminology(merge_strategy, name, terminology_data, params::Dict{String,<:Any})
Creates or updates a custom terminology, depending on whether one already exists for the
given terminology name. Importing a terminology with the same name as an existing one will
merge the terminologies based on the chosen merge strategy. The only supported merge
strategy is OVERWRITE, where the imported terminology overwrites the existing terminology
of the same name. If you import a terminology that overwrites an existing one, the new
terminology takes up to 10 minutes to fully propagate. After that, translations have access
to the new terminology.
# Arguments
- `merge_strategy`: The merge strategy of the custom terminology being imported. Currently,
only the OVERWRITE merge strategy is supported. In this case, the imported terminology will
overwrite an existing terminology of the same name.
- `name`: The name of the custom terminology being imported.
- `terminology_data`: The terminology data for the custom terminology being imported.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description of the custom terminology being imported.
- `"EncryptionKey"`: The encryption key for the custom terminology being imported.
- `"Tags"`: Tags to be associated with this resource. A tag is a key-value pair that adds
metadata to a resource. Each tag key for the resource must be unique. For more information,
see Tagging your resources.
"""
function import_terminology(
MergeStrategy, Name, TerminologyData; aws_config::AbstractAWSConfig=global_aws_config()
)
return translate(
"ImportTerminology",
Dict{String,Any}(
"MergeStrategy" => MergeStrategy,
"Name" => Name,
"TerminologyData" => TerminologyData,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function import_terminology(
MergeStrategy,
Name,
TerminologyData,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return translate(
"ImportTerminology",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MergeStrategy" => MergeStrategy,
"Name" => Name,
"TerminologyData" => TerminologyData,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_languages()
list_languages(params::Dict{String,<:Any})
Provides a list of languages (RFC-5646 codes and names) that Amazon Translate supports.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DisplayLanguageCode"`: The language code for the language to use to display the
language names in the response. The language code is en by default.
- `"MaxResults"`: The maximum number of results to return in each response.
- `"NextToken"`: Include the NextToken value to fetch the next group of supported
languages.
"""
function list_languages(; aws_config::AbstractAWSConfig=global_aws_config())
return translate(
"ListLanguages"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_languages(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return translate(
"ListLanguages", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_parallel_data()
list_parallel_data(params::Dict{String,<:Any})
Provides a list of your parallel data resources in Amazon Translate.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of parallel data resources returned for each request.
- `"NextToken"`: A string that specifies the next page of results to return in a paginated
response.
"""
function list_parallel_data(; aws_config::AbstractAWSConfig=global_aws_config())
return translate(
"ListParallelData"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_parallel_data(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return translate(
"ListParallelData", 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 Translate resource. For more information, see
Tagging your resources.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the given Amazon Translate resource you
are querying.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return translate(
"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 translate(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_terminologies()
list_terminologies(params::Dict{String,<:Any})
Provides a list of custom terminologies 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 custom terminologies returned per list request.
- `"NextToken"`: If the result of the request to ListTerminologies was truncated, include
the NextToken to fetch the next group of custom terminologies.
"""
function list_terminologies(; aws_config::AbstractAWSConfig=global_aws_config())
return translate(
"ListTerminologies"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_terminologies(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return translate(
"ListTerminologies", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_text_translation_jobs()
list_text_translation_jobs(params::Dict{String,<:Any})
Gets a list of the batch translation jobs that you have submitted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: The parameters that specify which batch translation jobs to retrieve. Filters
include job name, job status, and submission time. You can only set one filter at a time.
- `"MaxResults"`: The maximum number of results to return in each page. The default value
is 100.
- `"NextToken"`: The token to request the next page of results.
"""
function list_text_translation_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return translate(
"ListTextTranslationJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_text_translation_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return translate(
"ListTextTranslationJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_text_translation_job(client_token, data_access_role_arn, input_data_config, output_data_config, source_language_code, target_language_codes)
start_text_translation_job(client_token, data_access_role_arn, input_data_config, output_data_config, source_language_code, target_language_codes, params::Dict{String,<:Any})
Starts an asynchronous batch translation job. Use batch translation jobs to translate large
volumes of text across multiple documents at once. For batch translation, you can input
documents with different source languages (specify auto as the source language). You can
specify one or more target languages. Batch translation translates each input document into
each of the target languages. For more information, see Asynchronous batch processing.
Batch translation jobs can be described with the DescribeTextTranslationJob operation,
listed with the ListTextTranslationJobs operation, and stopped with the
StopTextTranslationJob operation.
# Arguments
- `client_token`: A unique identifier for the request. This token is generated for you when
using the Amazon Translate SDK.
- `data_access_role_arn`: The Amazon Resource Name (ARN) of an AWS Identity Access and
Management (IAM) role that grants Amazon Translate read access to your input data. For more
information, see Identity and access management .
- `input_data_config`: Specifies the format and location of the input documents for the
translation job.
- `output_data_config`: Specifies the S3 folder to which your job output will be saved.
- `source_language_code`: The language code of the input language. Specify the language if
all input documents share the same language. If you don't know the language of the source
files, or your input documents contains different source languages, select auto. Amazon
Translate auto detects the source language for each input document. For a list of supported
language codes, see Supported languages.
- `target_language_codes`: The target languages of the translation job. Enter up to 10
language codes. Each input file is translated into each target language. Each language code
is 2 or 5 characters long. For a list of language codes, see Supported languages.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"JobName"`: The name of the batch translation job to be performed.
- `"ParallelDataNames"`: The name of a parallel data resource to add to the translation
job. This resource consists of examples that show how you want segments of text to be
translated. If you specify multiple target languages for the job, the parallel data file
must include translations for all the target languages. When you add parallel data to a
translation job, you create an Active Custom Translation job. This parameter accepts only
one parallel data resource. Active Custom Translation jobs are priced at a higher rate
than other jobs that don't use parallel data. For more information, see Amazon Translate
pricing. For a list of available parallel data resources, use the ListParallelData
operation. For more information, see Customizing your translations with parallel data.
- `"Settings"`: Settings to configure your translation output. You can configure the
following options: Brevity: not supported. Formality: sets the formality level of the
output text. Profanity: masks profane words and phrases in your translation output.
- `"TerminologyNames"`: The name of a custom terminology resource to add to the translation
job. This resource lists examples source terms and the desired translation for each term.
This parameter accepts only one custom terminology resource. If you specify multiple target
languages for the job, translate uses the designated terminology for each requested target
language that has an entry for the source term in the terminology file. For a list of
available custom terminology resources, use the ListTerminologies operation. For more
information, see Custom terminology.
"""
function start_text_translation_job(
ClientToken,
DataAccessRoleArn,
InputDataConfig,
OutputDataConfig,
SourceLanguageCode,
TargetLanguageCodes;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return translate(
"StartTextTranslationJob",
Dict{String,Any}(
"ClientToken" => ClientToken,
"DataAccessRoleArn" => DataAccessRoleArn,
"InputDataConfig" => InputDataConfig,
"OutputDataConfig" => OutputDataConfig,
"SourceLanguageCode" => SourceLanguageCode,
"TargetLanguageCodes" => TargetLanguageCodes,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_text_translation_job(
ClientToken,
DataAccessRoleArn,
InputDataConfig,
OutputDataConfig,
SourceLanguageCode,
TargetLanguageCodes,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return translate(
"StartTextTranslationJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientToken" => ClientToken,
"DataAccessRoleArn" => DataAccessRoleArn,
"InputDataConfig" => InputDataConfig,
"OutputDataConfig" => OutputDataConfig,
"SourceLanguageCode" => SourceLanguageCode,
"TargetLanguageCodes" => TargetLanguageCodes,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_text_translation_job(job_id)
stop_text_translation_job(job_id, params::Dict{String,<:Any})
Stops an asynchronous batch translation job that is in progress. If the job's state is
IN_PROGRESS, the job will be 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 put into the STOPPED state. Asynchronous batch translation jobs are
started with the StartTextTranslationJob operation. You can use the
DescribeTextTranslationJob or ListTextTranslationJobs operations to get a batch translation
job's JobId.
# Arguments
- `job_id`: The job ID of the job to be stopped.
"""
function stop_text_translation_job(JobId; aws_config::AbstractAWSConfig=global_aws_config())
return translate(
"StopTextTranslationJob",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_text_translation_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return translate(
"StopTextTranslationJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => 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})
Associates a specific tag with a resource. A tag is a key-value pair that adds as a
metadata to a resource. For more information, see Tagging your resources.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the given Amazon Translate resource to
which you want to associate the tags.
- `tags`: Tags being associated with a specific Amazon Translate 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 translate(
"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 translate(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
translate_document(document, source_language_code, target_language_code)
translate_document(document, source_language_code, target_language_code, params::Dict{String,<:Any})
Translates the input document from the source language to the target language. This
synchronous operation supports text, HTML, or Word documents as the input document.
TranslateDocument supports translations from English to any supported language, and from
any supported language to English. Therefore, specify either the source language code or
the target language code as “en” (English). If you set the Formality parameter, the
request will fail if the target language does not support formality. For a list of target
languages that support formality, see Setting formality.
# Arguments
- `document`: The content and content type for the document to be translated. The document
size must not exceed 100 KB.
- `source_language_code`: The language code for the language of the source text. For a list
of supported language codes, see Supported languages. To have Amazon Translate determine
the source language of your text, you can specify auto in the SourceLanguageCode field. If
you specify auto, Amazon Translate will call Amazon Comprehend to determine the source
language. If you specify auto, you must send the TranslateDocument request in a region
that supports Amazon Comprehend. Otherwise, the request returns an error indicating that
autodetect is not supported.
- `target_language_code`: The language code requested for the translated document. For a
list of supported language codes, see Supported languages.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Settings"`: Settings to configure your translation output. You can configure the
following options: Brevity: not supported. Formality: sets the formality level of the
output text. Profanity: masks profane words and phrases in your translation output.
- `"TerminologyNames"`: The name of a terminology list file to add to the translation job.
This file provides source terms and the desired translation for each term. A terminology
list can contain a maximum of 256 terms. You can use one custom terminology resource in
your translation request. Use the ListTerminologies operation to get the available
terminology lists. For more information about custom terminology lists, see Custom
terminology.
"""
function translate_document(
Document,
SourceLanguageCode,
TargetLanguageCode;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return translate(
"TranslateDocument",
Dict{String,Any}(
"Document" => Document,
"SourceLanguageCode" => SourceLanguageCode,
"TargetLanguageCode" => TargetLanguageCode,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function translate_document(
Document,
SourceLanguageCode,
TargetLanguageCode,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return translate(
"TranslateDocument",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Document" => Document,
"SourceLanguageCode" => SourceLanguageCode,
"TargetLanguageCode" => TargetLanguageCode,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
translate_text(source_language_code, target_language_code, text)
translate_text(source_language_code, target_language_code, text, params::Dict{String,<:Any})
Translates input text from the source language to the target language. For a list of
available languages and language codes, see Supported languages.
# Arguments
- `source_language_code`: The language code for the language of the source text. For a list
of language codes, see Supported languages. To have Amazon Translate determine the source
language of your text, you can specify auto in the SourceLanguageCode field. If you specify
auto, Amazon Translate will call Amazon Comprehend to determine the source language. If
you specify auto, you must send the TranslateText request in a region that supports Amazon
Comprehend. Otherwise, the request returns an error indicating that autodetect is not
supported.
- `target_language_code`: The language code requested for the language of the target text.
For a list of language codes, see Supported languages.
- `text`: The text to translate. The text string can be a maximum of 10,000 bytes long.
Depending on your character set, this may be fewer than 10,000 characters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Settings"`: Settings to configure your translation output. You can configure the
following options: Brevity: reduces the length of the translated output for most
translations. Formality: sets the formality level of the output text. Profanity: masks
profane words and phrases in your translation output.
- `"TerminologyNames"`: The name of a terminology list file to add to the translation job.
This file provides source terms and the desired translation for each term. A terminology
list can contain a maximum of 256 terms. You can use one custom terminology resource in
your translation request. Use the ListTerminologies operation to get the available
terminology lists. For more information about custom terminology lists, see Custom
terminology.
"""
function translate_text(
SourceLanguageCode,
TargetLanguageCode,
Text;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return translate(
"TranslateText",
Dict{String,Any}(
"SourceLanguageCode" => SourceLanguageCode,
"TargetLanguageCode" => TargetLanguageCode,
"Text" => Text,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function translate_text(
SourceLanguageCode,
TargetLanguageCode,
Text,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return translate(
"TranslateText",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SourceLanguageCode" => SourceLanguageCode,
"TargetLanguageCode" => TargetLanguageCode,
"Text" => Text,
),
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 Translate resource. For more information,
see Tagging your resources.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the given Amazon Translate 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. Keys must be unique and cannot be duplicated for a particular resource.
"""
function untag_resource(
ResourceArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return translate(
"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 translate(
"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_parallel_data(client_token, name, parallel_data_config)
update_parallel_data(client_token, name, parallel_data_config, params::Dict{String,<:Any})
Updates a previously created parallel data resource by importing a new input file from
Amazon S3.
# Arguments
- `client_token`: A unique identifier for the request. This token is automatically
generated when you use Amazon Translate through an AWS SDK.
- `name`: The name of the parallel data resource being updated.
- `parallel_data_config`: Specifies the format and S3 location of the parallel data input
file.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A custom description for the parallel data resource in Amazon Translate.
"""
function update_parallel_data(
ClientToken, Name, ParallelDataConfig; aws_config::AbstractAWSConfig=global_aws_config()
)
return translate(
"UpdateParallelData",
Dict{String,Any}(
"ClientToken" => ClientToken,
"Name" => Name,
"ParallelDataConfig" => ParallelDataConfig,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_parallel_data(
ClientToken,
Name,
ParallelDataConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return translate(
"UpdateParallelData",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientToken" => ClientToken,
"Name" => Name,
"ParallelDataConfig" => ParallelDataConfig,
),
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 | 16101 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: trustedadvisor
using AWS.Compat
using AWS.UUIDs
"""
batch_update_recommendation_resource_exclusion(recommendation_resource_exclusions)
batch_update_recommendation_resource_exclusion(recommendation_resource_exclusions, params::Dict{String,<:Any})
Update one or more exclusion status for a list of recommendation resources
# Arguments
- `recommendation_resource_exclusions`: A list of recommendation resource ARNs and
exclusion status to update
"""
function batch_update_recommendation_resource_exclusion(
recommendationResourceExclusions; aws_config::AbstractAWSConfig=global_aws_config()
)
return trustedadvisor(
"PUT",
"/v1/batch-update-recommendation-resource-exclusion",
Dict{String,Any}(
"recommendationResourceExclusions" => recommendationResourceExclusions
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_update_recommendation_resource_exclusion(
recommendationResourceExclusions,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return trustedadvisor(
"PUT",
"/v1/batch-update-recommendation-resource-exclusion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"recommendationResourceExclusions" => recommendationResourceExclusions
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_organization_recommendation(organization_recommendation_identifier)
get_organization_recommendation(organization_recommendation_identifier, params::Dict{String,<:Any})
Get a specific recommendation within an AWS Organizations organization. This API supports
only prioritized recommendations.
# Arguments
- `organization_recommendation_identifier`: The Recommendation identifier
"""
function get_organization_recommendation(
organizationRecommendationIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return trustedadvisor(
"GET",
"/v1/organization-recommendations/$(organizationRecommendationIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_organization_recommendation(
organizationRecommendationIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return trustedadvisor(
"GET",
"/v1/organization-recommendations/$(organizationRecommendationIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_recommendation(recommendation_identifier)
get_recommendation(recommendation_identifier, params::Dict{String,<:Any})
Get a specific Recommendation
# Arguments
- `recommendation_identifier`: The Recommendation identifier
"""
function get_recommendation(
recommendationIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return trustedadvisor(
"GET",
"/v1/recommendations/$(recommendationIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_recommendation(
recommendationIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return trustedadvisor(
"GET",
"/v1/recommendations/$(recommendationIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_checks()
list_checks(params::Dict{String,<:Any})
List a filterable set of Checks
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"awsService"`: The aws service associated with the check
- `"language"`: The ISO 639-1 code for the language that you want your checks to appear in.
- `"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.
- `"pillar"`: The pillar of the check
- `"source"`: The source of the check
"""
function list_checks(; aws_config::AbstractAWSConfig=global_aws_config())
return trustedadvisor(
"GET", "/v1/checks"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_checks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return trustedadvisor(
"GET", "/v1/checks", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_organization_recommendation_accounts(organization_recommendation_identifier)
list_organization_recommendation_accounts(organization_recommendation_identifier, params::Dict{String,<:Any})
Lists the accounts that own the resources for an organization aggregate recommendation.
This API only supports prioritized recommendations.
# Arguments
- `organization_recommendation_identifier`: The Recommendation identifier
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"affectedAccountId"`: An account affected by this organization recommendation
- `"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_organization_recommendation_accounts(
organizationRecommendationIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return trustedadvisor(
"GET",
"/v1/organization-recommendations/$(organizationRecommendationIdentifier)/accounts";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_organization_recommendation_accounts(
organizationRecommendationIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return trustedadvisor(
"GET",
"/v1/organization-recommendations/$(organizationRecommendationIdentifier)/accounts",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_organization_recommendation_resources(organization_recommendation_identifier)
list_organization_recommendation_resources(organization_recommendation_identifier, params::Dict{String,<:Any})
List Resources of a Recommendation within an Organization. This API only supports
prioritized recommendations.
# Arguments
- `organization_recommendation_identifier`: The AWS Organization organization's
Recommendation identifier
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"affectedAccountId"`: An account affected by this organization recommendation
- `"exclusionStatus"`: The exclusion status of the resource
- `"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.
- `"regionCode"`: The AWS Region code of the resource
- `"status"`: The status of the resource
"""
function list_organization_recommendation_resources(
organizationRecommendationIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return trustedadvisor(
"GET",
"/v1/organization-recommendations/$(organizationRecommendationIdentifier)/resources";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_organization_recommendation_resources(
organizationRecommendationIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return trustedadvisor(
"GET",
"/v1/organization-recommendations/$(organizationRecommendationIdentifier)/resources",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_organization_recommendations()
list_organization_recommendations(params::Dict{String,<:Any})
List a filterable set of Recommendations within an Organization. This API only supports
prioritized recommendations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"afterLastUpdatedAt"`: After the last update of the Recommendation
- `"awsService"`: The aws service associated with the Recommendation
- `"beforeLastUpdatedAt"`: Before the last update of the Recommendation
- `"checkIdentifier"`: The check identifier of the Recommendation
- `"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.
- `"pillar"`: The pillar of the Recommendation
- `"source"`: The source of the Recommendation
- `"status"`: The status of the Recommendation
- `"type"`: The type of the Recommendation
"""
function list_organization_recommendations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return trustedadvisor(
"GET",
"/v1/organization-recommendations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_organization_recommendations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return trustedadvisor(
"GET",
"/v1/organization-recommendations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_recommendation_resources(recommendation_identifier)
list_recommendation_resources(recommendation_identifier, params::Dict{String,<:Any})
List Resources of a Recommendation
# Arguments
- `recommendation_identifier`: The Recommendation identifier
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"exclusionStatus"`: The exclusion status of the resource
- `"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.
- `"regionCode"`: The AWS Region code of the resource
- `"status"`: The status of the resource
"""
function list_recommendation_resources(
recommendationIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return trustedadvisor(
"GET",
"/v1/recommendations/$(recommendationIdentifier)/resources";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_recommendation_resources(
recommendationIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return trustedadvisor(
"GET",
"/v1/recommendations/$(recommendationIdentifier)/resources",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_recommendations()
list_recommendations(params::Dict{String,<:Any})
List a filterable set of Recommendations
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"afterLastUpdatedAt"`: After the last update of the Recommendation
- `"awsService"`: The aws service associated with the Recommendation
- `"beforeLastUpdatedAt"`: Before the last update of the Recommendation
- `"checkIdentifier"`: The check identifier of the Recommendation
- `"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.
- `"pillar"`: The pillar of the Recommendation
- `"source"`: The source of the Recommendation
- `"status"`: The status of the Recommendation
- `"type"`: The type of the Recommendation
"""
function list_recommendations(; aws_config::AbstractAWSConfig=global_aws_config())
return trustedadvisor(
"GET", "/v1/recommendations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_recommendations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return trustedadvisor(
"GET",
"/v1/recommendations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_organization_recommendation_lifecycle(lifecycle_stage, organization_recommendation_identifier)
update_organization_recommendation_lifecycle(lifecycle_stage, organization_recommendation_identifier, params::Dict{String,<:Any})
Update the lifecycle of a Recommendation within an Organization. This API only supports
prioritized recommendations.
# Arguments
- `lifecycle_stage`: The new lifecycle stage
- `organization_recommendation_identifier`: The Recommendation identifier for AWS Trusted
Advisor Priority recommendations
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"updateReason"`: Reason for the lifecycle stage change
- `"updateReasonCode"`: Reason code for the lifecycle state change
"""
function update_organization_recommendation_lifecycle(
lifecycleStage,
organizationRecommendationIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return trustedadvisor(
"PUT",
"/v1/organization-recommendations/$(organizationRecommendationIdentifier)/lifecycle",
Dict{String,Any}("lifecycleStage" => lifecycleStage);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_organization_recommendation_lifecycle(
lifecycleStage,
organizationRecommendationIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return trustedadvisor(
"PUT",
"/v1/organization-recommendations/$(organizationRecommendationIdentifier)/lifecycle",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("lifecycleStage" => lifecycleStage), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_recommendation_lifecycle(lifecycle_stage, recommendation_identifier)
update_recommendation_lifecycle(lifecycle_stage, recommendation_identifier, params::Dict{String,<:Any})
Update the lifecyle of a Recommendation. This API only supports prioritized recommendations.
# Arguments
- `lifecycle_stage`: The new lifecycle stage
- `recommendation_identifier`: The Recommendation identifier for AWS Trusted Advisor
Priority recommendations
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"updateReason"`: Reason for the lifecycle stage change
- `"updateReasonCode"`: Reason code for the lifecycle state change
"""
function update_recommendation_lifecycle(
lifecycleStage,
recommendationIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return trustedadvisor(
"PUT",
"/v1/recommendations/$(recommendationIdentifier)/lifecycle",
Dict{String,Any}("lifecycleStage" => lifecycleStage);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_recommendation_lifecycle(
lifecycleStage,
recommendationIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return trustedadvisor(
"PUT",
"/v1/recommendations/$(recommendationIdentifier)/lifecycle",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("lifecycleStage" => lifecycleStage), 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 | 59801 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: verifiedpermissions
using AWS.Compat
using AWS.UUIDs
"""
batch_is_authorized(policy_store_id, requests)
batch_is_authorized(policy_store_id, requests, params::Dict{String,<:Any})
Makes a series of decisions about multiple authorization requests for one principal or
resource. Each request contains the equivalent content of an IsAuthorized request:
principal, action, resource, and context. Either the principal or the resource parameter
must be identical across all requests. For example, Verified Permissions won't evaluate a
pair of requests where bob views photo1 and alice views photo2. Authorization of bob to
view photo1 and photo2, or bob and alice to view photo1, are valid batches. The request is
evaluated against all policies in the specified policy store that match the entities that
you declare. The result of the decisions is a series of Allow or Deny responses, along with
the IDs of the policies that produced each decision. The entities of a BatchIsAuthorized
API request can contain up to 100 principals and up to 100 resources. The requests of a
BatchIsAuthorized API request can contain up to 30 requests. The BatchIsAuthorized
operation doesn't have its own IAM permission. To authorize this operation for Amazon Web
Services principals, include the permission verifiedpermissions:IsAuthorized in their IAM
policies.
# Arguments
- `policy_store_id`: Specifies the ID of the policy store. Policies in this policy store
will be used to make the authorization decisions for the input.
- `requests`: An array of up to 30 requests that you want Verified Permissions to evaluate.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"entities"`: Specifies the list of resources and principals and their associated
attributes that Verified Permissions can examine when evaluating the policies. You can
include only principal and resource entities in this parameter; you can't include actions.
You must specify actions in the schema.
"""
function batch_is_authorized(
policyStoreId, requests; aws_config::AbstractAWSConfig=global_aws_config()
)
return verifiedpermissions(
"BatchIsAuthorized",
Dict{String,Any}("policyStoreId" => policyStoreId, "requests" => requests);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_is_authorized(
policyStoreId,
requests,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return verifiedpermissions(
"BatchIsAuthorized",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("policyStoreId" => policyStoreId, "requests" => requests),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_is_authorized_with_token(policy_store_id, requests)
batch_is_authorized_with_token(policy_store_id, requests, params::Dict{String,<:Any})
Makes a series of decisions about multiple authorization requests for one token. The
principal in this request comes from an external identity source in the form of an identity
or access token, formatted as a JSON web token (JWT). The information in the parameters can
also define additional context that Verified Permissions can include in the evaluations.
The request is evaluated against all policies in the specified policy store that match the
entities that you provide in the entities declaration and in the token. The result of the
decisions is a series of Allow or Deny responses, along with the IDs of the policies that
produced each decision. The entities of a BatchIsAuthorizedWithToken API request can
contain up to 100 resources and up to 99 user groups. The requests of a
BatchIsAuthorizedWithToken API request can contain up to 30 requests. The
BatchIsAuthorizedWithToken operation doesn't have its own IAM permission. To authorize this
operation for Amazon Web Services principals, include the permission
verifiedpermissions:IsAuthorizedWithToken in their IAM policies.
# Arguments
- `policy_store_id`: Specifies the ID of the policy store. Policies in this policy store
will be used to make an authorization decision for the input.
- `requests`: An array of up to 30 requests that you want Verified Permissions to evaluate.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accessToken"`: Specifies an access token for the principal that you want to authorize
in each request. This token is provided to you by the identity provider (IdP) associated
with the specified identity source. You must specify either an accessToken, an
identityToken, or both. Must be an access token. Verified Permissions returns an error if
the token_use claim in the submitted token isn't access.
- `"entities"`: Specifies the list of resources and their associated attributes that
Verified Permissions can examine when evaluating the policies. You can't include
principals in this parameter, only resource and action entities. This parameter can't
include any entities of a type that matches the user or group entity types that you defined
in your identity source. The BatchIsAuthorizedWithToken operation takes principal
attributes from only the identityToken or accessToken passed to the operation. For
action entities, you can include only their Identifier and EntityType.
- `"identityToken"`: Specifies an identity (ID) token for the principal that you want to
authorize in each request. This token is provided to you by the identity provider (IdP)
associated with the specified identity source. You must specify either an accessToken, an
identityToken, or both. Must be an ID token. Verified Permissions returns an error if the
token_use claim in the submitted token isn't id.
"""
function batch_is_authorized_with_token(
policyStoreId, requests; aws_config::AbstractAWSConfig=global_aws_config()
)
return verifiedpermissions(
"BatchIsAuthorizedWithToken",
Dict{String,Any}("policyStoreId" => policyStoreId, "requests" => requests);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_is_authorized_with_token(
policyStoreId,
requests,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return verifiedpermissions(
"BatchIsAuthorizedWithToken",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("policyStoreId" => policyStoreId, "requests" => requests),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_identity_source(configuration, policy_store_id)
create_identity_source(configuration, policy_store_id, params::Dict{String,<:Any})
Adds an identity source to a policy store–an Amazon Cognito user pool or OpenID Connect
(OIDC) identity provider (IdP). After you create an identity source, you can use the
identities provided by the IdP as proxies for the principal in authorization queries that
use the IsAuthorizedWithToken or BatchIsAuthorizedWithToken API operations. These
identities take the form of tokens that contain claims about the user, such as IDs,
attributes and group memberships. Identity sources provide identity (ID) tokens and access
tokens. Verified Permissions derives information about your user and session from token
claims. Access tokens provide action context to your policies, and ID tokens provide
principal Attributes. Tokens from an identity source user continue to be usable until they
expire. Token revocation and resource deletion have no effect on the validity of a token in
your policy store To reference a user from this identity source in your Cedar policies,
refer to the following syntax examples. Amazon Cognito user pool: Namespace::[Entity
type]::[User pool ID]|[user principal attribute], for example
MyCorp::User::us-east-1_EXAMPLE|a1b2c3d4-5678-90ab-cdef-EXAMPLE11111. OpenID Connect
(OIDC) provider: Namespace::[Entity type]::[principalIdClaim]|[user principal attribute],
for example MyCorp::User::MyOIDCProvider|a1b2c3d4-5678-90ab-cdef-EXAMPLE22222. Verified
Permissions is eventually consistent . It can take a few seconds for a new or changed
element to propagate through the service and be visible in the results of other Verified
Permissions operations.
# Arguments
- `configuration`: Specifies the details required to communicate with the identity provider
(IdP) associated with this identity source.
- `policy_store_id`: Specifies the ID of the policy store in which you want to store this
identity source. Only policies and requests made using this policy store can reference
identities from the identity provider configured in the new identity source.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Specifies a unique, case-sensitive ID that you provide to ensure the
idempotency of the request. This lets you safely retry the request without accidentally
performing the same operation a second time. Passing the same value to a later call to an
operation requires that you also pass the same value for all other parameters. We recommend
that you use a UUID type of value.. If you don't provide this value, then Amazon Web
Services generates a random one for you. If you retry the operation with the same
ClientToken, but with different parameters, the retry fails with an ConflictException
error. Verified Permissions recognizes a ClientToken for eight hours. After eight hours,
the next request with the same parameters performs the operation again regardless of the
value of ClientToken.
- `"principalEntityType"`: Specifies the namespace and data type of the principals
generated for identities authenticated by the new identity source.
"""
function create_identity_source(
configuration, policyStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return verifiedpermissions(
"CreateIdentitySource",
Dict{String,Any}(
"configuration" => configuration,
"policyStoreId" => policyStoreId,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_identity_source(
configuration,
policyStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return verifiedpermissions(
"CreateIdentitySource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"configuration" => configuration,
"policyStoreId" => policyStoreId,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_policy(definition, policy_store_id)
create_policy(definition, policy_store_id, params::Dict{String,<:Any})
Creates a Cedar policy and saves it in the specified policy store. You can create either a
static policy or a policy linked to a policy template. To create a static policy, provide
the Cedar policy text in the StaticPolicy section of the PolicyDefinition. To create a
policy that is dynamically linked to a policy template, specify the policy template ID and
the principal and resource to associate with this policy in the templateLinked section of
the PolicyDefinition. If the policy template is ever updated, any policies linked to the
policy template automatically use the updated template. Creating a policy causes it to
be validated against the schema in the policy store. If the policy doesn't pass validation,
the operation fails and the policy isn't stored. Verified Permissions is eventually
consistent . It can take a few seconds for a new or changed element to propagate through
the service and be visible in the results of other Verified Permissions operations.
# Arguments
- `definition`: A structure that specifies the policy type and content to use for the new
policy. You must include either a static or a templateLinked element. The policy content
must be written in the Cedar policy language.
- `policy_store_id`: Specifies the PolicyStoreId of the policy store you want to store the
policy in.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Specifies a unique, case-sensitive ID that you provide to ensure the
idempotency of the request. This lets you safely retry the request without accidentally
performing the same operation a second time. Passing the same value to a later call to an
operation requires that you also pass the same value for all other parameters. We recommend
that you use a UUID type of value.. If you don't provide this value, then Amazon Web
Services generates a random one for you. If you retry the operation with the same
ClientToken, but with different parameters, the retry fails with an ConflictException
error. Verified Permissions recognizes a ClientToken for eight hours. After eight hours,
the next request with the same parameters performs the operation again regardless of the
value of ClientToken.
"""
function create_policy(
definition, policyStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return verifiedpermissions(
"CreatePolicy",
Dict{String,Any}(
"definition" => definition,
"policyStoreId" => policyStoreId,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_policy(
definition,
policyStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return verifiedpermissions(
"CreatePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"definition" => definition,
"policyStoreId" => policyStoreId,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_policy_store(validation_settings)
create_policy_store(validation_settings, params::Dict{String,<:Any})
Creates a policy store. A policy store is a container for policy resources. Although Cedar
supports multiple namespaces, Verified Permissions currently supports only one namespace
per policy store. Verified Permissions is eventually consistent . It can take a few
seconds for a new or changed element to propagate through the service and be visible in the
results of other Verified Permissions operations.
# Arguments
- `validation_settings`: Specifies the validation setting for this policy store. Currently,
the only valid and required value is Mode. We recommend that you turn on STRICT mode only
after you define a schema. If a schema doesn't exist, then STRICT mode causes any policy to
fail validation, and Verified Permissions rejects the policy. You can turn off validation
by using the UpdatePolicyStore. Then, when you have a schema defined, use UpdatePolicyStore
again to turn validation back on.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Specifies a unique, case-sensitive ID that you provide to ensure the
idempotency of the request. This lets you safely retry the request without accidentally
performing the same operation a second time. Passing the same value to a later call to an
operation requires that you also pass the same value for all other parameters. We recommend
that you use a UUID type of value.. If you don't provide this value, then Amazon Web
Services generates a random one for you. If you retry the operation with the same
ClientToken, but with different parameters, the retry fails with an ConflictException
error. Verified Permissions recognizes a ClientToken for eight hours. After eight hours,
the next request with the same parameters performs the operation again regardless of the
value of ClientToken.
- `"description"`: Descriptive text that you can provide to help with identification of the
current policy store.
"""
function create_policy_store(
validationSettings; aws_config::AbstractAWSConfig=global_aws_config()
)
return verifiedpermissions(
"CreatePolicyStore",
Dict{String,Any}(
"validationSettings" => validationSettings, "clientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_policy_store(
validationSettings,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return verifiedpermissions(
"CreatePolicyStore",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"validationSettings" => validationSettings,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_policy_template(policy_store_id, statement)
create_policy_template(policy_store_id, statement, params::Dict{String,<:Any})
Creates a policy template. A template can use placeholders for the principal and resource.
A template must be instantiated into a policy by associating it with specific principals
and resources to use for the placeholders. That instantiated policy can then be considered
in authorization decisions. The instantiated policy works identically to any other policy,
except that it is dynamically linked to the template. If the template changes, then any
policies that are linked to that template are immediately updated as well. Verified
Permissions is eventually consistent . It can take a few seconds for a new or changed
element to propagate through the service and be visible in the results of other Verified
Permissions operations.
# Arguments
- `policy_store_id`: The ID of the policy store in which to create the policy template.
- `statement`: Specifies the content that you want to use for the new policy template,
written in the Cedar policy language.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Specifies a unique, case-sensitive ID that you provide to ensure the
idempotency of the request. This lets you safely retry the request without accidentally
performing the same operation a second time. Passing the same value to a later call to an
operation requires that you also pass the same value for all other parameters. We recommend
that you use a UUID type of value.. If you don't provide this value, then Amazon Web
Services generates a random one for you. If you retry the operation with the same
ClientToken, but with different parameters, the retry fails with an ConflictException
error. Verified Permissions recognizes a ClientToken for eight hours. After eight hours,
the next request with the same parameters performs the operation again regardless of the
value of ClientToken.
- `"description"`: Specifies a description for the policy template.
"""
function create_policy_template(
policyStoreId, statement; aws_config::AbstractAWSConfig=global_aws_config()
)
return verifiedpermissions(
"CreatePolicyTemplate",
Dict{String,Any}(
"policyStoreId" => policyStoreId,
"statement" => statement,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_policy_template(
policyStoreId,
statement,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return verifiedpermissions(
"CreatePolicyTemplate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"policyStoreId" => policyStoreId,
"statement" => statement,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_identity_source(identity_source_id, policy_store_id)
delete_identity_source(identity_source_id, policy_store_id, params::Dict{String,<:Any})
Deletes an identity source that references an identity provider (IdP) such as Amazon
Cognito. After you delete the identity source, you can no longer use tokens for identities
from that identity source to represent principals in authorization queries made using
IsAuthorizedWithToken. operations.
# Arguments
- `identity_source_id`: Specifies the ID of the identity source that you want to delete.
- `policy_store_id`: Specifies the ID of the policy store that contains the identity source
that you want to delete.
"""
function delete_identity_source(
identitySourceId, policyStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return verifiedpermissions(
"DeleteIdentitySource",
Dict{String,Any}(
"identitySourceId" => identitySourceId, "policyStoreId" => policyStoreId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_identity_source(
identitySourceId,
policyStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return verifiedpermissions(
"DeleteIdentitySource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"identitySourceId" => identitySourceId, "policyStoreId" => policyStoreId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_policy(policy_id, policy_store_id)
delete_policy(policy_id, policy_store_id, params::Dict{String,<:Any})
Deletes the specified policy from the policy store. This operation is idempotent; if you
specify a policy that doesn't exist, the request response returns a successful HTTP 200
status code.
# Arguments
- `policy_id`: Specifies the ID of the policy that you want to delete.
- `policy_store_id`: Specifies the ID of the policy store that contains the policy that you
want to delete.
"""
function delete_policy(
policyId, policyStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return verifiedpermissions(
"DeletePolicy",
Dict{String,Any}("policyId" => policyId, "policyStoreId" => policyStoreId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_policy(
policyId,
policyStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return verifiedpermissions(
"DeletePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("policyId" => policyId, "policyStoreId" => policyStoreId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_policy_store(policy_store_id)
delete_policy_store(policy_store_id, params::Dict{String,<:Any})
Deletes the specified policy store. This operation is idempotent. If you specify a policy
store that does not exist, the request response will still return a successful HTTP 200
status code.
# Arguments
- `policy_store_id`: Specifies the ID of the policy store that you want to delete.
"""
function delete_policy_store(
policyStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return verifiedpermissions(
"DeletePolicyStore",
Dict{String,Any}("policyStoreId" => policyStoreId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_policy_store(
policyStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return verifiedpermissions(
"DeletePolicyStore",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("policyStoreId" => policyStoreId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_policy_template(policy_store_id, policy_template_id)
delete_policy_template(policy_store_id, policy_template_id, params::Dict{String,<:Any})
Deletes the specified policy template from the policy store. This operation also deletes
any policies that were created from the specified policy template. Those policies are
immediately removed from all future API responses, and are asynchronously deleted from the
policy store.
# Arguments
- `policy_store_id`: Specifies the ID of the policy store that contains the policy template
that you want to delete.
- `policy_template_id`: Specifies the ID of the policy template that you want to delete.
"""
function delete_policy_template(
policyStoreId, policyTemplateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return verifiedpermissions(
"DeletePolicyTemplate",
Dict{String,Any}(
"policyStoreId" => policyStoreId, "policyTemplateId" => policyTemplateId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_policy_template(
policyStoreId,
policyTemplateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return verifiedpermissions(
"DeletePolicyTemplate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"policyStoreId" => policyStoreId, "policyTemplateId" => policyTemplateId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_identity_source(identity_source_id, policy_store_id)
get_identity_source(identity_source_id, policy_store_id, params::Dict{String,<:Any})
Retrieves the details about the specified identity source.
# Arguments
- `identity_source_id`: Specifies the ID of the identity source you want information about.
- `policy_store_id`: Specifies the ID of the policy store that contains the identity source
you want information about.
"""
function get_identity_source(
identitySourceId, policyStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return verifiedpermissions(
"GetIdentitySource",
Dict{String,Any}(
"identitySourceId" => identitySourceId, "policyStoreId" => policyStoreId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_identity_source(
identitySourceId,
policyStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return verifiedpermissions(
"GetIdentitySource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"identitySourceId" => identitySourceId, "policyStoreId" => policyStoreId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_policy(policy_id, policy_store_id)
get_policy(policy_id, policy_store_id, params::Dict{String,<:Any})
Retrieves information about the specified policy.
# Arguments
- `policy_id`: Specifies the ID of the policy you want information about.
- `policy_store_id`: Specifies the ID of the policy store that contains the policy that you
want information about.
"""
function get_policy(
policyId, policyStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return verifiedpermissions(
"GetPolicy",
Dict{String,Any}("policyId" => policyId, "policyStoreId" => policyStoreId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_policy(
policyId,
policyStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return verifiedpermissions(
"GetPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("policyId" => policyId, "policyStoreId" => policyStoreId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_policy_store(policy_store_id)
get_policy_store(policy_store_id, params::Dict{String,<:Any})
Retrieves details about a policy store.
# Arguments
- `policy_store_id`: Specifies the ID of the policy store that you want information about.
"""
function get_policy_store(policyStoreId; aws_config::AbstractAWSConfig=global_aws_config())
return verifiedpermissions(
"GetPolicyStore",
Dict{String,Any}("policyStoreId" => policyStoreId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_policy_store(
policyStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return verifiedpermissions(
"GetPolicyStore",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("policyStoreId" => policyStoreId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_policy_template(policy_store_id, policy_template_id)
get_policy_template(policy_store_id, policy_template_id, params::Dict{String,<:Any})
Retrieve the details for the specified policy template in the specified policy store.
# Arguments
- `policy_store_id`: Specifies the ID of the policy store that contains the policy template
that you want information about.
- `policy_template_id`: Specifies the ID of the policy template that you want information
about.
"""
function get_policy_template(
policyStoreId, policyTemplateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return verifiedpermissions(
"GetPolicyTemplate",
Dict{String,Any}(
"policyStoreId" => policyStoreId, "policyTemplateId" => policyTemplateId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_policy_template(
policyStoreId,
policyTemplateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return verifiedpermissions(
"GetPolicyTemplate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"policyStoreId" => policyStoreId, "policyTemplateId" => policyTemplateId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_schema(policy_store_id)
get_schema(policy_store_id, params::Dict{String,<:Any})
Retrieve the details for the specified schema in the specified policy store.
# Arguments
- `policy_store_id`: Specifies the ID of the policy store that contains the schema.
"""
function get_schema(policyStoreId; aws_config::AbstractAWSConfig=global_aws_config())
return verifiedpermissions(
"GetSchema",
Dict{String,Any}("policyStoreId" => policyStoreId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_schema(
policyStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return verifiedpermissions(
"GetSchema",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("policyStoreId" => policyStoreId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
is_authorized(policy_store_id)
is_authorized(policy_store_id, params::Dict{String,<:Any})
Makes an authorization decision about a service request described in the parameters. The
information in the parameters can also define additional context that Verified Permissions
can include in the evaluation. The request is evaluated against all matching policies in
the specified policy store. The result of the decision is either Allow or Deny, along with
a list of the policies that resulted in the decision.
# Arguments
- `policy_store_id`: Specifies the ID of the policy store. Policies in this policy store
will be used to make an authorization decision for the input.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"action"`: Specifies the requested action to be authorized. For example, is the
principal authorized to perform this action on the resource?
- `"context"`: Specifies additional context that can be used to make more granular
authorization decisions.
- `"entities"`: Specifies the list of resources and principals and their associated
attributes that Verified Permissions can examine when evaluating the policies. You can
include only principal and resource entities in this parameter; you can't include actions.
You must specify actions in the schema.
- `"principal"`: Specifies the principal for which the authorization decision is to be made.
- `"resource"`: Specifies the resource for which the authorization decision is to be made.
"""
function is_authorized(policyStoreId; aws_config::AbstractAWSConfig=global_aws_config())
return verifiedpermissions(
"IsAuthorized",
Dict{String,Any}("policyStoreId" => policyStoreId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function is_authorized(
policyStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return verifiedpermissions(
"IsAuthorized",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("policyStoreId" => policyStoreId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
is_authorized_with_token(policy_store_id)
is_authorized_with_token(policy_store_id, params::Dict{String,<:Any})
Makes an authorization decision about a service request described in the parameters. The
principal in this request comes from an external identity source in the form of an identity
token formatted as a JSON web token (JWT). The information in the parameters can also
define additional context that Verified Permissions can include in the evaluation. The
request is evaluated against all matching policies in the specified policy store. The
result of the decision is either Allow or Deny, along with a list of the policies that
resulted in the decision. At this time, Verified Permissions accepts tokens from only
Amazon Cognito. Verified Permissions validates each token that is specified in a request by
checking its expiration date and its signature. Tokens from an identity source user
continue to be usable until they expire. Token revocation and resource deletion have no
effect on the validity of a token in your policy store
# Arguments
- `policy_store_id`: Specifies the ID of the policy store. Policies in this policy store
will be used to make an authorization decision for the input.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accessToken"`: Specifies an access token for the principal to be authorized. This token
is provided to you by the identity provider (IdP) associated with the specified identity
source. You must specify either an accessToken, an identityToken, or both. Must be an
access token. Verified Permissions returns an error if the token_use claim in the submitted
token isn't access.
- `"action"`: Specifies the requested action to be authorized. Is the specified principal
authorized to perform this action on the specified resource.
- `"context"`: Specifies additional context that can be used to make more granular
authorization decisions.
- `"entities"`: Specifies the list of resources and their associated attributes that
Verified Permissions can examine when evaluating the policies. You can't include
principals in this parameter, only resource and action entities. This parameter can't
include any entities of a type that matches the user or group entity types that you defined
in your identity source. The IsAuthorizedWithToken operation takes principal attributes
from only the identityToken or accessToken passed to the operation. For action
entities, you can include only their Identifier and EntityType.
- `"identityToken"`: Specifies an identity token for the principal to be authorized. This
token is provided to you by the identity provider (IdP) associated with the specified
identity source. You must specify either an accessToken, an identityToken, or both. Must be
an ID token. Verified Permissions returns an error if the token_use claim in the submitted
token isn't id.
- `"resource"`: Specifies the resource for which the authorization decision is made. For
example, is the principal allowed to perform the action on the resource?
"""
function is_authorized_with_token(
policyStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return verifiedpermissions(
"IsAuthorizedWithToken",
Dict{String,Any}("policyStoreId" => policyStoreId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function is_authorized_with_token(
policyStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return verifiedpermissions(
"IsAuthorizedWithToken",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("policyStoreId" => policyStoreId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_identity_sources(policy_store_id)
list_identity_sources(policy_store_id, params::Dict{String,<:Any})
Returns a paginated list of all of the identity sources defined in the specified policy
store.
# Arguments
- `policy_store_id`: Specifies the ID of the policy store that contains the identity
sources that you want to list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: Specifies characteristics of an identity source that you can use to limit
the output to matching identity sources.
- `"maxResults"`: Specifies the total number of results that you want included in each
response. If additional items exist beyond the number you specify, the NextToken response
element is returned with a value (not null). Include the specified value as the NextToken
request parameter in the next call to the operation to get the next set of results. Note
that the service might return fewer results than the maximum even when there are more
results available. You should check NextToken after every operation to ensure that you
receive all of the results. If you do not specify this parameter, the operation defaults to
10 identity sources per response. You can specify a maximum of 50 identity sources per
response.
- `"nextToken"`: Specifies that you want to receive the next page of results. Valid only if
you received a NextToken response in the previous request. If you did, it indicates that
more output is available. Set this parameter to the value provided by the previous call's
NextToken response to request the next page of results.
"""
function list_identity_sources(
policyStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return verifiedpermissions(
"ListIdentitySources",
Dict{String,Any}("policyStoreId" => policyStoreId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_identity_sources(
policyStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return verifiedpermissions(
"ListIdentitySources",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("policyStoreId" => policyStoreId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_policies(policy_store_id)
list_policies(policy_store_id, params::Dict{String,<:Any})
Returns a paginated list of all policies stored in the specified policy store.
# Arguments
- `policy_store_id`: Specifies the ID of the policy store you want to list policies from.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: Specifies a filter that limits the response to only policies that match the
specified criteria. For example, you list only the policies that reference a specified
principal.
- `"maxResults"`: Specifies the total number of results that you want included in each
response. If additional items exist beyond the number you specify, the NextToken response
element is returned with a value (not null). Include the specified value as the NextToken
request parameter in the next call to the operation to get the next set of results. Note
that the service might return fewer results than the maximum even when there are more
results available. You should check NextToken after every operation to ensure that you
receive all of the results. If you do not specify this parameter, the operation defaults to
10 policies per response. You can specify a maximum of 50 policies per response.
- `"nextToken"`: Specifies that you want to receive the next page of results. Valid only if
you received a NextToken response in the previous request. If you did, it indicates that
more output is available. Set this parameter to the value provided by the previous call's
NextToken response to request the next page of results.
"""
function list_policies(policyStoreId; aws_config::AbstractAWSConfig=global_aws_config())
return verifiedpermissions(
"ListPolicies",
Dict{String,Any}("policyStoreId" => policyStoreId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_policies(
policyStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return verifiedpermissions(
"ListPolicies",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("policyStoreId" => policyStoreId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_policy_stores()
list_policy_stores(params::Dict{String,<:Any})
Returns a paginated list of all policy stores in the calling Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Specifies the total number of results that you want included in each
response. If additional items exist beyond the number you specify, the NextToken response
element is returned with a value (not null). Include the specified value as the NextToken
request parameter in the next call to the operation to get the next set of results. Note
that the service might return fewer results than the maximum even when there are more
results available. You should check NextToken after every operation to ensure that you
receive all of the results. If you do not specify this parameter, the operation defaults to
10 policy stores per response. You can specify a maximum of 50 policy stores per response.
- `"nextToken"`: Specifies that you want to receive the next page of results. Valid only if
you received a NextToken response in the previous request. If you did, it indicates that
more output is available. Set this parameter to the value provided by the previous call's
NextToken response to request the next page of results.
"""
function list_policy_stores(; aws_config::AbstractAWSConfig=global_aws_config())
return verifiedpermissions(
"ListPolicyStores"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_policy_stores(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return verifiedpermissions(
"ListPolicyStores", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_policy_templates(policy_store_id)
list_policy_templates(policy_store_id, params::Dict{String,<:Any})
Returns a paginated list of all policy templates in the specified policy store.
# Arguments
- `policy_store_id`: Specifies the ID of the policy store that contains the policy
templates you want to list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Specifies the total number of results that you want included in each
response. If additional items exist beyond the number you specify, the NextToken response
element is returned with a value (not null). Include the specified value as the NextToken
request parameter in the next call to the operation to get the next set of results. Note
that the service might return fewer results than the maximum even when there are more
results available. You should check NextToken after every operation to ensure that you
receive all of the results. If you do not specify this parameter, the operation defaults to
10 policy templates per response. You can specify a maximum of 50 policy templates per
response.
- `"nextToken"`: Specifies that you want to receive the next page of results. Valid only if
you received a NextToken response in the previous request. If you did, it indicates that
more output is available. Set this parameter to the value provided by the previous call's
NextToken response to request the next page of results.
"""
function list_policy_templates(
policyStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return verifiedpermissions(
"ListPolicyTemplates",
Dict{String,Any}("policyStoreId" => policyStoreId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_policy_templates(
policyStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return verifiedpermissions(
"ListPolicyTemplates",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("policyStoreId" => policyStoreId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_schema(definition, policy_store_id)
put_schema(definition, policy_store_id, params::Dict{String,<:Any})
Creates or updates the policy schema in the specified policy store. The schema is used to
validate any Cedar policies and policy templates submitted to the policy store. Any changes
to the schema validate only policies and templates submitted after the schema change.
Existing policies and templates are not re-evaluated against the changed schema. If you
later update a policy, then it is evaluated against the new schema at that time. Verified
Permissions is eventually consistent . It can take a few seconds for a new or changed
element to propagate through the service and be visible in the results of other Verified
Permissions operations.
# Arguments
- `definition`: Specifies the definition of the schema to be stored. The schema definition
must be written in Cedar schema JSON.
- `policy_store_id`: Specifies the ID of the policy store in which to place the schema.
"""
function put_schema(
definition, policyStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return verifiedpermissions(
"PutSchema",
Dict{String,Any}("definition" => definition, "policyStoreId" => policyStoreId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_schema(
definition,
policyStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return verifiedpermissions(
"PutSchema",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"definition" => definition, "policyStoreId" => policyStoreId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_identity_source(identity_source_id, policy_store_id, update_configuration)
update_identity_source(identity_source_id, policy_store_id, update_configuration, params::Dict{String,<:Any})
Updates the specified identity source to use a new identity provider (IdP), or to change
the mapping of identities from the IdP to a different principal entity type. Verified
Permissions is eventually consistent . It can take a few seconds for a new or changed
element to propagate through the service and be visible in the results of other Verified
Permissions operations.
# Arguments
- `identity_source_id`: Specifies the ID of the identity source that you want to update.
- `policy_store_id`: Specifies the ID of the policy store that contains the identity source
that you want to update.
- `update_configuration`: Specifies the details required to communicate with the identity
provider (IdP) associated with this identity source. At this time, the only valid member
of this structure is a Amazon Cognito user pool configuration. You must specify a
userPoolArn, and optionally, a ClientId.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"principalEntityType"`: Specifies the data type of principals generated for identities
authenticated by the identity source.
"""
function update_identity_source(
identitySourceId,
policyStoreId,
updateConfiguration;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return verifiedpermissions(
"UpdateIdentitySource",
Dict{String,Any}(
"identitySourceId" => identitySourceId,
"policyStoreId" => policyStoreId,
"updateConfiguration" => updateConfiguration,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_identity_source(
identitySourceId,
policyStoreId,
updateConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return verifiedpermissions(
"UpdateIdentitySource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"identitySourceId" => identitySourceId,
"policyStoreId" => policyStoreId,
"updateConfiguration" => updateConfiguration,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_policy(definition, policy_id, policy_store_id)
update_policy(definition, policy_id, policy_store_id, params::Dict{String,<:Any})
Modifies a Cedar static policy in the specified policy store. You can change only certain
elements of the UpdatePolicyDefinition parameter. You can directly update only static
policies. To change a template-linked policy, you must update the template instead, using
UpdatePolicyTemplate. If policy validation is enabled in the policy store, then updating
a static policy causes Verified Permissions to validate the policy against the schema in
the policy store. If the updated static policy doesn't pass validation, the operation fails
and the update isn't stored. When you edit a static policy, you can change only certain
elements of a static policy: The action referenced by the policy. A condition clause,
such as when and unless. You can't change these elements of a static policy: Changing
a policy from a static policy to a template-linked policy. Changing the effect of a
static policy from permit or forbid. The principal referenced by a static policy. The
resource referenced by a static policy. To update a template-linked policy, you must
update the template instead. Verified Permissions is eventually consistent . It can
take a few seconds for a new or changed element to propagate through the service and be
visible in the results of other Verified Permissions operations.
# Arguments
- `definition`: Specifies the updated policy content that you want to replace on the
specified policy. The content must be valid Cedar policy language text. You can change only
the following elements from the policy definition: The action referenced by the policy.
Any conditional clauses, such as when or unless clauses. You can't change the following
elements: Changing from static to templateLinked. Changing the effect of the policy
from permit or forbid. The principal referenced by the policy. The resource referenced
by the policy.
- `policy_id`: Specifies the ID of the policy that you want to update. To find this value,
you can use ListPolicies.
- `policy_store_id`: Specifies the ID of the policy store that contains the policy that you
want to update.
"""
function update_policy(
definition, policyId, policyStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return verifiedpermissions(
"UpdatePolicy",
Dict{String,Any}(
"definition" => definition,
"policyId" => policyId,
"policyStoreId" => policyStoreId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_policy(
definition,
policyId,
policyStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return verifiedpermissions(
"UpdatePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"definition" => definition,
"policyId" => policyId,
"policyStoreId" => policyStoreId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_policy_store(policy_store_id, validation_settings)
update_policy_store(policy_store_id, validation_settings, params::Dict{String,<:Any})
Modifies the validation setting for a policy store. Verified Permissions is eventually
consistent . It can take a few seconds for a new or changed element to propagate through
the service and be visible in the results of other Verified Permissions operations.
# Arguments
- `policy_store_id`: Specifies the ID of the policy store that you want to update
- `validation_settings`: A structure that defines the validation settings that want to
enable for the policy store.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: Descriptive text that you can provide to help with identification of the
current policy store.
"""
function update_policy_store(
policyStoreId, validationSettings; aws_config::AbstractAWSConfig=global_aws_config()
)
return verifiedpermissions(
"UpdatePolicyStore",
Dict{String,Any}(
"policyStoreId" => policyStoreId, "validationSettings" => validationSettings
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_policy_store(
policyStoreId,
validationSettings,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return verifiedpermissions(
"UpdatePolicyStore",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"policyStoreId" => policyStoreId,
"validationSettings" => validationSettings,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_policy_template(policy_store_id, policy_template_id, statement)
update_policy_template(policy_store_id, policy_template_id, statement, params::Dict{String,<:Any})
Updates the specified policy template. You can update only the description and the some
elements of the policyBody. Changes you make to the policy template content are
immediately (within the constraints of eventual consistency) reflected in authorization
decisions that involve all template-linked policies instantiated from this template.
Verified Permissions is eventually consistent . It can take a few seconds for a new or
changed element to propagate through the service and be visible in the results of other
Verified Permissions operations.
# Arguments
- `policy_store_id`: Specifies the ID of the policy store that contains the policy template
that you want to update.
- `policy_template_id`: Specifies the ID of the policy template that you want to update.
- `statement`: Specifies new statement content written in Cedar policy language to replace
the current body of the policy template. You can change only the following elements of the
policy body: The action referenced by the policy template. Any conditional clauses,
such as when or unless clauses. You can't change the following elements: The effect
(permit or forbid) of the policy template. The principal referenced by the policy
template. The resource referenced by the policy template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: Specifies a new description to apply to the policy template.
"""
function update_policy_template(
policyStoreId,
policyTemplateId,
statement;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return verifiedpermissions(
"UpdatePolicyTemplate",
Dict{String,Any}(
"policyStoreId" => policyStoreId,
"policyTemplateId" => policyTemplateId,
"statement" => statement,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_policy_template(
policyStoreId,
policyTemplateId,
statement,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return verifiedpermissions(
"UpdatePolicyTemplate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"policyStoreId" => policyStoreId,
"policyTemplateId" => policyTemplateId,
"statement" => statement,
),
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 | 43777 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: voice_id
using AWS.Compat
using AWS.UUIDs
"""
associate_fraudster(domain_id, fraudster_id, watchlist_id)
associate_fraudster(domain_id, fraudster_id, watchlist_id, params::Dict{String,<:Any})
Associates the fraudsters with the watchlist specified in the same domain.
# Arguments
- `domain_id`: The identifier of the domain that contains the fraudster.
- `fraudster_id`: The identifier of the fraudster to be associated with the watchlist.
- `watchlist_id`: The identifier of the watchlist you want to associate with the fraudster.
"""
function associate_fraudster(
DomainId, FraudsterId, WatchlistId; aws_config::AbstractAWSConfig=global_aws_config()
)
return voice_id(
"AssociateFraudster",
Dict{String,Any}(
"DomainId" => DomainId,
"FraudsterId" => FraudsterId,
"WatchlistId" => WatchlistId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_fraudster(
DomainId,
FraudsterId,
WatchlistId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return voice_id(
"AssociateFraudster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DomainId" => DomainId,
"FraudsterId" => FraudsterId,
"WatchlistId" => WatchlistId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_domain(name, server_side_encryption_configuration)
create_domain(name, server_side_encryption_configuration, params::Dict{String,<:Any})
Creates a domain that contains all Amazon Connect Voice ID data, such as speakers,
fraudsters, customer audio, and voiceprints. Every domain is created with a default
watchlist that fraudsters can be a part of.
# Arguments
- `name`: The name of the domain.
- `server_side_encryption_configuration`: The configuration, containing the KMS key
identifier, to be used by Voice ID for the server-side encryption of your data. Refer to
Amazon Connect Voice ID encryption at rest for more details on how the KMS key is used.
# 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 brief description of this domain.
- `"Tags"`: A list of tags you want added to the domain.
"""
function create_domain(
Name,
ServerSideEncryptionConfiguration;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return voice_id(
"CreateDomain",
Dict{String,Any}(
"Name" => Name,
"ServerSideEncryptionConfiguration" => ServerSideEncryptionConfiguration,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_domain(
Name,
ServerSideEncryptionConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return voice_id(
"CreateDomain",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Name" => Name,
"ServerSideEncryptionConfiguration" =>
ServerSideEncryptionConfiguration,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_watchlist(domain_id, name)
create_watchlist(domain_id, name, params::Dict{String,<:Any})
Creates a watchlist that fraudsters can be a part of.
# Arguments
- `domain_id`: The identifier of the domain that contains the watchlist.
- `name`: The name of the watchlist.
# 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 brief description of this watchlist.
"""
function create_watchlist(DomainId, Name; aws_config::AbstractAWSConfig=global_aws_config())
return voice_id(
"CreateWatchlist",
Dict{String,Any}(
"DomainId" => DomainId, "Name" => Name, "ClientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_watchlist(
DomainId,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return voice_id(
"CreateWatchlist",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DomainId" => DomainId, "Name" => Name, "ClientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_domain(domain_id)
delete_domain(domain_id, params::Dict{String,<:Any})
Deletes the specified domain from Voice ID.
# Arguments
- `domain_id`: The identifier of the domain you want to delete.
"""
function delete_domain(DomainId; aws_config::AbstractAWSConfig=global_aws_config())
return voice_id(
"DeleteDomain",
Dict{String,Any}("DomainId" => 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 voice_id(
"DeleteDomain",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainId" => DomainId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_fraudster(domain_id, fraudster_id)
delete_fraudster(domain_id, fraudster_id, params::Dict{String,<:Any})
Deletes the specified fraudster from Voice ID. This action disassociates the fraudster from
any watchlists it is a part of.
# Arguments
- `domain_id`: The identifier of the domain that contains the fraudster.
- `fraudster_id`: The identifier of the fraudster you want to delete.
"""
function delete_fraudster(
DomainId, FraudsterId; aws_config::AbstractAWSConfig=global_aws_config()
)
return voice_id(
"DeleteFraudster",
Dict{String,Any}("DomainId" => DomainId, "FraudsterId" => FraudsterId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_fraudster(
DomainId,
FraudsterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return voice_id(
"DeleteFraudster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DomainId" => DomainId, "FraudsterId" => FraudsterId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_speaker(domain_id, speaker_id)
delete_speaker(domain_id, speaker_id, params::Dict{String,<:Any})
Deletes the specified speaker from Voice ID.
# Arguments
- `domain_id`: The identifier of the domain that contains the speaker.
- `speaker_id`: The identifier of the speaker you want to delete.
"""
function delete_speaker(
DomainId, SpeakerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return voice_id(
"DeleteSpeaker",
Dict{String,Any}("DomainId" => DomainId, "SpeakerId" => SpeakerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_speaker(
DomainId,
SpeakerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return voice_id(
"DeleteSpeaker",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DomainId" => DomainId, "SpeakerId" => SpeakerId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_watchlist(domain_id, watchlist_id)
delete_watchlist(domain_id, watchlist_id, params::Dict{String,<:Any})
Deletes the specified watchlist from Voice ID. This API throws an exception when there are
fraudsters in the watchlist that you are trying to delete. You must delete the fraudsters,
and then delete the watchlist. Every domain has a default watchlist which cannot be
deleted.
# Arguments
- `domain_id`: The identifier of the domain that contains the watchlist.
- `watchlist_id`: The identifier of the watchlist to be deleted.
"""
function delete_watchlist(
DomainId, WatchlistId; aws_config::AbstractAWSConfig=global_aws_config()
)
return voice_id(
"DeleteWatchlist",
Dict{String,Any}("DomainId" => DomainId, "WatchlistId" => WatchlistId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_watchlist(
DomainId,
WatchlistId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return voice_id(
"DeleteWatchlist",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DomainId" => DomainId, "WatchlistId" => WatchlistId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_domain(domain_id)
describe_domain(domain_id, params::Dict{String,<:Any})
Describes the specified domain.
# Arguments
- `domain_id`: The identifier of the domain that you are describing.
"""
function describe_domain(DomainId; aws_config::AbstractAWSConfig=global_aws_config())
return voice_id(
"DescribeDomain",
Dict{String,Any}("DomainId" => DomainId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_domain(
DomainId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return voice_id(
"DescribeDomain",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainId" => DomainId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_fraudster(domain_id, fraudster_id)
describe_fraudster(domain_id, fraudster_id, params::Dict{String,<:Any})
Describes the specified fraudster.
# Arguments
- `domain_id`: The identifier of the domain that contains the fraudster.
- `fraudster_id`: The identifier of the fraudster you are describing.
"""
function describe_fraudster(
DomainId, FraudsterId; aws_config::AbstractAWSConfig=global_aws_config()
)
return voice_id(
"DescribeFraudster",
Dict{String,Any}("DomainId" => DomainId, "FraudsterId" => FraudsterId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_fraudster(
DomainId,
FraudsterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return voice_id(
"DescribeFraudster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DomainId" => DomainId, "FraudsterId" => FraudsterId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_fraudster_registration_job(domain_id, job_id)
describe_fraudster_registration_job(domain_id, job_id, params::Dict{String,<:Any})
Describes the specified fraudster registration job.
# Arguments
- `domain_id`: The identifier of the domain that contains the fraudster registration job.
- `job_id`: The identifier of the fraudster registration job you are describing.
"""
function describe_fraudster_registration_job(
DomainId, JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return voice_id(
"DescribeFraudsterRegistrationJob",
Dict{String,Any}("DomainId" => DomainId, "JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_fraudster_registration_job(
DomainId,
JobId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return voice_id(
"DescribeFraudsterRegistrationJob",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("DomainId" => DomainId, "JobId" => JobId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_speaker(domain_id, speaker_id)
describe_speaker(domain_id, speaker_id, params::Dict{String,<:Any})
Describes the specified speaker.
# Arguments
- `domain_id`: The identifier of the domain that contains the speaker.
- `speaker_id`: The identifier of the speaker you are describing.
"""
function describe_speaker(
DomainId, SpeakerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return voice_id(
"DescribeSpeaker",
Dict{String,Any}("DomainId" => DomainId, "SpeakerId" => SpeakerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_speaker(
DomainId,
SpeakerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return voice_id(
"DescribeSpeaker",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DomainId" => DomainId, "SpeakerId" => SpeakerId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_speaker_enrollment_job(domain_id, job_id)
describe_speaker_enrollment_job(domain_id, job_id, params::Dict{String,<:Any})
Describes the specified speaker enrollment job.
# Arguments
- `domain_id`: The identifier of the domain that contains the speaker enrollment job.
- `job_id`: The identifier of the speaker enrollment job you are describing.
"""
function describe_speaker_enrollment_job(
DomainId, JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return voice_id(
"DescribeSpeakerEnrollmentJob",
Dict{String,Any}("DomainId" => DomainId, "JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_speaker_enrollment_job(
DomainId,
JobId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return voice_id(
"DescribeSpeakerEnrollmentJob",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("DomainId" => DomainId, "JobId" => JobId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_watchlist(domain_id, watchlist_id)
describe_watchlist(domain_id, watchlist_id, params::Dict{String,<:Any})
Describes the specified watchlist.
# Arguments
- `domain_id`: The identifier of the domain that contains the watchlist.
- `watchlist_id`: The identifier of the watchlist that you are describing.
"""
function describe_watchlist(
DomainId, WatchlistId; aws_config::AbstractAWSConfig=global_aws_config()
)
return voice_id(
"DescribeWatchlist",
Dict{String,Any}("DomainId" => DomainId, "WatchlistId" => WatchlistId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_watchlist(
DomainId,
WatchlistId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return voice_id(
"DescribeWatchlist",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DomainId" => DomainId, "WatchlistId" => WatchlistId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_fraudster(domain_id, fraudster_id, watchlist_id)
disassociate_fraudster(domain_id, fraudster_id, watchlist_id, params::Dict{String,<:Any})
Disassociates the fraudsters from the watchlist specified. Voice ID always expects a
fraudster to be a part of at least one watchlist. If you try to disassociate a fraudster
from its only watchlist, a ValidationException is thrown.
# Arguments
- `domain_id`: The identifier of the domain that contains the fraudster.
- `fraudster_id`: The identifier of the fraudster to be disassociated from the watchlist.
- `watchlist_id`: The identifier of the watchlist that you want to disassociate from the
fraudster.
"""
function disassociate_fraudster(
DomainId, FraudsterId, WatchlistId; aws_config::AbstractAWSConfig=global_aws_config()
)
return voice_id(
"DisassociateFraudster",
Dict{String,Any}(
"DomainId" => DomainId,
"FraudsterId" => FraudsterId,
"WatchlistId" => WatchlistId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_fraudster(
DomainId,
FraudsterId,
WatchlistId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return voice_id(
"DisassociateFraudster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DomainId" => DomainId,
"FraudsterId" => FraudsterId,
"WatchlistId" => WatchlistId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
evaluate_session(domain_id, session_name_or_id)
evaluate_session(domain_id, session_name_or_id, params::Dict{String,<:Any})
Evaluates a specified session based on audio data accumulated during a streaming Amazon
Connect Voice ID call.
# Arguments
- `domain_id`: The identifier of the domain where the session started.
- `session_name_or_id`: The session identifier, or name of the session, that you want to
evaluate. In Voice ID integration, this is the Contact-Id.
"""
function evaluate_session(
DomainId, SessionNameOrId; aws_config::AbstractAWSConfig=global_aws_config()
)
return voice_id(
"EvaluateSession",
Dict{String,Any}("DomainId" => DomainId, "SessionNameOrId" => SessionNameOrId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function evaluate_session(
DomainId,
SessionNameOrId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return voice_id(
"EvaluateSession",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DomainId" => DomainId, "SessionNameOrId" => SessionNameOrId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_domains()
list_domains(params::Dict{String,<:Any})
Lists all the domains in the 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 results that are returned per call. You can use
NextToken to obtain more pages of results. The default is 100; the maximum allowed page
size is also 100.
- `"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.
"""
function list_domains(; aws_config::AbstractAWSConfig=global_aws_config())
return voice_id("ListDomains"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_domains(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return voice_id(
"ListDomains", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_fraudster_registration_jobs(domain_id)
list_fraudster_registration_jobs(domain_id, params::Dict{String,<:Any})
Lists all the fraudster registration jobs in the domain with the given JobStatus. If
JobStatus is not provided, this lists all fraudster registration jobs in the given domain.
# Arguments
- `domain_id`: The identifier of the domain that contains the fraudster registration Jobs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"JobStatus"`: Provides the status of your fraudster registration job.
- `"MaxResults"`: The maximum number of results that are returned per call. You can use
NextToken to obtain more pages of results. The default is 100; the maximum allowed page
size is also 100.
- `"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.
"""
function list_fraudster_registration_jobs(
DomainId; aws_config::AbstractAWSConfig=global_aws_config()
)
return voice_id(
"ListFraudsterRegistrationJobs",
Dict{String,Any}("DomainId" => DomainId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_fraudster_registration_jobs(
DomainId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return voice_id(
"ListFraudsterRegistrationJobs",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainId" => DomainId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_fraudsters(domain_id)
list_fraudsters(domain_id, params::Dict{String,<:Any})
Lists all fraudsters in a specified watchlist or domain.
# Arguments
- `domain_id`: The identifier 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 that are returned per call. You can use
NextToken to obtain more pages of results. The default is 100; the maximum allowed page
size is also 100.
- `"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.
- `"WatchlistId"`: The identifier of the watchlist. If provided, all fraudsters in the
watchlist are listed. If not provided, all fraudsters in the domain are listed.
"""
function list_fraudsters(DomainId; aws_config::AbstractAWSConfig=global_aws_config())
return voice_id(
"ListFraudsters",
Dict{String,Any}("DomainId" => DomainId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_fraudsters(
DomainId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return voice_id(
"ListFraudsters",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainId" => DomainId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_speaker_enrollment_jobs(domain_id)
list_speaker_enrollment_jobs(domain_id, params::Dict{String,<:Any})
Lists all the speaker enrollment jobs in the domain with the specified JobStatus. If
JobStatus is not provided, this lists all jobs with all possible speaker enrollment job
statuses.
# Arguments
- `domain_id`: The identifier of the domain that contains the speaker enrollment jobs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"JobStatus"`: Provides the status of your speaker enrollment Job.
- `"MaxResults"`: The maximum number of results that are returned per call. You can use
NextToken to obtain more pages of results. The default is 100; the maximum allowed page
size is also 100.
- `"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.
"""
function list_speaker_enrollment_jobs(
DomainId; aws_config::AbstractAWSConfig=global_aws_config()
)
return voice_id(
"ListSpeakerEnrollmentJobs",
Dict{String,Any}("DomainId" => DomainId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_speaker_enrollment_jobs(
DomainId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return voice_id(
"ListSpeakerEnrollmentJobs",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainId" => DomainId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_speakers(domain_id)
list_speakers(domain_id, params::Dict{String,<:Any})
Lists all speakers in a specified domain.
# Arguments
- `domain_id`: The identifier 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 that are returned per call. You can use
NextToken to obtain more pages of results. The default is 100; the maximum allowed page
size is also 100.
- `"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.
"""
function list_speakers(DomainId; aws_config::AbstractAWSConfig=global_aws_config())
return voice_id(
"ListSpeakers",
Dict{String,Any}("DomainId" => DomainId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_speakers(
DomainId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return voice_id(
"ListSpeakers",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainId" => DomainId), 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 specified Voice ID resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the Voice ID resource for which you
want to list the tags.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return voice_id(
"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 voice_id(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_watchlists(domain_id)
list_watchlists(domain_id, params::Dict{String,<:Any})
Lists all watchlists in a specified domain.
# Arguments
- `domain_id`: The identifier 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 that are returned per call. You can use
NextToken to obtain more pages of results. The default is 100; the maximum allowed page
size is also 100.
- `"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.
"""
function list_watchlists(DomainId; aws_config::AbstractAWSConfig=global_aws_config())
return voice_id(
"ListWatchlists",
Dict{String,Any}("DomainId" => DomainId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_watchlists(
DomainId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return voice_id(
"ListWatchlists",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainId" => DomainId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
opt_out_speaker(domain_id, speaker_id)
opt_out_speaker(domain_id, speaker_id, params::Dict{String,<:Any})
Opts out a speaker from Voice ID. A speaker can be opted out regardless of whether or not
they already exist in Voice ID. If they don't yet exist, a new speaker is created in an
opted out state. If they already exist, their existing status is overridden and they are
opted out. Enrollment and evaluation authentication requests are rejected for opted out
speakers, and opted out speakers have no voice embeddings stored in Voice ID.
# Arguments
- `domain_id`: The identifier of the domain that contains the speaker.
- `speaker_id`: The identifier of the speaker you want opted-out.
"""
function opt_out_speaker(
DomainId, SpeakerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return voice_id(
"OptOutSpeaker",
Dict{String,Any}("DomainId" => DomainId, "SpeakerId" => SpeakerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function opt_out_speaker(
DomainId,
SpeakerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return voice_id(
"OptOutSpeaker",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DomainId" => DomainId, "SpeakerId" => SpeakerId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_fraudster_registration_job(data_access_role_arn, domain_id, input_data_config, output_data_config)
start_fraudster_registration_job(data_access_role_arn, domain_id, input_data_config, output_data_config, params::Dict{String,<:Any})
Starts a new batch fraudster registration job using provided details.
# Arguments
- `data_access_role_arn`: The IAM role Amazon Resource Name (ARN) that grants Voice ID
permissions to access customer's buckets to read the input manifest file and write the Job
output file. Refer to the Create and edit a fraudster watchlist documentation for the
permissions needed in this role.
- `domain_id`: The identifier of the domain that contains the fraudster registration job
and in which the fraudsters are registered.
- `input_data_config`: The input data config containing an S3 URI for the input manifest
file that contains the list of fraudster registration requests.
- `output_data_config`: The output data config containing the S3 location where Voice ID
writes the job output file; you must also include a KMS key ID to encrypt the file.
# 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.
- `"JobName"`: The name of the new fraudster registration job.
- `"RegistrationConfig"`: The registration config containing details such as the action to
take when a duplicate fraudster is detected, and the similarity threshold to use for
detecting a duplicate fraudster.
"""
function start_fraudster_registration_job(
DataAccessRoleArn,
DomainId,
InputDataConfig,
OutputDataConfig;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return voice_id(
"StartFraudsterRegistrationJob",
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"DomainId" => DomainId,
"InputDataConfig" => InputDataConfig,
"OutputDataConfig" => OutputDataConfig,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_fraudster_registration_job(
DataAccessRoleArn,
DomainId,
InputDataConfig,
OutputDataConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return voice_id(
"StartFraudsterRegistrationJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"DomainId" => DomainId,
"InputDataConfig" => InputDataConfig,
"OutputDataConfig" => OutputDataConfig,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_speaker_enrollment_job(data_access_role_arn, domain_id, input_data_config, output_data_config)
start_speaker_enrollment_job(data_access_role_arn, domain_id, input_data_config, output_data_config, params::Dict{String,<:Any})
Starts a new batch speaker enrollment job using specified details.
# Arguments
- `data_access_role_arn`: The IAM role Amazon Resource Name (ARN) that grants Voice ID
permissions to access customer's buckets to read the input manifest file and write the job
output file. Refer to Batch enrollment using audio data from prior calls for the
permissions needed in this role.
- `domain_id`: The identifier of the domain that contains the speaker enrollment job and in
which the speakers are enrolled.
- `input_data_config`: The input data config containing the S3 location for the input
manifest file that contains the list of speaker enrollment requests.
- `output_data_config`: The output data config containing the S3 location where Voice ID
writes the job output file; you must also include a KMS key ID to encrypt the file.
# 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.
- `"EnrollmentConfig"`: The enrollment config that contains details such as the action to
take when a speaker is already enrolled in Voice ID or when a speaker is identified as a
fraudster.
- `"JobName"`: A name for your speaker enrollment job.
"""
function start_speaker_enrollment_job(
DataAccessRoleArn,
DomainId,
InputDataConfig,
OutputDataConfig;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return voice_id(
"StartSpeakerEnrollmentJob",
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"DomainId" => DomainId,
"InputDataConfig" => InputDataConfig,
"OutputDataConfig" => OutputDataConfig,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_speaker_enrollment_job(
DataAccessRoleArn,
DomainId,
InputDataConfig,
OutputDataConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return voice_id(
"StartSpeakerEnrollmentJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"DomainId" => DomainId,
"InputDataConfig" => InputDataConfig,
"OutputDataConfig" => OutputDataConfig,
"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 Voice ID resource with the provided list of tags.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the Voice ID resource you want to tag.
- `tags`: The list of tags to assign to the specified resource.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return voice_id(
"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 voice_id(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes specified tags from a specified Amazon Connect Voice ID resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the Voice ID resource you want to
remove tags from.
- `tag_keys`: The list of tag keys you want to remove from the specified resource.
"""
function untag_resource(
ResourceArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return voice_id(
"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 voice_id(
"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_domain(domain_id, name, server_side_encryption_configuration)
update_domain(domain_id, name, server_side_encryption_configuration, params::Dict{String,<:Any})
Updates the specified domain. This API has clobber behavior, and clears and replaces all
attributes. If an optional field, such as 'Description' is not provided, it is removed from
the domain.
# Arguments
- `domain_id`: The identifier of the domain to be updated.
- `name`: The name of the domain.
- `server_side_encryption_configuration`: The configuration, containing the KMS key
identifier, to be used by Voice ID for the server-side encryption of your data. Changing
the domain's associated KMS key immediately triggers an asynchronous process to remove
dependency on the old KMS key, such that the domain's data can only be accessed using the
new KMS key. The domain's ServerSideEncryptionUpdateDetails contains the details for this
process.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A brief description about this domain.
"""
function update_domain(
DomainId,
Name,
ServerSideEncryptionConfiguration;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return voice_id(
"UpdateDomain",
Dict{String,Any}(
"DomainId" => DomainId,
"Name" => Name,
"ServerSideEncryptionConfiguration" => ServerSideEncryptionConfiguration,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_domain(
DomainId,
Name,
ServerSideEncryptionConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return voice_id(
"UpdateDomain",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DomainId" => DomainId,
"Name" => Name,
"ServerSideEncryptionConfiguration" =>
ServerSideEncryptionConfiguration,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_watchlist(domain_id, watchlist_id)
update_watchlist(domain_id, watchlist_id, params::Dict{String,<:Any})
Updates the specified watchlist. Every domain has a default watchlist which cannot be
updated.
# Arguments
- `domain_id`: The identifier of the domain that contains the watchlist.
- `watchlist_id`: The identifier of the watchlist to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A brief description about this watchlist.
- `"Name"`: The name of the watchlist.
"""
function update_watchlist(
DomainId, WatchlistId; aws_config::AbstractAWSConfig=global_aws_config()
)
return voice_id(
"UpdateWatchlist",
Dict{String,Any}("DomainId" => DomainId, "WatchlistId" => WatchlistId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_watchlist(
DomainId,
WatchlistId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return voice_id(
"UpdateWatchlist",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DomainId" => DomainId, "WatchlistId" => WatchlistId),
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 | 73369 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: vpc_lattice
using AWS.Compat
using AWS.UUIDs
"""
batch_update_rule(listener_identifier, rules, service_identifier)
batch_update_rule(listener_identifier, rules, service_identifier, params::Dict{String,<:Any})
Updates the listener rules in a batch. You can use this operation to change the priority of
listener rules. This can be useful when bulk updating or swapping rule priority. Required
permissions: vpc-lattice:UpdateRule For more information, see How Amazon VPC Lattice works
with IAM in the Amazon VPC Lattice User Guide.
# Arguments
- `listener_identifier`: The ID or Amazon Resource Name (ARN) of the listener.
- `rules`: The rules for the specified listener.
- `service_identifier`: The ID or Amazon Resource Name (ARN) of the service.
"""
function batch_update_rule(
listenerIdentifier,
rules,
serviceIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"PATCH",
"/services/$(serviceIdentifier)/listeners/$(listenerIdentifier)/rules",
Dict{String,Any}("rules" => rules);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_update_rule(
listenerIdentifier,
rules,
serviceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"PATCH",
"/services/$(serviceIdentifier)/listeners/$(listenerIdentifier)/rules",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("rules" => rules), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_access_log_subscription(destination_arn, resource_identifier)
create_access_log_subscription(destination_arn, resource_identifier, params::Dict{String,<:Any})
Enables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data
Firehose. The service network owner can use the access logs to audit the services in the
network. The service network owner can only see access logs from clients and services that
are associated with their service network. Access log entries represent traffic originated
from VPCs associated with that network. For more information, see Access logs in the Amazon
VPC Lattice User Guide.
# Arguments
- `destination_arn`: The Amazon Resource Name (ARN) of the destination. The supported
destination types are CloudWatch Log groups, Kinesis Data Firehose delivery streams, and
Amazon S3 buckets.
- `resource_identifier`: The ID or Amazon Resource Name (ARN) of the service network or
service.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you retry a request that completed successfully using the
same client token and parameters, the retry succeeds without performing any actions. If the
parameters aren't identical, the retry fails.
- `"tags"`: The tags for the access log subscription.
"""
function create_access_log_subscription(
destinationArn, resourceIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return vpc_lattice(
"POST",
"/accesslogsubscriptions",
Dict{String,Any}(
"destinationArn" => destinationArn,
"resourceIdentifier" => resourceIdentifier,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_access_log_subscription(
destinationArn,
resourceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"POST",
"/accesslogsubscriptions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"destinationArn" => destinationArn,
"resourceIdentifier" => resourceIdentifier,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_listener(default_action, name, protocol, service_identifier)
create_listener(default_action, name, protocol, service_identifier, params::Dict{String,<:Any})
Creates a listener for a service. Before you start using your Amazon VPC Lattice service,
you must add one or more listeners. A listener is a process that checks for connection
requests to your services. For more information, see Listeners in the Amazon VPC Lattice
User Guide.
# Arguments
- `default_action`: The action for the default rule. Each listener has a default rule. The
default rule is used if no other rules match.
- `name`: The name of the listener. A listener name must be unique within a service. The
valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last
character, or immediately after another hyphen.
- `protocol`: The listener protocol.
- `service_identifier`: The ID or Amazon Resource Name (ARN) of the service.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you retry a request that completed successfully using the
same client token and parameters, the retry succeeds without performing any actions. If the
parameters aren't identical, the retry fails.
- `"port"`: The listener port. You can specify a value from 1 to 65535. For HTTP, the
default is 80. For HTTPS, the default is 443.
- `"tags"`: The tags for the listener.
"""
function create_listener(
defaultAction,
name,
protocol,
serviceIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"POST",
"/services/$(serviceIdentifier)/listeners",
Dict{String,Any}(
"defaultAction" => defaultAction,
"name" => name,
"protocol" => protocol,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_listener(
defaultAction,
name,
protocol,
serviceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"POST",
"/services/$(serviceIdentifier)/listeners",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"defaultAction" => defaultAction,
"name" => name,
"protocol" => protocol,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_rule(action, listener_identifier, match, name, priority, service_identifier)
create_rule(action, listener_identifier, match, name, priority, service_identifier, params::Dict{String,<:Any})
Creates a listener rule. Each listener has a default rule for checking connection requests,
but you can define additional rules. Each rule consists of a priority, one or more actions,
and one or more conditions. For more information, see Listener rules in the Amazon VPC
Lattice User Guide.
# Arguments
- `action`: The action for the default rule.
- `listener_identifier`: The ID or Amazon Resource Name (ARN) of the listener.
- `match`: The rule match.
- `name`: The name of the rule. The name must be unique within the listener. The valid
characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last
character, or immediately after another hyphen.
- `priority`: The priority assigned to the rule. Each rule for a specific listener must
have a unique priority. The lower the priority number the higher the priority.
- `service_identifier`: The ID or Amazon Resource Name (ARN) of the service.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you retry a request that completed successfully using the
same client token and parameters, the retry succeeds without performing any actions. If the
parameters aren't identical, the retry fails.
- `"tags"`: The tags for the rule.
"""
function create_rule(
action,
listenerIdentifier,
match,
name,
priority,
serviceIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"POST",
"/services/$(serviceIdentifier)/listeners/$(listenerIdentifier)/rules",
Dict{String,Any}(
"action" => action,
"match" => match,
"name" => name,
"priority" => priority,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_rule(
action,
listenerIdentifier,
match,
name,
priority,
serviceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"POST",
"/services/$(serviceIdentifier)/listeners/$(listenerIdentifier)/rules",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"action" => action,
"match" => match,
"name" => name,
"priority" => priority,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_service(name)
create_service(name, params::Dict{String,<:Any})
Creates a service. A service is any software application that can run on instances
containers, or serverless functions within an account or virtual private cloud (VPC). For
more information, see Services in the Amazon VPC Lattice User Guide.
# Arguments
- `name`: The name of the service. The name must be unique within the account. The valid
characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last
character, or immediately after another hyphen.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"authType"`: The type of IAM policy. NONE: The resource does not use an IAM policy.
This is the default. AWS_IAM: The resource uses an IAM policy. When this type is used,
auth is enabled and an auth policy is required.
- `"certificateArn"`: The Amazon Resource Name (ARN) of the certificate.
- `"clientToken"`: A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you retry a request that completed successfully using the
same client token and parameters, the retry succeeds without performing any actions. If the
parameters aren't identical, the retry fails.
- `"customDomainName"`: The custom domain name of the service.
- `"tags"`: The tags for the service.
"""
function create_service(name; aws_config::AbstractAWSConfig=global_aws_config())
return vpc_lattice(
"POST",
"/services",
Dict{String,Any}("name" => name, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_service(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return vpc_lattice(
"POST",
"/services",
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_service_network(name)
create_service_network(name, params::Dict{String,<:Any})
Creates a service network. A service network is a logical boundary for a collection of
services. You can associate services and VPCs with a service network. For more information,
see Service networks in the Amazon VPC Lattice User Guide.
# Arguments
- `name`: The name of the service network. The name must be unique to the account. The
valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last
character, or immediately after another hyphen.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"authType"`: The type of IAM policy. NONE: The resource does not use an IAM policy.
This is the default. AWS_IAM: The resource uses an IAM policy. When this type is used,
auth is enabled and an auth policy is required.
- `"clientToken"`: A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you retry a request that completed successfully using the
same client token and parameters, the retry succeeds without performing any actions. If the
parameters aren't identical, the retry fails.
- `"tags"`: The tags for the service network.
"""
function create_service_network(name; aws_config::AbstractAWSConfig=global_aws_config())
return vpc_lattice(
"POST",
"/servicenetworks",
Dict{String,Any}("name" => name, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_service_network(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return vpc_lattice(
"POST",
"/servicenetworks",
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_service_network_service_association(service_identifier, service_network_identifier)
create_service_network_service_association(service_identifier, service_network_identifier, params::Dict{String,<:Any})
Associates a service with a service network. For more information, see Manage service
associations in the Amazon VPC Lattice User Guide. You can't use this operation if the
service and service network are already associated or if there is a disassociation or
deletion in progress. If the association fails, you can retry the operation by deleting the
association and recreating it. You cannot associate a service and service network that are
shared with a caller. The caller must own either the service or the service network. As a
result of this operation, the association is created in the service network account and the
association owner account.
# Arguments
- `service_identifier`: The ID or Amazon Resource Name (ARN) of the service.
- `service_network_identifier`: The ID or Amazon Resource Name (ARN) of the service
network. You must use the ARN if the resources specified in the operation are in different
accounts.
# 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 you retry a request that completed successfully using the
same client token and parameters, the retry succeeds without performing any actions. If the
parameters aren't identical, the retry fails.
- `"tags"`: The tags for the association.
"""
function create_service_network_service_association(
serviceIdentifier,
serviceNetworkIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"POST",
"/servicenetworkserviceassociations",
Dict{String,Any}(
"serviceIdentifier" => serviceIdentifier,
"serviceNetworkIdentifier" => serviceNetworkIdentifier,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_service_network_service_association(
serviceIdentifier,
serviceNetworkIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"POST",
"/servicenetworkserviceassociations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"serviceIdentifier" => serviceIdentifier,
"serviceNetworkIdentifier" => serviceNetworkIdentifier,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_service_network_vpc_association(service_network_identifier, vpc_identifier)
create_service_network_vpc_association(service_network_identifier, vpc_identifier, params::Dict{String,<:Any})
Associates a VPC with a service network. When you associate a VPC with the service network,
it enables all the resources within that VPC to be clients and communicate with other
services in the service network. For more information, see Manage VPC associations in the
Amazon VPC Lattice User Guide. You can't use this operation if there is a disassociation in
progress. If the association fails, retry by deleting the association and recreating it. As
a result of this operation, the association gets created in the service network account and
the VPC owner account. If you add a security group to the service network and VPC
association, the association must continue to always have at least one security group. You
can add or edit security groups at any time. However, to remove all security groups, you
must first delete the association and recreate it without security groups.
# Arguments
- `service_network_identifier`: The ID or Amazon Resource Name (ARN) of the service
network. You must use the ARN when the resources specified in the operation are in
different accounts.
- `vpc_identifier`: The ID of the VPC.
# 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 you retry a request that completed successfully using the
same client token and parameters, the retry succeeds without performing any actions. If the
parameters aren't identical, the retry fails.
- `"securityGroupIds"`: The IDs of the security groups. Security groups aren't added by
default. You can add a security group to apply network level controls to control which
resources in a VPC are allowed to access the service network and its services. For more
information, see Control traffic to resources using security groups in the Amazon VPC User
Guide.
- `"tags"`: The tags for the association.
"""
function create_service_network_vpc_association(
serviceNetworkIdentifier,
vpcIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"POST",
"/servicenetworkvpcassociations",
Dict{String,Any}(
"serviceNetworkIdentifier" => serviceNetworkIdentifier,
"vpcIdentifier" => vpcIdentifier,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_service_network_vpc_association(
serviceNetworkIdentifier,
vpcIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"POST",
"/servicenetworkvpcassociations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"serviceNetworkIdentifier" => serviceNetworkIdentifier,
"vpcIdentifier" => vpcIdentifier,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_target_group(name, type)
create_target_group(name, type, params::Dict{String,<:Any})
Creates a target group. A target group is a collection of targets, or compute resources,
that run your application or service. A target group can only be used by a single service.
For more information, see Target groups in the Amazon VPC Lattice User Guide.
# Arguments
- `name`: The name of the target group. The name must be unique within the account. The
valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last
character, or immediately after another hyphen.
- `type`: The type of target 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 you retry a request that completed successfully using the
same client token and parameters, the retry succeeds without performing any actions. If the
parameters aren't identical, the retry fails.
- `"config"`: The target group configuration.
- `"tags"`: The tags for the target group.
"""
function create_target_group(name, type; aws_config::AbstractAWSConfig=global_aws_config())
return vpc_lattice(
"POST",
"/targetgroups",
Dict{String,Any}("name" => name, "type" => type, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_target_group(
name,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"POST",
"/targetgroups",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name, "type" => type, "clientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_access_log_subscription(access_log_subscription_identifier)
delete_access_log_subscription(access_log_subscription_identifier, params::Dict{String,<:Any})
Deletes the specified access log subscription.
# Arguments
- `access_log_subscription_identifier`: The ID or Amazon Resource Name (ARN) of the access
log subscription.
"""
function delete_access_log_subscription(
accessLogSubscriptionIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return vpc_lattice(
"DELETE",
"/accesslogsubscriptions/$(accessLogSubscriptionIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_access_log_subscription(
accessLogSubscriptionIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"DELETE",
"/accesslogsubscriptions/$(accessLogSubscriptionIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_auth_policy(resource_identifier)
delete_auth_policy(resource_identifier, params::Dict{String,<:Any})
Deletes the specified auth policy. If an auth is set to AWS_IAM and the auth policy is
deleted, all requests are denied. If you are trying to remove the auth policy completely,
you must set the auth type to NONE. If auth is enabled on the resource, but no auth policy
is set, all requests are denied.
# Arguments
- `resource_identifier`: The ID or Amazon Resource Name (ARN) of the resource.
"""
function delete_auth_policy(
resourceIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return vpc_lattice(
"DELETE",
"/authpolicy/$(resourceIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_auth_policy(
resourceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"DELETE",
"/authpolicy/$(resourceIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_listener(listener_identifier, service_identifier)
delete_listener(listener_identifier, service_identifier, params::Dict{String,<:Any})
Deletes the specified listener.
# Arguments
- `listener_identifier`: The ID or Amazon Resource Name (ARN) of the listener.
- `service_identifier`: The ID or Amazon Resource Name (ARN) of the service.
"""
function delete_listener(
listenerIdentifier, serviceIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return vpc_lattice(
"DELETE",
"/services/$(serviceIdentifier)/listeners/$(listenerIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_listener(
listenerIdentifier,
serviceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"DELETE",
"/services/$(serviceIdentifier)/listeners/$(listenerIdentifier)",
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 specified resource policy.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
"""
function delete_resource_policy(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return vpc_lattice(
"DELETE",
"/resourcepolicy/$(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 vpc_lattice(
"DELETE",
"/resourcepolicy/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_rule(listener_identifier, rule_identifier, service_identifier)
delete_rule(listener_identifier, rule_identifier, service_identifier, params::Dict{String,<:Any})
Deletes a listener rule. Each listener has a default rule for checking connection requests,
but you can define additional rules. Each rule consists of a priority, one or more actions,
and one or more conditions. You can delete additional listener rules, but you cannot delete
the default rule. For more information, see Listener rules in the Amazon VPC Lattice User
Guide.
# Arguments
- `listener_identifier`: The ID or Amazon Resource Name (ARN) of the listener.
- `rule_identifier`: The ID or Amazon Resource Name (ARN) of the rule.
- `service_identifier`: The ID or Amazon Resource Name (ARN) of the service.
"""
function delete_rule(
listenerIdentifier,
ruleIdentifier,
serviceIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"DELETE",
"/services/$(serviceIdentifier)/listeners/$(listenerIdentifier)/rules/$(ruleIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_rule(
listenerIdentifier,
ruleIdentifier,
serviceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"DELETE",
"/services/$(serviceIdentifier)/listeners/$(listenerIdentifier)/rules/$(ruleIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_service(service_identifier)
delete_service(service_identifier, params::Dict{String,<:Any})
Deletes a service. A service can't be deleted if it's associated with a service network. If
you delete a service, all resources related to the service, such as the resource policy,
auth policy, listeners, listener rules, and access log subscriptions, are also deleted. For
more information, see Delete a service in the Amazon VPC Lattice User Guide.
# Arguments
- `service_identifier`: The ID or Amazon Resource Name (ARN) of the service.
"""
function delete_service(
serviceIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return vpc_lattice(
"DELETE",
"/services/$(serviceIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_service(
serviceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"DELETE",
"/services/$(serviceIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_service_network(service_network_identifier)
delete_service_network(service_network_identifier, params::Dict{String,<:Any})
Deletes a service network. You can only delete the service network if there is no service
or VPC associated with it. If you delete a service network, all resources related to the
service network, such as the resource policy, auth policy, and access log subscriptions,
are also deleted. For more information, see Delete a service network in the Amazon VPC
Lattice User Guide.
# Arguments
- `service_network_identifier`: The Amazon Resource Name (ARN) or ID of the service network.
"""
function delete_service_network(
serviceNetworkIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return vpc_lattice(
"DELETE",
"/servicenetworks/$(serviceNetworkIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_service_network(
serviceNetworkIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"DELETE",
"/servicenetworks/$(serviceNetworkIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_service_network_service_association(service_network_service_association_identifier)
delete_service_network_service_association(service_network_service_association_identifier, params::Dict{String,<:Any})
Deletes the association between a specified service and the specific service network. This
operation fails if an association is still in progress.
# Arguments
- `service_network_service_association_identifier`: The ID or Amazon Resource Name (ARN) of
the association.
"""
function delete_service_network_service_association(
serviceNetworkServiceAssociationIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"DELETE",
"/servicenetworkserviceassociations/$(serviceNetworkServiceAssociationIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_service_network_service_association(
serviceNetworkServiceAssociationIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"DELETE",
"/servicenetworkserviceassociations/$(serviceNetworkServiceAssociationIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_service_network_vpc_association(service_network_vpc_association_identifier)
delete_service_network_vpc_association(service_network_vpc_association_identifier, params::Dict{String,<:Any})
Disassociates the VPC from the service network. You can't disassociate the VPC if there is
a create or update association in progress.
# Arguments
- `service_network_vpc_association_identifier`: The ID or Amazon Resource Name (ARN) of the
association.
"""
function delete_service_network_vpc_association(
serviceNetworkVpcAssociationIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"DELETE",
"/servicenetworkvpcassociations/$(serviceNetworkVpcAssociationIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_service_network_vpc_association(
serviceNetworkVpcAssociationIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"DELETE",
"/servicenetworkvpcassociations/$(serviceNetworkVpcAssociationIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_target_group(target_group_identifier)
delete_target_group(target_group_identifier, params::Dict{String,<:Any})
Deletes a target group. You can't delete a target group if it is used in a listener rule or
if the target group creation is in progress.
# Arguments
- `target_group_identifier`: The ID or Amazon Resource Name (ARN) of the target group.
"""
function delete_target_group(
targetGroupIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return vpc_lattice(
"DELETE",
"/targetgroups/$(targetGroupIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_target_group(
targetGroupIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"DELETE",
"/targetgroups/$(targetGroupIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_targets(target_group_identifier, targets)
deregister_targets(target_group_identifier, targets, params::Dict{String,<:Any})
Deregisters the specified targets from the specified target group.
# Arguments
- `target_group_identifier`: The ID or Amazon Resource Name (ARN) of the target group.
- `targets`: The targets to deregister.
"""
function deregister_targets(
targetGroupIdentifier, targets; aws_config::AbstractAWSConfig=global_aws_config()
)
return vpc_lattice(
"POST",
"/targetgroups/$(targetGroupIdentifier)/deregistertargets",
Dict{String,Any}("targets" => targets);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_targets(
targetGroupIdentifier,
targets,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"POST",
"/targetgroups/$(targetGroupIdentifier)/deregistertargets",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("targets" => targets), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_access_log_subscription(access_log_subscription_identifier)
get_access_log_subscription(access_log_subscription_identifier, params::Dict{String,<:Any})
Retrieves information about the specified access log subscription.
# Arguments
- `access_log_subscription_identifier`: The ID or Amazon Resource Name (ARN) of the access
log subscription.
"""
function get_access_log_subscription(
accessLogSubscriptionIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return vpc_lattice(
"GET",
"/accesslogsubscriptions/$(accessLogSubscriptionIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_access_log_subscription(
accessLogSubscriptionIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"GET",
"/accesslogsubscriptions/$(accessLogSubscriptionIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_auth_policy(resource_identifier)
get_auth_policy(resource_identifier, params::Dict{String,<:Any})
Retrieves information about the auth policy for the specified service or service network.
# Arguments
- `resource_identifier`: The ID or Amazon Resource Name (ARN) of the service network or
service.
"""
function get_auth_policy(
resourceIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return vpc_lattice(
"GET",
"/authpolicy/$(resourceIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_auth_policy(
resourceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"GET",
"/authpolicy/$(resourceIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_listener(listener_identifier, service_identifier)
get_listener(listener_identifier, service_identifier, params::Dict{String,<:Any})
Retrieves information about the specified listener for the specified service.
# Arguments
- `listener_identifier`: The ID or Amazon Resource Name (ARN) of the listener.
- `service_identifier`: The ID or Amazon Resource Name (ARN) of the service.
"""
function get_listener(
listenerIdentifier, serviceIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return vpc_lattice(
"GET",
"/services/$(serviceIdentifier)/listeners/$(listenerIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_listener(
listenerIdentifier,
serviceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"GET",
"/services/$(serviceIdentifier)/listeners/$(listenerIdentifier)",
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})
Retrieves information about the resource policy. The resource policy is an IAM policy
created on behalf of the resource owner when they share a resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the service network or service.
"""
function get_resource_policy(resourceArn; aws_config::AbstractAWSConfig=global_aws_config())
return vpc_lattice(
"GET",
"/resourcepolicy/$(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 vpc_lattice(
"GET",
"/resourcepolicy/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_rule(listener_identifier, rule_identifier, service_identifier)
get_rule(listener_identifier, rule_identifier, service_identifier, params::Dict{String,<:Any})
Retrieves information about listener rules. You can also retrieve information about the
default listener rule. For more information, see Listener rules in the Amazon VPC Lattice
User Guide.
# Arguments
- `listener_identifier`: The ID or Amazon Resource Name (ARN) of the listener.
- `rule_identifier`: The ID or Amazon Resource Name (ARN) of the listener rule.
- `service_identifier`: The ID or Amazon Resource Name (ARN) of the service.
"""
function get_rule(
listenerIdentifier,
ruleIdentifier,
serviceIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"GET",
"/services/$(serviceIdentifier)/listeners/$(listenerIdentifier)/rules/$(ruleIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_rule(
listenerIdentifier,
ruleIdentifier,
serviceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"GET",
"/services/$(serviceIdentifier)/listeners/$(listenerIdentifier)/rules/$(ruleIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_service(service_identifier)
get_service(service_identifier, params::Dict{String,<:Any})
Retrieves information about the specified service.
# Arguments
- `service_identifier`: The ID or Amazon Resource Name (ARN) of the service.
"""
function get_service(serviceIdentifier; aws_config::AbstractAWSConfig=global_aws_config())
return vpc_lattice(
"GET",
"/services/$(serviceIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_service(
serviceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"GET",
"/services/$(serviceIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_service_network(service_network_identifier)
get_service_network(service_network_identifier, params::Dict{String,<:Any})
Retrieves information about the specified service network.
# Arguments
- `service_network_identifier`: The ID or Amazon Resource Name (ARN) of the service network.
"""
function get_service_network(
serviceNetworkIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return vpc_lattice(
"GET",
"/servicenetworks/$(serviceNetworkIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_service_network(
serviceNetworkIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"GET",
"/servicenetworks/$(serviceNetworkIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_service_network_service_association(service_network_service_association_identifier)
get_service_network_service_association(service_network_service_association_identifier, params::Dict{String,<:Any})
Retrieves information about the specified association between a service network and a
service.
# Arguments
- `service_network_service_association_identifier`: The ID or Amazon Resource Name (ARN) of
the association.
"""
function get_service_network_service_association(
serviceNetworkServiceAssociationIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"GET",
"/servicenetworkserviceassociations/$(serviceNetworkServiceAssociationIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_service_network_service_association(
serviceNetworkServiceAssociationIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"GET",
"/servicenetworkserviceassociations/$(serviceNetworkServiceAssociationIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_service_network_vpc_association(service_network_vpc_association_identifier)
get_service_network_vpc_association(service_network_vpc_association_identifier, params::Dict{String,<:Any})
Retrieves information about the association between a service network and a VPC.
# Arguments
- `service_network_vpc_association_identifier`: The ID or Amazon Resource Name (ARN) of the
association.
"""
function get_service_network_vpc_association(
serviceNetworkVpcAssociationIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"GET",
"/servicenetworkvpcassociations/$(serviceNetworkVpcAssociationIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_service_network_vpc_association(
serviceNetworkVpcAssociationIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"GET",
"/servicenetworkvpcassociations/$(serviceNetworkVpcAssociationIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_target_group(target_group_identifier)
get_target_group(target_group_identifier, params::Dict{String,<:Any})
Retrieves information about the specified target group.
# Arguments
- `target_group_identifier`: The ID or Amazon Resource Name (ARN) of the target group.
"""
function get_target_group(
targetGroupIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return vpc_lattice(
"GET",
"/targetgroups/$(targetGroupIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_target_group(
targetGroupIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"GET",
"/targetgroups/$(targetGroupIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_access_log_subscriptions(resource_identifier)
list_access_log_subscriptions(resource_identifier, params::Dict{String,<:Any})
Lists all access log subscriptions for the specified service network or service.
# Arguments
- `resource_identifier`: The ID or Amazon Resource Name (ARN) of the service network or
service.
# 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 pagination token for the next page of results.
"""
function list_access_log_subscriptions(
resourceIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return vpc_lattice(
"GET",
"/accesslogsubscriptions",
Dict{String,Any}("resourceIdentifier" => resourceIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_access_log_subscriptions(
resourceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"GET",
"/accesslogsubscriptions",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("resourceIdentifier" => resourceIdentifier), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_listeners(service_identifier)
list_listeners(service_identifier, params::Dict{String,<:Any})
Lists the listeners for the specified service.
# Arguments
- `service_identifier`: The ID or Amazon Resource Name (ARN) of the service.
# 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 pagination token for the next page of results.
"""
function list_listeners(
serviceIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return vpc_lattice(
"GET",
"/services/$(serviceIdentifier)/listeners";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_listeners(
serviceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"GET",
"/services/$(serviceIdentifier)/listeners",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_rules(listener_identifier, service_identifier)
list_rules(listener_identifier, service_identifier, params::Dict{String,<:Any})
Lists the rules for the listener.
# Arguments
- `listener_identifier`: The ID or Amazon Resource Name (ARN) of the listener.
- `service_identifier`: The ID or Amazon Resource Name (ARN) of the service.
# 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 pagination token for the next page of results.
"""
function list_rules(
listenerIdentifier, serviceIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return vpc_lattice(
"GET",
"/services/$(serviceIdentifier)/listeners/$(listenerIdentifier)/rules";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_rules(
listenerIdentifier,
serviceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"GET",
"/services/$(serviceIdentifier)/listeners/$(listenerIdentifier)/rules",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_service_network_service_associations()
list_service_network_service_associations(params::Dict{String,<:Any})
Lists the associations between the service network and the service. You can filter the list
either by service or service network. You must provide either the service network
identifier or the service identifier. Every association in Amazon VPC Lattice is given a
unique Amazon Resource Name (ARN), such as when a service network is associated with a VPC
or when a service is associated with a service network. If the association is for a
resource that is shared with another account, the association includes the local account ID
as the prefix in the ARN for each account the resource is shared with.
# 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 pagination token for the next page of results.
- `"serviceIdentifier"`: The ID or Amazon Resource Name (ARN) of the service.
- `"serviceNetworkIdentifier"`: The ID or Amazon Resource Name (ARN) of the service network.
"""
function list_service_network_service_associations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return vpc_lattice(
"GET",
"/servicenetworkserviceassociations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_service_network_service_associations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return vpc_lattice(
"GET",
"/servicenetworkserviceassociations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_service_network_vpc_associations()
list_service_network_vpc_associations(params::Dict{String,<:Any})
Lists the service network and VPC associations. You can filter the list either by VPC or
service network. You must provide either the service network identifier or the VPC
identifier.
# 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 pagination token for the next page of results.
- `"serviceNetworkIdentifier"`: The ID or Amazon Resource Name (ARN) of the service network.
- `"vpcIdentifier"`: The ID or Amazon Resource Name (ARN) of the VPC.
"""
function list_service_network_vpc_associations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return vpc_lattice(
"GET",
"/servicenetworkvpcassociations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_service_network_vpc_associations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return vpc_lattice(
"GET",
"/servicenetworkvpcassociations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_service_networks()
list_service_networks(params::Dict{String,<:Any})
Lists the service networks owned by the caller account or shared with the caller account.
Also includes the account ID in the ARN to show which account owns the service network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return.
- `"nextToken"`: A pagination token for the next page of results.
"""
function list_service_networks(; aws_config::AbstractAWSConfig=global_aws_config())
return vpc_lattice(
"GET", "/servicenetworks"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_service_networks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return vpc_lattice(
"GET",
"/servicenetworks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_services()
list_services(params::Dict{String,<:Any})
Lists the services owned by the caller account or shared with the caller account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return.
- `"nextToken"`: A pagination token for the next page of results.
"""
function list_services(; aws_config::AbstractAWSConfig=global_aws_config())
return vpc_lattice(
"GET", "/services"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_services(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return vpc_lattice(
"GET", "/services", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Lists the tags 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 vpc_lattice(
"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 vpc_lattice(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_target_groups()
list_target_groups(params::Dict{String,<:Any})
Lists your target groups. You can narrow your search by using the filters below in your
request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return.
- `"nextToken"`: A pagination token for the next page of results.
- `"targetGroupType"`: The target group type.
- `"vpcIdentifier"`: The ID or Amazon Resource Name (ARN) of the VPC.
"""
function list_target_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return vpc_lattice(
"GET", "/targetgroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_target_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return vpc_lattice(
"GET",
"/targetgroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_targets(target_group_identifier)
list_targets(target_group_identifier, params::Dict{String,<:Any})
Lists the targets for the target group. By default, all targets are included. You can use
this API to check the health status of targets. You can also filter the results by target.
# Arguments
- `target_group_identifier`: The ID or Amazon Resource Name (ARN) of the target group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return.
- `"nextToken"`: A pagination token for the next page of results.
- `"targets"`: The targets.
"""
function list_targets(
targetGroupIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return vpc_lattice(
"POST",
"/targetgroups/$(targetGroupIdentifier)/listtargets";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_targets(
targetGroupIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"POST",
"/targetgroups/$(targetGroupIdentifier)/listtargets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_auth_policy(policy, resource_identifier)
put_auth_policy(policy, resource_identifier, params::Dict{String,<:Any})
Creates or updates the auth policy. The policy string in JSON must not contain newlines or
blank lines. For more information, see Auth policies in the Amazon VPC Lattice User Guide.
# Arguments
- `policy`: The auth policy. The policy string in JSON must not contain newlines or blank
lines.
- `resource_identifier`: The ID or Amazon Resource Name (ARN) of the service network or
service for which the policy is created.
"""
function put_auth_policy(
policy, resourceIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return vpc_lattice(
"PUT",
"/authpolicy/$(resourceIdentifier)",
Dict{String,Any}("policy" => policy);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_auth_policy(
policy,
resourceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"PUT",
"/authpolicy/$(resourceIdentifier)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("policy" => policy), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_resource_policy(policy, resource_arn)
put_resource_policy(policy, resource_arn, params::Dict{String,<:Any})
Attaches a resource-based permission policy to a service or service network. The policy
must contain the same actions and condition statements as the Amazon Web Services Resource
Access Manager permission for sharing services and service networks.
# Arguments
- `policy`: An IAM policy. The policy string in JSON must not contain newlines or blank
lines.
- `resource_arn`: The ID or Amazon Resource Name (ARN) of the service network or service
for which the policy is created.
"""
function put_resource_policy(
policy, resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return vpc_lattice(
"PUT",
"/resourcepolicy/$(resourceArn)",
Dict{String,Any}("policy" => policy);
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 vpc_lattice(
"PUT",
"/resourcepolicy/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("policy" => policy), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_targets(target_group_identifier, targets)
register_targets(target_group_identifier, targets, params::Dict{String,<:Any})
Registers the targets with the target group. If it's a Lambda target, you can only have one
target in a target group.
# Arguments
- `target_group_identifier`: The ID or Amazon Resource Name (ARN) of the target group.
- `targets`: The targets.
"""
function register_targets(
targetGroupIdentifier, targets; aws_config::AbstractAWSConfig=global_aws_config()
)
return vpc_lattice(
"POST",
"/targetgroups/$(targetGroupIdentifier)/registertargets",
Dict{String,Any}("targets" => targets);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_targets(
targetGroupIdentifier,
targets,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"POST",
"/targetgroups/$(targetGroupIdentifier)/registertargets",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("targets" => targets), 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.
# 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 vpc_lattice(
"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 vpc_lattice(
"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 of the tags to remove.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return vpc_lattice(
"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 vpc_lattice(
"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_log_subscription(access_log_subscription_identifier, destination_arn)
update_access_log_subscription(access_log_subscription_identifier, destination_arn, params::Dict{String,<:Any})
Updates the specified access log subscription.
# Arguments
- `access_log_subscription_identifier`: The ID or Amazon Resource Name (ARN) of the access
log subscription.
- `destination_arn`: The Amazon Resource Name (ARN) of the access log destination.
"""
function update_access_log_subscription(
accessLogSubscriptionIdentifier,
destinationArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"PATCH",
"/accesslogsubscriptions/$(accessLogSubscriptionIdentifier)",
Dict{String,Any}("destinationArn" => destinationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_access_log_subscription(
accessLogSubscriptionIdentifier,
destinationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"PATCH",
"/accesslogsubscriptions/$(accessLogSubscriptionIdentifier)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("destinationArn" => destinationArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_listener(default_action, listener_identifier, service_identifier)
update_listener(default_action, listener_identifier, service_identifier, params::Dict{String,<:Any})
Updates the specified listener for the specified service.
# Arguments
- `default_action`: The action for the default rule.
- `listener_identifier`: The ID or Amazon Resource Name (ARN) of the listener.
- `service_identifier`: The ID or Amazon Resource Name (ARN) of the service.
"""
function update_listener(
defaultAction,
listenerIdentifier,
serviceIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"PATCH",
"/services/$(serviceIdentifier)/listeners/$(listenerIdentifier)",
Dict{String,Any}("defaultAction" => defaultAction);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_listener(
defaultAction,
listenerIdentifier,
serviceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"PATCH",
"/services/$(serviceIdentifier)/listeners/$(listenerIdentifier)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("defaultAction" => defaultAction), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_rule(listener_identifier, rule_identifier, service_identifier)
update_rule(listener_identifier, rule_identifier, service_identifier, params::Dict{String,<:Any})
Updates a rule for the listener. You can't modify a default listener rule. To modify a
default listener rule, use UpdateListener.
# Arguments
- `listener_identifier`: The ID or Amazon Resource Name (ARN) of the listener.
- `rule_identifier`: The ID or Amazon Resource Name (ARN) of the rule.
- `service_identifier`: The ID or Amazon Resource Name (ARN) of the service.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"action"`: Information about the action for the specified listener rule.
- `"match"`: The rule match.
- `"priority"`: The rule priority. A listener can't have multiple rules with the same
priority.
"""
function update_rule(
listenerIdentifier,
ruleIdentifier,
serviceIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"PATCH",
"/services/$(serviceIdentifier)/listeners/$(listenerIdentifier)/rules/$(ruleIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_rule(
listenerIdentifier,
ruleIdentifier,
serviceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"PATCH",
"/services/$(serviceIdentifier)/listeners/$(listenerIdentifier)/rules/$(ruleIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_service(service_identifier)
update_service(service_identifier, params::Dict{String,<:Any})
Updates the specified service.
# Arguments
- `service_identifier`: The ID or Amazon Resource Name (ARN) of the service.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"authType"`: The type of IAM policy. NONE: The resource does not use an IAM policy.
This is the default. AWS_IAM: The resource uses an IAM policy. When this type is used,
auth is enabled and an auth policy is required.
- `"certificateArn"`: The Amazon Resource Name (ARN) of the certificate.
"""
function update_service(
serviceIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return vpc_lattice(
"PATCH",
"/services/$(serviceIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_service(
serviceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"PATCH",
"/services/$(serviceIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_service_network(auth_type, service_network_identifier)
update_service_network(auth_type, service_network_identifier, params::Dict{String,<:Any})
Updates the specified service network.
# Arguments
- `auth_type`: The type of IAM policy. NONE: The resource does not use an IAM policy.
This is the default. AWS_IAM: The resource uses an IAM policy. When this type is used,
auth is enabled and an auth policy is required.
- `service_network_identifier`: The ID or Amazon Resource Name (ARN) of the service network.
"""
function update_service_network(
authType, serviceNetworkIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return vpc_lattice(
"PATCH",
"/servicenetworks/$(serviceNetworkIdentifier)",
Dict{String,Any}("authType" => authType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_service_network(
authType,
serviceNetworkIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"PATCH",
"/servicenetworks/$(serviceNetworkIdentifier)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("authType" => authType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_service_network_vpc_association(security_group_ids, service_network_vpc_association_identifier)
update_service_network_vpc_association(security_group_ids, service_network_vpc_association_identifier, params::Dict{String,<:Any})
Updates the service network and VPC association. If you add a security group to the service
network and VPC association, the association must continue to always have at least one
security group. You can add or edit security groups at any time. However, to remove all
security groups, you must first delete the association and recreate it without security
groups.
# Arguments
- `security_group_ids`: The IDs of the security groups.
- `service_network_vpc_association_identifier`: The ID or Amazon Resource Name (ARN) of the
association.
"""
function update_service_network_vpc_association(
securityGroupIds,
serviceNetworkVpcAssociationIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"PATCH",
"/servicenetworkvpcassociations/$(serviceNetworkVpcAssociationIdentifier)",
Dict{String,Any}("securityGroupIds" => securityGroupIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_service_network_vpc_association(
securityGroupIds,
serviceNetworkVpcAssociationIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"PATCH",
"/servicenetworkvpcassociations/$(serviceNetworkVpcAssociationIdentifier)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("securityGroupIds" => securityGroupIds), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_target_group(health_check, target_group_identifier)
update_target_group(health_check, target_group_identifier, params::Dict{String,<:Any})
Updates the specified target group.
# Arguments
- `health_check`: The health check configuration.
- `target_group_identifier`: The ID or Amazon Resource Name (ARN) of the target group.
"""
function update_target_group(
healthCheck, targetGroupIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return vpc_lattice(
"PATCH",
"/targetgroups/$(targetGroupIdentifier)",
Dict{String,Any}("healthCheck" => healthCheck);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_target_group(
healthCheck,
targetGroupIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return vpc_lattice(
"PATCH",
"/targetgroups/$(targetGroupIdentifier)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("healthCheck" => healthCheck), 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 | 171892 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: waf
using AWS.Compat
using AWS.UUIDs
"""
create_byte_match_set(change_token, name)
create_byte_match_set(change_token, name, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Creates a ByteMatchSet. You then use UpdateByteMatchSet to
identify the part of a web request that you want AWS WAF to inspect, such as the values of
the User-Agent header or the query string. For example, you can create a ByteMatchSet that
matches any requests with User-Agent headers that contain the string BadBot. You can then
configure AWS WAF to reject those requests. To create and configure a ByteMatchSet, perform
the following steps: Use GetChangeToken to get the change token that you provide in the
ChangeToken parameter of a CreateByteMatchSet request. Submit a CreateByteMatchSet
request. Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of an UpdateByteMatchSet request. Submit an UpdateByteMatchSet request to
specify the part of the request that you want AWS WAF to inspect (for example, the header
or the URI) and the value that you want AWS WAF to watch for. For more information about
how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `name`: A friendly name or description of the ByteMatchSet. You can't change Name after
you create a ByteMatchSet.
"""
function create_byte_match_set(
ChangeToken, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"CreateByteMatchSet",
Dict{String,Any}("ChangeToken" => ChangeToken, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_byte_match_set(
ChangeToken,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"CreateByteMatchSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ChangeToken" => ChangeToken, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_geo_match_set(change_token, name)
create_geo_match_set(change_token, name, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Creates an GeoMatchSet, which you use to specify which web
requests you want to allow or block based on the country that the requests originate from.
For example, if you're receiving a lot of requests from one or more countries and you want
to block the requests, you can create an GeoMatchSet that contains those countries and then
configure AWS WAF to block the requests. To create and configure a GeoMatchSet, perform
the following steps: Use GetChangeToken to get the change token that you provide in the
ChangeToken parameter of a CreateGeoMatchSet request. Submit a CreateGeoMatchSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter
of an UpdateGeoMatchSet request. Submit an UpdateGeoMatchSetSet request to specify the
countries that you want AWS WAF to watch for. For more information about how to use the
AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `name`: A friendly name or description of the GeoMatchSet. You can't change Name after
you create the GeoMatchSet.
"""
function create_geo_match_set(
ChangeToken, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"CreateGeoMatchSet",
Dict{String,Any}("ChangeToken" => ChangeToken, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_geo_match_set(
ChangeToken,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"CreateGeoMatchSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ChangeToken" => ChangeToken, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_ipset(change_token, name)
create_ipset(change_token, name, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Creates an IPSet, which you use to specify which web requests
that you want to allow or block based on the IP addresses that the requests originate from.
For example, if you're receiving a lot of requests from one or more individual IP addresses
or one or more ranges of IP addresses and you want to block the requests, you can create an
IPSet that contains those IP addresses and then configure AWS WAF to block the requests.
To create and configure an IPSet, perform the following steps: Use GetChangeToken to get
the change token that you provide in the ChangeToken parameter of a CreateIPSet request.
Submit a CreateIPSet request. Use GetChangeToken to get the change token that you provide
in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateIPSet request to
specify the IP addresses that you want AWS WAF to watch for. For more information about
how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `name`: A friendly name or description of the IPSet. You can't change Name after you
create the IPSet.
"""
function create_ipset(ChangeToken, Name; aws_config::AbstractAWSConfig=global_aws_config())
return waf(
"CreateIPSet",
Dict{String,Any}("ChangeToken" => ChangeToken, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_ipset(
ChangeToken,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"CreateIPSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ChangeToken" => ChangeToken, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_rate_based_rule(change_token, metric_name, name, rate_key, rate_limit)
create_rate_based_rule(change_token, metric_name, name, rate_key, rate_limit, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Creates a RateBasedRule. The RateBasedRule contains a RateLimit,
which specifies the maximum number of requests that AWS WAF allows from a specified IP
address in a five-minute period. The RateBasedRule also contains the IPSet objects,
ByteMatchSet objects, and other predicates that identify the requests that you want to
count or block if these requests exceed the RateLimit. If you add more than one predicate
to a RateBasedRule, a request not only must exceed the RateLimit, but it also must match
all the conditions to be counted or blocked. For example, suppose you add the following to
a RateBasedRule: An IPSet that matches the IP address 192.0.2.44/32 A ByteMatchSet
that matches BadBot in the User-Agent header Further, you specify a RateLimit of 1,000.
You then add the RateBasedRule to a WebACL and specify that you want to block requests that
meet the conditions in the rule. For a request to be blocked, it must come from the IP
address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot.
Further, requests that match these two conditions must be received at a rate of more than
1,000 requests every five minutes. If both conditions are met and the rate is exceeded, AWS
WAF blocks the requests. If the rate drops below 1,000 for a five-minute period, AWS WAF no
longer blocks the requests. As a second example, suppose you want to limit requests to a
particular page on your site. To do this, you could add the following to a RateBasedRule:
A ByteMatchSet with FieldToMatch of URI A PositionalConstraint of STARTS_WITH A
TargetString of login Further, you specify a RateLimit of 1,000. By adding this
RateBasedRule to a WebACL, you could limit requests to your login page without affecting
the rest of your site. To create and configure a RateBasedRule, perform the following
steps: Create and update the predicates that you want to include in the rule. For more
information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. Use
GetChangeToken to get the change token that you provide in the ChangeToken parameter of a
CreateRule request. Submit a CreateRateBasedRule request. Use GetChangeToken to get the
change token that you provide in the ChangeToken parameter of an UpdateRule request.
Submit an UpdateRateBasedRule request to specify the predicates that you want to include in
the rule. Create and update a WebACL that contains the RateBasedRule. For more
information, see CreateWebACL. For more information about how to use the AWS WAF API to
allow or block HTTP requests, see the AWS WAF Developer Guide.
# Arguments
- `change_token`: The ChangeToken that you used to submit the CreateRateBasedRule request.
You can also use this value to query the status of the request. For more information, see
GetChangeTokenStatus.
- `metric_name`: A friendly name or description for the metrics for this RateBasedRule. The
name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and
minimum length one. It can't contain whitespace or metric names reserved for AWS WAF,
including \"All\" and \"Default_Action.\" You can't change the name of the metric after you
create the RateBasedRule.
- `name`: A friendly name or description of the RateBasedRule. You can't change the name of
a RateBasedRule after you create it.
- `rate_key`: The field that AWS WAF uses to determine if requests are likely arriving from
a single source and thus subject to rate monitoring. The only valid value for RateKey is
IP. IP indicates that requests that arrive from the same IP address are subject to the
RateLimit that is specified in the RateBasedRule.
- `rate_limit`: The maximum number of requests, which have an identical value in the field
that is specified by RateKey, allowed in a five-minute period. If the number of requests
exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF
triggers the action that is specified for this rule.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`:
"""
function create_rate_based_rule(
ChangeToken,
MetricName,
Name,
RateKey,
RateLimit;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"CreateRateBasedRule",
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"MetricName" => MetricName,
"Name" => Name,
"RateKey" => RateKey,
"RateLimit" => RateLimit,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_rate_based_rule(
ChangeToken,
MetricName,
Name,
RateKey,
RateLimit,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"CreateRateBasedRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"MetricName" => MetricName,
"Name" => Name,
"RateKey" => RateKey,
"RateLimit" => RateLimit,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_regex_match_set(change_token, name)
create_regex_match_set(change_token, name, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Creates a RegexMatchSet. You then use UpdateRegexMatchSet to
identify the part of a web request that you want AWS WAF to inspect, such as the values of
the User-Agent header or the query string. For example, you can create a RegexMatchSet that
contains a RegexMatchTuple that looks for any requests with User-Agent headers that match a
RegexPatternSet with pattern B[a@]dB[o0]t. You can then configure AWS WAF to reject those
requests. To create and configure a RegexMatchSet, perform the following steps: Use
GetChangeToken to get the change token that you provide in the ChangeToken parameter of a
CreateRegexMatchSet request. Submit a CreateRegexMatchSet request. Use GetChangeToken
to get the change token that you provide in the ChangeToken parameter of an
UpdateRegexMatchSet request. Submit an UpdateRegexMatchSet request to specify the part of
the request that you want AWS WAF to inspect (for example, the header or the URI) and the
value, using a RegexPatternSet, that you want AWS WAF to watch for. For more information
about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer
Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `name`: A friendly name or description of the RegexMatchSet. You can't change Name after
you create a RegexMatchSet.
"""
function create_regex_match_set(
ChangeToken, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"CreateRegexMatchSet",
Dict{String,Any}("ChangeToken" => ChangeToken, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_regex_match_set(
ChangeToken,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"CreateRegexMatchSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ChangeToken" => ChangeToken, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_regex_pattern_set(change_token, name)
create_regex_pattern_set(change_token, name, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Creates a RegexPatternSet. You then use UpdateRegexPatternSet to
specify the regular expression (regex) pattern that you want AWS WAF to search for, such as
B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests. To create and
configure a RegexPatternSet, perform the following steps: Use GetChangeToken to get the
change token that you provide in the ChangeToken parameter of a CreateRegexPatternSet
request. Submit a CreateRegexPatternSet request. Use GetChangeToken to get the change
token that you provide in the ChangeToken parameter of an UpdateRegexPatternSet request.
Submit an UpdateRegexPatternSet request to specify the string that you want AWS WAF to
watch for. For more information about how to use the AWS WAF API to allow or block HTTP
requests, see the AWS WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `name`: A friendly name or description of the RegexPatternSet. You can't change Name
after you create a RegexPatternSet.
"""
function create_regex_pattern_set(
ChangeToken, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"CreateRegexPatternSet",
Dict{String,Any}("ChangeToken" => ChangeToken, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_regex_pattern_set(
ChangeToken,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"CreateRegexPatternSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ChangeToken" => ChangeToken, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_rule(change_token, metric_name, name)
create_rule(change_token, metric_name, name, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Creates a Rule, which contains the IPSet objects, ByteMatchSet
objects, and other predicates that identify the requests that you want to block. If you add
more than one predicate to a Rule, a request must match all of the specifications to be
allowed or blocked. For example, suppose that you add the following to a Rule: An IPSet
that matches the IP address 192.0.2.44/32 A ByteMatchSet that matches BadBot in the
User-Agent header You then add the Rule to a WebACL and specify that you want to blocks
requests that satisfy the Rule. For a request to be blocked, it must come from the IP
address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot.
To create and configure a Rule, perform the following steps: Create and update the
predicates that you want to include in the Rule. For more information, see
CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. Use GetChangeToken to
get the change token that you provide in the ChangeToken parameter of a CreateRule request.
Submit a CreateRule request. Use GetChangeToken to get the change token that you
provide in the ChangeToken parameter of an UpdateRule request. Submit an UpdateRule
request to specify the predicates that you want to include in the Rule. Create and update
a WebACL that contains the Rule. For more information, see CreateWebACL. For more
information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS
WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `metric_name`: A friendly name or description for the metrics for this Rule. The name can
contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum
length one. It can't contain whitespace or metric names reserved for AWS WAF, including
\"All\" and \"Default_Action.\" You can't change the name of the metric after you create
the Rule.
- `name`: A friendly name or description of the Rule. You can't change the name of a Rule
after you create it.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`:
"""
function create_rule(
ChangeToken, MetricName, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"CreateRule",
Dict{String,Any}(
"ChangeToken" => ChangeToken, "MetricName" => MetricName, "Name" => Name
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_rule(
ChangeToken,
MetricName,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"CreateRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken, "MetricName" => MetricName, "Name" => Name
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_rule_group(change_token, metric_name, name)
create_rule_group(change_token, metric_name, name, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Creates a RuleGroup. A rule group is a collection of predefined
rules that you add to a web ACL. You use UpdateRuleGroup to add rules to the rule group.
Rule groups are subject to the following limits: Three rule groups per account. You can
request an increase to this limit by contacting customer support. One rule group per web
ACL. Ten rules per rule group. For more information about how to use the AWS WAF API to
allow or block HTTP requests, see the AWS WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `metric_name`: A friendly name or description for the metrics for this RuleGroup. The
name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and
minimum length one. It can't contain whitespace or metric names reserved for AWS WAF,
including \"All\" and \"Default_Action.\" You can't change the name of the metric after you
create the RuleGroup.
- `name`: A friendly name or description of the RuleGroup. You can't change Name after you
create a RuleGroup.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`:
"""
function create_rule_group(
ChangeToken, MetricName, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"CreateRuleGroup",
Dict{String,Any}(
"ChangeToken" => ChangeToken, "MetricName" => MetricName, "Name" => Name
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_rule_group(
ChangeToken,
MetricName,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"CreateRuleGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken, "MetricName" => MetricName, "Name" => Name
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_size_constraint_set(change_token, name)
create_size_constraint_set(change_token, name, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Creates a SizeConstraintSet. You then use
UpdateSizeConstraintSet to identify the part of a web request that you want AWS WAF to
check for length, such as the length of the User-Agent header or the length of the query
string. For example, you can create a SizeConstraintSet that matches any requests that have
a query string that is longer than 100 bytes. You can then configure AWS WAF to reject
those requests. To create and configure a SizeConstraintSet, perform the following steps:
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of
a CreateSizeConstraintSet request. Submit a CreateSizeConstraintSet request. Use
GetChangeToken to get the change token that you provide in the ChangeToken parameter of an
UpdateSizeConstraintSet request. Submit an UpdateSizeConstraintSet request to specify the
part of the request that you want AWS WAF to inspect (for example, the header or the URI)
and the value that you want AWS WAF to watch for. For more information about how to use
the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `name`: A friendly name or description of the SizeConstraintSet. You can't change Name
after you create a SizeConstraintSet.
"""
function create_size_constraint_set(
ChangeToken, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"CreateSizeConstraintSet",
Dict{String,Any}("ChangeToken" => ChangeToken, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_size_constraint_set(
ChangeToken,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"CreateSizeConstraintSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ChangeToken" => ChangeToken, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_sql_injection_match_set(change_token, name)
create_sql_injection_match_set(change_token, name, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Creates a SqlInjectionMatchSet, which you use to allow, block,
or count requests that contain snippets of SQL code in a specified part of web requests.
AWS WAF searches for character sequences that are likely to be malicious strings. To create
and configure a SqlInjectionMatchSet, perform the following steps: Use GetChangeToken to
get the change token that you provide in the ChangeToken parameter of a
CreateSqlInjectionMatchSet request. Submit a CreateSqlInjectionMatchSet request. Use
GetChangeToken to get the change token that you provide in the ChangeToken parameter of an
UpdateSqlInjectionMatchSet request. Submit an UpdateSqlInjectionMatchSet request to
specify the parts of web requests in which you want to allow, block, or count malicious SQL
code. For more information about how to use the AWS WAF API to allow or block HTTP
requests, see the AWS WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `name`: A friendly name or description for the SqlInjectionMatchSet that you're creating.
You can't change Name after you create the SqlInjectionMatchSet.
"""
function create_sql_injection_match_set(
ChangeToken, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"CreateSqlInjectionMatchSet",
Dict{String,Any}("ChangeToken" => ChangeToken, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_sql_injection_match_set(
ChangeToken,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"CreateSqlInjectionMatchSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ChangeToken" => ChangeToken, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_web_acl(change_token, default_action, metric_name, name)
create_web_acl(change_token, default_action, metric_name, name, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Creates a WebACL, which contains the Rules that identify the
CloudFront web requests that you want to allow, block, or count. AWS WAF evaluates Rules in
order based on the value of Priority for each Rule. You also specify a default action,
either ALLOW or BLOCK. If a web request doesn't match any of the Rules in a WebACL, AWS WAF
responds to the request with the default action. To create and configure a WebACL, perform
the following steps: Create and update the ByteMatchSet objects and other predicates that
you want to include in Rules. For more information, see CreateByteMatchSet,
UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and
UpdateSqlInjectionMatchSet. Create and update the Rules that you want to include in the
WebACL. For more information, see CreateRule and UpdateRule. Use GetChangeToken to get
the change token that you provide in the ChangeToken parameter of a CreateWebACL request.
Submit a CreateWebACL request. Use GetChangeToken to get the change token that you
provide in the ChangeToken parameter of an UpdateWebACL request. Submit an UpdateWebACL
request to specify the Rules that you want to include in the WebACL, to specify the default
action, and to associate the WebACL with a CloudFront distribution. For more information
about how to use the AWS WAF API, see the AWS WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `default_action`: The action that you want AWS WAF to take when a request doesn't match
the criteria specified in any of the Rule objects that are associated with the WebACL.
- `metric_name`: A friendly name or description for the metrics for this WebACL.The name
can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and
minimum length one. It can't contain whitespace or metric names reserved for AWS WAF,
including \"All\" and \"Default_Action.\" You can't change MetricName after you create the
WebACL.
- `name`: A friendly name or description of the WebACL. You can't change Name after you
create the WebACL.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`:
"""
function create_web_acl(
ChangeToken,
DefaultAction,
MetricName,
Name;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"CreateWebACL",
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"DefaultAction" => DefaultAction,
"MetricName" => MetricName,
"Name" => Name,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_web_acl(
ChangeToken,
DefaultAction,
MetricName,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"CreateWebACL",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"DefaultAction" => DefaultAction,
"MetricName" => MetricName,
"Name" => Name,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_web_aclmigration_stack(ignore_unsupported_type, s3_bucket_name, web_aclid)
create_web_aclmigration_stack(ignore_unsupported_type, s3_bucket_name, web_aclid, params::Dict{String,<:Any})
Creates an AWS CloudFormation WAFV2 template for the specified web ACL in the specified
Amazon S3 bucket. Then, in CloudFormation, you create a stack from the template, to create
the web ACL and its resources in AWS WAFV2. Use this to migrate your AWS WAF Classic web
ACL to the latest version of AWS WAF. This is part of a larger migration procedure for web
ACLs from AWS WAF Classic to the latest version of AWS WAF. For the full procedure,
including caveats and manual steps to complete the migration and switch over to the new web
ACL, see Migrating your AWS WAF Classic resources to AWS WAF in the AWS WAF Developer
Guide.
# Arguments
- `ignore_unsupported_type`: Indicates whether to exclude entities that can't be migrated
or to stop the migration. Set this to true to ignore unsupported entities in the web ACL
during the migration. Otherwise, if AWS WAF encounters unsupported entities, it stops the
process and throws an exception.
- `s3_bucket_name`: The name of the Amazon S3 bucket to store the CloudFormation template
in. The S3 bucket must be configured as follows for the migration: The bucket name must
start with aws-waf-migration-. For example, aws-waf-migration-my-web-acl. The bucket must
be in the Region where you are deploying the template. For example, for a web ACL in
us-west-2, you must use an Amazon S3 bucket in us-west-2 and you must deploy the template
stack to us-west-2. The bucket policies must permit the migration process to write data.
For listings of the bucket policies, see the Examples section.
- `web_aclid`: The UUID of the WAF Classic web ACL that you want to migrate to WAF v2.
"""
function create_web_aclmigration_stack(
IgnoreUnsupportedType,
S3BucketName,
WebACLId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"CreateWebACLMigrationStack",
Dict{String,Any}(
"IgnoreUnsupportedType" => IgnoreUnsupportedType,
"S3BucketName" => S3BucketName,
"WebACLId" => WebACLId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_web_aclmigration_stack(
IgnoreUnsupportedType,
S3BucketName,
WebACLId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"CreateWebACLMigrationStack",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IgnoreUnsupportedType" => IgnoreUnsupportedType,
"S3BucketName" => S3BucketName,
"WebACLId" => WebACLId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_xss_match_set(change_token, name)
create_xss_match_set(change_token, name, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Creates an XssMatchSet, which you use to allow, block, or count
requests that contain cross-site scripting attacks in the specified part of web requests.
AWS WAF searches for character sequences that are likely to be malicious strings. To create
and configure an XssMatchSet, perform the following steps: Use GetChangeToken to get the
change token that you provide in the ChangeToken parameter of a CreateXssMatchSet request.
Submit a CreateXssMatchSet request. Use GetChangeToken to get the change token that you
provide in the ChangeToken parameter of an UpdateXssMatchSet request. Submit an
UpdateXssMatchSet request to specify the parts of web requests in which you want to allow,
block, or count cross-site scripting attacks. For more information about how to use the
AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `name`: A friendly name or description for the XssMatchSet that you're creating. You
can't change Name after you create the XssMatchSet.
"""
function create_xss_match_set(
ChangeToken, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"CreateXssMatchSet",
Dict{String,Any}("ChangeToken" => ChangeToken, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_xss_match_set(
ChangeToken,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"CreateXssMatchSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ChangeToken" => ChangeToken, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_byte_match_set(byte_match_set_id, change_token)
delete_byte_match_set(byte_match_set_id, change_token, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Permanently deletes a ByteMatchSet. You can't delete a
ByteMatchSet if it's still used in any Rules or if it still includes any ByteMatchTuple
objects (any filters). If you just want to remove a ByteMatchSet from a Rule, use
UpdateRule. To permanently delete a ByteMatchSet, perform the following steps: Update the
ByteMatchSet to remove filters, if any. For more information, see UpdateByteMatchSet. Use
GetChangeToken to get the change token that you provide in the ChangeToken parameter of a
DeleteByteMatchSet request. Submit a DeleteByteMatchSet request.
# Arguments
- `byte_match_set_id`: The ByteMatchSetId of the ByteMatchSet that you want to delete.
ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
- `change_token`: The value returned by the most recent call to GetChangeToken.
"""
function delete_byte_match_set(
ByteMatchSetId, ChangeToken; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"DeleteByteMatchSet",
Dict{String,Any}("ByteMatchSetId" => ByteMatchSetId, "ChangeToken" => ChangeToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_byte_match_set(
ByteMatchSetId,
ChangeToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"DeleteByteMatchSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ByteMatchSetId" => ByteMatchSetId, "ChangeToken" => ChangeToken
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_geo_match_set(change_token, geo_match_set_id)
delete_geo_match_set(change_token, geo_match_set_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Permanently deletes a GeoMatchSet. You can't delete a
GeoMatchSet if it's still used in any Rules or if it still includes any countries. If you
just want to remove a GeoMatchSet from a Rule, use UpdateRule. To permanently delete a
GeoMatchSet from AWS WAF, perform the following steps: Update the GeoMatchSet to remove
any countries. For more information, see UpdateGeoMatchSet. Use GetChangeToken to get the
change token that you provide in the ChangeToken parameter of a DeleteGeoMatchSet request.
Submit a DeleteGeoMatchSet request.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `geo_match_set_id`: The GeoMatchSetID of the GeoMatchSet that you want to delete.
GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.
"""
function delete_geo_match_set(
ChangeToken, GeoMatchSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"DeleteGeoMatchSet",
Dict{String,Any}("ChangeToken" => ChangeToken, "GeoMatchSetId" => GeoMatchSetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_geo_match_set(
ChangeToken,
GeoMatchSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"DeleteGeoMatchSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken, "GeoMatchSetId" => GeoMatchSetId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_ipset(change_token, ipset_id)
delete_ipset(change_token, ipset_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Permanently deletes an IPSet. You can't delete an IPSet if it's
still used in any Rules or if it still includes any IP addresses. If you just want to
remove an IPSet from a Rule, use UpdateRule. To permanently delete an IPSet from AWS WAF,
perform the following steps: Update the IPSet to remove IP address ranges, if any. For
more information, see UpdateIPSet. Use GetChangeToken to get the change token that you
provide in the ChangeToken parameter of a DeleteIPSet request. Submit a DeleteIPSet
request.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `ipset_id`: The IPSetId of the IPSet that you want to delete. IPSetId is returned by
CreateIPSet and by ListIPSets.
"""
function delete_ipset(
ChangeToken, IPSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"DeleteIPSet",
Dict{String,Any}("ChangeToken" => ChangeToken, "IPSetId" => IPSetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_ipset(
ChangeToken,
IPSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"DeleteIPSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ChangeToken" => ChangeToken, "IPSetId" => IPSetId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_logging_configuration(resource_arn)
delete_logging_configuration(resource_arn, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Permanently deletes the LoggingConfiguration from the specified
web ACL.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the web ACL from which you want to
delete the LoggingConfiguration.
"""
function delete_logging_configuration(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"DeleteLoggingConfiguration",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_logging_configuration(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"DeleteLoggingConfiguration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_permission_policy(resource_arn)
delete_permission_policy(resource_arn, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Permanently deletes an IAM policy from the specified RuleGroup.
The user making the request must be the owner of the RuleGroup.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the RuleGroup from which you want to
delete the policy. The user making the request must be the owner of the RuleGroup.
"""
function delete_permission_policy(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"DeletePermissionPolicy",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_permission_policy(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"DeletePermissionPolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_rate_based_rule(change_token, rule_id)
delete_rate_based_rule(change_token, rule_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Permanently deletes a RateBasedRule. You can't delete a rule if
it's still used in any WebACL objects or if it still includes any predicates, such as
ByteMatchSet objects. If you just want to remove a rule from a WebACL, use UpdateWebACL. To
permanently delete a RateBasedRule from AWS WAF, perform the following steps: Update the
RateBasedRule to remove predicates, if any. For more information, see UpdateRateBasedRule.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter
of a DeleteRateBasedRule request. Submit a DeleteRateBasedRule request.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `rule_id`: The RuleId of the RateBasedRule that you want to delete. RuleId is returned by
CreateRateBasedRule and by ListRateBasedRules.
"""
function delete_rate_based_rule(
ChangeToken, RuleId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"DeleteRateBasedRule",
Dict{String,Any}("ChangeToken" => ChangeToken, "RuleId" => RuleId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_rate_based_rule(
ChangeToken,
RuleId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"DeleteRateBasedRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ChangeToken" => ChangeToken, "RuleId" => RuleId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_regex_match_set(change_token, regex_match_set_id)
delete_regex_match_set(change_token, regex_match_set_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Permanently deletes a RegexMatchSet. You can't delete a
RegexMatchSet if it's still used in any Rules or if it still includes any RegexMatchTuples
objects (any filters). If you just want to remove a RegexMatchSet from a Rule, use
UpdateRule. To permanently delete a RegexMatchSet, perform the following steps: Update
the RegexMatchSet to remove filters, if any. For more information, see UpdateRegexMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter
of a DeleteRegexMatchSet request. Submit a DeleteRegexMatchSet request.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `regex_match_set_id`: The RegexMatchSetId of the RegexMatchSet that you want to delete.
RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.
"""
function delete_regex_match_set(
ChangeToken, RegexMatchSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"DeleteRegexMatchSet",
Dict{String,Any}(
"ChangeToken" => ChangeToken, "RegexMatchSetId" => RegexMatchSetId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_regex_match_set(
ChangeToken,
RegexMatchSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"DeleteRegexMatchSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken, "RegexMatchSetId" => RegexMatchSetId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_regex_pattern_set(change_token, regex_pattern_set_id)
delete_regex_pattern_set(change_token, regex_pattern_set_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Permanently deletes a RegexPatternSet. You can't delete a
RegexPatternSet if it's still used in any RegexMatchSet or if the RegexPatternSet is not
empty.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `regex_pattern_set_id`: The RegexPatternSetId of the RegexPatternSet that you want to
delete. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
"""
function delete_regex_pattern_set(
ChangeToken, RegexPatternSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"DeleteRegexPatternSet",
Dict{String,Any}(
"ChangeToken" => ChangeToken, "RegexPatternSetId" => RegexPatternSetId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_regex_pattern_set(
ChangeToken,
RegexPatternSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"DeleteRegexPatternSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken, "RegexPatternSetId" => RegexPatternSetId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_rule(change_token, rule_id)
delete_rule(change_token, rule_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Permanently deletes a Rule. You can't delete a Rule if it's
still used in any WebACL objects or if it still includes any predicates, such as
ByteMatchSet objects. If you just want to remove a Rule from a WebACL, use UpdateWebACL. To
permanently delete a Rule from AWS WAF, perform the following steps: Update the Rule to
remove predicates, if any. For more information, see UpdateRule. Use GetChangeToken to
get the change token that you provide in the ChangeToken parameter of a DeleteRule request.
Submit a DeleteRule request.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `rule_id`: The RuleId of the Rule that you want to delete. RuleId is returned by
CreateRule and by ListRules.
"""
function delete_rule(ChangeToken, RuleId; aws_config::AbstractAWSConfig=global_aws_config())
return waf(
"DeleteRule",
Dict{String,Any}("ChangeToken" => ChangeToken, "RuleId" => RuleId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_rule(
ChangeToken,
RuleId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"DeleteRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ChangeToken" => ChangeToken, "RuleId" => RuleId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_rule_group(change_token, rule_group_id)
delete_rule_group(change_token, rule_group_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Permanently deletes a RuleGroup. You can't delete a RuleGroup if
it's still used in any WebACL objects or if it still includes any rules. If you just want
to remove a RuleGroup from a WebACL, use UpdateWebACL. To permanently delete a RuleGroup
from AWS WAF, perform the following steps: Update the RuleGroup to remove rules, if any.
For more information, see UpdateRuleGroup. Use GetChangeToken to get the change token
that you provide in the ChangeToken parameter of a DeleteRuleGroup request. Submit a
DeleteRuleGroup request.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `rule_group_id`: The RuleGroupId of the RuleGroup that you want to delete. RuleGroupId is
returned by CreateRuleGroup and by ListRuleGroups.
"""
function delete_rule_group(
ChangeToken, RuleGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"DeleteRuleGroup",
Dict{String,Any}("ChangeToken" => ChangeToken, "RuleGroupId" => RuleGroupId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_rule_group(
ChangeToken,
RuleGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"DeleteRuleGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken, "RuleGroupId" => RuleGroupId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_size_constraint_set(change_token, size_constraint_set_id)
delete_size_constraint_set(change_token, size_constraint_set_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Permanently deletes a SizeConstraintSet. You can't delete a
SizeConstraintSet if it's still used in any Rules or if it still includes any
SizeConstraint objects (any filters). If you just want to remove a SizeConstraintSet from a
Rule, use UpdateRule. To permanently delete a SizeConstraintSet, perform the following
steps: Update the SizeConstraintSet to remove filters, if any. For more information, see
UpdateSizeConstraintSet. Use GetChangeToken to get the change token that you provide in
the ChangeToken parameter of a DeleteSizeConstraintSet request. Submit a
DeleteSizeConstraintSet request.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `size_constraint_set_id`: The SizeConstraintSetId of the SizeConstraintSet that you want
to delete. SizeConstraintSetId is returned by CreateSizeConstraintSet and by
ListSizeConstraintSets.
"""
function delete_size_constraint_set(
ChangeToken, SizeConstraintSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"DeleteSizeConstraintSet",
Dict{String,Any}(
"ChangeToken" => ChangeToken, "SizeConstraintSetId" => SizeConstraintSetId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_size_constraint_set(
ChangeToken,
SizeConstraintSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"DeleteSizeConstraintSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"SizeConstraintSetId" => SizeConstraintSetId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_sql_injection_match_set(change_token, sql_injection_match_set_id)
delete_sql_injection_match_set(change_token, sql_injection_match_set_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Permanently deletes a SqlInjectionMatchSet. You can't delete a
SqlInjectionMatchSet if it's still used in any Rules or if it still contains any
SqlInjectionMatchTuple objects. If you just want to remove a SqlInjectionMatchSet from a
Rule, use UpdateRule. To permanently delete a SqlInjectionMatchSet from AWS WAF, perform
the following steps: Update the SqlInjectionMatchSet to remove filters, if any. For more
information, see UpdateSqlInjectionMatchSet. Use GetChangeToken to get the change token
that you provide in the ChangeToken parameter of a DeleteSqlInjectionMatchSet request.
Submit a DeleteSqlInjectionMatchSet request.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `sql_injection_match_set_id`: The SqlInjectionMatchSetId of the SqlInjectionMatchSet that
you want to delete. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by
ListSqlInjectionMatchSets.
"""
function delete_sql_injection_match_set(
ChangeToken, SqlInjectionMatchSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"DeleteSqlInjectionMatchSet",
Dict{String,Any}(
"ChangeToken" => ChangeToken, "SqlInjectionMatchSetId" => SqlInjectionMatchSetId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_sql_injection_match_set(
ChangeToken,
SqlInjectionMatchSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"DeleteSqlInjectionMatchSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"SqlInjectionMatchSetId" => SqlInjectionMatchSetId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_web_acl(change_token, web_aclid)
delete_web_acl(change_token, web_aclid, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Permanently deletes a WebACL. You can't delete a WebACL if it
still contains any Rules. To delete a WebACL, perform the following steps: Update the
WebACL to remove Rules, if any. For more information, see UpdateWebACL. Use
GetChangeToken to get the change token that you provide in the ChangeToken parameter of a
DeleteWebACL request. Submit a DeleteWebACL request.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `web_aclid`: The WebACLId of the WebACL that you want to delete. WebACLId is returned by
CreateWebACL and by ListWebACLs.
"""
function delete_web_acl(
ChangeToken, WebACLId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"DeleteWebACL",
Dict{String,Any}("ChangeToken" => ChangeToken, "WebACLId" => WebACLId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_web_acl(
ChangeToken,
WebACLId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"DeleteWebACL",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ChangeToken" => ChangeToken, "WebACLId" => WebACLId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_xss_match_set(change_token, xss_match_set_id)
delete_xss_match_set(change_token, xss_match_set_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Permanently deletes an XssMatchSet. You can't delete an
XssMatchSet if it's still used in any Rules or if it still contains any XssMatchTuple
objects. If you just want to remove an XssMatchSet from a Rule, use UpdateRule. To
permanently delete an XssMatchSet from AWS WAF, perform the following steps: Update the
XssMatchSet to remove filters, if any. For more information, see UpdateXssMatchSet. Use
GetChangeToken to get the change token that you provide in the ChangeToken parameter of a
DeleteXssMatchSet request. Submit a DeleteXssMatchSet request.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `xss_match_set_id`: The XssMatchSetId of the XssMatchSet that you want to delete.
XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
"""
function delete_xss_match_set(
ChangeToken, XssMatchSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"DeleteXssMatchSet",
Dict{String,Any}("ChangeToken" => ChangeToken, "XssMatchSetId" => XssMatchSetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_xss_match_set(
ChangeToken,
XssMatchSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"DeleteXssMatchSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken, "XssMatchSetId" => XssMatchSetId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_byte_match_set(byte_match_set_id)
get_byte_match_set(byte_match_set_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns the ByteMatchSet specified by ByteMatchSetId.
# Arguments
- `byte_match_set_id`: The ByteMatchSetId of the ByteMatchSet that you want to get.
ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
"""
function get_byte_match_set(
ByteMatchSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"GetByteMatchSet",
Dict{String,Any}("ByteMatchSetId" => ByteMatchSetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_byte_match_set(
ByteMatchSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"GetByteMatchSet",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ByteMatchSetId" => ByteMatchSetId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_change_token()
get_change_token(params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. When you want to create, update, or delete AWS WAF objects, get
a change token and include the change token in the create, update, or delete request.
Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF.
Each create, update, or delete request must use a unique change token. If your application
submits a GetChangeToken request and then submits a second GetChangeToken request before
submitting a create, update, or delete request, the second GetChangeToken request returns
the same value as the first GetChangeToken request. When you use a change token in a
create, update, or delete request, the status of the change token changes to PENDING, which
indicates that AWS WAF is propagating the change to all AWS WAF servers. Use
GetChangeTokenStatus to determine the status of your change token.
"""
function get_change_token(; aws_config::AbstractAWSConfig=global_aws_config())
return waf("GetChangeToken"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_change_token(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"GetChangeToken", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_change_token_status(change_token)
get_change_token_status(change_token, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns the status of a ChangeToken that you got by calling
GetChangeToken. ChangeTokenStatus is one of the following values: PROVISIONED: You
requested the change token by calling GetChangeToken, but you haven't used it yet in a call
to create, update, or delete an AWS WAF object. PENDING: AWS WAF is propagating the
create, update, or delete request to all AWS WAF servers. INSYNC: Propagation is
complete.
# Arguments
- `change_token`: The change token for which you want to get the status. This change token
was previously returned in the GetChangeToken response.
"""
function get_change_token_status(
ChangeToken; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"GetChangeTokenStatus",
Dict{String,Any}("ChangeToken" => ChangeToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_change_token_status(
ChangeToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"GetChangeTokenStatus",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ChangeToken" => ChangeToken), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_geo_match_set(geo_match_set_id)
get_geo_match_set(geo_match_set_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns the GeoMatchSet that is specified by GeoMatchSetId.
# Arguments
- `geo_match_set_id`: The GeoMatchSetId of the GeoMatchSet that you want to get.
GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.
"""
function get_geo_match_set(GeoMatchSetId; aws_config::AbstractAWSConfig=global_aws_config())
return waf(
"GetGeoMatchSet",
Dict{String,Any}("GeoMatchSetId" => GeoMatchSetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_geo_match_set(
GeoMatchSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"GetGeoMatchSet",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GeoMatchSetId" => GeoMatchSetId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_ipset(ipset_id)
get_ipset(ipset_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns the IPSet that is specified by IPSetId.
# Arguments
- `ipset_id`: The IPSetId of the IPSet that you want to get. IPSetId is returned by
CreateIPSet and by ListIPSets.
"""
function get_ipset(IPSetId; aws_config::AbstractAWSConfig=global_aws_config())
return waf(
"GetIPSet",
Dict{String,Any}("IPSetId" => IPSetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_ipset(
IPSetId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"GetIPSet",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("IPSetId" => IPSetId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_logging_configuration(resource_arn)
get_logging_configuration(resource_arn, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns the LoggingConfiguration for the specified web ACL.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the web ACL for which you want to get
the LoggingConfiguration.
"""
function get_logging_configuration(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"GetLoggingConfiguration",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_logging_configuration(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"GetLoggingConfiguration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_permission_policy(resource_arn)
get_permission_policy(resource_arn, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns the IAM policy attached to the RuleGroup.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the RuleGroup for which you want to get
the policy.
"""
function get_permission_policy(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"GetPermissionPolicy",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_permission_policy(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"GetPermissionPolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_rate_based_rule(rule_id)
get_rate_based_rule(rule_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns the RateBasedRule that is specified by the RuleId that
you included in the GetRateBasedRule request.
# Arguments
- `rule_id`: The RuleId of the RateBasedRule that you want to get. RuleId is returned by
CreateRateBasedRule and by ListRateBasedRules.
"""
function get_rate_based_rule(RuleId; aws_config::AbstractAWSConfig=global_aws_config())
return waf(
"GetRateBasedRule",
Dict{String,Any}("RuleId" => RuleId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_rate_based_rule(
RuleId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"GetRateBasedRule",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("RuleId" => RuleId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_rate_based_rule_managed_keys(rule_id)
get_rate_based_rule_managed_keys(rule_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns an array of IP addresses currently being blocked by the
RateBasedRule that is specified by the RuleId. The maximum number of managed keys that will
be blocked is 10,000. If more than 10,000 addresses exceed the rate limit, the 10,000
addresses with the highest rates will be blocked.
# Arguments
- `rule_id`: The RuleId of the RateBasedRule for which you want to get a list of
ManagedKeys. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextMarker"`: A null value and not currently used. Do not include this in your request.
"""
function get_rate_based_rule_managed_keys(
RuleId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"GetRateBasedRuleManagedKeys",
Dict{String,Any}("RuleId" => RuleId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_rate_based_rule_managed_keys(
RuleId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"GetRateBasedRuleManagedKeys",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("RuleId" => RuleId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_regex_match_set(regex_match_set_id)
get_regex_match_set(regex_match_set_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns the RegexMatchSet specified by RegexMatchSetId.
# Arguments
- `regex_match_set_id`: The RegexMatchSetId of the RegexMatchSet that you want to get.
RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.
"""
function get_regex_match_set(
RegexMatchSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"GetRegexMatchSet",
Dict{String,Any}("RegexMatchSetId" => RegexMatchSetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_regex_match_set(
RegexMatchSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"GetRegexMatchSet",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("RegexMatchSetId" => RegexMatchSetId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_regex_pattern_set(regex_pattern_set_id)
get_regex_pattern_set(regex_pattern_set_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns the RegexPatternSet specified by RegexPatternSetId.
# Arguments
- `regex_pattern_set_id`: The RegexPatternSetId of the RegexPatternSet that you want to
get. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
"""
function get_regex_pattern_set(
RegexPatternSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"GetRegexPatternSet",
Dict{String,Any}("RegexPatternSetId" => RegexPatternSetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_regex_pattern_set(
RegexPatternSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"GetRegexPatternSet",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("RegexPatternSetId" => RegexPatternSetId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_rule(rule_id)
get_rule(rule_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns the Rule that is specified by the RuleId that you
included in the GetRule request.
# Arguments
- `rule_id`: The RuleId of the Rule that you want to get. RuleId is returned by CreateRule
and by ListRules.
"""
function get_rule(RuleId; aws_config::AbstractAWSConfig=global_aws_config())
return waf(
"GetRule",
Dict{String,Any}("RuleId" => RuleId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_rule(
RuleId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"GetRule",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("RuleId" => RuleId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_rule_group(rule_group_id)
get_rule_group(rule_group_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns the RuleGroup that is specified by the RuleGroupId that
you included in the GetRuleGroup request. To view the rules in a rule group, use
ListActivatedRulesInRuleGroup.
# Arguments
- `rule_group_id`: The RuleGroupId of the RuleGroup that you want to get. RuleGroupId is
returned by CreateRuleGroup and by ListRuleGroups.
"""
function get_rule_group(RuleGroupId; aws_config::AbstractAWSConfig=global_aws_config())
return waf(
"GetRuleGroup",
Dict{String,Any}("RuleGroupId" => RuleGroupId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_rule_group(
RuleGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"GetRuleGroup",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RuleGroupId" => RuleGroupId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_sampled_requests(max_items, rule_id, time_window, web_acl_id)
get_sampled_requests(max_items, rule_id, time_window, web_acl_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Gets detailed information about a specified number of
requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that
your AWS resource received during a time range that you choose. You can specify a sample
size of up to 500 requests, and you can specify any time range in the previous three hours.
GetSampledRequests returns a time range, which is usually the time range that you
specified. However, if your resource (such as a CloudFront distribution) received 5,000
requests before the specified time range elapsed, GetSampledRequests returns an updated
time range. This new time range indicates the actual period during which AWS WAF selected
the requests in the sample.
# Arguments
- `max_items`: The number of requests that you want AWS WAF to return from among the first
5,000 requests that your AWS resource received during the time range. If your resource
received fewer requests than the value of MaxItems, GetSampledRequests returns information
about all of them.
- `rule_id`: RuleId is one of three values: The RuleId of the Rule or the RuleGroupId of
the RuleGroup for which you want GetSampledRequests to return a sample of requests.
Default_Action, which causes GetSampledRequests to return a sample of the requests that
didn't match any of the rules in the specified WebACL.
- `time_window`: The start date and time and the end date and time of the range for which
you want GetSampledRequests to return a sample of requests. You must specify the times in
Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For
example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.
- `web_acl_id`: The WebACLId of the WebACL for which you want GetSampledRequests to return
a sample of requests.
"""
function get_sampled_requests(
MaxItems,
RuleId,
TimeWindow,
WebAclId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"GetSampledRequests",
Dict{String,Any}(
"MaxItems" => MaxItems,
"RuleId" => RuleId,
"TimeWindow" => TimeWindow,
"WebAclId" => WebAclId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_sampled_requests(
MaxItems,
RuleId,
TimeWindow,
WebAclId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"GetSampledRequests",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MaxItems" => MaxItems,
"RuleId" => RuleId,
"TimeWindow" => TimeWindow,
"WebAclId" => WebAclId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_size_constraint_set(size_constraint_set_id)
get_size_constraint_set(size_constraint_set_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns the SizeConstraintSet specified by SizeConstraintSetId.
# Arguments
- `size_constraint_set_id`: The SizeConstraintSetId of the SizeConstraintSet that you want
to get. SizeConstraintSetId is returned by CreateSizeConstraintSet and by
ListSizeConstraintSets.
"""
function get_size_constraint_set(
SizeConstraintSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"GetSizeConstraintSet",
Dict{String,Any}("SizeConstraintSetId" => SizeConstraintSetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_size_constraint_set(
SizeConstraintSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"GetSizeConstraintSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("SizeConstraintSetId" => SizeConstraintSetId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_sql_injection_match_set(sql_injection_match_set_id)
get_sql_injection_match_set(sql_injection_match_set_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns the SqlInjectionMatchSet that is specified by
SqlInjectionMatchSetId.
# Arguments
- `sql_injection_match_set_id`: The SqlInjectionMatchSetId of the SqlInjectionMatchSet that
you want to get. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by
ListSqlInjectionMatchSets.
"""
function get_sql_injection_match_set(
SqlInjectionMatchSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"GetSqlInjectionMatchSet",
Dict{String,Any}("SqlInjectionMatchSetId" => SqlInjectionMatchSetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_sql_injection_match_set(
SqlInjectionMatchSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"GetSqlInjectionMatchSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("SqlInjectionMatchSetId" => SqlInjectionMatchSetId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_web_acl(web_aclid)
get_web_acl(web_aclid, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns the WebACL that is specified by WebACLId.
# Arguments
- `web_aclid`: The WebACLId of the WebACL that you want to get. WebACLId is returned by
CreateWebACL and by ListWebACLs.
"""
function get_web_acl(WebACLId; aws_config::AbstractAWSConfig=global_aws_config())
return waf(
"GetWebACL",
Dict{String,Any}("WebACLId" => WebACLId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_web_acl(
WebACLId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"GetWebACL",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("WebACLId" => WebACLId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_xss_match_set(xss_match_set_id)
get_xss_match_set(xss_match_set_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns the XssMatchSet that is specified by XssMatchSetId.
# Arguments
- `xss_match_set_id`: The XssMatchSetId of the XssMatchSet that you want to get.
XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
"""
function get_xss_match_set(XssMatchSetId; aws_config::AbstractAWSConfig=global_aws_config())
return waf(
"GetXssMatchSet",
Dict{String,Any}("XssMatchSetId" => XssMatchSetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_xss_match_set(
XssMatchSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"GetXssMatchSet",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("XssMatchSetId" => XssMatchSetId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_activated_rules_in_rule_group()
list_activated_rules_in_rule_group(params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns an array of ActivatedRule objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies the number of ActivatedRules that you want AWS WAF to return for
this request. If you have more ActivatedRules than the number that you specify for Limit,
the response includes a NextMarker value that you can use to get another batch of
ActivatedRules.
- `"NextMarker"`: If you specify a value for Limit and you have more ActivatedRules than
the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to
list another group of ActivatedRules. For the second and subsequent
ListActivatedRulesInRuleGroup requests, specify the value of NextMarker from the previous
response to get information about another batch of ActivatedRules.
- `"RuleGroupId"`: The RuleGroupId of the RuleGroup for which you want to get a list of
ActivatedRule objects.
"""
function list_activated_rules_in_rule_group(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"ListActivatedRulesInRuleGroup";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_activated_rules_in_rule_group(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"ListActivatedRulesInRuleGroup",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_byte_match_sets()
list_byte_match_sets(params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns an array of ByteMatchSetSummary objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies the number of ByteMatchSet objects that you want AWS WAF to return
for this request. If you have more ByteMatchSets objects than the number you specify for
Limit, the response includes a NextMarker value that you can use to get another batch of
ByteMatchSet objects.
- `"NextMarker"`: If you specify a value for Limit and you have more ByteMatchSets than the
value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list
another group of ByteMatchSets. For the second and subsequent ListByteMatchSets requests,
specify the value of NextMarker from the previous response to get information about another
batch of ByteMatchSets.
"""
function list_byte_match_sets(; aws_config::AbstractAWSConfig=global_aws_config())
return waf("ListByteMatchSets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_byte_match_sets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"ListByteMatchSets", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_geo_match_sets()
list_geo_match_sets(params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns an array of GeoMatchSetSummary objects in the response.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies the number of GeoMatchSet objects that you want AWS WAF to return
for this request. If you have more GeoMatchSet objects than the number you specify for
Limit, the response includes a NextMarker value that you can use to get another batch of
GeoMatchSet objects.
- `"NextMarker"`: If you specify a value for Limit and you have more GeoMatchSets than the
value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list
another group of GeoMatchSet objects. For the second and subsequent ListGeoMatchSets
requests, specify the value of NextMarker from the previous response to get information
about another batch of GeoMatchSet objects.
"""
function list_geo_match_sets(; aws_config::AbstractAWSConfig=global_aws_config())
return waf("ListGeoMatchSets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_geo_match_sets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"ListGeoMatchSets", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_ipsets()
list_ipsets(params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns an array of IPSetSummary objects in the response.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies the number of IPSet objects that you want AWS WAF to return for this
request. If you have more IPSet objects than the number you specify for Limit, the response
includes a NextMarker value that you can use to get another batch of IPSet objects.
- `"NextMarker"`: AWS WAF returns a NextMarker value in the response that allows you to
list another group of IPSets. For the second and subsequent ListIPSets requests, specify
the value of NextMarker from the previous response to get information about another batch
of IPSets.
"""
function list_ipsets(; aws_config::AbstractAWSConfig=global_aws_config())
return waf("ListIPSets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_ipsets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf("ListIPSets", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
"""
list_logging_configurations()
list_logging_configurations(params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns an array of LoggingConfiguration objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies the number of LoggingConfigurations that you want AWS WAF to return
for this request. If you have more LoggingConfigurations than the number that you specify
for Limit, the response includes a NextMarker value that you can use to get another batch
of LoggingConfigurations.
- `"NextMarker"`: If you specify a value for Limit and you have more LoggingConfigurations
than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you
to list another group of LoggingConfigurations. For the second and subsequent
ListLoggingConfigurations requests, specify the value of NextMarker from the previous
response to get information about another batch of ListLoggingConfigurations.
"""
function list_logging_configurations(; aws_config::AbstractAWSConfig=global_aws_config())
return waf(
"ListLoggingConfigurations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_logging_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"ListLoggingConfigurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_rate_based_rules()
list_rate_based_rules(params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns an array of RuleSummary objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies the number of Rules that you want AWS WAF to return for this
request. If you have more Rules than the number that you specify for Limit, the response
includes a NextMarker value that you can use to get another batch of Rules.
- `"NextMarker"`: If you specify a value for Limit and you have more Rules than the value
of Limit, AWS WAF returns a NextMarker value in the response that allows you to list
another group of Rules. For the second and subsequent ListRateBasedRules requests, specify
the value of NextMarker from the previous response to get information about another batch
of Rules.
"""
function list_rate_based_rules(; aws_config::AbstractAWSConfig=global_aws_config())
return waf("ListRateBasedRules"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_rate_based_rules(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"ListRateBasedRules", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_regex_match_sets()
list_regex_match_sets(params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns an array of RegexMatchSetSummary objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies the number of RegexMatchSet objects that you want AWS WAF to return
for this request. If you have more RegexMatchSet objects than the number you specify for
Limit, the response includes a NextMarker value that you can use to get another batch of
RegexMatchSet objects.
- `"NextMarker"`: If you specify a value for Limit and you have more RegexMatchSet objects
than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you
to list another group of ByteMatchSets. For the second and subsequent ListRegexMatchSets
requests, specify the value of NextMarker from the previous response to get information
about another batch of RegexMatchSet objects.
"""
function list_regex_match_sets(; aws_config::AbstractAWSConfig=global_aws_config())
return waf("ListRegexMatchSets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_regex_match_sets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"ListRegexMatchSets", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_regex_pattern_sets()
list_regex_pattern_sets(params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns an array of RegexPatternSetSummary objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies the number of RegexPatternSet objects that you want AWS WAF to
return for this request. If you have more RegexPatternSet objects than the number you
specify for Limit, the response includes a NextMarker value that you can use to get another
batch of RegexPatternSet objects.
- `"NextMarker"`: If you specify a value for Limit and you have more RegexPatternSet
objects than the value of Limit, AWS WAF returns a NextMarker value in the response that
allows you to list another group of RegexPatternSet objects. For the second and subsequent
ListRegexPatternSets requests, specify the value of NextMarker from the previous response
to get information about another batch of RegexPatternSet objects.
"""
function list_regex_pattern_sets(; aws_config::AbstractAWSConfig=global_aws_config())
return waf(
"ListRegexPatternSets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_regex_pattern_sets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"ListRegexPatternSets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_rule_groups()
list_rule_groups(params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns an array of RuleGroup objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies the number of RuleGroups that you want AWS WAF to return for this
request. If you have more RuleGroups than the number that you specify for Limit, the
response includes a NextMarker value that you can use to get another batch of RuleGroups.
- `"NextMarker"`: If you specify a value for Limit and you have more RuleGroups than the
value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list
another group of RuleGroups. For the second and subsequent ListRuleGroups requests, specify
the value of NextMarker from the previous response to get information about another batch
of RuleGroups.
"""
function list_rule_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return waf("ListRuleGroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_rule_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"ListRuleGroups", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_rules()
list_rules(params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns an array of RuleSummary objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies the number of Rules that you want AWS WAF to return for this
request. If you have more Rules than the number that you specify for Limit, the response
includes a NextMarker value that you can use to get another batch of Rules.
- `"NextMarker"`: If you specify a value for Limit and you have more Rules than the value
of Limit, AWS WAF returns a NextMarker value in the response that allows you to list
another group of Rules. For the second and subsequent ListRules requests, specify the value
of NextMarker from the previous response to get information about another batch of Rules.
"""
function list_rules(; aws_config::AbstractAWSConfig=global_aws_config())
return waf("ListRules"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_rules(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf("ListRules", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
"""
list_size_constraint_sets()
list_size_constraint_sets(params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns an array of SizeConstraintSetSummary objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies the number of SizeConstraintSet objects that you want AWS WAF to
return for this request. If you have more SizeConstraintSets objects than the number you
specify for Limit, the response includes a NextMarker value that you can use to get another
batch of SizeConstraintSet objects.
- `"NextMarker"`: If you specify a value for Limit and you have more SizeConstraintSets
than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you
to list another group of SizeConstraintSets. For the second and subsequent
ListSizeConstraintSets requests, specify the value of NextMarker from the previous response
to get information about another batch of SizeConstraintSets.
"""
function list_size_constraint_sets(; aws_config::AbstractAWSConfig=global_aws_config())
return waf(
"ListSizeConstraintSets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_size_constraint_sets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"ListSizeConstraintSets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_sql_injection_match_sets()
list_sql_injection_match_sets(params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns an array of SqlInjectionMatchSet objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies the number of SqlInjectionMatchSet objects that you want AWS WAF to
return for this request. If you have more SqlInjectionMatchSet objects than the number you
specify for Limit, the response includes a NextMarker value that you can use to get another
batch of Rules.
- `"NextMarker"`: If you specify a value for Limit and you have more SqlInjectionMatchSet
objects than the value of Limit, AWS WAF returns a NextMarker value in the response that
allows you to list another group of SqlInjectionMatchSets. For the second and subsequent
ListSqlInjectionMatchSets requests, specify the value of NextMarker from the previous
response to get information about another batch of SqlInjectionMatchSets.
"""
function list_sql_injection_match_sets(; aws_config::AbstractAWSConfig=global_aws_config())
return waf(
"ListSqlInjectionMatchSets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_sql_injection_match_sets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"ListSqlInjectionMatchSets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_subscribed_rule_groups()
list_subscribed_rule_groups(params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns an array of RuleGroup objects that you are subscribed to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies the number of subscribed rule groups that you want AWS WAF to return
for this request. If you have more objects than the number you specify for Limit, the
response includes a NextMarker value that you can use to get another batch of objects.
- `"NextMarker"`: If you specify a value for Limit and you have more
ByteMatchSetssubscribed rule groups than the value of Limit, AWS WAF returns a NextMarker
value in the response that allows you to list another group of subscribed rule groups. For
the second and subsequent ListSubscribedRuleGroupsRequest requests, specify the value of
NextMarker from the previous response to get information about another batch of subscribed
rule groups.
"""
function list_subscribed_rule_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return waf(
"ListSubscribedRuleGroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_subscribed_rule_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"ListSubscribedRuleGroups",
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 is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Retrieves the tags associated with the specified AWS resource.
Tags are key:value pairs that you can use to categorize and manage your resources, for
purposes like billing. For example, you might set the tag key to \"customer\" and the value
to the customer name or ID. You can specify one or more tags to add to each AWS resource,
up to 50 tags for a resource. Tagging is only available through the API, SDKs, and CLI. You
can't manage or view tags through the AWS WAF Classic console. You can tag the AWS
resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules.
# Arguments
- `resource_arn`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`:
- `"NextMarker"`:
"""
function list_tags_for_resource(
ResourceARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"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 waf(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceARN" => ResourceARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_web_acls()
list_web_acls(params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns an array of WebACLSummary objects in the response.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies the number of WebACL objects that you want AWS WAF to return for
this request. If you have more WebACL objects than the number that you specify for Limit,
the response includes a NextMarker value that you can use to get another batch of WebACL
objects.
- `"NextMarker"`: If you specify a value for Limit and you have more WebACL objects than
the number that you specify for Limit, AWS WAF returns a NextMarker value in the response
that allows you to list another group of WebACL objects. For the second and subsequent
ListWebACLs requests, specify the value of NextMarker from the previous response to get
information about another batch of WebACL objects.
"""
function list_web_acls(; aws_config::AbstractAWSConfig=global_aws_config())
return waf("ListWebACLs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_web_acls(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"ListWebACLs", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_xss_match_sets()
list_xss_match_sets(params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns an array of XssMatchSet objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies the number of XssMatchSet objects that you want AWS WAF to return
for this request. If you have more XssMatchSet objects than the number you specify for
Limit, the response includes a NextMarker value that you can use to get another batch of
Rules.
- `"NextMarker"`: If you specify a value for Limit and you have more XssMatchSet objects
than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you
to list another group of XssMatchSets. For the second and subsequent ListXssMatchSets
requests, specify the value of NextMarker from the previous response to get information
about another batch of XssMatchSets.
"""
function list_xss_match_sets(; aws_config::AbstractAWSConfig=global_aws_config())
return waf("ListXssMatchSets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_xss_match_sets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"ListXssMatchSets", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
put_logging_configuration(logging_configuration)
put_logging_configuration(logging_configuration, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Associates a LoggingConfiguration with a specified web ACL. You
can access information about all traffic that AWS WAF inspects using the following steps:
Create an Amazon Kinesis Data Firehose. Create the data firehose with a PUT source and in
the region that you are operating. However, if you are capturing logs for Amazon
CloudFront, always create the firehose in US East (N. Virginia). Do not create the data
firehose using a Kinesis stream as your source. Associate that firehose to your web ACL
using a PutLoggingConfiguration request. When you successfully enable logging using a
PutLoggingConfiguration request, AWS WAF will create a service linked role with the
necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more
information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide.
# Arguments
- `logging_configuration`: The Amazon Kinesis Data Firehose that contains the inspected
traffic information, the redacted fields details, and the Amazon Resource Name (ARN) of the
web ACL to monitor. When specifying Type in RedactedFields, you must use one of the
following values: URI, QUERY_STRING, HEADER, or METHOD.
"""
function put_logging_configuration(
LoggingConfiguration; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"PutLoggingConfiguration",
Dict{String,Any}("LoggingConfiguration" => LoggingConfiguration);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_logging_configuration(
LoggingConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"PutLoggingConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LoggingConfiguration" => LoggingConfiguration),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_permission_policy(policy, resource_arn)
put_permission_policy(policy, resource_arn, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Attaches an IAM policy to the specified resource. The only
supported use for this action is to share a RuleGroup across accounts. The
PutPermissionPolicy is subject to the following restrictions: You can attach only one
policy with each PutPermissionPolicy request. The policy must include an Effect, Action
and Principal. Effect must specify Allow. The Action in the policy must be
waf:UpdateWebACL, waf-regional:UpdateWebACL, waf:GetRuleGroup and waf-regional:GetRuleGroup
. Any extra or wildcard actions in the policy will be rejected. The policy cannot include
a Resource parameter. The ARN in the request must be a valid WAF RuleGroup ARN and the
RuleGroup must exist in the same region. The user making the request must be the owner of
the RuleGroup. Your policy must be composed using IAM Policy version 2012-10-17. For
more information, see IAM Policies. An example of a valid policy parameter is shown in the
Examples section below.
# Arguments
- `policy`: The policy to attach to the specified RuleGroup.
- `resource_arn`: The Amazon Resource Name (ARN) of the RuleGroup to which you want to
attach the policy.
"""
function put_permission_policy(
Policy, ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"PutPermissionPolicy",
Dict{String,Any}("Policy" => Policy, "ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_permission_policy(
Policy,
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"PutPermissionPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Policy" => Policy, "ResourceArn" => ResourceArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Associates tags with the specified AWS resource. Tags are
key:value pairs that you can use to categorize and manage your resources, for purposes like
billing. For example, you might set the tag key to \"customer\" and the value to the
customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50
tags for a resource. Tagging is only available through the API, SDKs, and CLI. You can't
manage or view tags through the AWS WAF Classic console. You can use this action to tag the
AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules.
# Arguments
- `resource_arn`:
- `tags`:
"""
function tag_resource(ResourceARN, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return waf(
"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 waf(
"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 is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use.
# Arguments
- `resource_arn`:
- `tag_keys`:
"""
function untag_resource(
ResourceARN, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"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 waf(
"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_byte_match_set(byte_match_set_id, change_token, updates)
update_byte_match_set(byte_match_set_id, change_token, updates, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Inserts or deletes ByteMatchTuple objects (filters) in a
ByteMatchSet. For each ByteMatchTuple object, you specify the following values: Whether
to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate
object, you delete the existing object and add a new one. The part of a web request that
you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.
The bytes (typically a string that corresponds with ASCII characters) that you want AWS
WAF to look for. For more information, including how you specify the values for the AWS WAF
API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple data type. Where to
look, such as at the beginning or the end of a query string. Whether to perform any
conversions on the request, such as converting it to lowercase, before inspecting it for
the specified string. For example, you can add a ByteMatchSetUpdate object that matches
web requests in which User-Agent headers contain the string BadBot. You can then configure
AWS WAF to block those requests. To create and configure a ByteMatchSet, perform the
following steps: Create a ByteMatchSet. For more information, see CreateByteMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of
an UpdateByteMatchSet request. Submit an UpdateByteMatchSet request to specify the part
of the request that you want AWS WAF to inspect (for example, the header or the URI) and
the value that you want AWS WAF to watch for. For more information about how to use the
AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
# Arguments
- `byte_match_set_id`: The ByteMatchSetId of the ByteMatchSet that you want to update.
ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `updates`: An array of ByteMatchSetUpdate objects that you want to insert into or delete
from a ByteMatchSet. For more information, see the applicable data types:
ByteMatchSetUpdate: Contains Action and ByteMatchTuple ByteMatchTuple: Contains
FieldToMatch, PositionalConstraint, TargetString, and TextTransformation FieldToMatch:
Contains Data and Type
"""
function update_byte_match_set(
ByteMatchSetId, ChangeToken, Updates; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"UpdateByteMatchSet",
Dict{String,Any}(
"ByteMatchSetId" => ByteMatchSetId,
"ChangeToken" => ChangeToken,
"Updates" => Updates,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_byte_match_set(
ByteMatchSetId,
ChangeToken,
Updates,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"UpdateByteMatchSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ByteMatchSetId" => ByteMatchSetId,
"ChangeToken" => ChangeToken,
"Updates" => Updates,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_geo_match_set(change_token, geo_match_set_id, updates)
update_geo_match_set(change_token, geo_match_set_id, updates, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Inserts or deletes GeoMatchConstraint objects in an GeoMatchSet.
For each GeoMatchConstraint object, you specify the following values: Whether to insert
or delete the object from the array. If you want to change an GeoMatchConstraint object,
you delete the existing object and add a new one. The Type. The only valid value for Type
is Country. The Value, which is a two character code for the country to add to the
GeoMatchConstraint object. Valid codes are listed in GeoMatchConstraintValue. To create
and configure an GeoMatchSet, perform the following steps: Submit a CreateGeoMatchSet
request. Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of an UpdateGeoMatchSet request. Submit an UpdateGeoMatchSet request to specify
the country that you want AWS WAF to watch for. When you update an GeoMatchSet, you
specify the country that you want to add and/or the country that you want to delete. If you
want to change a country, you delete the existing country and add the new one. For more
information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS
WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `geo_match_set_id`: The GeoMatchSetId of the GeoMatchSet that you want to update.
GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.
- `updates`: An array of GeoMatchSetUpdate objects that you want to insert into or delete
from an GeoMatchSet. For more information, see the applicable data types:
GeoMatchSetUpdate: Contains Action and GeoMatchConstraint GeoMatchConstraint: Contains
Type and Value You can have only one Type and Value per GeoMatchConstraint. To add
multiple countries, include multiple GeoMatchSetUpdate objects in your request.
"""
function update_geo_match_set(
ChangeToken, GeoMatchSetId, Updates; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"UpdateGeoMatchSet",
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"GeoMatchSetId" => GeoMatchSetId,
"Updates" => Updates,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_geo_match_set(
ChangeToken,
GeoMatchSetId,
Updates,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"UpdateGeoMatchSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"GeoMatchSetId" => GeoMatchSetId,
"Updates" => Updates,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_ipset(change_token, ipset_id, updates)
update_ipset(change_token, ipset_id, updates, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Inserts or deletes IPSetDescriptor objects in an IPSet. For each
IPSetDescriptor object, you specify the following values: Whether to insert or delete
the object from the array. If you want to change an IPSetDescriptor object, you delete the
existing object and add a new one. The IP address version, IPv4 or IPv6. The IP
address in CIDR notation, for example, 192.0.2.0/24 (for the range of IP addresses from
192.0.2.0 to 192.0.2.255) or 192.0.2.44/32 (for the individual IP address 192.0.2.44).
AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF
supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. For more information about
CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. IPv6 addresses can
be represented using any of the following formats:
1111:0000:0000:0000:0000:0000:0000:0111/128 1111:0:0:0:0:0:0:0111/128 1111::0111/128
1111::111/128 You use an IPSet to specify which web requests you want to allow or block
based on the IP addresses that the requests originated from. For example, if you're
receiving a lot of requests from one or a small number of IP addresses and you want to
block the requests, you can create an IPSet that specifies those IP addresses, and then
configure AWS WAF to block the requests. To create and configure an IPSet, perform the
following steps: Submit a CreateIPSet request. Use GetChangeToken to get the change
token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an
UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for. When
you update an IPSet, you specify the IP addresses that you want to add and/or the IP
addresses that you want to delete. If you want to change an IP address, you delete the
existing IP address and add the new one. You can insert a maximum of 1000 addresses in a
single request. For more information about how to use the AWS WAF API to allow or block
HTTP requests, see the AWS WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `ipset_id`: The IPSetId of the IPSet that you want to update. IPSetId is returned by
CreateIPSet and by ListIPSets.
- `updates`: An array of IPSetUpdate objects that you want to insert into or delete from an
IPSet. For more information, see the applicable data types: IPSetUpdate: Contains Action
and IPSetDescriptor IPSetDescriptor: Contains Type and Value You can insert a
maximum of 1000 addresses in a single request.
"""
function update_ipset(
ChangeToken, IPSetId, Updates; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"UpdateIPSet",
Dict{String,Any}(
"ChangeToken" => ChangeToken, "IPSetId" => IPSetId, "Updates" => Updates
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_ipset(
ChangeToken,
IPSetId,
Updates,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"UpdateIPSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken, "IPSetId" => IPSetId, "Updates" => Updates
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_rate_based_rule(change_token, rate_limit, rule_id, updates)
update_rate_based_rule(change_token, rate_limit, rule_id, updates, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Inserts or deletes Predicate objects in a rule and updates the
RateLimit in the rule. Each Predicate object identifies a predicate, such as a
ByteMatchSet or an IPSet, that specifies the web requests that you want to block or count.
The RateLimit specifies the number of requests every five minutes that triggers the rule.
If you add more than one predicate to a RateBasedRule, a request must match all the
predicates and exceed the RateLimit to be counted or blocked. For example, suppose you add
the following to a RateBasedRule: An IPSet that matches the IP address 192.0.2.44/32 A
ByteMatchSet that matches BadBot in the User-Agent header Further, you specify a
RateLimit of 1,000. You then add the RateBasedRule to a WebACL and specify that you want to
block requests that satisfy the rule. For a request to be blocked, it must come from the IP
address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot.
Further, requests that match these two conditions much be received at a rate of more than
1,000 every five minutes. If the rate drops below this limit, AWS WAF no longer blocks the
requests. As a second example, suppose you want to limit requests to a particular page on
your site. To do this, you could add the following to a RateBasedRule: A ByteMatchSet
with FieldToMatch of URI A PositionalConstraint of STARTS_WITH A TargetString of
login Further, you specify a RateLimit of 1,000. By adding this RateBasedRule to a
WebACL, you could limit requests to your login page without affecting the rest of your site.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `rate_limit`: The maximum number of requests, which have an identical value in the field
specified by the RateKey, allowed in a five-minute period. If the number of requests
exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF
triggers the action that is specified for this rule.
- `rule_id`: The RuleId of the RateBasedRule that you want to update. RuleId is returned by
CreateRateBasedRule and by ListRateBasedRules.
- `updates`: An array of RuleUpdate objects that you want to insert into or delete from a
RateBasedRule.
"""
function update_rate_based_rule(
ChangeToken,
RateLimit,
RuleId,
Updates;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"UpdateRateBasedRule",
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"RateLimit" => RateLimit,
"RuleId" => RuleId,
"Updates" => Updates,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_rate_based_rule(
ChangeToken,
RateLimit,
RuleId,
Updates,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"UpdateRateBasedRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"RateLimit" => RateLimit,
"RuleId" => RuleId,
"Updates" => Updates,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_regex_match_set(change_token, regex_match_set_id, updates)
update_regex_match_set(change_token, regex_match_set_id, updates, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Inserts or deletes RegexMatchTuple objects (filters) in a
RegexMatchSet. For each RegexMatchSetUpdate object, you specify the following values:
Whether to insert or delete the object from the array. If you want to change a
RegexMatchSetUpdate object, you delete the existing object and add a new one. The part of
a web request that you want AWS WAF to inspectupdate, such as a query string or the value
of the User-Agent header. The identifier of the pattern (a regular expression) that you
want AWS WAF to look for. For more information, see RegexPatternSet. Whether to perform
any conversions on the request, such as converting it to lowercase, before inspecting it
for the specified string. For example, you can create a RegexPatternSet that matches any
requests with User-Agent headers that contain the string B[a@]dB[o0]t. You can then
configure AWS WAF to reject those requests. To create and configure a RegexMatchSet,
perform the following steps: Create a RegexMatchSet. For more information, see
CreateRegexMatchSet. Use GetChangeToken to get the change token that you provide in the
ChangeToken parameter of an UpdateRegexMatchSet request. Submit an UpdateRegexMatchSet
request to specify the part of the request that you want AWS WAF to inspect (for example,
the header or the URI) and the identifier of the RegexPatternSet that contain the regular
expression patters you want AWS WAF to watch for. For more information about how to use
the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `regex_match_set_id`: The RegexMatchSetId of the RegexMatchSet that you want to update.
RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.
- `updates`: An array of RegexMatchSetUpdate objects that you want to insert into or delete
from a RegexMatchSet. For more information, see RegexMatchTuple.
"""
function update_regex_match_set(
ChangeToken, RegexMatchSetId, Updates; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"UpdateRegexMatchSet",
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"RegexMatchSetId" => RegexMatchSetId,
"Updates" => Updates,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_regex_match_set(
ChangeToken,
RegexMatchSetId,
Updates,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"UpdateRegexMatchSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"RegexMatchSetId" => RegexMatchSetId,
"Updates" => Updates,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_regex_pattern_set(change_token, regex_pattern_set_id, updates)
update_regex_pattern_set(change_token, regex_pattern_set_id, updates, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Inserts or deletes RegexPatternString objects in a
RegexPatternSet. For each RegexPatternString object, you specify the following values:
Whether to insert or delete the RegexPatternString. The regular expression pattern that
you want to insert or delete. For more information, see RegexPatternSet. For example,
you can create a RegexPatternString such as B[a@]dB[o0]t. AWS WAF will match this
RegexPatternString to: BadBot BadB0t B@dBot B@dB0t To create and configure a
RegexPatternSet, perform the following steps: Create a RegexPatternSet. For more
information, see CreateRegexPatternSet. Use GetChangeToken to get the change token that
you provide in the ChangeToken parameter of an UpdateRegexPatternSet request. Submit an
UpdateRegexPatternSet request to specify the regular expression pattern that you want AWS
WAF to watch for. For more information about how to use the AWS WAF API to allow or block
HTTP requests, see the AWS WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `regex_pattern_set_id`: The RegexPatternSetId of the RegexPatternSet that you want to
update. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
- `updates`: An array of RegexPatternSetUpdate objects that you want to insert into or
delete from a RegexPatternSet.
"""
function update_regex_pattern_set(
ChangeToken,
RegexPatternSetId,
Updates;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"UpdateRegexPatternSet",
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"RegexPatternSetId" => RegexPatternSetId,
"Updates" => Updates,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_regex_pattern_set(
ChangeToken,
RegexPatternSetId,
Updates,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"UpdateRegexPatternSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"RegexPatternSetId" => RegexPatternSetId,
"Updates" => Updates,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_rule(change_token, rule_id, updates)
update_rule(change_token, rule_id, updates, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Inserts or deletes Predicate objects in a Rule. Each Predicate
object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web
requests that you want to allow, block, or count. If you add more than one predicate to a
Rule, a request must match all of the specifications to be allowed, blocked, or counted.
For example, suppose that you add the following to a Rule: A ByteMatchSet that matches
the value BadBot in the User-Agent header An IPSet that matches the IP address 192.0.2.44
You then add the Rule to a WebACL and specify that you want to block requests that
satisfy the Rule. For a request to be blocked, the User-Agent header in the request must
contain the value BadBot and the request must originate from the IP address 192.0.2.44. To
create and configure a Rule, perform the following steps: Create and update the
predicates that you want to include in the Rule. Create the Rule. See CreateRule. Use
GetChangeToken to get the change token that you provide in the ChangeToken parameter of an
UpdateRule request. Submit an UpdateRule request to add predicates to the Rule. Create
and update a WebACL that contains the Rule. See CreateWebACL. If you want to replace one
ByteMatchSet or IPSet with another, you delete the existing one and add the new one. For
more information about how to use the AWS WAF API to allow or block HTTP requests, see the
AWS WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `rule_id`: The RuleId of the Rule that you want to update. RuleId is returned by
CreateRule and by ListRules.
- `updates`: An array of RuleUpdate objects that you want to insert into or delete from a
Rule. For more information, see the applicable data types: RuleUpdate: Contains Action
and Predicate Predicate: Contains DataId, Negated, and Type FieldToMatch: Contains
Data and Type
"""
function update_rule(
ChangeToken, RuleId, Updates; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"UpdateRule",
Dict{String,Any}(
"ChangeToken" => ChangeToken, "RuleId" => RuleId, "Updates" => Updates
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_rule(
ChangeToken,
RuleId,
Updates,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"UpdateRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken, "RuleId" => RuleId, "Updates" => Updates
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_rule_group(change_token, rule_group_id, updates)
update_rule_group(change_token, rule_group_id, updates, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Inserts or deletes ActivatedRule objects in a RuleGroup. You can
only insert REGULAR rules into a rule group. You can have a maximum of ten rules per rule
group. To create and configure a RuleGroup, perform the following steps: Create and
update the Rules that you want to include in the RuleGroup. See CreateRule. Use
GetChangeToken to get the change token that you provide in the ChangeToken parameter of an
UpdateRuleGroup request. Submit an UpdateRuleGroup request to add Rules to the RuleGroup.
Create and update a WebACL that contains the RuleGroup. See CreateWebACL. If you want
to replace one Rule with another, you delete the existing one and add the new one. For more
information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS
WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `rule_group_id`: The RuleGroupId of the RuleGroup that you want to update. RuleGroupId is
returned by CreateRuleGroup and by ListRuleGroups.
- `updates`: An array of RuleGroupUpdate objects that you want to insert into or delete
from a RuleGroup. You can only insert REGULAR rules into a rule group.
ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL.
In this case you do not use ActivatedRule|Action. For all other update requests,
ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.
"""
function update_rule_group(
ChangeToken, RuleGroupId, Updates; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"UpdateRuleGroup",
Dict{String,Any}(
"ChangeToken" => ChangeToken, "RuleGroupId" => RuleGroupId, "Updates" => Updates
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_rule_group(
ChangeToken,
RuleGroupId,
Updates,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"UpdateRuleGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"RuleGroupId" => RuleGroupId,
"Updates" => Updates,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_size_constraint_set(change_token, size_constraint_set_id, updates)
update_size_constraint_set(change_token, size_constraint_set_id, updates, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Inserts or deletes SizeConstraint objects (filters) in a
SizeConstraintSet. For each SizeConstraint object, you specify the following values:
Whether to insert or delete the object from the array. If you want to change a
SizeConstraintSetUpdate object, you delete the existing object and add a new one. The
part of a web request that you want AWS WAF to evaluate, such as the length of a query
string or the length of the User-Agent header. Whether to perform any transformations on
the request, such as converting it to lowercase, before checking its length. Note that
transformations of the request body are not supported because the AWS resource forwards
only the first 8192 bytes of your request to AWS WAF. You can only specify a single type of
TextTransformation. A ComparisonOperator used for evaluating the selected part of the
request against the specified Size, such as equals, greater than, less than, and so on.
The length, in bytes, that you want AWS WAF to watch for in selected part of the request.
The length is computed after applying the transformation. For example, you can add a
SizeConstraintSetUpdate object that matches web requests in which the length of the
User-Agent header is greater than 100 bytes. You can then configure AWS WAF to block those
requests. To create and configure a SizeConstraintSet, perform the following steps:
Create a SizeConstraintSet. For more information, see CreateSizeConstraintSet. Use
GetChangeToken to get the change token that you provide in the ChangeToken parameter of an
UpdateSizeConstraintSet request. Submit an UpdateSizeConstraintSet request to specify the
part of the request that you want AWS WAF to inspect (for example, the header or the URI)
and the value that you want AWS WAF to watch for. For more information about how to use
the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `size_constraint_set_id`: The SizeConstraintSetId of the SizeConstraintSet that you want
to update. SizeConstraintSetId is returned by CreateSizeConstraintSet and by
ListSizeConstraintSets.
- `updates`: An array of SizeConstraintSetUpdate objects that you want to insert into or
delete from a SizeConstraintSet. For more information, see the applicable data types:
SizeConstraintSetUpdate: Contains Action and SizeConstraint SizeConstraint: Contains
FieldToMatch, TextTransformation, ComparisonOperator, and Size FieldToMatch: Contains
Data and Type
"""
function update_size_constraint_set(
ChangeToken,
SizeConstraintSetId,
Updates;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"UpdateSizeConstraintSet",
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"SizeConstraintSetId" => SizeConstraintSetId,
"Updates" => Updates,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_size_constraint_set(
ChangeToken,
SizeConstraintSetId,
Updates,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"UpdateSizeConstraintSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"SizeConstraintSetId" => SizeConstraintSetId,
"Updates" => Updates,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_sql_injection_match_set(change_token, sql_injection_match_set_id, updates)
update_sql_injection_match_set(change_token, sql_injection_match_set_id, updates, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Inserts or deletes SqlInjectionMatchTuple objects (filters) in a
SqlInjectionMatchSet. For each SqlInjectionMatchTuple object, you specify the following
values: Action: Whether to insert the object into or delete the object from the array.
To change a SqlInjectionMatchTuple, you delete the existing object and add a new one.
FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want
AWS WAF to inspect a header or custom query parameter, the name of the header or parameter.
TextTransformation: Which text transformation, if any, to perform on the web request
before inspecting the request for snippets of malicious SQL code. You can only specify a
single type of TextTransformation. You use SqlInjectionMatchSet objects to specify which
CloudFront requests that you want to allow, block, or count. For example, if you're
receiving requests that contain snippets of SQL code in the query string and you want to
block the requests, you can create a SqlInjectionMatchSet with the applicable settings, and
then configure AWS WAF to block the requests. To create and configure a
SqlInjectionMatchSet, perform the following steps: Submit a CreateSqlInjectionMatchSet
request. Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of an UpdateIPSet request. Submit an UpdateSqlInjectionMatchSet request to
specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL
code. For more information about how to use the AWS WAF API to allow or block HTTP
requests, see the AWS WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `sql_injection_match_set_id`: The SqlInjectionMatchSetId of the SqlInjectionMatchSet that
you want to update. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by
ListSqlInjectionMatchSets.
- `updates`: An array of SqlInjectionMatchSetUpdate objects that you want to insert into or
delete from a SqlInjectionMatchSet. For more information, see the applicable data types:
SqlInjectionMatchSetUpdate: Contains Action and SqlInjectionMatchTuple
SqlInjectionMatchTuple: Contains FieldToMatch and TextTransformation FieldToMatch:
Contains Data and Type
"""
function update_sql_injection_match_set(
ChangeToken,
SqlInjectionMatchSetId,
Updates;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"UpdateSqlInjectionMatchSet",
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"SqlInjectionMatchSetId" => SqlInjectionMatchSetId,
"Updates" => Updates,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_sql_injection_match_set(
ChangeToken,
SqlInjectionMatchSetId,
Updates,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"UpdateSqlInjectionMatchSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"SqlInjectionMatchSetId" => SqlInjectionMatchSetId,
"Updates" => Updates,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_web_acl(change_token, web_aclid)
update_web_acl(change_token, web_aclid, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Inserts or deletes ActivatedRule objects in a WebACL. Each Rule
identifies web requests that you want to allow, block, or count. When you update a WebACL,
you specify the following values: A default action for the WebACL, either ALLOW or BLOCK.
AWS WAF performs the default action if a request doesn't match the criteria in any of the
Rules in a WebACL. The Rules that you want to add or delete. If you want to replace one
Rule with another, you delete the existing Rule and add the new one. For each Rule,
whether you want AWS WAF to allow requests, block requests, or count requests that match
the conditions in the Rule. The order in which you want AWS WAF to evaluate the Rules in
a WebACL. If you add more than one Rule to a WebACL, AWS WAF evaluates each request against
the Rules in order based on the value of Priority. (The Rule that has the lowest value for
Priority is evaluated first.) When a web request matches all the predicates (such as
ByteMatchSets and IPSets) in a Rule, AWS WAF immediately takes the corresponding action,
allow or block, and doesn't evaluate the request against the remaining Rules in the WebACL,
if any. To create and configure a WebACL, perform the following steps: Create and
update the predicates that you want to include in Rules. For more information, see
CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet,
CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet. Create and update the Rules
that you want to include in the WebACL. For more information, see CreateRule and
UpdateRule. Create a WebACL. See CreateWebACL. Use GetChangeToken to get the change
token that you provide in the ChangeToken parameter of an UpdateWebACL request. Submit an
UpdateWebACL request to specify the Rules that you want to include in the WebACL, to
specify the default action, and to associate the WebACL with a CloudFront distribution.
The ActivatedRule can be a rule group. If you specify a rule group as your ActivatedRule ,
you can exclude specific rules from that rule group. If you already have a rule group
associated with a web ACL and want to submit an UpdateWebACL request to exclude certain
rules from that rule group, you must first remove the rule group from the web ACL, the
re-insert it again, specifying the excluded rules. For details, see
ActivatedRuleExcludedRules . Be aware that if you try to add a RATE_BASED rule to a web
ACL without setting the rule type when first creating the rule, the UpdateWebACL request
will fail because the request tries to add a REGULAR rule (the default rule type) with the
specified ID, which does not exist. For more information about how to use the AWS WAF API
to allow or block HTTP requests, see the AWS WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `web_aclid`: The WebACLId of the WebACL that you want to update. WebACLId is returned by
CreateWebACL and by ListWebACLs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DefaultAction"`: A default action for the web ACL, either ALLOW or BLOCK. AWS WAF
performs the default action if a request doesn't match the criteria in any of the rules in
a web ACL.
- `"Updates"`: An array of updates to make to the WebACL. An array of WebACLUpdate objects
that you want to insert into or delete from a WebACL. For more information, see the
applicable data types: WebACLUpdate: Contains Action and ActivatedRule
ActivatedRule: Contains Action, OverrideAction, Priority, RuleId, and Type.
ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL.
In this case, you do not use ActivatedRule|Action. For all other update requests,
ActivatedRule|Action is used instead of ActivatedRule|OverrideAction. WafAction:
Contains Type
"""
function update_web_acl(
ChangeToken, WebACLId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"UpdateWebACL",
Dict{String,Any}("ChangeToken" => ChangeToken, "WebACLId" => WebACLId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_web_acl(
ChangeToken,
WebACLId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"UpdateWebACL",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ChangeToken" => ChangeToken, "WebACLId" => WebACLId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_xss_match_set(change_token, updates, xss_match_set_id)
update_xss_match_set(change_token, updates, xss_match_set_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Inserts or deletes XssMatchTuple objects (filters) in an
XssMatchSet. For each XssMatchTuple object, you specify the following values: Action:
Whether to insert the object into or delete the object from the array. To change an
XssMatchTuple, you delete the existing object and add a new one. FieldToMatch: The part
of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a
header or custom query parameter, the name of the header or parameter.
TextTransformation: Which text transformation, if any, to perform on the web request before
inspecting the request for cross-site scripting attacks. You can only specify a single type
of TextTransformation. You use XssMatchSet objects to specify which CloudFront requests
that you want to allow, block, or count. For example, if you're receiving requests that
contain cross-site scripting attacks in the request body and you want to block the
requests, you can create an XssMatchSet with the applicable settings, and then configure
AWS WAF to block the requests. To create and configure an XssMatchSet, perform the
following steps: Submit a CreateXssMatchSet request. Use GetChangeToken to get the
change token that you provide in the ChangeToken parameter of an UpdateIPSet request.
Submit an UpdateXssMatchSet request to specify the parts of web requests that you want AWS
WAF to inspect for cross-site scripting attacks. For more information about how to use
the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `updates`: An array of XssMatchSetUpdate objects that you want to insert into or delete
from an XssMatchSet. For more information, see the applicable data types:
XssMatchSetUpdate: Contains Action and XssMatchTuple XssMatchTuple: Contains
FieldToMatch and TextTransformation FieldToMatch: Contains Data and Type
- `xss_match_set_id`: The XssMatchSetId of the XssMatchSet that you want to update.
XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
"""
function update_xss_match_set(
ChangeToken, Updates, XssMatchSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf(
"UpdateXssMatchSet",
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"Updates" => Updates,
"XssMatchSetId" => XssMatchSetId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_xss_match_set(
ChangeToken,
Updates,
XssMatchSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf(
"UpdateXssMatchSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"Updates" => Updates,
"XssMatchSetId" => XssMatchSetId,
),
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 | 180254 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: waf_regional
using AWS.Compat
using AWS.UUIDs
"""
associate_web_acl(resource_arn, web_aclid)
associate_web_acl(resource_arn, web_aclid, params::Dict{String,<:Any})
This is AWS WAF Classic Regional documentation. For more information, see AWS WAF Classic
in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see
the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints
for regional and global use. Associates a web ACL with a resource, either an application
load balancer or Amazon API Gateway stage.
# Arguments
- `resource_arn`: The ARN (Amazon Resource Name) of the resource to be protected, either an
application load balancer or Amazon API Gateway stage. The ARN should be in one of the
following formats: For an Application Load Balancer:
arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-bala
ncer-id For an Amazon API Gateway stage:
arn:aws:apigateway:region::/restapis/api-id/stages/stage-name
- `web_aclid`: A unique identifier (ID) for the web ACL.
"""
function associate_web_acl(
ResourceArn, WebACLId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"AssociateWebACL",
Dict{String,Any}("ResourceArn" => ResourceArn, "WebACLId" => WebACLId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_web_acl(
ResourceArn,
WebACLId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"AssociateWebACL",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "WebACLId" => WebACLId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_byte_match_set(change_token, name)
create_byte_match_set(change_token, name, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Creates a ByteMatchSet. You then use UpdateByteMatchSet to
identify the part of a web request that you want AWS WAF to inspect, such as the values of
the User-Agent header or the query string. For example, you can create a ByteMatchSet that
matches any requests with User-Agent headers that contain the string BadBot. You can then
configure AWS WAF to reject those requests. To create and configure a ByteMatchSet, perform
the following steps: Use GetChangeToken to get the change token that you provide in the
ChangeToken parameter of a CreateByteMatchSet request. Submit a CreateByteMatchSet
request. Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of an UpdateByteMatchSet request. Submit an UpdateByteMatchSet request to
specify the part of the request that you want AWS WAF to inspect (for example, the header
or the URI) and the value that you want AWS WAF to watch for. For more information about
how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `name`: A friendly name or description of the ByteMatchSet. You can't change Name after
you create a ByteMatchSet.
"""
function create_byte_match_set(
ChangeToken, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"CreateByteMatchSet",
Dict{String,Any}("ChangeToken" => ChangeToken, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_byte_match_set(
ChangeToken,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"CreateByteMatchSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ChangeToken" => ChangeToken, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_geo_match_set(change_token, name)
create_geo_match_set(change_token, name, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Creates an GeoMatchSet, which you use to specify which web
requests you want to allow or block based on the country that the requests originate from.
For example, if you're receiving a lot of requests from one or more countries and you want
to block the requests, you can create an GeoMatchSet that contains those countries and then
configure AWS WAF to block the requests. To create and configure a GeoMatchSet, perform
the following steps: Use GetChangeToken to get the change token that you provide in the
ChangeToken parameter of a CreateGeoMatchSet request. Submit a CreateGeoMatchSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter
of an UpdateGeoMatchSet request. Submit an UpdateGeoMatchSetSet request to specify the
countries that you want AWS WAF to watch for. For more information about how to use the
AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `name`: A friendly name or description of the GeoMatchSet. You can't change Name after
you create the GeoMatchSet.
"""
function create_geo_match_set(
ChangeToken, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"CreateGeoMatchSet",
Dict{String,Any}("ChangeToken" => ChangeToken, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_geo_match_set(
ChangeToken,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"CreateGeoMatchSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ChangeToken" => ChangeToken, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_ipset(change_token, name)
create_ipset(change_token, name, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Creates an IPSet, which you use to specify which web requests
that you want to allow or block based on the IP addresses that the requests originate from.
For example, if you're receiving a lot of requests from one or more individual IP addresses
or one or more ranges of IP addresses and you want to block the requests, you can create an
IPSet that contains those IP addresses and then configure AWS WAF to block the requests.
To create and configure an IPSet, perform the following steps: Use GetChangeToken to get
the change token that you provide in the ChangeToken parameter of a CreateIPSet request.
Submit a CreateIPSet request. Use GetChangeToken to get the change token that you provide
in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateIPSet request to
specify the IP addresses that you want AWS WAF to watch for. For more information about
how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `name`: A friendly name or description of the IPSet. You can't change Name after you
create the IPSet.
"""
function create_ipset(ChangeToken, Name; aws_config::AbstractAWSConfig=global_aws_config())
return waf_regional(
"CreateIPSet",
Dict{String,Any}("ChangeToken" => ChangeToken, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_ipset(
ChangeToken,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"CreateIPSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ChangeToken" => ChangeToken, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_rate_based_rule(change_token, metric_name, name, rate_key, rate_limit)
create_rate_based_rule(change_token, metric_name, name, rate_key, rate_limit, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Creates a RateBasedRule. The RateBasedRule contains a RateLimit,
which specifies the maximum number of requests that AWS WAF allows from a specified IP
address in a five-minute period. The RateBasedRule also contains the IPSet objects,
ByteMatchSet objects, and other predicates that identify the requests that you want to
count or block if these requests exceed the RateLimit. If you add more than one predicate
to a RateBasedRule, a request not only must exceed the RateLimit, but it also must match
all the conditions to be counted or blocked. For example, suppose you add the following to
a RateBasedRule: An IPSet that matches the IP address 192.0.2.44/32 A ByteMatchSet
that matches BadBot in the User-Agent header Further, you specify a RateLimit of 1,000.
You then add the RateBasedRule to a WebACL and specify that you want to block requests that
meet the conditions in the rule. For a request to be blocked, it must come from the IP
address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot.
Further, requests that match these two conditions must be received at a rate of more than
1,000 requests every five minutes. If both conditions are met and the rate is exceeded, AWS
WAF blocks the requests. If the rate drops below 1,000 for a five-minute period, AWS WAF no
longer blocks the requests. As a second example, suppose you want to limit requests to a
particular page on your site. To do this, you could add the following to a RateBasedRule:
A ByteMatchSet with FieldToMatch of URI A PositionalConstraint of STARTS_WITH A
TargetString of login Further, you specify a RateLimit of 1,000. By adding this
RateBasedRule to a WebACL, you could limit requests to your login page without affecting
the rest of your site. To create and configure a RateBasedRule, perform the following
steps: Create and update the predicates that you want to include in the rule. For more
information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. Use
GetChangeToken to get the change token that you provide in the ChangeToken parameter of a
CreateRule request. Submit a CreateRateBasedRule request. Use GetChangeToken to get the
change token that you provide in the ChangeToken parameter of an UpdateRule request.
Submit an UpdateRateBasedRule request to specify the predicates that you want to include in
the rule. Create and update a WebACL that contains the RateBasedRule. For more
information, see CreateWebACL. For more information about how to use the AWS WAF API to
allow or block HTTP requests, see the AWS WAF Developer Guide.
# Arguments
- `change_token`: The ChangeToken that you used to submit the CreateRateBasedRule request.
You can also use this value to query the status of the request. For more information, see
GetChangeTokenStatus.
- `metric_name`: A friendly name or description for the metrics for this RateBasedRule. The
name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and
minimum length one. It can't contain whitespace or metric names reserved for AWS WAF,
including \"All\" and \"Default_Action.\" You can't change the name of the metric after you
create the RateBasedRule.
- `name`: A friendly name or description of the RateBasedRule. You can't change the name of
a RateBasedRule after you create it.
- `rate_key`: The field that AWS WAF uses to determine if requests are likely arriving from
a single source and thus subject to rate monitoring. The only valid value for RateKey is
IP. IP indicates that requests that arrive from the same IP address are subject to the
RateLimit that is specified in the RateBasedRule.
- `rate_limit`: The maximum number of requests, which have an identical value in the field
that is specified by RateKey, allowed in a five-minute period. If the number of requests
exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF
triggers the action that is specified for this rule.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`:
"""
function create_rate_based_rule(
ChangeToken,
MetricName,
Name,
RateKey,
RateLimit;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"CreateRateBasedRule",
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"MetricName" => MetricName,
"Name" => Name,
"RateKey" => RateKey,
"RateLimit" => RateLimit,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_rate_based_rule(
ChangeToken,
MetricName,
Name,
RateKey,
RateLimit,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"CreateRateBasedRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"MetricName" => MetricName,
"Name" => Name,
"RateKey" => RateKey,
"RateLimit" => RateLimit,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_regex_match_set(change_token, name)
create_regex_match_set(change_token, name, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Creates a RegexMatchSet. You then use UpdateRegexMatchSet to
identify the part of a web request that you want AWS WAF to inspect, such as the values of
the User-Agent header or the query string. For example, you can create a RegexMatchSet that
contains a RegexMatchTuple that looks for any requests with User-Agent headers that match a
RegexPatternSet with pattern B[a@]dB[o0]t. You can then configure AWS WAF to reject those
requests. To create and configure a RegexMatchSet, perform the following steps: Use
GetChangeToken to get the change token that you provide in the ChangeToken parameter of a
CreateRegexMatchSet request. Submit a CreateRegexMatchSet request. Use GetChangeToken
to get the change token that you provide in the ChangeToken parameter of an
UpdateRegexMatchSet request. Submit an UpdateRegexMatchSet request to specify the part of
the request that you want AWS WAF to inspect (for example, the header or the URI) and the
value, using a RegexPatternSet, that you want AWS WAF to watch for. For more information
about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer
Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `name`: A friendly name or description of the RegexMatchSet. You can't change Name after
you create a RegexMatchSet.
"""
function create_regex_match_set(
ChangeToken, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"CreateRegexMatchSet",
Dict{String,Any}("ChangeToken" => ChangeToken, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_regex_match_set(
ChangeToken,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"CreateRegexMatchSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ChangeToken" => ChangeToken, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_regex_pattern_set(change_token, name)
create_regex_pattern_set(change_token, name, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Creates a RegexPatternSet. You then use UpdateRegexPatternSet to
specify the regular expression (regex) pattern that you want AWS WAF to search for, such as
B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests. To create and
configure a RegexPatternSet, perform the following steps: Use GetChangeToken to get the
change token that you provide in the ChangeToken parameter of a CreateRegexPatternSet
request. Submit a CreateRegexPatternSet request. Use GetChangeToken to get the change
token that you provide in the ChangeToken parameter of an UpdateRegexPatternSet request.
Submit an UpdateRegexPatternSet request to specify the string that you want AWS WAF to
watch for. For more information about how to use the AWS WAF API to allow or block HTTP
requests, see the AWS WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `name`: A friendly name or description of the RegexPatternSet. You can't change Name
after you create a RegexPatternSet.
"""
function create_regex_pattern_set(
ChangeToken, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"CreateRegexPatternSet",
Dict{String,Any}("ChangeToken" => ChangeToken, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_regex_pattern_set(
ChangeToken,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"CreateRegexPatternSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ChangeToken" => ChangeToken, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_rule(change_token, metric_name, name)
create_rule(change_token, metric_name, name, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Creates a Rule, which contains the IPSet objects, ByteMatchSet
objects, and other predicates that identify the requests that you want to block. If you add
more than one predicate to a Rule, a request must match all of the specifications to be
allowed or blocked. For example, suppose that you add the following to a Rule: An IPSet
that matches the IP address 192.0.2.44/32 A ByteMatchSet that matches BadBot in the
User-Agent header You then add the Rule to a WebACL and specify that you want to blocks
requests that satisfy the Rule. For a request to be blocked, it must come from the IP
address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot.
To create and configure a Rule, perform the following steps: Create and update the
predicates that you want to include in the Rule. For more information, see
CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. Use GetChangeToken to
get the change token that you provide in the ChangeToken parameter of a CreateRule request.
Submit a CreateRule request. Use GetChangeToken to get the change token that you
provide in the ChangeToken parameter of an UpdateRule request. Submit an UpdateRule
request to specify the predicates that you want to include in the Rule. Create and update
a WebACL that contains the Rule. For more information, see CreateWebACL. For more
information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS
WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `metric_name`: A friendly name or description for the metrics for this Rule. The name can
contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum
length one. It can't contain whitespace or metric names reserved for AWS WAF, including
\"All\" and \"Default_Action.\" You can't change the name of the metric after you create
the Rule.
- `name`: A friendly name or description of the Rule. You can't change the name of a Rule
after you create it.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`:
"""
function create_rule(
ChangeToken, MetricName, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"CreateRule",
Dict{String,Any}(
"ChangeToken" => ChangeToken, "MetricName" => MetricName, "Name" => Name
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_rule(
ChangeToken,
MetricName,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"CreateRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken, "MetricName" => MetricName, "Name" => Name
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_rule_group(change_token, metric_name, name)
create_rule_group(change_token, metric_name, name, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Creates a RuleGroup. A rule group is a collection of predefined
rules that you add to a web ACL. You use UpdateRuleGroup to add rules to the rule group.
Rule groups are subject to the following limits: Three rule groups per account. You can
request an increase to this limit by contacting customer support. One rule group per web
ACL. Ten rules per rule group. For more information about how to use the AWS WAF API to
allow or block HTTP requests, see the AWS WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `metric_name`: A friendly name or description for the metrics for this RuleGroup. The
name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and
minimum length one. It can't contain whitespace or metric names reserved for AWS WAF,
including \"All\" and \"Default_Action.\" You can't change the name of the metric after you
create the RuleGroup.
- `name`: A friendly name or description of the RuleGroup. You can't change Name after you
create a RuleGroup.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`:
"""
function create_rule_group(
ChangeToken, MetricName, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"CreateRuleGroup",
Dict{String,Any}(
"ChangeToken" => ChangeToken, "MetricName" => MetricName, "Name" => Name
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_rule_group(
ChangeToken,
MetricName,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"CreateRuleGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken, "MetricName" => MetricName, "Name" => Name
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_size_constraint_set(change_token, name)
create_size_constraint_set(change_token, name, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Creates a SizeConstraintSet. You then use
UpdateSizeConstraintSet to identify the part of a web request that you want AWS WAF to
check for length, such as the length of the User-Agent header or the length of the query
string. For example, you can create a SizeConstraintSet that matches any requests that have
a query string that is longer than 100 bytes. You can then configure AWS WAF to reject
those requests. To create and configure a SizeConstraintSet, perform the following steps:
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of
a CreateSizeConstraintSet request. Submit a CreateSizeConstraintSet request. Use
GetChangeToken to get the change token that you provide in the ChangeToken parameter of an
UpdateSizeConstraintSet request. Submit an UpdateSizeConstraintSet request to specify the
part of the request that you want AWS WAF to inspect (for example, the header or the URI)
and the value that you want AWS WAF to watch for. For more information about how to use
the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `name`: A friendly name or description of the SizeConstraintSet. You can't change Name
after you create a SizeConstraintSet.
"""
function create_size_constraint_set(
ChangeToken, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"CreateSizeConstraintSet",
Dict{String,Any}("ChangeToken" => ChangeToken, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_size_constraint_set(
ChangeToken,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"CreateSizeConstraintSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ChangeToken" => ChangeToken, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_sql_injection_match_set(change_token, name)
create_sql_injection_match_set(change_token, name, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Creates a SqlInjectionMatchSet, which you use to allow, block,
or count requests that contain snippets of SQL code in a specified part of web requests.
AWS WAF searches for character sequences that are likely to be malicious strings. To create
and configure a SqlInjectionMatchSet, perform the following steps: Use GetChangeToken to
get the change token that you provide in the ChangeToken parameter of a
CreateSqlInjectionMatchSet request. Submit a CreateSqlInjectionMatchSet request. Use
GetChangeToken to get the change token that you provide in the ChangeToken parameter of an
UpdateSqlInjectionMatchSet request. Submit an UpdateSqlInjectionMatchSet request to
specify the parts of web requests in which you want to allow, block, or count malicious SQL
code. For more information about how to use the AWS WAF API to allow or block HTTP
requests, see the AWS WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `name`: A friendly name or description for the SqlInjectionMatchSet that you're creating.
You can't change Name after you create the SqlInjectionMatchSet.
"""
function create_sql_injection_match_set(
ChangeToken, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"CreateSqlInjectionMatchSet",
Dict{String,Any}("ChangeToken" => ChangeToken, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_sql_injection_match_set(
ChangeToken,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"CreateSqlInjectionMatchSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ChangeToken" => ChangeToken, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_web_acl(change_token, default_action, metric_name, name)
create_web_acl(change_token, default_action, metric_name, name, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Creates a WebACL, which contains the Rules that identify the
CloudFront web requests that you want to allow, block, or count. AWS WAF evaluates Rules in
order based on the value of Priority for each Rule. You also specify a default action,
either ALLOW or BLOCK. If a web request doesn't match any of the Rules in a WebACL, AWS WAF
responds to the request with the default action. To create and configure a WebACL, perform
the following steps: Create and update the ByteMatchSet objects and other predicates that
you want to include in Rules. For more information, see CreateByteMatchSet,
UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and
UpdateSqlInjectionMatchSet. Create and update the Rules that you want to include in the
WebACL. For more information, see CreateRule and UpdateRule. Use GetChangeToken to get
the change token that you provide in the ChangeToken parameter of a CreateWebACL request.
Submit a CreateWebACL request. Use GetChangeToken to get the change token that you
provide in the ChangeToken parameter of an UpdateWebACL request. Submit an UpdateWebACL
request to specify the Rules that you want to include in the WebACL, to specify the default
action, and to associate the WebACL with a CloudFront distribution. For more information
about how to use the AWS WAF API, see the AWS WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `default_action`: The action that you want AWS WAF to take when a request doesn't match
the criteria specified in any of the Rule objects that are associated with the WebACL.
- `metric_name`: A friendly name or description for the metrics for this WebACL.The name
can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and
minimum length one. It can't contain whitespace or metric names reserved for AWS WAF,
including \"All\" and \"Default_Action.\" You can't change MetricName after you create the
WebACL.
- `name`: A friendly name or description of the WebACL. You can't change Name after you
create the WebACL.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`:
"""
function create_web_acl(
ChangeToken,
DefaultAction,
MetricName,
Name;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"CreateWebACL",
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"DefaultAction" => DefaultAction,
"MetricName" => MetricName,
"Name" => Name,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_web_acl(
ChangeToken,
DefaultAction,
MetricName,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"CreateWebACL",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"DefaultAction" => DefaultAction,
"MetricName" => MetricName,
"Name" => Name,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_web_aclmigration_stack(ignore_unsupported_type, s3_bucket_name, web_aclid)
create_web_aclmigration_stack(ignore_unsupported_type, s3_bucket_name, web_aclid, params::Dict{String,<:Any})
Creates an AWS CloudFormation WAFV2 template for the specified web ACL in the specified
Amazon S3 bucket. Then, in CloudFormation, you create a stack from the template, to create
the web ACL and its resources in AWS WAFV2. Use this to migrate your AWS WAF Classic web
ACL to the latest version of AWS WAF. This is part of a larger migration procedure for web
ACLs from AWS WAF Classic to the latest version of AWS WAF. For the full procedure,
including caveats and manual steps to complete the migration and switch over to the new web
ACL, see Migrating your AWS WAF Classic resources to AWS WAF in the AWS WAF Developer
Guide.
# Arguments
- `ignore_unsupported_type`: Indicates whether to exclude entities that can't be migrated
or to stop the migration. Set this to true to ignore unsupported entities in the web ACL
during the migration. Otherwise, if AWS WAF encounters unsupported entities, it stops the
process and throws an exception.
- `s3_bucket_name`: The name of the Amazon S3 bucket to store the CloudFormation template
in. The S3 bucket must be configured as follows for the migration: The bucket name must
start with aws-waf-migration-. For example, aws-waf-migration-my-web-acl. The bucket must
be in the Region where you are deploying the template. For example, for a web ACL in
us-west-2, you must use an Amazon S3 bucket in us-west-2 and you must deploy the template
stack to us-west-2. The bucket policies must permit the migration process to write data.
For listings of the bucket policies, see the Examples section.
- `web_aclid`: The UUID of the WAF Classic web ACL that you want to migrate to WAF v2.
"""
function create_web_aclmigration_stack(
IgnoreUnsupportedType,
S3BucketName,
WebACLId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"CreateWebACLMigrationStack",
Dict{String,Any}(
"IgnoreUnsupportedType" => IgnoreUnsupportedType,
"S3BucketName" => S3BucketName,
"WebACLId" => WebACLId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_web_aclmigration_stack(
IgnoreUnsupportedType,
S3BucketName,
WebACLId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"CreateWebACLMigrationStack",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IgnoreUnsupportedType" => IgnoreUnsupportedType,
"S3BucketName" => S3BucketName,
"WebACLId" => WebACLId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_xss_match_set(change_token, name)
create_xss_match_set(change_token, name, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Creates an XssMatchSet, which you use to allow, block, or count
requests that contain cross-site scripting attacks in the specified part of web requests.
AWS WAF searches for character sequences that are likely to be malicious strings. To create
and configure an XssMatchSet, perform the following steps: Use GetChangeToken to get the
change token that you provide in the ChangeToken parameter of a CreateXssMatchSet request.
Submit a CreateXssMatchSet request. Use GetChangeToken to get the change token that you
provide in the ChangeToken parameter of an UpdateXssMatchSet request. Submit an
UpdateXssMatchSet request to specify the parts of web requests in which you want to allow,
block, or count cross-site scripting attacks. For more information about how to use the
AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `name`: A friendly name or description for the XssMatchSet that you're creating. You
can't change Name after you create the XssMatchSet.
"""
function create_xss_match_set(
ChangeToken, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"CreateXssMatchSet",
Dict{String,Any}("ChangeToken" => ChangeToken, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_xss_match_set(
ChangeToken,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"CreateXssMatchSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ChangeToken" => ChangeToken, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_byte_match_set(byte_match_set_id, change_token)
delete_byte_match_set(byte_match_set_id, change_token, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Permanently deletes a ByteMatchSet. You can't delete a
ByteMatchSet if it's still used in any Rules or if it still includes any ByteMatchTuple
objects (any filters). If you just want to remove a ByteMatchSet from a Rule, use
UpdateRule. To permanently delete a ByteMatchSet, perform the following steps: Update the
ByteMatchSet to remove filters, if any. For more information, see UpdateByteMatchSet. Use
GetChangeToken to get the change token that you provide in the ChangeToken parameter of a
DeleteByteMatchSet request. Submit a DeleteByteMatchSet request.
# Arguments
- `byte_match_set_id`: The ByteMatchSetId of the ByteMatchSet that you want to delete.
ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
- `change_token`: The value returned by the most recent call to GetChangeToken.
"""
function delete_byte_match_set(
ByteMatchSetId, ChangeToken; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"DeleteByteMatchSet",
Dict{String,Any}("ByteMatchSetId" => ByteMatchSetId, "ChangeToken" => ChangeToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_byte_match_set(
ByteMatchSetId,
ChangeToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"DeleteByteMatchSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ByteMatchSetId" => ByteMatchSetId, "ChangeToken" => ChangeToken
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_geo_match_set(change_token, geo_match_set_id)
delete_geo_match_set(change_token, geo_match_set_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Permanently deletes a GeoMatchSet. You can't delete a
GeoMatchSet if it's still used in any Rules or if it still includes any countries. If you
just want to remove a GeoMatchSet from a Rule, use UpdateRule. To permanently delete a
GeoMatchSet from AWS WAF, perform the following steps: Update the GeoMatchSet to remove
any countries. For more information, see UpdateGeoMatchSet. Use GetChangeToken to get the
change token that you provide in the ChangeToken parameter of a DeleteGeoMatchSet request.
Submit a DeleteGeoMatchSet request.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `geo_match_set_id`: The GeoMatchSetID of the GeoMatchSet that you want to delete.
GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.
"""
function delete_geo_match_set(
ChangeToken, GeoMatchSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"DeleteGeoMatchSet",
Dict{String,Any}("ChangeToken" => ChangeToken, "GeoMatchSetId" => GeoMatchSetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_geo_match_set(
ChangeToken,
GeoMatchSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"DeleteGeoMatchSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken, "GeoMatchSetId" => GeoMatchSetId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_ipset(change_token, ipset_id)
delete_ipset(change_token, ipset_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Permanently deletes an IPSet. You can't delete an IPSet if it's
still used in any Rules or if it still includes any IP addresses. If you just want to
remove an IPSet from a Rule, use UpdateRule. To permanently delete an IPSet from AWS WAF,
perform the following steps: Update the IPSet to remove IP address ranges, if any. For
more information, see UpdateIPSet. Use GetChangeToken to get the change token that you
provide in the ChangeToken parameter of a DeleteIPSet request. Submit a DeleteIPSet
request.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `ipset_id`: The IPSetId of the IPSet that you want to delete. IPSetId is returned by
CreateIPSet and by ListIPSets.
"""
function delete_ipset(
ChangeToken, IPSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"DeleteIPSet",
Dict{String,Any}("ChangeToken" => ChangeToken, "IPSetId" => IPSetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_ipset(
ChangeToken,
IPSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"DeleteIPSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ChangeToken" => ChangeToken, "IPSetId" => IPSetId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_logging_configuration(resource_arn)
delete_logging_configuration(resource_arn, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Permanently deletes the LoggingConfiguration from the specified
web ACL.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the web ACL from which you want to
delete the LoggingConfiguration.
"""
function delete_logging_configuration(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"DeleteLoggingConfiguration",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_logging_configuration(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"DeleteLoggingConfiguration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_permission_policy(resource_arn)
delete_permission_policy(resource_arn, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Permanently deletes an IAM policy from the specified RuleGroup.
The user making the request must be the owner of the RuleGroup.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the RuleGroup from which you want to
delete the policy. The user making the request must be the owner of the RuleGroup.
"""
function delete_permission_policy(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"DeletePermissionPolicy",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_permission_policy(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"DeletePermissionPolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_rate_based_rule(change_token, rule_id)
delete_rate_based_rule(change_token, rule_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Permanently deletes a RateBasedRule. You can't delete a rule if
it's still used in any WebACL objects or if it still includes any predicates, such as
ByteMatchSet objects. If you just want to remove a rule from a WebACL, use UpdateWebACL. To
permanently delete a RateBasedRule from AWS WAF, perform the following steps: Update the
RateBasedRule to remove predicates, if any. For more information, see UpdateRateBasedRule.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter
of a DeleteRateBasedRule request. Submit a DeleteRateBasedRule request.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `rule_id`: The RuleId of the RateBasedRule that you want to delete. RuleId is returned by
CreateRateBasedRule and by ListRateBasedRules.
"""
function delete_rate_based_rule(
ChangeToken, RuleId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"DeleteRateBasedRule",
Dict{String,Any}("ChangeToken" => ChangeToken, "RuleId" => RuleId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_rate_based_rule(
ChangeToken,
RuleId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"DeleteRateBasedRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ChangeToken" => ChangeToken, "RuleId" => RuleId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_regex_match_set(change_token, regex_match_set_id)
delete_regex_match_set(change_token, regex_match_set_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Permanently deletes a RegexMatchSet. You can't delete a
RegexMatchSet if it's still used in any Rules or if it still includes any RegexMatchTuples
objects (any filters). If you just want to remove a RegexMatchSet from a Rule, use
UpdateRule. To permanently delete a RegexMatchSet, perform the following steps: Update
the RegexMatchSet to remove filters, if any. For more information, see UpdateRegexMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter
of a DeleteRegexMatchSet request. Submit a DeleteRegexMatchSet request.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `regex_match_set_id`: The RegexMatchSetId of the RegexMatchSet that you want to delete.
RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.
"""
function delete_regex_match_set(
ChangeToken, RegexMatchSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"DeleteRegexMatchSet",
Dict{String,Any}(
"ChangeToken" => ChangeToken, "RegexMatchSetId" => RegexMatchSetId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_regex_match_set(
ChangeToken,
RegexMatchSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"DeleteRegexMatchSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken, "RegexMatchSetId" => RegexMatchSetId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_regex_pattern_set(change_token, regex_pattern_set_id)
delete_regex_pattern_set(change_token, regex_pattern_set_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Permanently deletes a RegexPatternSet. You can't delete a
RegexPatternSet if it's still used in any RegexMatchSet or if the RegexPatternSet is not
empty.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `regex_pattern_set_id`: The RegexPatternSetId of the RegexPatternSet that you want to
delete. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
"""
function delete_regex_pattern_set(
ChangeToken, RegexPatternSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"DeleteRegexPatternSet",
Dict{String,Any}(
"ChangeToken" => ChangeToken, "RegexPatternSetId" => RegexPatternSetId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_regex_pattern_set(
ChangeToken,
RegexPatternSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"DeleteRegexPatternSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken, "RegexPatternSetId" => RegexPatternSetId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_rule(change_token, rule_id)
delete_rule(change_token, rule_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Permanently deletes a Rule. You can't delete a Rule if it's
still used in any WebACL objects or if it still includes any predicates, such as
ByteMatchSet objects. If you just want to remove a Rule from a WebACL, use UpdateWebACL. To
permanently delete a Rule from AWS WAF, perform the following steps: Update the Rule to
remove predicates, if any. For more information, see UpdateRule. Use GetChangeToken to
get the change token that you provide in the ChangeToken parameter of a DeleteRule request.
Submit a DeleteRule request.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `rule_id`: The RuleId of the Rule that you want to delete. RuleId is returned by
CreateRule and by ListRules.
"""
function delete_rule(ChangeToken, RuleId; aws_config::AbstractAWSConfig=global_aws_config())
return waf_regional(
"DeleteRule",
Dict{String,Any}("ChangeToken" => ChangeToken, "RuleId" => RuleId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_rule(
ChangeToken,
RuleId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"DeleteRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ChangeToken" => ChangeToken, "RuleId" => RuleId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_rule_group(change_token, rule_group_id)
delete_rule_group(change_token, rule_group_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Permanently deletes a RuleGroup. You can't delete a RuleGroup if
it's still used in any WebACL objects or if it still includes any rules. If you just want
to remove a RuleGroup from a WebACL, use UpdateWebACL. To permanently delete a RuleGroup
from AWS WAF, perform the following steps: Update the RuleGroup to remove rules, if any.
For more information, see UpdateRuleGroup. Use GetChangeToken to get the change token
that you provide in the ChangeToken parameter of a DeleteRuleGroup request. Submit a
DeleteRuleGroup request.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `rule_group_id`: The RuleGroupId of the RuleGroup that you want to delete. RuleGroupId is
returned by CreateRuleGroup and by ListRuleGroups.
"""
function delete_rule_group(
ChangeToken, RuleGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"DeleteRuleGroup",
Dict{String,Any}("ChangeToken" => ChangeToken, "RuleGroupId" => RuleGroupId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_rule_group(
ChangeToken,
RuleGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"DeleteRuleGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken, "RuleGroupId" => RuleGroupId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_size_constraint_set(change_token, size_constraint_set_id)
delete_size_constraint_set(change_token, size_constraint_set_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Permanently deletes a SizeConstraintSet. You can't delete a
SizeConstraintSet if it's still used in any Rules or if it still includes any
SizeConstraint objects (any filters). If you just want to remove a SizeConstraintSet from a
Rule, use UpdateRule. To permanently delete a SizeConstraintSet, perform the following
steps: Update the SizeConstraintSet to remove filters, if any. For more information, see
UpdateSizeConstraintSet. Use GetChangeToken to get the change token that you provide in
the ChangeToken parameter of a DeleteSizeConstraintSet request. Submit a
DeleteSizeConstraintSet request.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `size_constraint_set_id`: The SizeConstraintSetId of the SizeConstraintSet that you want
to delete. SizeConstraintSetId is returned by CreateSizeConstraintSet and by
ListSizeConstraintSets.
"""
function delete_size_constraint_set(
ChangeToken, SizeConstraintSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"DeleteSizeConstraintSet",
Dict{String,Any}(
"ChangeToken" => ChangeToken, "SizeConstraintSetId" => SizeConstraintSetId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_size_constraint_set(
ChangeToken,
SizeConstraintSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"DeleteSizeConstraintSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"SizeConstraintSetId" => SizeConstraintSetId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_sql_injection_match_set(change_token, sql_injection_match_set_id)
delete_sql_injection_match_set(change_token, sql_injection_match_set_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Permanently deletes a SqlInjectionMatchSet. You can't delete a
SqlInjectionMatchSet if it's still used in any Rules or if it still contains any
SqlInjectionMatchTuple objects. If you just want to remove a SqlInjectionMatchSet from a
Rule, use UpdateRule. To permanently delete a SqlInjectionMatchSet from AWS WAF, perform
the following steps: Update the SqlInjectionMatchSet to remove filters, if any. For more
information, see UpdateSqlInjectionMatchSet. Use GetChangeToken to get the change token
that you provide in the ChangeToken parameter of a DeleteSqlInjectionMatchSet request.
Submit a DeleteSqlInjectionMatchSet request.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `sql_injection_match_set_id`: The SqlInjectionMatchSetId of the SqlInjectionMatchSet that
you want to delete. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by
ListSqlInjectionMatchSets.
"""
function delete_sql_injection_match_set(
ChangeToken, SqlInjectionMatchSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"DeleteSqlInjectionMatchSet",
Dict{String,Any}(
"ChangeToken" => ChangeToken, "SqlInjectionMatchSetId" => SqlInjectionMatchSetId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_sql_injection_match_set(
ChangeToken,
SqlInjectionMatchSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"DeleteSqlInjectionMatchSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"SqlInjectionMatchSetId" => SqlInjectionMatchSetId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_web_acl(change_token, web_aclid)
delete_web_acl(change_token, web_aclid, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Permanently deletes a WebACL. You can't delete a WebACL if it
still contains any Rules. To delete a WebACL, perform the following steps: Update the
WebACL to remove Rules, if any. For more information, see UpdateWebACL. Use
GetChangeToken to get the change token that you provide in the ChangeToken parameter of a
DeleteWebACL request. Submit a DeleteWebACL request.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `web_aclid`: The WebACLId of the WebACL that you want to delete. WebACLId is returned by
CreateWebACL and by ListWebACLs.
"""
function delete_web_acl(
ChangeToken, WebACLId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"DeleteWebACL",
Dict{String,Any}("ChangeToken" => ChangeToken, "WebACLId" => WebACLId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_web_acl(
ChangeToken,
WebACLId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"DeleteWebACL",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ChangeToken" => ChangeToken, "WebACLId" => WebACLId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_xss_match_set(change_token, xss_match_set_id)
delete_xss_match_set(change_token, xss_match_set_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Permanently deletes an XssMatchSet. You can't delete an
XssMatchSet if it's still used in any Rules or if it still contains any XssMatchTuple
objects. If you just want to remove an XssMatchSet from a Rule, use UpdateRule. To
permanently delete an XssMatchSet from AWS WAF, perform the following steps: Update the
XssMatchSet to remove filters, if any. For more information, see UpdateXssMatchSet. Use
GetChangeToken to get the change token that you provide in the ChangeToken parameter of a
DeleteXssMatchSet request. Submit a DeleteXssMatchSet request.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `xss_match_set_id`: The XssMatchSetId of the XssMatchSet that you want to delete.
XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
"""
function delete_xss_match_set(
ChangeToken, XssMatchSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"DeleteXssMatchSet",
Dict{String,Any}("ChangeToken" => ChangeToken, "XssMatchSetId" => XssMatchSetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_xss_match_set(
ChangeToken,
XssMatchSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"DeleteXssMatchSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken, "XssMatchSetId" => XssMatchSetId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_web_acl(resource_arn)
disassociate_web_acl(resource_arn, params::Dict{String,<:Any})
This is AWS WAF Classic Regional documentation. For more information, see AWS WAF Classic
in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see
the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints
for regional and global use. Removes a web ACL from the specified resource, either an
application load balancer or Amazon API Gateway stage.
# Arguments
- `resource_arn`: The ARN (Amazon Resource Name) of the resource from which the web ACL is
being removed, either an application load balancer or Amazon API Gateway stage. The ARN
should be in one of the following formats: For an Application Load Balancer:
arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-bala
ncer-id For an Amazon API Gateway stage:
arn:aws:apigateway:region::/restapis/api-id/stages/stage-name
"""
function disassociate_web_acl(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"DisassociateWebACL",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_web_acl(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"DisassociateWebACL",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_byte_match_set(byte_match_set_id)
get_byte_match_set(byte_match_set_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns the ByteMatchSet specified by ByteMatchSetId.
# Arguments
- `byte_match_set_id`: The ByteMatchSetId of the ByteMatchSet that you want to get.
ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
"""
function get_byte_match_set(
ByteMatchSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"GetByteMatchSet",
Dict{String,Any}("ByteMatchSetId" => ByteMatchSetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_byte_match_set(
ByteMatchSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"GetByteMatchSet",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ByteMatchSetId" => ByteMatchSetId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_change_token()
get_change_token(params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. When you want to create, update, or delete AWS WAF objects, get
a change token and include the change token in the create, update, or delete request.
Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF.
Each create, update, or delete request must use a unique change token. If your application
submits a GetChangeToken request and then submits a second GetChangeToken request before
submitting a create, update, or delete request, the second GetChangeToken request returns
the same value as the first GetChangeToken request. When you use a change token in a
create, update, or delete request, the status of the change token changes to PENDING, which
indicates that AWS WAF is propagating the change to all AWS WAF servers. Use
GetChangeTokenStatus to determine the status of your change token.
"""
function get_change_token(; aws_config::AbstractAWSConfig=global_aws_config())
return waf_regional(
"GetChangeToken"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_change_token(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"GetChangeToken", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_change_token_status(change_token)
get_change_token_status(change_token, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns the status of a ChangeToken that you got by calling
GetChangeToken. ChangeTokenStatus is one of the following values: PROVISIONED: You
requested the change token by calling GetChangeToken, but you haven't used it yet in a call
to create, update, or delete an AWS WAF object. PENDING: AWS WAF is propagating the
create, update, or delete request to all AWS WAF servers. INSYNC: Propagation is
complete.
# Arguments
- `change_token`: The change token for which you want to get the status. This change token
was previously returned in the GetChangeToken response.
"""
function get_change_token_status(
ChangeToken; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"GetChangeTokenStatus",
Dict{String,Any}("ChangeToken" => ChangeToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_change_token_status(
ChangeToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"GetChangeTokenStatus",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ChangeToken" => ChangeToken), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_geo_match_set(geo_match_set_id)
get_geo_match_set(geo_match_set_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns the GeoMatchSet that is specified by GeoMatchSetId.
# Arguments
- `geo_match_set_id`: The GeoMatchSetId of the GeoMatchSet that you want to get.
GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.
"""
function get_geo_match_set(GeoMatchSetId; aws_config::AbstractAWSConfig=global_aws_config())
return waf_regional(
"GetGeoMatchSet",
Dict{String,Any}("GeoMatchSetId" => GeoMatchSetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_geo_match_set(
GeoMatchSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"GetGeoMatchSet",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GeoMatchSetId" => GeoMatchSetId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_ipset(ipset_id)
get_ipset(ipset_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns the IPSet that is specified by IPSetId.
# Arguments
- `ipset_id`: The IPSetId of the IPSet that you want to get. IPSetId is returned by
CreateIPSet and by ListIPSets.
"""
function get_ipset(IPSetId; aws_config::AbstractAWSConfig=global_aws_config())
return waf_regional(
"GetIPSet",
Dict{String,Any}("IPSetId" => IPSetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_ipset(
IPSetId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"GetIPSet",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("IPSetId" => IPSetId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_logging_configuration(resource_arn)
get_logging_configuration(resource_arn, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns the LoggingConfiguration for the specified web ACL.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the web ACL for which you want to get
the LoggingConfiguration.
"""
function get_logging_configuration(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"GetLoggingConfiguration",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_logging_configuration(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"GetLoggingConfiguration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_permission_policy(resource_arn)
get_permission_policy(resource_arn, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns the IAM policy attached to the RuleGroup.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the RuleGroup for which you want to get
the policy.
"""
function get_permission_policy(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"GetPermissionPolicy",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_permission_policy(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"GetPermissionPolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_rate_based_rule(rule_id)
get_rate_based_rule(rule_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns the RateBasedRule that is specified by the RuleId that
you included in the GetRateBasedRule request.
# Arguments
- `rule_id`: The RuleId of the RateBasedRule that you want to get. RuleId is returned by
CreateRateBasedRule and by ListRateBasedRules.
"""
function get_rate_based_rule(RuleId; aws_config::AbstractAWSConfig=global_aws_config())
return waf_regional(
"GetRateBasedRule",
Dict{String,Any}("RuleId" => RuleId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_rate_based_rule(
RuleId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"GetRateBasedRule",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("RuleId" => RuleId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_rate_based_rule_managed_keys(rule_id)
get_rate_based_rule_managed_keys(rule_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns an array of IP addresses currently being blocked by the
RateBasedRule that is specified by the RuleId. The maximum number of managed keys that will
be blocked is 10,000. If more than 10,000 addresses exceed the rate limit, the 10,000
addresses with the highest rates will be blocked.
# Arguments
- `rule_id`: The RuleId of the RateBasedRule for which you want to get a list of
ManagedKeys. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextMarker"`: A null value and not currently used. Do not include this in your request.
"""
function get_rate_based_rule_managed_keys(
RuleId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"GetRateBasedRuleManagedKeys",
Dict{String,Any}("RuleId" => RuleId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_rate_based_rule_managed_keys(
RuleId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"GetRateBasedRuleManagedKeys",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("RuleId" => RuleId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_regex_match_set(regex_match_set_id)
get_regex_match_set(regex_match_set_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns the RegexMatchSet specified by RegexMatchSetId.
# Arguments
- `regex_match_set_id`: The RegexMatchSetId of the RegexMatchSet that you want to get.
RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.
"""
function get_regex_match_set(
RegexMatchSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"GetRegexMatchSet",
Dict{String,Any}("RegexMatchSetId" => RegexMatchSetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_regex_match_set(
RegexMatchSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"GetRegexMatchSet",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("RegexMatchSetId" => RegexMatchSetId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_regex_pattern_set(regex_pattern_set_id)
get_regex_pattern_set(regex_pattern_set_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns the RegexPatternSet specified by RegexPatternSetId.
# Arguments
- `regex_pattern_set_id`: The RegexPatternSetId of the RegexPatternSet that you want to
get. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
"""
function get_regex_pattern_set(
RegexPatternSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"GetRegexPatternSet",
Dict{String,Any}("RegexPatternSetId" => RegexPatternSetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_regex_pattern_set(
RegexPatternSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"GetRegexPatternSet",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("RegexPatternSetId" => RegexPatternSetId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_rule(rule_id)
get_rule(rule_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns the Rule that is specified by the RuleId that you
included in the GetRule request.
# Arguments
- `rule_id`: The RuleId of the Rule that you want to get. RuleId is returned by CreateRule
and by ListRules.
"""
function get_rule(RuleId; aws_config::AbstractAWSConfig=global_aws_config())
return waf_regional(
"GetRule",
Dict{String,Any}("RuleId" => RuleId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_rule(
RuleId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"GetRule",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("RuleId" => RuleId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_rule_group(rule_group_id)
get_rule_group(rule_group_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns the RuleGroup that is specified by the RuleGroupId that
you included in the GetRuleGroup request. To view the rules in a rule group, use
ListActivatedRulesInRuleGroup.
# Arguments
- `rule_group_id`: The RuleGroupId of the RuleGroup that you want to get. RuleGroupId is
returned by CreateRuleGroup and by ListRuleGroups.
"""
function get_rule_group(RuleGroupId; aws_config::AbstractAWSConfig=global_aws_config())
return waf_regional(
"GetRuleGroup",
Dict{String,Any}("RuleGroupId" => RuleGroupId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_rule_group(
RuleGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"GetRuleGroup",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RuleGroupId" => RuleGroupId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_sampled_requests(max_items, rule_id, time_window, web_acl_id)
get_sampled_requests(max_items, rule_id, time_window, web_acl_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Gets detailed information about a specified number of
requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that
your AWS resource received during a time range that you choose. You can specify a sample
size of up to 500 requests, and you can specify any time range in the previous three hours.
GetSampledRequests returns a time range, which is usually the time range that you
specified. However, if your resource (such as a CloudFront distribution) received 5,000
requests before the specified time range elapsed, GetSampledRequests returns an updated
time range. This new time range indicates the actual period during which AWS WAF selected
the requests in the sample.
# Arguments
- `max_items`: The number of requests that you want AWS WAF to return from among the first
5,000 requests that your AWS resource received during the time range. If your resource
received fewer requests than the value of MaxItems, GetSampledRequests returns information
about all of them.
- `rule_id`: RuleId is one of three values: The RuleId of the Rule or the RuleGroupId of
the RuleGroup for which you want GetSampledRequests to return a sample of requests.
Default_Action, which causes GetSampledRequests to return a sample of the requests that
didn't match any of the rules in the specified WebACL.
- `time_window`: The start date and time and the end date and time of the range for which
you want GetSampledRequests to return a sample of requests. You must specify the times in
Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For
example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.
- `web_acl_id`: The WebACLId of the WebACL for which you want GetSampledRequests to return
a sample of requests.
"""
function get_sampled_requests(
MaxItems,
RuleId,
TimeWindow,
WebAclId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"GetSampledRequests",
Dict{String,Any}(
"MaxItems" => MaxItems,
"RuleId" => RuleId,
"TimeWindow" => TimeWindow,
"WebAclId" => WebAclId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_sampled_requests(
MaxItems,
RuleId,
TimeWindow,
WebAclId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"GetSampledRequests",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MaxItems" => MaxItems,
"RuleId" => RuleId,
"TimeWindow" => TimeWindow,
"WebAclId" => WebAclId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_size_constraint_set(size_constraint_set_id)
get_size_constraint_set(size_constraint_set_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns the SizeConstraintSet specified by SizeConstraintSetId.
# Arguments
- `size_constraint_set_id`: The SizeConstraintSetId of the SizeConstraintSet that you want
to get. SizeConstraintSetId is returned by CreateSizeConstraintSet and by
ListSizeConstraintSets.
"""
function get_size_constraint_set(
SizeConstraintSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"GetSizeConstraintSet",
Dict{String,Any}("SizeConstraintSetId" => SizeConstraintSetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_size_constraint_set(
SizeConstraintSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"GetSizeConstraintSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("SizeConstraintSetId" => SizeConstraintSetId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_sql_injection_match_set(sql_injection_match_set_id)
get_sql_injection_match_set(sql_injection_match_set_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns the SqlInjectionMatchSet that is specified by
SqlInjectionMatchSetId.
# Arguments
- `sql_injection_match_set_id`: The SqlInjectionMatchSetId of the SqlInjectionMatchSet that
you want to get. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by
ListSqlInjectionMatchSets.
"""
function get_sql_injection_match_set(
SqlInjectionMatchSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"GetSqlInjectionMatchSet",
Dict{String,Any}("SqlInjectionMatchSetId" => SqlInjectionMatchSetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_sql_injection_match_set(
SqlInjectionMatchSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"GetSqlInjectionMatchSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("SqlInjectionMatchSetId" => SqlInjectionMatchSetId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_web_acl(web_aclid)
get_web_acl(web_aclid, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns the WebACL that is specified by WebACLId.
# Arguments
- `web_aclid`: The WebACLId of the WebACL that you want to get. WebACLId is returned by
CreateWebACL and by ListWebACLs.
"""
function get_web_acl(WebACLId; aws_config::AbstractAWSConfig=global_aws_config())
return waf_regional(
"GetWebACL",
Dict{String,Any}("WebACLId" => WebACLId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_web_acl(
WebACLId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"GetWebACL",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("WebACLId" => WebACLId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_web_aclfor_resource(resource_arn)
get_web_aclfor_resource(resource_arn, params::Dict{String,<:Any})
This is AWS WAF Classic Regional documentation. For more information, see AWS WAF Classic
in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see
the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints
for regional and global use. Returns the web ACL for the specified resource, either an
application load balancer or Amazon API Gateway stage.
# Arguments
- `resource_arn`: The ARN (Amazon Resource Name) of the resource for which to get the web
ACL, either an application load balancer or Amazon API Gateway stage. The ARN should be in
one of the following formats: For an Application Load Balancer:
arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-bala
ncer-id For an Amazon API Gateway stage:
arn:aws:apigateway:region::/restapis/api-id/stages/stage-name
"""
function get_web_aclfor_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"GetWebACLForResource",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_web_aclfor_resource(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"GetWebACLForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_xss_match_set(xss_match_set_id)
get_xss_match_set(xss_match_set_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns the XssMatchSet that is specified by XssMatchSetId.
# Arguments
- `xss_match_set_id`: The XssMatchSetId of the XssMatchSet that you want to get.
XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
"""
function get_xss_match_set(XssMatchSetId; aws_config::AbstractAWSConfig=global_aws_config())
return waf_regional(
"GetXssMatchSet",
Dict{String,Any}("XssMatchSetId" => XssMatchSetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_xss_match_set(
XssMatchSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"GetXssMatchSet",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("XssMatchSetId" => XssMatchSetId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_activated_rules_in_rule_group()
list_activated_rules_in_rule_group(params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns an array of ActivatedRule objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies the number of ActivatedRules that you want AWS WAF to return for
this request. If you have more ActivatedRules than the number that you specify for Limit,
the response includes a NextMarker value that you can use to get another batch of
ActivatedRules.
- `"NextMarker"`: If you specify a value for Limit and you have more ActivatedRules than
the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to
list another group of ActivatedRules. For the second and subsequent
ListActivatedRulesInRuleGroup requests, specify the value of NextMarker from the previous
response to get information about another batch of ActivatedRules.
- `"RuleGroupId"`: The RuleGroupId of the RuleGroup for which you want to get a list of
ActivatedRule objects.
"""
function list_activated_rules_in_rule_group(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"ListActivatedRulesInRuleGroup";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_activated_rules_in_rule_group(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"ListActivatedRulesInRuleGroup",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_byte_match_sets()
list_byte_match_sets(params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns an array of ByteMatchSetSummary objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies the number of ByteMatchSet objects that you want AWS WAF to return
for this request. If you have more ByteMatchSets objects than the number you specify for
Limit, the response includes a NextMarker value that you can use to get another batch of
ByteMatchSet objects.
- `"NextMarker"`: If you specify a value for Limit and you have more ByteMatchSets than the
value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list
another group of ByteMatchSets. For the second and subsequent ListByteMatchSets requests,
specify the value of NextMarker from the previous response to get information about another
batch of ByteMatchSets.
"""
function list_byte_match_sets(; aws_config::AbstractAWSConfig=global_aws_config())
return waf_regional(
"ListByteMatchSets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_byte_match_sets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"ListByteMatchSets", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_geo_match_sets()
list_geo_match_sets(params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns an array of GeoMatchSetSummary objects in the response.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies the number of GeoMatchSet objects that you want AWS WAF to return
for this request. If you have more GeoMatchSet objects than the number you specify for
Limit, the response includes a NextMarker value that you can use to get another batch of
GeoMatchSet objects.
- `"NextMarker"`: If you specify a value for Limit and you have more GeoMatchSets than the
value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list
another group of GeoMatchSet objects. For the second and subsequent ListGeoMatchSets
requests, specify the value of NextMarker from the previous response to get information
about another batch of GeoMatchSet objects.
"""
function list_geo_match_sets(; aws_config::AbstractAWSConfig=global_aws_config())
return waf_regional(
"ListGeoMatchSets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_geo_match_sets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"ListGeoMatchSets", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_ipsets()
list_ipsets(params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns an array of IPSetSummary objects in the response.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies the number of IPSet objects that you want AWS WAF to return for this
request. If you have more IPSet objects than the number you specify for Limit, the response
includes a NextMarker value that you can use to get another batch of IPSet objects.
- `"NextMarker"`: AWS WAF returns a NextMarker value in the response that allows you to
list another group of IPSets. For the second and subsequent ListIPSets requests, specify
the value of NextMarker from the previous response to get information about another batch
of IPSets.
"""
function list_ipsets(; aws_config::AbstractAWSConfig=global_aws_config())
return waf_regional(
"ListIPSets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_ipsets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"ListIPSets", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_logging_configurations()
list_logging_configurations(params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns an array of LoggingConfiguration objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies the number of LoggingConfigurations that you want AWS WAF to return
for this request. If you have more LoggingConfigurations than the number that you specify
for Limit, the response includes a NextMarker value that you can use to get another batch
of LoggingConfigurations.
- `"NextMarker"`: If you specify a value for Limit and you have more LoggingConfigurations
than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you
to list another group of LoggingConfigurations. For the second and subsequent
ListLoggingConfigurations requests, specify the value of NextMarker from the previous
response to get information about another batch of ListLoggingConfigurations.
"""
function list_logging_configurations(; aws_config::AbstractAWSConfig=global_aws_config())
return waf_regional(
"ListLoggingConfigurations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_logging_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"ListLoggingConfigurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_rate_based_rules()
list_rate_based_rules(params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns an array of RuleSummary objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies the number of Rules that you want AWS WAF to return for this
request. If you have more Rules than the number that you specify for Limit, the response
includes a NextMarker value that you can use to get another batch of Rules.
- `"NextMarker"`: If you specify a value for Limit and you have more Rules than the value
of Limit, AWS WAF returns a NextMarker value in the response that allows you to list
another group of Rules. For the second and subsequent ListRateBasedRules requests, specify
the value of NextMarker from the previous response to get information about another batch
of Rules.
"""
function list_rate_based_rules(; aws_config::AbstractAWSConfig=global_aws_config())
return waf_regional(
"ListRateBasedRules"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_rate_based_rules(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"ListRateBasedRules", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_regex_match_sets()
list_regex_match_sets(params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns an array of RegexMatchSetSummary objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies the number of RegexMatchSet objects that you want AWS WAF to return
for this request. If you have more RegexMatchSet objects than the number you specify for
Limit, the response includes a NextMarker value that you can use to get another batch of
RegexMatchSet objects.
- `"NextMarker"`: If you specify a value for Limit and you have more RegexMatchSet objects
than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you
to list another group of ByteMatchSets. For the second and subsequent ListRegexMatchSets
requests, specify the value of NextMarker from the previous response to get information
about another batch of RegexMatchSet objects.
"""
function list_regex_match_sets(; aws_config::AbstractAWSConfig=global_aws_config())
return waf_regional(
"ListRegexMatchSets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_regex_match_sets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"ListRegexMatchSets", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_regex_pattern_sets()
list_regex_pattern_sets(params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns an array of RegexPatternSetSummary objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies the number of RegexPatternSet objects that you want AWS WAF to
return for this request. If you have more RegexPatternSet objects than the number you
specify for Limit, the response includes a NextMarker value that you can use to get another
batch of RegexPatternSet objects.
- `"NextMarker"`: If you specify a value for Limit and you have more RegexPatternSet
objects than the value of Limit, AWS WAF returns a NextMarker value in the response that
allows you to list another group of RegexPatternSet objects. For the second and subsequent
ListRegexPatternSets requests, specify the value of NextMarker from the previous response
to get information about another batch of RegexPatternSet objects.
"""
function list_regex_pattern_sets(; aws_config::AbstractAWSConfig=global_aws_config())
return waf_regional(
"ListRegexPatternSets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_regex_pattern_sets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"ListRegexPatternSets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_resources_for_web_acl(web_aclid)
list_resources_for_web_acl(web_aclid, params::Dict{String,<:Any})
This is AWS WAF Classic Regional documentation. For more information, see AWS WAF Classic
in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see
the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints
for regional and global use. Returns an array of resources associated with the specified
web ACL.
# Arguments
- `web_aclid`: The unique identifier (ID) of the web ACL for which to list the associated
resources.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ResourceType"`: The type of resource to list, either an application load balancer or
Amazon API Gateway.
"""
function list_resources_for_web_acl(
WebACLId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"ListResourcesForWebACL",
Dict{String,Any}("WebACLId" => WebACLId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_resources_for_web_acl(
WebACLId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"ListResourcesForWebACL",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("WebACLId" => WebACLId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_rule_groups()
list_rule_groups(params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns an array of RuleGroup objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies the number of RuleGroups that you want AWS WAF to return for this
request. If you have more RuleGroups than the number that you specify for Limit, the
response includes a NextMarker value that you can use to get another batch of RuleGroups.
- `"NextMarker"`: If you specify a value for Limit and you have more RuleGroups than the
value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list
another group of RuleGroups. For the second and subsequent ListRuleGroups requests, specify
the value of NextMarker from the previous response to get information about another batch
of RuleGroups.
"""
function list_rule_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return waf_regional(
"ListRuleGroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_rule_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"ListRuleGroups", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_rules()
list_rules(params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns an array of RuleSummary objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies the number of Rules that you want AWS WAF to return for this
request. If you have more Rules than the number that you specify for Limit, the response
includes a NextMarker value that you can use to get another batch of Rules.
- `"NextMarker"`: If you specify a value for Limit and you have more Rules than the value
of Limit, AWS WAF returns a NextMarker value in the response that allows you to list
another group of Rules. For the second and subsequent ListRules requests, specify the value
of NextMarker from the previous response to get information about another batch of Rules.
"""
function list_rules(; aws_config::AbstractAWSConfig=global_aws_config())
return waf_regional("ListRules"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_rules(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"ListRules", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_size_constraint_sets()
list_size_constraint_sets(params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns an array of SizeConstraintSetSummary objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies the number of SizeConstraintSet objects that you want AWS WAF to
return for this request. If you have more SizeConstraintSets objects than the number you
specify for Limit, the response includes a NextMarker value that you can use to get another
batch of SizeConstraintSet objects.
- `"NextMarker"`: If you specify a value for Limit and you have more SizeConstraintSets
than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you
to list another group of SizeConstraintSets. For the second and subsequent
ListSizeConstraintSets requests, specify the value of NextMarker from the previous response
to get information about another batch of SizeConstraintSets.
"""
function list_size_constraint_sets(; aws_config::AbstractAWSConfig=global_aws_config())
return waf_regional(
"ListSizeConstraintSets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_size_constraint_sets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"ListSizeConstraintSets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_sql_injection_match_sets()
list_sql_injection_match_sets(params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns an array of SqlInjectionMatchSet objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies the number of SqlInjectionMatchSet objects that you want AWS WAF to
return for this request. If you have more SqlInjectionMatchSet objects than the number you
specify for Limit, the response includes a NextMarker value that you can use to get another
batch of Rules.
- `"NextMarker"`: If you specify a value for Limit and you have more SqlInjectionMatchSet
objects than the value of Limit, AWS WAF returns a NextMarker value in the response that
allows you to list another group of SqlInjectionMatchSets. For the second and subsequent
ListSqlInjectionMatchSets requests, specify the value of NextMarker from the previous
response to get information about another batch of SqlInjectionMatchSets.
"""
function list_sql_injection_match_sets(; aws_config::AbstractAWSConfig=global_aws_config())
return waf_regional(
"ListSqlInjectionMatchSets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_sql_injection_match_sets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"ListSqlInjectionMatchSets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_subscribed_rule_groups()
list_subscribed_rule_groups(params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns an array of RuleGroup objects that you are subscribed to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies the number of subscribed rule groups that you want AWS WAF to return
for this request. If you have more objects than the number you specify for Limit, the
response includes a NextMarker value that you can use to get another batch of objects.
- `"NextMarker"`: If you specify a value for Limit and you have more
ByteMatchSetssubscribed rule groups than the value of Limit, AWS WAF returns a NextMarker
value in the response that allows you to list another group of subscribed rule groups. For
the second and subsequent ListSubscribedRuleGroupsRequest requests, specify the value of
NextMarker from the previous response to get information about another batch of subscribed
rule groups.
"""
function list_subscribed_rule_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return waf_regional(
"ListSubscribedRuleGroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_subscribed_rule_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"ListSubscribedRuleGroups",
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 is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Retrieves the tags associated with the specified AWS resource.
Tags are key:value pairs that you can use to categorize and manage your resources, for
purposes like billing. For example, you might set the tag key to \"customer\" and the value
to the customer name or ID. You can specify one or more tags to add to each AWS resource,
up to 50 tags for a resource. Tagging is only available through the API, SDKs, and CLI. You
can't manage or view tags through the AWS WAF Classic console. You can tag the AWS
resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules.
# Arguments
- `resource_arn`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`:
- `"NextMarker"`:
"""
function list_tags_for_resource(
ResourceARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"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 waf_regional(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceARN" => ResourceARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_web_acls()
list_web_acls(params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns an array of WebACLSummary objects in the response.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies the number of WebACL objects that you want AWS WAF to return for
this request. If you have more WebACL objects than the number that you specify for Limit,
the response includes a NextMarker value that you can use to get another batch of WebACL
objects.
- `"NextMarker"`: If you specify a value for Limit and you have more WebACL objects than
the number that you specify for Limit, AWS WAF returns a NextMarker value in the response
that allows you to list another group of WebACL objects. For the second and subsequent
ListWebACLs requests, specify the value of NextMarker from the previous response to get
information about another batch of WebACL objects.
"""
function list_web_acls(; aws_config::AbstractAWSConfig=global_aws_config())
return waf_regional(
"ListWebACLs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_web_acls(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"ListWebACLs", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_xss_match_sets()
list_xss_match_sets(params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Returns an array of XssMatchSet objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies the number of XssMatchSet objects that you want AWS WAF to return
for this request. If you have more XssMatchSet objects than the number you specify for
Limit, the response includes a NextMarker value that you can use to get another batch of
Rules.
- `"NextMarker"`: If you specify a value for Limit and you have more XssMatchSet objects
than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you
to list another group of XssMatchSets. For the second and subsequent ListXssMatchSets
requests, specify the value of NextMarker from the previous response to get information
about another batch of XssMatchSets.
"""
function list_xss_match_sets(; aws_config::AbstractAWSConfig=global_aws_config())
return waf_regional(
"ListXssMatchSets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_xss_match_sets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"ListXssMatchSets", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
put_logging_configuration(logging_configuration)
put_logging_configuration(logging_configuration, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Associates a LoggingConfiguration with a specified web ACL. You
can access information about all traffic that AWS WAF inspects using the following steps:
Create an Amazon Kinesis Data Firehose. Create the data firehose with a PUT source and in
the region that you are operating. However, if you are capturing logs for Amazon
CloudFront, always create the firehose in US East (N. Virginia). Do not create the data
firehose using a Kinesis stream as your source. Associate that firehose to your web ACL
using a PutLoggingConfiguration request. When you successfully enable logging using a
PutLoggingConfiguration request, AWS WAF will create a service linked role with the
necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more
information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide.
# Arguments
- `logging_configuration`: The Amazon Kinesis Data Firehose that contains the inspected
traffic information, the redacted fields details, and the Amazon Resource Name (ARN) of the
web ACL to monitor. When specifying Type in RedactedFields, you must use one of the
following values: URI, QUERY_STRING, HEADER, or METHOD.
"""
function put_logging_configuration(
LoggingConfiguration; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"PutLoggingConfiguration",
Dict{String,Any}("LoggingConfiguration" => LoggingConfiguration);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_logging_configuration(
LoggingConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"PutLoggingConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LoggingConfiguration" => LoggingConfiguration),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_permission_policy(policy, resource_arn)
put_permission_policy(policy, resource_arn, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Attaches an IAM policy to the specified resource. The only
supported use for this action is to share a RuleGroup across accounts. The
PutPermissionPolicy is subject to the following restrictions: You can attach only one
policy with each PutPermissionPolicy request. The policy must include an Effect, Action
and Principal. Effect must specify Allow. The Action in the policy must be
waf:UpdateWebACL, waf-regional:UpdateWebACL, waf:GetRuleGroup and waf-regional:GetRuleGroup
. Any extra or wildcard actions in the policy will be rejected. The policy cannot include
a Resource parameter. The ARN in the request must be a valid WAF RuleGroup ARN and the
RuleGroup must exist in the same region. The user making the request must be the owner of
the RuleGroup. Your policy must be composed using IAM Policy version 2012-10-17. For
more information, see IAM Policies. An example of a valid policy parameter is shown in the
Examples section below.
# Arguments
- `policy`: The policy to attach to the specified RuleGroup.
- `resource_arn`: The Amazon Resource Name (ARN) of the RuleGroup to which you want to
attach the policy.
"""
function put_permission_policy(
Policy, ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"PutPermissionPolicy",
Dict{String,Any}("Policy" => Policy, "ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_permission_policy(
Policy,
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"PutPermissionPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Policy" => Policy, "ResourceArn" => ResourceArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Associates tags with the specified AWS resource. Tags are
key:value pairs that you can use to categorize and manage your resources, for purposes like
billing. For example, you might set the tag key to \"customer\" and the value to the
customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50
tags for a resource. Tagging is only available through the API, SDKs, and CLI. You can't
manage or view tags through the AWS WAF Classic console. You can use this action to tag the
AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules.
# Arguments
- `resource_arn`:
- `tags`:
"""
function tag_resource(ResourceARN, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return waf_regional(
"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 waf_regional(
"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 is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use.
# Arguments
- `resource_arn`:
- `tag_keys`:
"""
function untag_resource(
ResourceARN, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"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 waf_regional(
"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_byte_match_set(byte_match_set_id, change_token, updates)
update_byte_match_set(byte_match_set_id, change_token, updates, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Inserts or deletes ByteMatchTuple objects (filters) in a
ByteMatchSet. For each ByteMatchTuple object, you specify the following values: Whether
to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate
object, you delete the existing object and add a new one. The part of a web request that
you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.
The bytes (typically a string that corresponds with ASCII characters) that you want AWS
WAF to look for. For more information, including how you specify the values for the AWS WAF
API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple data type. Where to
look, such as at the beginning or the end of a query string. Whether to perform any
conversions on the request, such as converting it to lowercase, before inspecting it for
the specified string. For example, you can add a ByteMatchSetUpdate object that matches
web requests in which User-Agent headers contain the string BadBot. You can then configure
AWS WAF to block those requests. To create and configure a ByteMatchSet, perform the
following steps: Create a ByteMatchSet. For more information, see CreateByteMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of
an UpdateByteMatchSet request. Submit an UpdateByteMatchSet request to specify the part
of the request that you want AWS WAF to inspect (for example, the header or the URI) and
the value that you want AWS WAF to watch for. For more information about how to use the
AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
# Arguments
- `byte_match_set_id`: The ByteMatchSetId of the ByteMatchSet that you want to update.
ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `updates`: An array of ByteMatchSetUpdate objects that you want to insert into or delete
from a ByteMatchSet. For more information, see the applicable data types:
ByteMatchSetUpdate: Contains Action and ByteMatchTuple ByteMatchTuple: Contains
FieldToMatch, PositionalConstraint, TargetString, and TextTransformation FieldToMatch:
Contains Data and Type
"""
function update_byte_match_set(
ByteMatchSetId, ChangeToken, Updates; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"UpdateByteMatchSet",
Dict{String,Any}(
"ByteMatchSetId" => ByteMatchSetId,
"ChangeToken" => ChangeToken,
"Updates" => Updates,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_byte_match_set(
ByteMatchSetId,
ChangeToken,
Updates,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"UpdateByteMatchSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ByteMatchSetId" => ByteMatchSetId,
"ChangeToken" => ChangeToken,
"Updates" => Updates,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_geo_match_set(change_token, geo_match_set_id, updates)
update_geo_match_set(change_token, geo_match_set_id, updates, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Inserts or deletes GeoMatchConstraint objects in an GeoMatchSet.
For each GeoMatchConstraint object, you specify the following values: Whether to insert
or delete the object from the array. If you want to change an GeoMatchConstraint object,
you delete the existing object and add a new one. The Type. The only valid value for Type
is Country. The Value, which is a two character code for the country to add to the
GeoMatchConstraint object. Valid codes are listed in GeoMatchConstraintValue. To create
and configure an GeoMatchSet, perform the following steps: Submit a CreateGeoMatchSet
request. Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of an UpdateGeoMatchSet request. Submit an UpdateGeoMatchSet request to specify
the country that you want AWS WAF to watch for. When you update an GeoMatchSet, you
specify the country that you want to add and/or the country that you want to delete. If you
want to change a country, you delete the existing country and add the new one. For more
information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS
WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `geo_match_set_id`: The GeoMatchSetId of the GeoMatchSet that you want to update.
GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.
- `updates`: An array of GeoMatchSetUpdate objects that you want to insert into or delete
from an GeoMatchSet. For more information, see the applicable data types:
GeoMatchSetUpdate: Contains Action and GeoMatchConstraint GeoMatchConstraint: Contains
Type and Value You can have only one Type and Value per GeoMatchConstraint. To add
multiple countries, include multiple GeoMatchSetUpdate objects in your request.
"""
function update_geo_match_set(
ChangeToken, GeoMatchSetId, Updates; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"UpdateGeoMatchSet",
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"GeoMatchSetId" => GeoMatchSetId,
"Updates" => Updates,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_geo_match_set(
ChangeToken,
GeoMatchSetId,
Updates,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"UpdateGeoMatchSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"GeoMatchSetId" => GeoMatchSetId,
"Updates" => Updates,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_ipset(change_token, ipset_id, updates)
update_ipset(change_token, ipset_id, updates, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Inserts or deletes IPSetDescriptor objects in an IPSet. For each
IPSetDescriptor object, you specify the following values: Whether to insert or delete
the object from the array. If you want to change an IPSetDescriptor object, you delete the
existing object and add a new one. The IP address version, IPv4 or IPv6. The IP
address in CIDR notation, for example, 192.0.2.0/24 (for the range of IP addresses from
192.0.2.0 to 192.0.2.255) or 192.0.2.44/32 (for the individual IP address 192.0.2.44).
AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF
supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. For more information about
CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. IPv6 addresses can
be represented using any of the following formats:
1111:0000:0000:0000:0000:0000:0000:0111/128 1111:0:0:0:0:0:0:0111/128 1111::0111/128
1111::111/128 You use an IPSet to specify which web requests you want to allow or block
based on the IP addresses that the requests originated from. For example, if you're
receiving a lot of requests from one or a small number of IP addresses and you want to
block the requests, you can create an IPSet that specifies those IP addresses, and then
configure AWS WAF to block the requests. To create and configure an IPSet, perform the
following steps: Submit a CreateIPSet request. Use GetChangeToken to get the change
token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an
UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for. When
you update an IPSet, you specify the IP addresses that you want to add and/or the IP
addresses that you want to delete. If you want to change an IP address, you delete the
existing IP address and add the new one. You can insert a maximum of 1000 addresses in a
single request. For more information about how to use the AWS WAF API to allow or block
HTTP requests, see the AWS WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `ipset_id`: The IPSetId of the IPSet that you want to update. IPSetId is returned by
CreateIPSet and by ListIPSets.
- `updates`: An array of IPSetUpdate objects that you want to insert into or delete from an
IPSet. For more information, see the applicable data types: IPSetUpdate: Contains Action
and IPSetDescriptor IPSetDescriptor: Contains Type and Value You can insert a
maximum of 1000 addresses in a single request.
"""
function update_ipset(
ChangeToken, IPSetId, Updates; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"UpdateIPSet",
Dict{String,Any}(
"ChangeToken" => ChangeToken, "IPSetId" => IPSetId, "Updates" => Updates
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_ipset(
ChangeToken,
IPSetId,
Updates,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"UpdateIPSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken, "IPSetId" => IPSetId, "Updates" => Updates
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_rate_based_rule(change_token, rate_limit, rule_id, updates)
update_rate_based_rule(change_token, rate_limit, rule_id, updates, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Inserts or deletes Predicate objects in a rule and updates the
RateLimit in the rule. Each Predicate object identifies a predicate, such as a
ByteMatchSet or an IPSet, that specifies the web requests that you want to block or count.
The RateLimit specifies the number of requests every five minutes that triggers the rule.
If you add more than one predicate to a RateBasedRule, a request must match all the
predicates and exceed the RateLimit to be counted or blocked. For example, suppose you add
the following to a RateBasedRule: An IPSet that matches the IP address 192.0.2.44/32 A
ByteMatchSet that matches BadBot in the User-Agent header Further, you specify a
RateLimit of 1,000. You then add the RateBasedRule to a WebACL and specify that you want to
block requests that satisfy the rule. For a request to be blocked, it must come from the IP
address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot.
Further, requests that match these two conditions much be received at a rate of more than
1,000 every five minutes. If the rate drops below this limit, AWS WAF no longer blocks the
requests. As a second example, suppose you want to limit requests to a particular page on
your site. To do this, you could add the following to a RateBasedRule: A ByteMatchSet
with FieldToMatch of URI A PositionalConstraint of STARTS_WITH A TargetString of
login Further, you specify a RateLimit of 1,000. By adding this RateBasedRule to a
WebACL, you could limit requests to your login page without affecting the rest of your site.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `rate_limit`: The maximum number of requests, which have an identical value in the field
specified by the RateKey, allowed in a five-minute period. If the number of requests
exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF
triggers the action that is specified for this rule.
- `rule_id`: The RuleId of the RateBasedRule that you want to update. RuleId is returned by
CreateRateBasedRule and by ListRateBasedRules.
- `updates`: An array of RuleUpdate objects that you want to insert into or delete from a
RateBasedRule.
"""
function update_rate_based_rule(
ChangeToken,
RateLimit,
RuleId,
Updates;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"UpdateRateBasedRule",
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"RateLimit" => RateLimit,
"RuleId" => RuleId,
"Updates" => Updates,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_rate_based_rule(
ChangeToken,
RateLimit,
RuleId,
Updates,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"UpdateRateBasedRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"RateLimit" => RateLimit,
"RuleId" => RuleId,
"Updates" => Updates,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_regex_match_set(change_token, regex_match_set_id, updates)
update_regex_match_set(change_token, regex_match_set_id, updates, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Inserts or deletes RegexMatchTuple objects (filters) in a
RegexMatchSet. For each RegexMatchSetUpdate object, you specify the following values:
Whether to insert or delete the object from the array. If you want to change a
RegexMatchSetUpdate object, you delete the existing object and add a new one. The part of
a web request that you want AWS WAF to inspectupdate, such as a query string or the value
of the User-Agent header. The identifier of the pattern (a regular expression) that you
want AWS WAF to look for. For more information, see RegexPatternSet. Whether to perform
any conversions on the request, such as converting it to lowercase, before inspecting it
for the specified string. For example, you can create a RegexPatternSet that matches any
requests with User-Agent headers that contain the string B[a@]dB[o0]t. You can then
configure AWS WAF to reject those requests. To create and configure a RegexMatchSet,
perform the following steps: Create a RegexMatchSet. For more information, see
CreateRegexMatchSet. Use GetChangeToken to get the change token that you provide in the
ChangeToken parameter of an UpdateRegexMatchSet request. Submit an UpdateRegexMatchSet
request to specify the part of the request that you want AWS WAF to inspect (for example,
the header or the URI) and the identifier of the RegexPatternSet that contain the regular
expression patters you want AWS WAF to watch for. For more information about how to use
the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `regex_match_set_id`: The RegexMatchSetId of the RegexMatchSet that you want to update.
RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.
- `updates`: An array of RegexMatchSetUpdate objects that you want to insert into or delete
from a RegexMatchSet. For more information, see RegexMatchTuple.
"""
function update_regex_match_set(
ChangeToken, RegexMatchSetId, Updates; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"UpdateRegexMatchSet",
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"RegexMatchSetId" => RegexMatchSetId,
"Updates" => Updates,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_regex_match_set(
ChangeToken,
RegexMatchSetId,
Updates,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"UpdateRegexMatchSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"RegexMatchSetId" => RegexMatchSetId,
"Updates" => Updates,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_regex_pattern_set(change_token, regex_pattern_set_id, updates)
update_regex_pattern_set(change_token, regex_pattern_set_id, updates, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Inserts or deletes RegexPatternString objects in a
RegexPatternSet. For each RegexPatternString object, you specify the following values:
Whether to insert or delete the RegexPatternString. The regular expression pattern that
you want to insert or delete. For more information, see RegexPatternSet. For example,
you can create a RegexPatternString such as B[a@]dB[o0]t. AWS WAF will match this
RegexPatternString to: BadBot BadB0t B@dBot B@dB0t To create and configure a
RegexPatternSet, perform the following steps: Create a RegexPatternSet. For more
information, see CreateRegexPatternSet. Use GetChangeToken to get the change token that
you provide in the ChangeToken parameter of an UpdateRegexPatternSet request. Submit an
UpdateRegexPatternSet request to specify the regular expression pattern that you want AWS
WAF to watch for. For more information about how to use the AWS WAF API to allow or block
HTTP requests, see the AWS WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `regex_pattern_set_id`: The RegexPatternSetId of the RegexPatternSet that you want to
update. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
- `updates`: An array of RegexPatternSetUpdate objects that you want to insert into or
delete from a RegexPatternSet.
"""
function update_regex_pattern_set(
ChangeToken,
RegexPatternSetId,
Updates;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"UpdateRegexPatternSet",
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"RegexPatternSetId" => RegexPatternSetId,
"Updates" => Updates,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_regex_pattern_set(
ChangeToken,
RegexPatternSetId,
Updates,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"UpdateRegexPatternSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"RegexPatternSetId" => RegexPatternSetId,
"Updates" => Updates,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_rule(change_token, rule_id, updates)
update_rule(change_token, rule_id, updates, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Inserts or deletes Predicate objects in a Rule. Each Predicate
object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web
requests that you want to allow, block, or count. If you add more than one predicate to a
Rule, a request must match all of the specifications to be allowed, blocked, or counted.
For example, suppose that you add the following to a Rule: A ByteMatchSet that matches
the value BadBot in the User-Agent header An IPSet that matches the IP address 192.0.2.44
You then add the Rule to a WebACL and specify that you want to block requests that
satisfy the Rule. For a request to be blocked, the User-Agent header in the request must
contain the value BadBot and the request must originate from the IP address 192.0.2.44. To
create and configure a Rule, perform the following steps: Create and update the
predicates that you want to include in the Rule. Create the Rule. See CreateRule. Use
GetChangeToken to get the change token that you provide in the ChangeToken parameter of an
UpdateRule request. Submit an UpdateRule request to add predicates to the Rule. Create
and update a WebACL that contains the Rule. See CreateWebACL. If you want to replace one
ByteMatchSet or IPSet with another, you delete the existing one and add the new one. For
more information about how to use the AWS WAF API to allow or block HTTP requests, see the
AWS WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `rule_id`: The RuleId of the Rule that you want to update. RuleId is returned by
CreateRule and by ListRules.
- `updates`: An array of RuleUpdate objects that you want to insert into or delete from a
Rule. For more information, see the applicable data types: RuleUpdate: Contains Action
and Predicate Predicate: Contains DataId, Negated, and Type FieldToMatch: Contains
Data and Type
"""
function update_rule(
ChangeToken, RuleId, Updates; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"UpdateRule",
Dict{String,Any}(
"ChangeToken" => ChangeToken, "RuleId" => RuleId, "Updates" => Updates
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_rule(
ChangeToken,
RuleId,
Updates,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"UpdateRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken, "RuleId" => RuleId, "Updates" => Updates
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_rule_group(change_token, rule_group_id, updates)
update_rule_group(change_token, rule_group_id, updates, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Inserts or deletes ActivatedRule objects in a RuleGroup. You can
only insert REGULAR rules into a rule group. You can have a maximum of ten rules per rule
group. To create and configure a RuleGroup, perform the following steps: Create and
update the Rules that you want to include in the RuleGroup. See CreateRule. Use
GetChangeToken to get the change token that you provide in the ChangeToken parameter of an
UpdateRuleGroup request. Submit an UpdateRuleGroup request to add Rules to the RuleGroup.
Create and update a WebACL that contains the RuleGroup. See CreateWebACL. If you want
to replace one Rule with another, you delete the existing one and add the new one. For more
information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS
WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `rule_group_id`: The RuleGroupId of the RuleGroup that you want to update. RuleGroupId is
returned by CreateRuleGroup and by ListRuleGroups.
- `updates`: An array of RuleGroupUpdate objects that you want to insert into or delete
from a RuleGroup. You can only insert REGULAR rules into a rule group.
ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL.
In this case you do not use ActivatedRule|Action. For all other update requests,
ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.
"""
function update_rule_group(
ChangeToken, RuleGroupId, Updates; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"UpdateRuleGroup",
Dict{String,Any}(
"ChangeToken" => ChangeToken, "RuleGroupId" => RuleGroupId, "Updates" => Updates
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_rule_group(
ChangeToken,
RuleGroupId,
Updates,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"UpdateRuleGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"RuleGroupId" => RuleGroupId,
"Updates" => Updates,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_size_constraint_set(change_token, size_constraint_set_id, updates)
update_size_constraint_set(change_token, size_constraint_set_id, updates, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Inserts or deletes SizeConstraint objects (filters) in a
SizeConstraintSet. For each SizeConstraint object, you specify the following values:
Whether to insert or delete the object from the array. If you want to change a
SizeConstraintSetUpdate object, you delete the existing object and add a new one. The
part of a web request that you want AWS WAF to evaluate, such as the length of a query
string or the length of the User-Agent header. Whether to perform any transformations on
the request, such as converting it to lowercase, before checking its length. Note that
transformations of the request body are not supported because the AWS resource forwards
only the first 8192 bytes of your request to AWS WAF. You can only specify a single type of
TextTransformation. A ComparisonOperator used for evaluating the selected part of the
request against the specified Size, such as equals, greater than, less than, and so on.
The length, in bytes, that you want AWS WAF to watch for in selected part of the request.
The length is computed after applying the transformation. For example, you can add a
SizeConstraintSetUpdate object that matches web requests in which the length of the
User-Agent header is greater than 100 bytes. You can then configure AWS WAF to block those
requests. To create and configure a SizeConstraintSet, perform the following steps:
Create a SizeConstraintSet. For more information, see CreateSizeConstraintSet. Use
GetChangeToken to get the change token that you provide in the ChangeToken parameter of an
UpdateSizeConstraintSet request. Submit an UpdateSizeConstraintSet request to specify the
part of the request that you want AWS WAF to inspect (for example, the header or the URI)
and the value that you want AWS WAF to watch for. For more information about how to use
the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `size_constraint_set_id`: The SizeConstraintSetId of the SizeConstraintSet that you want
to update. SizeConstraintSetId is returned by CreateSizeConstraintSet and by
ListSizeConstraintSets.
- `updates`: An array of SizeConstraintSetUpdate objects that you want to insert into or
delete from a SizeConstraintSet. For more information, see the applicable data types:
SizeConstraintSetUpdate: Contains Action and SizeConstraint SizeConstraint: Contains
FieldToMatch, TextTransformation, ComparisonOperator, and Size FieldToMatch: Contains
Data and Type
"""
function update_size_constraint_set(
ChangeToken,
SizeConstraintSetId,
Updates;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"UpdateSizeConstraintSet",
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"SizeConstraintSetId" => SizeConstraintSetId,
"Updates" => Updates,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_size_constraint_set(
ChangeToken,
SizeConstraintSetId,
Updates,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"UpdateSizeConstraintSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"SizeConstraintSetId" => SizeConstraintSetId,
"Updates" => Updates,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_sql_injection_match_set(change_token, sql_injection_match_set_id, updates)
update_sql_injection_match_set(change_token, sql_injection_match_set_id, updates, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Inserts or deletes SqlInjectionMatchTuple objects (filters) in a
SqlInjectionMatchSet. For each SqlInjectionMatchTuple object, you specify the following
values: Action: Whether to insert the object into or delete the object from the array.
To change a SqlInjectionMatchTuple, you delete the existing object and add a new one.
FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want
AWS WAF to inspect a header or custom query parameter, the name of the header or parameter.
TextTransformation: Which text transformation, if any, to perform on the web request
before inspecting the request for snippets of malicious SQL code. You can only specify a
single type of TextTransformation. You use SqlInjectionMatchSet objects to specify which
CloudFront requests that you want to allow, block, or count. For example, if you're
receiving requests that contain snippets of SQL code in the query string and you want to
block the requests, you can create a SqlInjectionMatchSet with the applicable settings, and
then configure AWS WAF to block the requests. To create and configure a
SqlInjectionMatchSet, perform the following steps: Submit a CreateSqlInjectionMatchSet
request. Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of an UpdateIPSet request. Submit an UpdateSqlInjectionMatchSet request to
specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL
code. For more information about how to use the AWS WAF API to allow or block HTTP
requests, see the AWS WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `sql_injection_match_set_id`: The SqlInjectionMatchSetId of the SqlInjectionMatchSet that
you want to update. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by
ListSqlInjectionMatchSets.
- `updates`: An array of SqlInjectionMatchSetUpdate objects that you want to insert into or
delete from a SqlInjectionMatchSet. For more information, see the applicable data types:
SqlInjectionMatchSetUpdate: Contains Action and SqlInjectionMatchTuple
SqlInjectionMatchTuple: Contains FieldToMatch and TextTransformation FieldToMatch:
Contains Data and Type
"""
function update_sql_injection_match_set(
ChangeToken,
SqlInjectionMatchSetId,
Updates;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"UpdateSqlInjectionMatchSet",
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"SqlInjectionMatchSetId" => SqlInjectionMatchSetId,
"Updates" => Updates,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_sql_injection_match_set(
ChangeToken,
SqlInjectionMatchSetId,
Updates,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"UpdateSqlInjectionMatchSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"SqlInjectionMatchSetId" => SqlInjectionMatchSetId,
"Updates" => Updates,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_web_acl(change_token, web_aclid)
update_web_acl(change_token, web_aclid, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Inserts or deletes ActivatedRule objects in a WebACL. Each Rule
identifies web requests that you want to allow, block, or count. When you update a WebACL,
you specify the following values: A default action for the WebACL, either ALLOW or BLOCK.
AWS WAF performs the default action if a request doesn't match the criteria in any of the
Rules in a WebACL. The Rules that you want to add or delete. If you want to replace one
Rule with another, you delete the existing Rule and add the new one. For each Rule,
whether you want AWS WAF to allow requests, block requests, or count requests that match
the conditions in the Rule. The order in which you want AWS WAF to evaluate the Rules in
a WebACL. If you add more than one Rule to a WebACL, AWS WAF evaluates each request against
the Rules in order based on the value of Priority. (The Rule that has the lowest value for
Priority is evaluated first.) When a web request matches all the predicates (such as
ByteMatchSets and IPSets) in a Rule, AWS WAF immediately takes the corresponding action,
allow or block, and doesn't evaluate the request against the remaining Rules in the WebACL,
if any. To create and configure a WebACL, perform the following steps: Create and
update the predicates that you want to include in Rules. For more information, see
CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet,
CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet. Create and update the Rules
that you want to include in the WebACL. For more information, see CreateRule and
UpdateRule. Create a WebACL. See CreateWebACL. Use GetChangeToken to get the change
token that you provide in the ChangeToken parameter of an UpdateWebACL request. Submit an
UpdateWebACL request to specify the Rules that you want to include in the WebACL, to
specify the default action, and to associate the WebACL with a CloudFront distribution.
The ActivatedRule can be a rule group. If you specify a rule group as your ActivatedRule ,
you can exclude specific rules from that rule group. If you already have a rule group
associated with a web ACL and want to submit an UpdateWebACL request to exclude certain
rules from that rule group, you must first remove the rule group from the web ACL, the
re-insert it again, specifying the excluded rules. For details, see
ActivatedRuleExcludedRules . Be aware that if you try to add a RATE_BASED rule to a web
ACL without setting the rule type when first creating the rule, the UpdateWebACL request
will fail because the request tries to add a REGULAR rule (the default rule type) with the
specified ID, which does not exist. For more information about how to use the AWS WAF API
to allow or block HTTP requests, see the AWS WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `web_aclid`: The WebACLId of the WebACL that you want to update. WebACLId is returned by
CreateWebACL and by ListWebACLs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DefaultAction"`: A default action for the web ACL, either ALLOW or BLOCK. AWS WAF
performs the default action if a request doesn't match the criteria in any of the rules in
a web ACL.
- `"Updates"`: An array of updates to make to the WebACL. An array of WebACLUpdate objects
that you want to insert into or delete from a WebACL. For more information, see the
applicable data types: WebACLUpdate: Contains Action and ActivatedRule
ActivatedRule: Contains Action, OverrideAction, Priority, RuleId, and Type.
ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL.
In this case, you do not use ActivatedRule|Action. For all other update requests,
ActivatedRule|Action is used instead of ActivatedRule|OverrideAction. WafAction:
Contains Type
"""
function update_web_acl(
ChangeToken, WebACLId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"UpdateWebACL",
Dict{String,Any}("ChangeToken" => ChangeToken, "WebACLId" => WebACLId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_web_acl(
ChangeToken,
WebACLId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"UpdateWebACL",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ChangeToken" => ChangeToken, "WebACLId" => WebACLId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_xss_match_set(change_token, updates, xss_match_set_id)
update_xss_match_set(change_token, updates, xss_match_set_id, params::Dict{String,<:Any})
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the
developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS
WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for
regional and global use. Inserts or deletes XssMatchTuple objects (filters) in an
XssMatchSet. For each XssMatchTuple object, you specify the following values: Action:
Whether to insert the object into or delete the object from the array. To change an
XssMatchTuple, you delete the existing object and add a new one. FieldToMatch: The part
of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a
header or custom query parameter, the name of the header or parameter.
TextTransformation: Which text transformation, if any, to perform on the web request before
inspecting the request for cross-site scripting attacks. You can only specify a single type
of TextTransformation. You use XssMatchSet objects to specify which CloudFront requests
that you want to allow, block, or count. For example, if you're receiving requests that
contain cross-site scripting attacks in the request body and you want to block the
requests, you can create an XssMatchSet with the applicable settings, and then configure
AWS WAF to block the requests. To create and configure an XssMatchSet, perform the
following steps: Submit a CreateXssMatchSet request. Use GetChangeToken to get the
change token that you provide in the ChangeToken parameter of an UpdateIPSet request.
Submit an UpdateXssMatchSet request to specify the parts of web requests that you want AWS
WAF to inspect for cross-site scripting attacks. For more information about how to use
the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
# Arguments
- `change_token`: The value returned by the most recent call to GetChangeToken.
- `updates`: An array of XssMatchSetUpdate objects that you want to insert into or delete
from an XssMatchSet. For more information, see the applicable data types:
XssMatchSetUpdate: Contains Action and XssMatchTuple XssMatchTuple: Contains
FieldToMatch and TextTransformation FieldToMatch: Contains Data and Type
- `xss_match_set_id`: The XssMatchSetId of the XssMatchSet that you want to update.
XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
"""
function update_xss_match_set(
ChangeToken, Updates, XssMatchSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return waf_regional(
"UpdateXssMatchSet",
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"Updates" => Updates,
"XssMatchSetId" => XssMatchSetId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_xss_match_set(
ChangeToken,
Updates,
XssMatchSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return waf_regional(
"UpdateXssMatchSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChangeToken" => ChangeToken,
"Updates" => Updates,
"XssMatchSetId" => XssMatchSetId,
),
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 | 144567 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: wafv2
using AWS.Compat
using AWS.UUIDs
"""
associate_web_acl(resource_arn, web_aclarn)
associate_web_acl(resource_arn, web_aclarn, params::Dict{String,<:Any})
Associates a web ACL with a regional application resource, to protect the resource. A
regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST
API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an
Amazon Web Services Verified Access instance. For Amazon CloudFront, don't use this call.
Instead, use your CloudFront distribution configuration. To associate a web ACL, in the
CloudFront call UpdateDistribution, set the web ACL ID to the Amazon Resource Name (ARN) of
the web ACL. For information, see UpdateDistribution in the Amazon CloudFront Developer
Guide. Required permissions for customer-managed IAM policies This call requires
permissions that are specific to the protected resource type. For details, see Permissions
for AssociateWebACL in the WAF Developer Guide. Temporary inconsistencies during updates
When you create or change a web ACL or other WAF resources, the changes take a small amount
of time to propagate to all areas where the resources are stored. The propagation time can
be from a few seconds to a number of minutes. The following are examples of the temporary
inconsistencies that you might notice during change propagation: After you create a web
ACL, if you try to associate it with a resource, you might get an exception indicating that
the web ACL is unavailable. After you add a rule group to a web ACL, the new rule group
rules might be in effect in one area where the web ACL is used and not in another. After
you change a rule action setting, you might see the old action in some places and the new
action in others. After you add an IP address to an IP set that is in use in a blocking
rule, the new address might be blocked in one area while still allowed in another.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource to associate with the web
ACL. The ARN must be in one of the following formats: For an Application Load Balancer:
arn:partition:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/loa
d-balancer-id For an Amazon API Gateway REST API:
arn:partition:apigateway:region::/restapis/api-id/stages/stage-name For an AppSync
GraphQL API: arn:partition:appsync:region:account-id:apis/GraphQLApiId For an Amazon
Cognito user pool: arn:partition:cognito-idp:region:account-id:userpool/user-pool-id
For an App Runner service:
arn:partition:apprunner:region:account-id:service/apprunner-service-name/apprunner-service-i
d For an Amazon Web Services Verified Access instance:
arn:partition:ec2:region:account-id:verified-access-instance/instance-id
- `web_aclarn`: The Amazon Resource Name (ARN) of the web ACL that you want to associate
with the resource.
"""
function associate_web_acl(
ResourceArn, WebACLArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"AssociateWebACL",
Dict{String,Any}("ResourceArn" => ResourceArn, "WebACLArn" => WebACLArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_web_acl(
ResourceArn,
WebACLArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"AssociateWebACL",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "WebACLArn" => WebACLArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
check_capacity(rules, scope)
check_capacity(rules, scope, params::Dict{String,<:Any})
Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of
rules. You can use this to check the capacity requirements for the rules you want to use in
a RuleGroup or WebACL. WAF uses WCUs to calculate and control the operating resources that
are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently
for each rule type, to reflect the relative cost of each rule. Simple rules that cost
little to run use fewer WCUs than more complex rules that use more processing power. Rule
group capacity is fixed at creation, which helps users plan their web ACL WCU usage when
they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the
WAF Developer Guide.
# Arguments
- `rules`: An array of Rule that you're configuring to use in a rule group or web ACL.
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
"""
function check_capacity(Rules, Scope; aws_config::AbstractAWSConfig=global_aws_config())
return wafv2(
"CheckCapacity",
Dict{String,Any}("Rules" => Rules, "Scope" => Scope);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function check_capacity(
Rules,
Scope,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"CheckCapacity",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Rules" => Rules, "Scope" => Scope), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_apikey(scope, token_domains)
create_apikey(scope, token_domains, params::Dict{String,<:Any})
Creates an API key that contains a set of token domains. API keys are required for the
integration of the CAPTCHA API in your JavaScript client applications. The API lets you
customize the placement and characteristics of the CAPTCHA puzzle for your end users. For
more information about the CAPTCHA JavaScript integration, see WAF client application
integration in the WAF Developer Guide. You can use a single key for up to 5 domains. After
you generate a key, you can copy it for use in your JavaScript integration.
# Arguments
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
- `token_domains`: The client application domains that you want to use this API key for.
Example JSON: \"TokenDomains\": [\"abc.com\", \"store.abc.com\"] Public suffixes aren't
allowed. For example, you can't use gov.au or co.uk as token domains.
"""
function create_apikey(
Scope, TokenDomains; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"CreateAPIKey",
Dict{String,Any}("Scope" => Scope, "TokenDomains" => TokenDomains);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_apikey(
Scope,
TokenDomains,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"CreateAPIKey",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Scope" => Scope, "TokenDomains" => TokenDomains),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_ipset(addresses, ipaddress_version, name, scope)
create_ipset(addresses, ipaddress_version, name, scope, params::Dict{String,<:Any})
Creates an IPSet, which you use to identify web requests that originate from specific IP
addresses or ranges of IP addresses. For example, if you're receiving a lot of requests
from a ranges of IP addresses, you can configure WAF to block them using an IPSet that
lists those IP addresses.
# Arguments
- `addresses`: Contains an array of strings that specifies zero or more IP addresses or
blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses
must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all
IPv4 and IPv6 CIDR ranges except for /0. Example address strings: For requests that
originated from the IP address 192.0.2.44, specify 192.0.2.44/32. For requests that
originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24. For
requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111,
specify 1111:0000:0000:0000:0000:0000:0000:0111/128. For requests that originated from IP
addresses 1111:0000:0000:0000:0000:0000:0000:0000 to
1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
1111:0000:0000:0000:0000:0000:0000:0000/64. For more information about CIDR notation, see
the Wikipedia entry Classless Inter-Domain Routing. Example JSON Addresses specifications:
Empty array: \"Addresses\": [] Array with one address: \"Addresses\":
[\"192.0.2.44/32\"] Array with three addresses: \"Addresses\": [\"192.0.2.44/32\",
\"192.0.2.0/24\", \"192.0.0.0/16\"] INVALID specification: \"Addresses\": [\"\"] INVALID
- `ipaddress_version`: The version of the IP addresses, either IPV4 or IPV6.
- `name`: The name of the IP set. You cannot change the name of an IPSet after you create
it.
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the IP set that helps with identification.
- `"Tags"`: An array of key:value pairs to associate with the resource.
"""
function create_ipset(
Addresses,
IPAddressVersion,
Name,
Scope;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"CreateIPSet",
Dict{String,Any}(
"Addresses" => Addresses,
"IPAddressVersion" => IPAddressVersion,
"Name" => Name,
"Scope" => Scope,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_ipset(
Addresses,
IPAddressVersion,
Name,
Scope,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"CreateIPSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Addresses" => Addresses,
"IPAddressVersion" => IPAddressVersion,
"Name" => Name,
"Scope" => Scope,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_regex_pattern_set(name, regular_expression_list, scope)
create_regex_pattern_set(name, regular_expression_list, scope, params::Dict{String,<:Any})
Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to
have WAF inspect a web request component for the specified patterns.
# Arguments
- `name`: The name of the set. You cannot change the name after you create the set.
- `regular_expression_list`: Array of regular expression strings.
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the set that helps with identification.
- `"Tags"`: An array of key:value pairs to associate with the resource.
"""
function create_regex_pattern_set(
Name, RegularExpressionList, Scope; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"CreateRegexPatternSet",
Dict{String,Any}(
"Name" => Name,
"RegularExpressionList" => RegularExpressionList,
"Scope" => Scope,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_regex_pattern_set(
Name,
RegularExpressionList,
Scope,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"CreateRegexPatternSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Name" => Name,
"RegularExpressionList" => RegularExpressionList,
"Scope" => Scope,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_rule_group(capacity, name, scope, visibility_config)
create_rule_group(capacity, name, scope, visibility_config, params::Dict{String,<:Any})
Creates a RuleGroup per the specifications provided. A rule group defines a collection of
rules to inspect and control web requests that you can use in a WebACL. When you create a
rule group, you define an immutable capacity limit. If you update a rule group, you must
stay within the capacity. This allows others to reuse the rule group with confidence in its
capacity requirements.
# Arguments
- `capacity`: The web ACL capacity units (WCUs) required for this rule group. When you
create your own rule group, you define this, and you cannot change it after creation. When
you add or modify the rules in a rule group, WAF enforces this limit. You can check the
capacity for a set of rules using CheckCapacity. WAF uses WCUs to calculate and control the
operating resources that are used to run your rules, rule groups, and web ACLs. WAF
calculates capacity differently for each rule type, to reflect the relative cost of each
rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use
more processing power. Rule group capacity is fixed at creation, which helps users plan
their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL
capacity units (WCU) in the WAF Developer Guide.
- `name`: The name of the rule group. You cannot change the name of a rule group after you
create it.
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
- `visibility_config`: Defines and enables Amazon CloudWatch metrics and web request sample
collection.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CustomResponseBodies"`: A map of custom response keys and content bodies. When you
create a rule with a block action, you can send a custom response to the web request. You
define these for the rule group, and then use them in the rules that you define in the rule
group. For information about customizing web requests and responses, see Customizing web
requests and responses in WAF in the WAF Developer Guide. For information about the limits
on count and size for custom request and response settings, see WAF quotas in the WAF
Developer Guide.
- `"Description"`: A description of the rule group that helps with identification.
- `"Rules"`: The Rule statements used to identify the web requests that you want to manage.
Each rule includes one top-level statement that WAF uses to identify matching web requests,
and parameters that govern how WAF handles them.
- `"Tags"`: An array of key:value pairs to associate with the resource.
"""
function create_rule_group(
Capacity,
Name,
Scope,
VisibilityConfig;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"CreateRuleGroup",
Dict{String,Any}(
"Capacity" => Capacity,
"Name" => Name,
"Scope" => Scope,
"VisibilityConfig" => VisibilityConfig,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_rule_group(
Capacity,
Name,
Scope,
VisibilityConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"CreateRuleGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Capacity" => Capacity,
"Name" => Name,
"Scope" => Scope,
"VisibilityConfig" => VisibilityConfig,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_web_acl(default_action, name, scope, visibility_config)
create_web_acl(default_action, name, scope, visibility_config, params::Dict{String,<:Any})
Creates a WebACL per the specifications provided. A web ACL defines a collection of rules
to use to inspect and control web requests. Each rule has a statement that defines what to
look for in web requests and an action that WAF applies to requests that match the
statement. In the web ACL, you assign a default action to take (allow, block) for any
request that does not match any of the rules. The rules in a web ACL can be a combination
of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one
or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront
distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync
GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services
Verified Access instance.
# Arguments
- `default_action`: The action to perform if none of the Rules contained in the WebACL
match.
- `name`: The name of the web ACL. You cannot change the name of a web ACL after you create
it.
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
- `visibility_config`: Defines and enables Amazon CloudWatch metrics and web request sample
collection.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AssociationConfig"`: Specifies custom configurations for the associations between the
web ACL and protected resources. Use this to customize the maximum size of the request
body that your protected resources forward to WAF for inspection. You can customize this
setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access
resources. The default setting is 16 KB (16,384 bytes). You are charged additional fees
when your protected resources forward body sizes that are larger than the default. For more
information, see WAF Pricing. For Application Load Balancer and AppSync, the limit is
fixed at 8 KB (8,192 bytes).
- `"CaptchaConfig"`: Specifies how WAF should handle CAPTCHA evaluations for rules that
don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its
default settings for CaptchaConfig.
- `"ChallengeConfig"`: Specifies how WAF should handle challenge evaluations for rules that
don't have their own ChallengeConfig settings. If you don't specify this, WAF uses its
default settings for ChallengeConfig.
- `"CustomResponseBodies"`: A map of custom response keys and content bodies. When you
create a rule with a block action, you can send a custom response to the web request. You
define these for the web ACL, and then use them in the rules and default actions that you
define in the web ACL. For information about customizing web requests and responses, see
Customizing web requests and responses in WAF in the WAF Developer Guide. For information
about the limits on count and size for custom request and response settings, see WAF quotas
in the WAF Developer Guide.
- `"Description"`: A description of the web ACL that helps with identification.
- `"Rules"`: The Rule statements used to identify the web requests that you want to manage.
Each rule includes one top-level statement that WAF uses to identify matching web requests,
and parameters that govern how WAF handles them.
- `"Tags"`: An array of key:value pairs to associate with the resource.
- `"TokenDomains"`: Specifies the domains that WAF should accept in a web request token.
This enables the use of tokens across multiple protected websites. When WAF provides a
token, it uses the domain of the Amazon Web Services resource that the web ACL is
protecting. If you don't specify a list of token domains, WAF accepts tokens only for the
domain of the protected resource. With a token domain list, WAF accepts the resource's host
domain plus all domains in the token domain list, including their prefixed subdomains.
Example JSON: \"TokenDomains\": { \"mywebsite.com\", \"myotherwebsite.com\" } Public
suffixes aren't allowed. For example, you can't use gov.au or co.uk as token domains.
"""
function create_web_acl(
DefaultAction,
Name,
Scope,
VisibilityConfig;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"CreateWebACL",
Dict{String,Any}(
"DefaultAction" => DefaultAction,
"Name" => Name,
"Scope" => Scope,
"VisibilityConfig" => VisibilityConfig,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_web_acl(
DefaultAction,
Name,
Scope,
VisibilityConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"CreateWebACL",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DefaultAction" => DefaultAction,
"Name" => Name,
"Scope" => Scope,
"VisibilityConfig" => VisibilityConfig,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_apikey(apikey, scope)
delete_apikey(apikey, scope, params::Dict{String,<:Any})
Deletes the specified API key. After you delete a key, it can take up to 24 hours for WAF
to disallow use of the key in all regions.
# Arguments
- `apikey`: The encrypted API key that you want to delete.
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
"""
function delete_apikey(APIKey, Scope; aws_config::AbstractAWSConfig=global_aws_config())
return wafv2(
"DeleteAPIKey",
Dict{String,Any}("APIKey" => APIKey, "Scope" => Scope);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_apikey(
APIKey,
Scope,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"DeleteAPIKey",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("APIKey" => APIKey, "Scope" => Scope), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_firewall_manager_rule_groups(web_aclarn, web_acllock_token)
delete_firewall_manager_rule_groups(web_aclarn, web_acllock_token, params::Dict{String,<:Any})
Deletes all rule groups that are managed by Firewall Manager for the specified web ACL.
You can only use this if ManagedByFirewallManager is false in the specified WebACL.
# Arguments
- `web_aclarn`: The Amazon Resource Name (ARN) of the web ACL.
- `web_acllock_token`: A token used for optimistic locking. WAF returns a token to your get
and list requests, to mark the state of the entity at the time of the request. To make
changes to the entity associated with the token, you provide the token to operations like
update and delete. WAF uses the token to ensure that no changes have been made to the
entity since you last retrieved it. If a change has been made, the update fails with a
WAFOptimisticLockException. If this happens, perform another get, and use the new token
returned by that operation.
"""
function delete_firewall_manager_rule_groups(
WebACLArn, WebACLLockToken; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"DeleteFirewallManagerRuleGroups",
Dict{String,Any}("WebACLArn" => WebACLArn, "WebACLLockToken" => WebACLLockToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_firewall_manager_rule_groups(
WebACLArn,
WebACLLockToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"DeleteFirewallManagerRuleGroups",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"WebACLArn" => WebACLArn, "WebACLLockToken" => WebACLLockToken
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_ipset(id, lock_token, name, scope)
delete_ipset(id, lock_token, name, scope, params::Dict{String,<:Any})
Deletes the specified IPSet.
# Arguments
- `id`: A unique identifier for the set. This ID is returned in the responses to create and
list commands. You provide it to operations like update and delete.
- `lock_token`: A token used for optimistic locking. WAF returns a token to your get and
list requests, to mark the state of the entity at the time of the request. To make changes
to the entity associated with the token, you provide the token to operations like update
and delete. WAF uses the token to ensure that no changes have been made to the entity since
you last retrieved it. If a change has been made, the update fails with a
WAFOptimisticLockException. If this happens, perform another get, and use the new token
returned by that operation.
- `name`: The name of the IP set. You cannot change the name of an IPSet after you create
it.
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
"""
function delete_ipset(
Id, LockToken, Name, Scope; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"DeleteIPSet",
Dict{String,Any}(
"Id" => Id, "LockToken" => LockToken, "Name" => Name, "Scope" => Scope
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_ipset(
Id,
LockToken,
Name,
Scope,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"DeleteIPSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Id" => Id, "LockToken" => LockToken, "Name" => Name, "Scope" => Scope
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_logging_configuration(resource_arn)
delete_logging_configuration(resource_arn, params::Dict{String,<:Any})
Deletes the LoggingConfiguration from the specified web ACL.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the web ACL from which you want to
delete the LoggingConfiguration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LogScope"`: The owner of the logging configuration, which must be set to CUSTOMER for
the configurations that you manage. The log scope SECURITY_LAKE indicates a configuration
that is managed through Amazon Security Lake. You can use Security Lake to collect log and
event data from various sources for normalization, analysis, and management. For
information, see Collecting data from Amazon Web Services services in the Amazon Security
Lake user guide. Default: CUSTOMER
- `"LogType"`: Used to distinguish between various logging options. Currently, there is one
option. Default: WAF_LOGS
"""
function delete_logging_configuration(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"DeleteLoggingConfiguration",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_logging_configuration(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"DeleteLoggingConfiguration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_permission_policy(resource_arn)
delete_permission_policy(resource_arn, params::Dict{String,<:Any})
Permanently deletes an IAM policy from the specified rule group. You must be the owner of
the rule group to perform this operation.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the rule group from which you want to
delete the policy. You must be the owner of the rule group to perform this operation.
"""
function delete_permission_policy(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"DeletePermissionPolicy",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_permission_policy(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"DeletePermissionPolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_regex_pattern_set(id, lock_token, name, scope)
delete_regex_pattern_set(id, lock_token, name, scope, params::Dict{String,<:Any})
Deletes the specified RegexPatternSet.
# Arguments
- `id`: A unique identifier for the set. This ID is returned in the responses to create and
list commands. You provide it to operations like update and delete.
- `lock_token`: A token used for optimistic locking. WAF returns a token to your get and
list requests, to mark the state of the entity at the time of the request. To make changes
to the entity associated with the token, you provide the token to operations like update
and delete. WAF uses the token to ensure that no changes have been made to the entity since
you last retrieved it. If a change has been made, the update fails with a
WAFOptimisticLockException. If this happens, perform another get, and use the new token
returned by that operation.
- `name`: The name of the set. You cannot change the name after you create the set.
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
"""
function delete_regex_pattern_set(
Id, LockToken, Name, Scope; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"DeleteRegexPatternSet",
Dict{String,Any}(
"Id" => Id, "LockToken" => LockToken, "Name" => Name, "Scope" => Scope
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_regex_pattern_set(
Id,
LockToken,
Name,
Scope,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"DeleteRegexPatternSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Id" => Id, "LockToken" => LockToken, "Name" => Name, "Scope" => Scope
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_rule_group(id, lock_token, name, scope)
delete_rule_group(id, lock_token, name, scope, params::Dict{String,<:Any})
Deletes the specified RuleGroup.
# Arguments
- `id`: A unique identifier for the rule group. This ID is returned in the responses to
create and list commands. You provide it to operations like update and delete.
- `lock_token`: A token used for optimistic locking. WAF returns a token to your get and
list requests, to mark the state of the entity at the time of the request. To make changes
to the entity associated with the token, you provide the token to operations like update
and delete. WAF uses the token to ensure that no changes have been made to the entity since
you last retrieved it. If a change has been made, the update fails with a
WAFOptimisticLockException. If this happens, perform another get, and use the new token
returned by that operation.
- `name`: The name of the rule group. You cannot change the name of a rule group after you
create it.
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
"""
function delete_rule_group(
Id, LockToken, Name, Scope; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"DeleteRuleGroup",
Dict{String,Any}(
"Id" => Id, "LockToken" => LockToken, "Name" => Name, "Scope" => Scope
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_rule_group(
Id,
LockToken,
Name,
Scope,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"DeleteRuleGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Id" => Id, "LockToken" => LockToken, "Name" => Name, "Scope" => Scope
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_web_acl(id, lock_token, name, scope)
delete_web_acl(id, lock_token, name, scope, params::Dict{String,<:Any})
Deletes the specified WebACL. You can only use this if ManagedByFirewallManager is false
in the specified WebACL. Before deleting any web ACL, first disassociate it from all
resources. To retrieve a list of the resources that are associated with a web ACL, use
the following calls: For regional resources, call ListResourcesForWebACL. For Amazon
CloudFront distributions, use the CloudFront call ListDistributionsByWebACLId. For
information, see ListDistributionsByWebACLId in the Amazon CloudFront API Reference.
To disassociate a resource from a web ACL, use the following calls: For regional
resources, call DisassociateWebACL. For Amazon CloudFront distributions, provide an empty
web ACL ID in the CloudFront call UpdateDistribution. For information, see
UpdateDistribution in the Amazon CloudFront API Reference.
# Arguments
- `id`: The unique identifier for the web ACL. This ID is returned in the responses to
create and list commands. You provide it to operations like update and delete.
- `lock_token`: A token used for optimistic locking. WAF returns a token to your get and
list requests, to mark the state of the entity at the time of the request. To make changes
to the entity associated with the token, you provide the token to operations like update
and delete. WAF uses the token to ensure that no changes have been made to the entity since
you last retrieved it. If a change has been made, the update fails with a
WAFOptimisticLockException. If this happens, perform another get, and use the new token
returned by that operation.
- `name`: The name of the web ACL. You cannot change the name of a web ACL after you create
it.
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
"""
function delete_web_acl(
Id, LockToken, Name, Scope; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"DeleteWebACL",
Dict{String,Any}(
"Id" => Id, "LockToken" => LockToken, "Name" => Name, "Scope" => Scope
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_web_acl(
Id,
LockToken,
Name,
Scope,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"DeleteWebACL",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Id" => Id, "LockToken" => LockToken, "Name" => Name, "Scope" => Scope
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_all_managed_products(scope)
describe_all_managed_products(scope, params::Dict{String,<:Any})
Provides high-level information for the Amazon Web Services Managed Rules rule groups and
Amazon Web Services Marketplace managed rule groups.
# Arguments
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
"""
function describe_all_managed_products(
Scope; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"DescribeAllManagedProducts",
Dict{String,Any}("Scope" => Scope);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_all_managed_products(
Scope, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"DescribeAllManagedProducts",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Scope" => Scope), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_managed_products_by_vendor(scope, vendor_name)
describe_managed_products_by_vendor(scope, vendor_name, params::Dict{String,<:Any})
Provides high-level information for the managed rule groups owned by a specific vendor.
# Arguments
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
- `vendor_name`: The name of the managed rule group vendor. You use this, along with the
rule group name, to identify a rule group.
"""
function describe_managed_products_by_vendor(
Scope, VendorName; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"DescribeManagedProductsByVendor",
Dict{String,Any}("Scope" => Scope, "VendorName" => VendorName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_managed_products_by_vendor(
Scope,
VendorName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"DescribeManagedProductsByVendor",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Scope" => Scope, "VendorName" => VendorName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_managed_rule_group(name, scope, vendor_name)
describe_managed_rule_group(name, scope, vendor_name, params::Dict{String,<:Any})
Provides high-level information for a managed rule group, including descriptions of the
rules.
# Arguments
- `name`: The name of the managed rule group. You use this, along with the vendor name, to
identify the rule group.
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
- `vendor_name`: The name of the managed rule group vendor. You use this, along with the
rule group name, to identify a rule group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"VersionName"`: The version of the rule group. You can only use a version that is not
scheduled for expiration. If you don't provide this, WAF uses the vendor's default version.
"""
function describe_managed_rule_group(
Name, Scope, VendorName; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"DescribeManagedRuleGroup",
Dict{String,Any}("Name" => Name, "Scope" => Scope, "VendorName" => VendorName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_managed_rule_group(
Name,
Scope,
VendorName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"DescribeManagedRuleGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Name" => Name, "Scope" => Scope, "VendorName" => VendorName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_web_acl(resource_arn)
disassociate_web_acl(resource_arn, params::Dict{String,<:Any})
Disassociates the specified regional application resource from any existing web ACL
association. A resource can have at most one web ACL association. A regional application
can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync
GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services
Verified Access instance. For Amazon CloudFront, don't use this call. Instead, use your
CloudFront distribution configuration. To disassociate a web ACL, provide an empty web ACL
ID in the CloudFront call UpdateDistribution. For information, see UpdateDistribution in
the Amazon CloudFront API Reference. Required permissions for customer-managed IAM
policies This call requires permissions that are specific to the protected resource type.
For details, see Permissions for DisassociateWebACL in the WAF Developer Guide.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource to disassociate from the
web ACL. The ARN must be in one of the following formats: For an Application Load
Balancer:
arn:partition:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/loa
d-balancer-id For an Amazon API Gateway REST API:
arn:partition:apigateway:region::/restapis/api-id/stages/stage-name For an AppSync
GraphQL API: arn:partition:appsync:region:account-id:apis/GraphQLApiId For an Amazon
Cognito user pool: arn:partition:cognito-idp:region:account-id:userpool/user-pool-id
For an App Runner service:
arn:partition:apprunner:region:account-id:service/apprunner-service-name/apprunner-service-i
d For an Amazon Web Services Verified Access instance:
arn:partition:ec2:region:account-id:verified-access-instance/instance-id
"""
function disassociate_web_acl(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"DisassociateWebACL",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_web_acl(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"DisassociateWebACL",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
generate_mobile_sdk_release_url(platform, release_version)
generate_mobile_sdk_release_url(platform, release_version, params::Dict{String,<:Any})
Generates a presigned download URL for the specified release of the mobile SDK. The mobile
SDK is not generally available. Customers who have access to the mobile SDK can use it to
establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF.
For more information, see WAF client application integration in the WAF Developer Guide.
# Arguments
- `platform`: The device platform.
- `release_version`: The release version. For the latest available version, specify LATEST.
"""
function generate_mobile_sdk_release_url(
Platform, ReleaseVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"GenerateMobileSdkReleaseUrl",
Dict{String,Any}("Platform" => Platform, "ReleaseVersion" => ReleaseVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function generate_mobile_sdk_release_url(
Platform,
ReleaseVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"GenerateMobileSdkReleaseUrl",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Platform" => Platform, "ReleaseVersion" => ReleaseVersion
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_decrypted_apikey(apikey, scope)
get_decrypted_apikey(apikey, scope, params::Dict{String,<:Any})
Returns your API key in decrypted form. Use this to check the token domains that you have
defined for the key. API keys are required for the integration of the CAPTCHA API in your
JavaScript client applications. The API lets you customize the placement and
characteristics of the CAPTCHA puzzle for your end users. For more information about the
CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer
Guide.
# Arguments
- `apikey`: The encrypted API key.
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
"""
function get_decrypted_apikey(
APIKey, Scope; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"GetDecryptedAPIKey",
Dict{String,Any}("APIKey" => APIKey, "Scope" => Scope);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_decrypted_apikey(
APIKey,
Scope,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"GetDecryptedAPIKey",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("APIKey" => APIKey, "Scope" => Scope), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_ipset(id, name, scope)
get_ipset(id, name, scope, params::Dict{String,<:Any})
Retrieves the specified IPSet.
# Arguments
- `id`: A unique identifier for the set. This ID is returned in the responses to create and
list commands. You provide it to operations like update and delete.
- `name`: The name of the IP set. You cannot change the name of an IPSet after you create
it.
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
"""
function get_ipset(Id, Name, Scope; aws_config::AbstractAWSConfig=global_aws_config())
return wafv2(
"GetIPSet",
Dict{String,Any}("Id" => Id, "Name" => Name, "Scope" => Scope);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_ipset(
Id,
Name,
Scope,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"GetIPSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Id" => Id, "Name" => Name, "Scope" => Scope),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_logging_configuration(resource_arn)
get_logging_configuration(resource_arn, params::Dict{String,<:Any})
Returns the LoggingConfiguration for the specified web ACL.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the web ACL for which you want to get
the LoggingConfiguration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LogScope"`: The owner of the logging configuration, which must be set to CUSTOMER for
the configurations that you manage. The log scope SECURITY_LAKE indicates a configuration
that is managed through Amazon Security Lake. You can use Security Lake to collect log and
event data from various sources for normalization, analysis, and management. For
information, see Collecting data from Amazon Web Services services in the Amazon Security
Lake user guide. Default: CUSTOMER
- `"LogType"`: Used to distinguish between various logging options. Currently, there is one
option. Default: WAF_LOGS
"""
function get_logging_configuration(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"GetLoggingConfiguration",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_logging_configuration(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"GetLoggingConfiguration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_managed_rule_set(id, name, scope)
get_managed_rule_set(id, name, scope, params::Dict{String,<:Any})
Retrieves the specified managed rule set. This is intended for use only by vendors of
managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace
sellers. Vendors, you can use the managed rule set APIs to provide controlled rollout of
your versioned managed rule group offerings for your customers. The APIs are
ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and
UpdateManagedRuleSetVersionExpiryDate.
# Arguments
- `id`: A unique identifier for the managed rule set. The ID is returned in the responses
to commands like list. You provide it to operations like get and update.
- `name`: The name of the managed rule set. You use this, along with the rule set ID, to
identify the rule set. This name is assigned to the corresponding managed rule group, which
your customers can access and use.
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
"""
function get_managed_rule_set(
Id, Name, Scope; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"GetManagedRuleSet",
Dict{String,Any}("Id" => Id, "Name" => Name, "Scope" => Scope);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_managed_rule_set(
Id,
Name,
Scope,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"GetManagedRuleSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Id" => Id, "Name" => Name, "Scope" => Scope),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_mobile_sdk_release(platform, release_version)
get_mobile_sdk_release(platform, release_version, params::Dict{String,<:Any})
Retrieves information for the specified mobile SDK release, including release notes and
tags. The mobile SDK is not generally available. Customers who have access to the mobile
SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile
device to WAF. For more information, see WAF client application integration in the WAF
Developer Guide.
# Arguments
- `platform`: The device platform.
- `release_version`: The release version. For the latest available version, specify LATEST.
"""
function get_mobile_sdk_release(
Platform, ReleaseVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"GetMobileSdkRelease",
Dict{String,Any}("Platform" => Platform, "ReleaseVersion" => ReleaseVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_mobile_sdk_release(
Platform,
ReleaseVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"GetMobileSdkRelease",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Platform" => Platform, "ReleaseVersion" => ReleaseVersion
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_permission_policy(resource_arn)
get_permission_policy(resource_arn, params::Dict{String,<:Any})
Returns the IAM policy that is attached to the specified rule group. You must be the owner
of the rule group to perform this operation.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the rule group for which you want to
get the policy.
"""
function get_permission_policy(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"GetPermissionPolicy",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_permission_policy(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"GetPermissionPolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_rate_based_statement_managed_keys(rule_name, scope, web_aclid, web_aclname)
get_rate_based_statement_managed_keys(rule_name, scope, web_aclid, web_aclname, params::Dict{String,<:Any})
Retrieves the IP addresses that are currently blocked by a rate-based rule instance. This
is only available for rate-based rules that aggregate solely on the IP address or on the
forwarded IP address. The maximum number of addresses that can be blocked for a single
rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit,
those with the highest rates are blocked. For a rate-based rule that you've defined inside
a rule group, provide the name of the rule group reference statement in your request, in
addition to the rate-based rule name and the web ACL name. WAF monitors web requests and
manages keys independently for each unique combination of web ACL, optional rule group, and
rate-based rule. For example, if you define a rate-based rule inside a rule group, and then
use the rule group in a web ACL, WAF monitors web requests and manages keys for that web
ACL, rule group reference statement, and rate-based rule instance. If you use the same rule
group in a second web ACL, WAF monitors web requests and manages keys for this second usage
completely independent of your first.
# Arguments
- `rule_name`: The name of the rate-based rule to get the keys for. If you have the rule
defined inside a rule group that you're using in your web ACL, also provide the name of the
rule group reference statement in the request parameter RuleGroupRuleName.
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
- `web_aclid`: The unique identifier for the web ACL. This ID is returned in the responses
to create and list commands. You provide it to operations like update and delete.
- `web_aclname`: The name of the web ACL. You cannot change the name of a web ACL after you
create it.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"RuleGroupRuleName"`: The name of the rule group reference statement in your web ACL.
This is required only when you have the rate-based rule nested inside a rule group.
"""
function get_rate_based_statement_managed_keys(
RuleName, Scope, WebACLId, WebACLName; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"GetRateBasedStatementManagedKeys",
Dict{String,Any}(
"RuleName" => RuleName,
"Scope" => Scope,
"WebACLId" => WebACLId,
"WebACLName" => WebACLName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_rate_based_statement_managed_keys(
RuleName,
Scope,
WebACLId,
WebACLName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"GetRateBasedStatementManagedKeys",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"RuleName" => RuleName,
"Scope" => Scope,
"WebACLId" => WebACLId,
"WebACLName" => WebACLName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_regex_pattern_set(id, name, scope)
get_regex_pattern_set(id, name, scope, params::Dict{String,<:Any})
Retrieves the specified RegexPatternSet.
# Arguments
- `id`: A unique identifier for the set. This ID is returned in the responses to create and
list commands. You provide it to operations like update and delete.
- `name`: The name of the set. You cannot change the name after you create the set.
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
"""
function get_regex_pattern_set(
Id, Name, Scope; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"GetRegexPatternSet",
Dict{String,Any}("Id" => Id, "Name" => Name, "Scope" => Scope);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_regex_pattern_set(
Id,
Name,
Scope,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"GetRegexPatternSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Id" => Id, "Name" => Name, "Scope" => Scope),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_rule_group()
get_rule_group(params::Dict{String,<:Any})
Retrieves the specified RuleGroup.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ARN"`: The Amazon Resource Name (ARN) of the entity.
- `"Id"`: A unique identifier for the rule group. This ID is returned in the responses to
create and list commands. You provide it to operations like update and delete.
- `"Name"`: The name of the rule group. You cannot change the name of a rule group after
you create it.
- `"Scope"`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
"""
function get_rule_group(; aws_config::AbstractAWSConfig=global_aws_config())
return wafv2("GetRuleGroup"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_rule_group(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"GetRuleGroup", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_sampled_requests(max_items, rule_metric_name, scope, time_window, web_acl_arn)
get_sampled_requests(max_items, rule_metric_name, scope, time_window, web_acl_arn, params::Dict{String,<:Any})
Gets detailed information about a specified number of requests--a sample--that WAF randomly
selects from among the first 5,000 requests that your Amazon Web Services resource received
during a time range that you choose. You can specify a sample size of up to 500 requests,
and you can specify any time range in the previous three hours. GetSampledRequests returns
a time range, which is usually the time range that you specified. However, if your resource
(such as a CloudFront distribution) received 5,000 requests before the specified time range
elapsed, GetSampledRequests returns an updated time range. This new time range indicates
the actual period during which WAF selected the requests in the sample.
# Arguments
- `max_items`: The number of requests that you want WAF to return from among the first
5,000 requests that your Amazon Web Services resource received during the time range. If
your resource received fewer requests than the value of MaxItems, GetSampledRequests
returns information about all of them.
- `rule_metric_name`: The metric name assigned to the Rule or RuleGroup dimension for which
you want a sample of requests.
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
- `time_window`: The start date and time and the end date and time of the range for which
you want GetSampledRequests to return a sample of requests. You must specify the times in
Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For
example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.
If you specify a start time that's earlier than three hours ago, WAF sets it to three hours
ago.
- `web_acl_arn`: The Amazon resource name (ARN) of the WebACL for which you want a sample
of requests.
"""
function get_sampled_requests(
MaxItems,
RuleMetricName,
Scope,
TimeWindow,
WebAclArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"GetSampledRequests",
Dict{String,Any}(
"MaxItems" => MaxItems,
"RuleMetricName" => RuleMetricName,
"Scope" => Scope,
"TimeWindow" => TimeWindow,
"WebAclArn" => WebAclArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_sampled_requests(
MaxItems,
RuleMetricName,
Scope,
TimeWindow,
WebAclArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"GetSampledRequests",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MaxItems" => MaxItems,
"RuleMetricName" => RuleMetricName,
"Scope" => Scope,
"TimeWindow" => TimeWindow,
"WebAclArn" => WebAclArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_web_acl(id, name, scope)
get_web_acl(id, name, scope, params::Dict{String,<:Any})
Retrieves the specified WebACL.
# Arguments
- `id`: The unique identifier for the web ACL. This ID is returned in the responses to
create and list commands. You provide it to operations like update and delete.
- `name`: The name of the web ACL. You cannot change the name of a web ACL after you create
it.
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
"""
function get_web_acl(Id, Name, Scope; aws_config::AbstractAWSConfig=global_aws_config())
return wafv2(
"GetWebACL",
Dict{String,Any}("Id" => Id, "Name" => Name, "Scope" => Scope);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_web_acl(
Id,
Name,
Scope,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"GetWebACL",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Id" => Id, "Name" => Name, "Scope" => Scope),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_web_aclfor_resource(resource_arn)
get_web_aclfor_resource(resource_arn, params::Dict{String,<:Any})
Retrieves the WebACL for the specified resource. This call uses GetWebACL, to verify that
your account has permission to access the retrieved web ACL. If you get an error that
indicates that your account isn't authorized to perform wafv2:GetWebACL on the resource,
that error won't be included in your CloudTrail event history. For Amazon CloudFront,
don't use this call. Instead, call the CloudFront action GetDistributionConfig. For
information, see GetDistributionConfig in the Amazon CloudFront API Reference. Required
permissions for customer-managed IAM policies This call requires permissions that are
specific to the protected resource type. For details, see Permissions for
GetWebACLForResource in the WAF Developer Guide.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource whose web ACL you want to
retrieve. The ARN must be in one of the following formats: For an Application Load
Balancer:
arn:partition:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/loa
d-balancer-id For an Amazon API Gateway REST API:
arn:partition:apigateway:region::/restapis/api-id/stages/stage-name For an AppSync
GraphQL API: arn:partition:appsync:region:account-id:apis/GraphQLApiId For an Amazon
Cognito user pool: arn:partition:cognito-idp:region:account-id:userpool/user-pool-id
For an App Runner service:
arn:partition:apprunner:region:account-id:service/apprunner-service-name/apprunner-service-i
d For an Amazon Web Services Verified Access instance:
arn:partition:ec2:region:account-id:verified-access-instance/instance-id
"""
function get_web_aclfor_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"GetWebACLForResource",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_web_aclfor_resource(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"GetWebACLForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_apikeys(scope)
list_apikeys(scope, params::Dict{String,<:Any})
Retrieves a list of the API keys that you've defined for the specified scope. API keys are
required for the integration of the CAPTCHA API in your JavaScript client applications. The
API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end
users. For more information about the CAPTCHA JavaScript integration, see WAF client
application integration in the WAF Developer Guide.
# Arguments
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of objects that you want WAF to return for this request. If
more objects are available, in the response, WAF provides a NextMarker value that you can
use in a subsequent call to get the next batch of objects.
- `"NextMarker"`: When you request a list of objects with a Limit setting, if the number of
objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the
prior call in your next request.
"""
function list_apikeys(Scope; aws_config::AbstractAWSConfig=global_aws_config())
return wafv2(
"ListAPIKeys",
Dict{String,Any}("Scope" => Scope);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_apikeys(
Scope, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"ListAPIKeys",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Scope" => Scope), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_available_managed_rule_group_versions(name, scope, vendor_name)
list_available_managed_rule_group_versions(name, scope, vendor_name, params::Dict{String,<:Any})
Returns a list of the available versions for the specified managed rule group.
# Arguments
- `name`: The name of the managed rule group. You use this, along with the vendor name, to
identify the rule group.
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
- `vendor_name`: The name of the managed rule group vendor. You use this, along with the
rule group name, to identify a rule group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of objects that you want WAF to return for this request. If
more objects are available, in the response, WAF provides a NextMarker value that you can
use in a subsequent call to get the next batch of objects.
- `"NextMarker"`: When you request a list of objects with a Limit setting, if the number of
objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the
prior call in your next request.
"""
function list_available_managed_rule_group_versions(
Name, Scope, VendorName; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"ListAvailableManagedRuleGroupVersions",
Dict{String,Any}("Name" => Name, "Scope" => Scope, "VendorName" => VendorName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_available_managed_rule_group_versions(
Name,
Scope,
VendorName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"ListAvailableManagedRuleGroupVersions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Name" => Name, "Scope" => Scope, "VendorName" => VendorName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_available_managed_rule_groups(scope)
list_available_managed_rule_groups(scope, params::Dict{String,<:Any})
Retrieves an array of managed rule groups that are available for you to use. This list
includes all Amazon Web Services Managed Rules rule groups and all of the Amazon Web
Services Marketplace managed rule groups that you're subscribed to.
# Arguments
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of objects that you want WAF to return for this request. If
more objects are available, in the response, WAF provides a NextMarker value that you can
use in a subsequent call to get the next batch of objects.
- `"NextMarker"`: When you request a list of objects with a Limit setting, if the number of
objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the
prior call in your next request.
"""
function list_available_managed_rule_groups(
Scope; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"ListAvailableManagedRuleGroups",
Dict{String,Any}("Scope" => Scope);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_available_managed_rule_groups(
Scope, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"ListAvailableManagedRuleGroups",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Scope" => Scope), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_ipsets(scope)
list_ipsets(scope, params::Dict{String,<:Any})
Retrieves an array of IPSetSummary objects for the IP sets that you manage.
# Arguments
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of objects that you want WAF to return for this request. If
more objects are available, in the response, WAF provides a NextMarker value that you can
use in a subsequent call to get the next batch of objects.
- `"NextMarker"`: When you request a list of objects with a Limit setting, if the number of
objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the
prior call in your next request.
"""
function list_ipsets(Scope; aws_config::AbstractAWSConfig=global_aws_config())
return wafv2(
"ListIPSets",
Dict{String,Any}("Scope" => Scope);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_ipsets(
Scope, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"ListIPSets",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Scope" => Scope), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_logging_configurations(scope)
list_logging_configurations(scope, params::Dict{String,<:Any})
Retrieves an array of your LoggingConfiguration objects.
# Arguments
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of objects that you want WAF to return for this request. If
more objects are available, in the response, WAF provides a NextMarker value that you can
use in a subsequent call to get the next batch of objects.
- `"LogScope"`: The owner of the logging configuration, which must be set to CUSTOMER for
the configurations that you manage. The log scope SECURITY_LAKE indicates a configuration
that is managed through Amazon Security Lake. You can use Security Lake to collect log and
event data from various sources for normalization, analysis, and management. For
information, see Collecting data from Amazon Web Services services in the Amazon Security
Lake user guide. Default: CUSTOMER
- `"NextMarker"`: When you request a list of objects with a Limit setting, if the number of
objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the
prior call in your next request.
"""
function list_logging_configurations(
Scope; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"ListLoggingConfigurations",
Dict{String,Any}("Scope" => Scope);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_logging_configurations(
Scope, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"ListLoggingConfigurations",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Scope" => Scope), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_managed_rule_sets(scope)
list_managed_rule_sets(scope, params::Dict{String,<:Any})
Retrieves the managed rule sets that you own. This is intended for use only by vendors of
managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace
sellers. Vendors, you can use the managed rule set APIs to provide controlled rollout of
your versioned managed rule group offerings for your customers. The APIs are
ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and
UpdateManagedRuleSetVersionExpiryDate.
# Arguments
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of objects that you want WAF to return for this request. If
more objects are available, in the response, WAF provides a NextMarker value that you can
use in a subsequent call to get the next batch of objects.
- `"NextMarker"`: When you request a list of objects with a Limit setting, if the number of
objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the
prior call in your next request.
"""
function list_managed_rule_sets(Scope; aws_config::AbstractAWSConfig=global_aws_config())
return wafv2(
"ListManagedRuleSets",
Dict{String,Any}("Scope" => Scope);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_managed_rule_sets(
Scope, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"ListManagedRuleSets",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Scope" => Scope), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_mobile_sdk_releases(platform)
list_mobile_sdk_releases(platform, params::Dict{String,<:Any})
Retrieves a list of the available releases for the mobile SDK and the specified device
platform. The mobile SDK is not generally available. Customers who have access to the
mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a
mobile device to WAF. For more information, see WAF client application integration in the
WAF Developer Guide.
# Arguments
- `platform`: The device platform to retrieve the list for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of objects that you want WAF to return for this request. If
more objects are available, in the response, WAF provides a NextMarker value that you can
use in a subsequent call to get the next batch of objects.
- `"NextMarker"`: When you request a list of objects with a Limit setting, if the number of
objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the
prior call in your next request.
"""
function list_mobile_sdk_releases(
Platform; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"ListMobileSdkReleases",
Dict{String,Any}("Platform" => Platform);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_mobile_sdk_releases(
Platform,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"ListMobileSdkReleases",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Platform" => Platform), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_regex_pattern_sets(scope)
list_regex_pattern_sets(scope, params::Dict{String,<:Any})
Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you
manage.
# Arguments
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of objects that you want WAF to return for this request. If
more objects are available, in the response, WAF provides a NextMarker value that you can
use in a subsequent call to get the next batch of objects.
- `"NextMarker"`: When you request a list of objects with a Limit setting, if the number of
objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the
prior call in your next request.
"""
function list_regex_pattern_sets(Scope; aws_config::AbstractAWSConfig=global_aws_config())
return wafv2(
"ListRegexPatternSets",
Dict{String,Any}("Scope" => Scope);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_regex_pattern_sets(
Scope, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"ListRegexPatternSets",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Scope" => Scope), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_resources_for_web_acl(web_aclarn)
list_resources_for_web_acl(web_aclarn, params::Dict{String,<:Any})
Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that are
associated with the specified web ACL. For Amazon CloudFront, don't use this call.
Instead, use the CloudFront call ListDistributionsByWebACLId. For information, see
ListDistributionsByWebACLId in the Amazon CloudFront API Reference. Required permissions
for customer-managed IAM policies This call requires permissions that are specific to the
protected resource type. For details, see Permissions for ListResourcesForWebACL in the WAF
Developer Guide.
# Arguments
- `web_aclarn`: The Amazon Resource Name (ARN) of the web ACL.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ResourceType"`: Used for web ACLs that are scoped for regional applications. A regional
application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an
AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web
Services Verified Access instance. If you don't provide a resource type, the call uses
the resource type APPLICATION_LOAD_BALANCER. Default: APPLICATION_LOAD_BALANCER
"""
function list_resources_for_web_acl(
WebACLArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"ListResourcesForWebACL",
Dict{String,Any}("WebACLArn" => WebACLArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_resources_for_web_acl(
WebACLArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"ListResourcesForWebACL",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("WebACLArn" => WebACLArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_rule_groups(scope)
list_rule_groups(scope, params::Dict{String,<:Any})
Retrieves an array of RuleGroupSummary objects for the rule groups that you manage.
# Arguments
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of objects that you want WAF to return for this request. If
more objects are available, in the response, WAF provides a NextMarker value that you can
use in a subsequent call to get the next batch of objects.
- `"NextMarker"`: When you request a list of objects with a Limit setting, if the number of
objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the
prior call in your next request.
"""
function list_rule_groups(Scope; aws_config::AbstractAWSConfig=global_aws_config())
return wafv2(
"ListRuleGroups",
Dict{String,Any}("Scope" => Scope);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_rule_groups(
Scope, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"ListRuleGroups",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Scope" => Scope), 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 TagInfoForResource for the specified resource. Tags are key:value pairs that
you can use to categorize and manage your resources, for purposes like billing. For
example, you might set the tag key to \"customer\" and the value to the customer name or
ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50
tags for a resource. You can tag the Amazon Web Services resources that you manage through
WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags
through the WAF console.
# 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:
- `"Limit"`: The maximum number of objects that you want WAF to return for this request. If
more objects are available, in the response, WAF provides a NextMarker value that you can
use in a subsequent call to get the next batch of objects.
- `"NextMarker"`: When you request a list of objects with a Limit setting, if the number of
objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the
prior call in your next request.
"""
function list_tags_for_resource(
ResourceARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"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 wafv2(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceARN" => ResourceARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_web_acls(scope)
list_web_acls(scope, params::Dict{String,<:Any})
Retrieves an array of WebACLSummary objects for the web ACLs that you manage.
# Arguments
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of objects that you want WAF to return for this request. If
more objects are available, in the response, WAF provides a NextMarker value that you can
use in a subsequent call to get the next batch of objects.
- `"NextMarker"`: When you request a list of objects with a Limit setting, if the number of
objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the
prior call in your next request.
"""
function list_web_acls(Scope; aws_config::AbstractAWSConfig=global_aws_config())
return wafv2(
"ListWebACLs",
Dict{String,Any}("Scope" => Scope);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_web_acls(
Scope, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"ListWebACLs",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Scope" => Scope), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_logging_configuration(logging_configuration)
put_logging_configuration(logging_configuration, params::Dict{String,<:Any})
Enables the specified LoggingConfiguration, to start logging from a web ACL, according to
the configuration provided. This operation completely replaces any mutable specifications
that you already have for a logging configuration with the ones that you provide to this
call. To modify an existing logging configuration, do the following: Retrieve it by
calling GetLoggingConfiguration Update its settings as needed Provide the complete
logging configuration specification to this call You can define one logging destination
per web ACL. You can access information about the traffic that WAF inspects using the
following steps: Create your logging destination. You can use an Amazon CloudWatch Logs
log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data
Firehose. The name that you give the destination must start with aws-waf-logs-. Depending
on the type of destination, you might need to configure additional settings or permissions.
For configuration requirements and pricing information for each destination type, see
Logging web ACL traffic in the WAF Developer Guide. Associate your logging destination to
your web ACL using a PutLoggingConfiguration request. When you successfully enable
logging using a PutLoggingConfiguration request, WAF creates an additional role or policy
that is required to write logs to the logging destination. For an Amazon CloudWatch Logs
log group, WAF creates a resource policy on the log group. For an Amazon S3 bucket, WAF
creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked
role. For additional information about web ACL logging, see Logging web ACL traffic
information in the WAF Developer Guide.
# Arguments
- `logging_configuration`:
"""
function put_logging_configuration(
LoggingConfiguration; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"PutLoggingConfiguration",
Dict{String,Any}("LoggingConfiguration" => LoggingConfiguration);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_logging_configuration(
LoggingConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"PutLoggingConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LoggingConfiguration" => LoggingConfiguration),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_managed_rule_set_versions(id, lock_token, name, scope)
put_managed_rule_set_versions(id, lock_token, name, scope, params::Dict{String,<:Any})
Defines the versions of your managed rule set that you are offering to the customers.
Customers see your offerings as managed rule groups with versioning. This is intended for
use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web
Services Marketplace sellers. Vendors, you can use the managed rule set APIs to provide
controlled rollout of your versioned managed rule group offerings for your customers. The
APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and
UpdateManagedRuleSetVersionExpiryDate. Customers retrieve their managed rule group list by
calling ListAvailableManagedRuleGroups. The name that you provide here for your managed
rule set is the name the customer sees for the corresponding managed rule group. Customers
can retrieve the available versions for a managed rule group by calling
ListAvailableManagedRuleGroupVersions. You provide a rule group specification for each
version. For each managed rule set, you must specify a version that you recommend using.
To initiate the expiration of a managed rule group version, use
UpdateManagedRuleSetVersionExpiryDate.
# Arguments
- `id`: A unique identifier for the managed rule set. The ID is returned in the responses
to commands like list. You provide it to operations like get and update.
- `lock_token`: A token used for optimistic locking. WAF returns a token to your get and
list requests, to mark the state of the entity at the time of the request. To make changes
to the entity associated with the token, you provide the token to operations like update
and delete. WAF uses the token to ensure that no changes have been made to the entity since
you last retrieved it. If a change has been made, the update fails with a
WAFOptimisticLockException. If this happens, perform another get, and use the new token
returned by that operation.
- `name`: The name of the managed rule set. You use this, along with the rule set ID, to
identify the rule set. This name is assigned to the corresponding managed rule group, which
your customers can access and use.
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"RecommendedVersion"`: The version of the named managed rule group that you'd like your
customers to choose, from among your version offerings.
- `"VersionsToPublish"`: The versions of the named managed rule group that you want to
offer to your customers.
"""
function put_managed_rule_set_versions(
Id, LockToken, Name, Scope; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"PutManagedRuleSetVersions",
Dict{String,Any}(
"Id" => Id, "LockToken" => LockToken, "Name" => Name, "Scope" => Scope
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_managed_rule_set_versions(
Id,
LockToken,
Name,
Scope,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"PutManagedRuleSetVersions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Id" => Id, "LockToken" => LockToken, "Name" => Name, "Scope" => Scope
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_permission_policy(policy, resource_arn)
put_permission_policy(policy, resource_arn, params::Dict{String,<:Any})
Attaches an IAM policy to the specified resource. Use this to share a rule group across
accounts. You must be the owner of the rule group to perform this operation. This action is
subject to the following restrictions: You can attach only one policy with each
PutPermissionPolicy request. The ARN in the request must be a valid WAF RuleGroup ARN and
the rule group must exist in the same Region. The user making the request must be the
owner of the rule group.
# Arguments
- `policy`: The policy to attach to the specified rule group. The policy specifications
must conform to the following: The policy must be composed using IAM Policy version
2012-10-17. The policy must include specifications for Effect, Action, and Principal.
Effect must specify Allow. Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL,
and wafv2:PutFirewallManagerRuleGroups and may optionally specify wafv2:GetRuleGroup. WAF
rejects any extra actions or wildcard actions in the policy. The policy must not include
a Resource parameter. For more information, see IAM Policies.
- `resource_arn`: The Amazon Resource Name (ARN) of the RuleGroup to which you want to
attach the policy.
"""
function put_permission_policy(
Policy, ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"PutPermissionPolicy",
Dict{String,Any}("Policy" => Policy, "ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_permission_policy(
Policy,
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"PutPermissionPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Policy" => Policy, "ResourceArn" => ResourceArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Associates tags with the specified Amazon Web Services resource. Tags are key:value pairs
that you can use to categorize and manage your resources, for purposes like billing. For
example, you might set the tag key to \"customer\" and the value to the customer name or
ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50
tags for a resource. You can tag the Amazon Web Services resources that you manage through
WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags
through the WAF console.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
- `tags`: An array of key:value pairs to associate with the resource.
"""
function tag_resource(ResourceARN, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return wafv2(
"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 wafv2(
"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})
Disassociates tags from an Amazon Web Services resource. Tags are key:value pairs that you
can associate with Amazon Web Services resources. For example, the tag key might be
\"customer\" and the tag value might be \"companyA.\" You can specify one or more tags to
add to each container. You can add up to 50 tags to each Amazon Web Services resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
- `tag_keys`: An array of keys identifying the tags to disassociate from the resource.
"""
function untag_resource(
ResourceARN, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"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 wafv2(
"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_ipset(addresses, id, lock_token, name, scope)
update_ipset(addresses, id, lock_token, name, scope, params::Dict{String,<:Any})
Updates the specified IPSet. This operation completely replaces the mutable
specifications that you already have for the IP set with the ones that you provide to this
call. To modify an IP set, do the following: Retrieve it by calling GetIPSet Update
its settings as needed Provide the complete IP set specification to this call
Temporary inconsistencies during updates When you create or change a web ACL or other WAF
resources, the changes take a small amount of time to propagate to all areas where the
resources are stored. The propagation time can be from a few seconds to a number of
minutes. The following are examples of the temporary inconsistencies that you might notice
during change propagation: After you create a web ACL, if you try to associate it with a
resource, you might get an exception indicating that the web ACL is unavailable. After
you add a rule group to a web ACL, the new rule group rules might be in effect in one area
where the web ACL is used and not in another. After you change a rule action setting, you
might see the old action in some places and the new action in others. After you add an
IP address to an IP set that is in use in a blocking rule, the new address might be blocked
in one area while still allowed in another.
# Arguments
- `addresses`: Contains an array of strings that specifies zero or more IP addresses or
blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses
must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all
IPv4 and IPv6 CIDR ranges except for /0. Example address strings: For requests that
originated from the IP address 192.0.2.44, specify 192.0.2.44/32. For requests that
originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24. For
requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111,
specify 1111:0000:0000:0000:0000:0000:0000:0111/128. For requests that originated from IP
addresses 1111:0000:0000:0000:0000:0000:0000:0000 to
1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
1111:0000:0000:0000:0000:0000:0000:0000/64. For more information about CIDR notation, see
the Wikipedia entry Classless Inter-Domain Routing. Example JSON Addresses specifications:
Empty array: \"Addresses\": [] Array with one address: \"Addresses\":
[\"192.0.2.44/32\"] Array with three addresses: \"Addresses\": [\"192.0.2.44/32\",
\"192.0.2.0/24\", \"192.0.0.0/16\"] INVALID specification: \"Addresses\": [\"\"] INVALID
- `id`: A unique identifier for the set. This ID is returned in the responses to create and
list commands. You provide it to operations like update and delete.
- `lock_token`: A token used for optimistic locking. WAF returns a token to your get and
list requests, to mark the state of the entity at the time of the request. To make changes
to the entity associated with the token, you provide the token to operations like update
and delete. WAF uses the token to ensure that no changes have been made to the entity since
you last retrieved it. If a change has been made, the update fails with a
WAFOptimisticLockException. If this happens, perform another get, and use the new token
returned by that operation.
- `name`: The name of the IP set. You cannot change the name of an IPSet after you create
it.
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the IP set that helps with identification.
"""
function update_ipset(
Addresses, Id, LockToken, Name, Scope; aws_config::AbstractAWSConfig=global_aws_config()
)
return wafv2(
"UpdateIPSet",
Dict{String,Any}(
"Addresses" => Addresses,
"Id" => Id,
"LockToken" => LockToken,
"Name" => Name,
"Scope" => Scope,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_ipset(
Addresses,
Id,
LockToken,
Name,
Scope,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"UpdateIPSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Addresses" => Addresses,
"Id" => Id,
"LockToken" => LockToken,
"Name" => Name,
"Scope" => Scope,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_managed_rule_set_version_expiry_date(expiry_timestamp, id, lock_token, name, scope, version_to_expire)
update_managed_rule_set_version_expiry_date(expiry_timestamp, id, lock_token, name, scope, version_to_expire, params::Dict{String,<:Any})
Updates the expiration information for your managed rule set. Use this to initiate the
expiration of a managed rule group version. After you initiate expiration for a version,
WAF excludes it from the response to ListAvailableManagedRuleGroupVersions for the managed
rule group. This is intended for use only by vendors of managed rule sets. Vendors are
Amazon Web Services and Amazon Web Services Marketplace sellers. Vendors, you can use the
managed rule set APIs to provide controlled rollout of your versioned managed rule group
offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet,
PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.
# Arguments
- `expiry_timestamp`: The time that you want the version to expire. Times are in
Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For
example, \"2016-09-27T14:50Z\".
- `id`: A unique identifier for the managed rule set. The ID is returned in the responses
to commands like list. You provide it to operations like get and update.
- `lock_token`: A token used for optimistic locking. WAF returns a token to your get and
list requests, to mark the state of the entity at the time of the request. To make changes
to the entity associated with the token, you provide the token to operations like update
and delete. WAF uses the token to ensure that no changes have been made to the entity since
you last retrieved it. If a change has been made, the update fails with a
WAFOptimisticLockException. If this happens, perform another get, and use the new token
returned by that operation.
- `name`: The name of the managed rule set. You use this, along with the rule set ID, to
identify the rule set. This name is assigned to the corresponding managed rule group, which
your customers can access and use.
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
- `version_to_expire`: The version that you want to remove from your list of offerings for
the named managed rule group.
"""
function update_managed_rule_set_version_expiry_date(
ExpiryTimestamp,
Id,
LockToken,
Name,
Scope,
VersionToExpire;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"UpdateManagedRuleSetVersionExpiryDate",
Dict{String,Any}(
"ExpiryTimestamp" => ExpiryTimestamp,
"Id" => Id,
"LockToken" => LockToken,
"Name" => Name,
"Scope" => Scope,
"VersionToExpire" => VersionToExpire,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_managed_rule_set_version_expiry_date(
ExpiryTimestamp,
Id,
LockToken,
Name,
Scope,
VersionToExpire,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"UpdateManagedRuleSetVersionExpiryDate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ExpiryTimestamp" => ExpiryTimestamp,
"Id" => Id,
"LockToken" => LockToken,
"Name" => Name,
"Scope" => Scope,
"VersionToExpire" => VersionToExpire,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_regex_pattern_set(id, lock_token, name, regular_expression_list, scope)
update_regex_pattern_set(id, lock_token, name, regular_expression_list, scope, params::Dict{String,<:Any})
Updates the specified RegexPatternSet. This operation completely replaces the mutable
specifications that you already have for the regex pattern set with the ones that you
provide to this call. To modify a regex pattern set, do the following: Retrieve it by
calling GetRegexPatternSet Update its settings as needed Provide the complete regex
pattern set specification to this call Temporary inconsistencies during updates When
you create or change a web ACL or other WAF resources, the changes take a small amount of
time to propagate to all areas where the resources are stored. The propagation time can be
from a few seconds to a number of minutes. The following are examples of the temporary
inconsistencies that you might notice during change propagation: After you create a web
ACL, if you try to associate it with a resource, you might get an exception indicating that
the web ACL is unavailable. After you add a rule group to a web ACL, the new rule group
rules might be in effect in one area where the web ACL is used and not in another. After
you change a rule action setting, you might see the old action in some places and the new
action in others. After you add an IP address to an IP set that is in use in a blocking
rule, the new address might be blocked in one area while still allowed in another.
# Arguments
- `id`: A unique identifier for the set. This ID is returned in the responses to create and
list commands. You provide it to operations like update and delete.
- `lock_token`: A token used for optimistic locking. WAF returns a token to your get and
list requests, to mark the state of the entity at the time of the request. To make changes
to the entity associated with the token, you provide the token to operations like update
and delete. WAF uses the token to ensure that no changes have been made to the entity since
you last retrieved it. If a change has been made, the update fails with a
WAFOptimisticLockException. If this happens, perform another get, and use the new token
returned by that operation.
- `name`: The name of the set. You cannot change the name after you create the set.
- `regular_expression_list`:
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the set that helps with identification.
"""
function update_regex_pattern_set(
Id,
LockToken,
Name,
RegularExpressionList,
Scope;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"UpdateRegexPatternSet",
Dict{String,Any}(
"Id" => Id,
"LockToken" => LockToken,
"Name" => Name,
"RegularExpressionList" => RegularExpressionList,
"Scope" => Scope,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_regex_pattern_set(
Id,
LockToken,
Name,
RegularExpressionList,
Scope,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"UpdateRegexPatternSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Id" => Id,
"LockToken" => LockToken,
"Name" => Name,
"RegularExpressionList" => RegularExpressionList,
"Scope" => Scope,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_rule_group(id, lock_token, name, scope, visibility_config)
update_rule_group(id, lock_token, name, scope, visibility_config, params::Dict{String,<:Any})
Updates the specified RuleGroup. This operation completely replaces the mutable
specifications that you already have for the rule group with the ones that you provide to
this call. To modify a rule group, do the following: Retrieve it by calling
GetRuleGroup Update its settings as needed Provide the complete rule group
specification to this call A rule group defines a collection of rules to inspect and
control web requests that you can use in a WebACL. When you create a rule group, you define
an immutable capacity limit. If you update a rule group, you must stay within the capacity.
This allows others to reuse the rule group with confidence in its capacity requirements.
Temporary inconsistencies during updates When you create or change a web ACL or other WAF
resources, the changes take a small amount of time to propagate to all areas where the
resources are stored. The propagation time can be from a few seconds to a number of
minutes. The following are examples of the temporary inconsistencies that you might notice
during change propagation: After you create a web ACL, if you try to associate it with a
resource, you might get an exception indicating that the web ACL is unavailable. After
you add a rule group to a web ACL, the new rule group rules might be in effect in one area
where the web ACL is used and not in another. After you change a rule action setting, you
might see the old action in some places and the new action in others. After you add an
IP address to an IP set that is in use in a blocking rule, the new address might be blocked
in one area while still allowed in another.
# Arguments
- `id`: A unique identifier for the rule group. This ID is returned in the responses to
create and list commands. You provide it to operations like update and delete.
- `lock_token`: A token used for optimistic locking. WAF returns a token to your get and
list requests, to mark the state of the entity at the time of the request. To make changes
to the entity associated with the token, you provide the token to operations like update
and delete. WAF uses the token to ensure that no changes have been made to the entity since
you last retrieved it. If a change has been made, the update fails with a
WAFOptimisticLockException. If this happens, perform another get, and use the new token
returned by that operation.
- `name`: The name of the rule group. You cannot change the name of a rule group after you
create it.
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
- `visibility_config`: Defines and enables Amazon CloudWatch metrics and web request sample
collection.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CustomResponseBodies"`: A map of custom response keys and content bodies. When you
create a rule with a block action, you can send a custom response to the web request. You
define these for the rule group, and then use them in the rules that you define in the rule
group. For information about customizing web requests and responses, see Customizing web
requests and responses in WAF in the WAF Developer Guide. For information about the limits
on count and size for custom request and response settings, see WAF quotas in the WAF
Developer Guide.
- `"Description"`: A description of the rule group that helps with identification.
- `"Rules"`: The Rule statements used to identify the web requests that you want to manage.
Each rule includes one top-level statement that WAF uses to identify matching web requests,
and parameters that govern how WAF handles them.
"""
function update_rule_group(
Id,
LockToken,
Name,
Scope,
VisibilityConfig;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"UpdateRuleGroup",
Dict{String,Any}(
"Id" => Id,
"LockToken" => LockToken,
"Name" => Name,
"Scope" => Scope,
"VisibilityConfig" => VisibilityConfig,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_rule_group(
Id,
LockToken,
Name,
Scope,
VisibilityConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"UpdateRuleGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Id" => Id,
"LockToken" => LockToken,
"Name" => Name,
"Scope" => Scope,
"VisibilityConfig" => VisibilityConfig,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_web_acl(default_action, id, lock_token, name, scope, visibility_config)
update_web_acl(default_action, id, lock_token, name, scope, visibility_config, params::Dict{String,<:Any})
Updates the specified WebACL. While updating a web ACL, WAF provides continuous coverage to
the resources that you have associated with the web ACL. This operation completely
replaces the mutable specifications that you already have for the web ACL with the ones
that you provide to this call. To modify a web ACL, do the following: Retrieve it by
calling GetWebACL Update its settings as needed Provide the complete web ACL
specification to this call A web ACL defines a collection of rules to use to inspect
and control web requests. Each rule has a statement that defines what to look for in web
requests and an action that WAF applies to requests that match the statement. In the web
ACL, you assign a default action to take (allow, block) for any request that does not match
any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup,
and managed rule group. You can associate a web ACL with one or more Amazon Web Services
resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API
Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito
user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
Temporary inconsistencies during updates When you create or change a web ACL or other WAF
resources, the changes take a small amount of time to propagate to all areas where the
resources are stored. The propagation time can be from a few seconds to a number of
minutes. The following are examples of the temporary inconsistencies that you might notice
during change propagation: After you create a web ACL, if you try to associate it with a
resource, you might get an exception indicating that the web ACL is unavailable. After
you add a rule group to a web ACL, the new rule group rules might be in effect in one area
where the web ACL is used and not in another. After you change a rule action setting, you
might see the old action in some places and the new action in others. After you add an
IP address to an IP set that is in use in a blocking rule, the new address might be blocked
in one area while still allowed in another.
# Arguments
- `default_action`: The action to perform if none of the Rules contained in the WebACL
match.
- `id`: The unique identifier for the web ACL. This ID is returned in the responses to
create and list commands. You provide it to operations like update and delete.
- `lock_token`: A token used for optimistic locking. WAF returns a token to your get and
list requests, to mark the state of the entity at the time of the request. To make changes
to the entity associated with the token, you provide the token to operations like update
and delete. WAF uses the token to ensure that no changes have been made to the entity since
you last retrieved it. If a change has been made, the update fails with a
WAFOptimisticLockException. If this happens, perform another get, and use the new token
returned by that operation.
- `name`: The name of the web ACL. You cannot change the name of a web ACL after you create
it.
- `scope`: Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load Balancer (ALB), an
Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App
Runner service, or an Amazon Web Services Verified Access instance. To work with
CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI -
Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
--region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1.
- `visibility_config`: Defines and enables Amazon CloudWatch metrics and web request sample
collection.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AssociationConfig"`: Specifies custom configurations for the associations between the
web ACL and protected resources. Use this to customize the maximum size of the request
body that your protected resources forward to WAF for inspection. You can customize this
setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access
resources. The default setting is 16 KB (16,384 bytes). You are charged additional fees
when your protected resources forward body sizes that are larger than the default. For more
information, see WAF Pricing. For Application Load Balancer and AppSync, the limit is
fixed at 8 KB (8,192 bytes).
- `"CaptchaConfig"`: Specifies how WAF should handle CAPTCHA evaluations for rules that
don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its
default settings for CaptchaConfig.
- `"ChallengeConfig"`: Specifies how WAF should handle challenge evaluations for rules that
don't have their own ChallengeConfig settings. If you don't specify this, WAF uses its
default settings for ChallengeConfig.
- `"CustomResponseBodies"`: A map of custom response keys and content bodies. When you
create a rule with a block action, you can send a custom response to the web request. You
define these for the web ACL, and then use them in the rules and default actions that you
define in the web ACL. For information about customizing web requests and responses, see
Customizing web requests and responses in WAF in the WAF Developer Guide. For information
about the limits on count and size for custom request and response settings, see WAF quotas
in the WAF Developer Guide.
- `"Description"`: A description of the web ACL that helps with identification.
- `"Rules"`: The Rule statements used to identify the web requests that you want to manage.
Each rule includes one top-level statement that WAF uses to identify matching web requests,
and parameters that govern how WAF handles them.
- `"TokenDomains"`: Specifies the domains that WAF should accept in a web request token.
This enables the use of tokens across multiple protected websites. When WAF provides a
token, it uses the domain of the Amazon Web Services resource that the web ACL is
protecting. If you don't specify a list of token domains, WAF accepts tokens only for the
domain of the protected resource. With a token domain list, WAF accepts the resource's host
domain plus all domains in the token domain list, including their prefixed subdomains.
Example JSON: \"TokenDomains\": { \"mywebsite.com\", \"myotherwebsite.com\" } Public
suffixes aren't allowed. For example, you can't use gov.au or co.uk as token domains.
"""
function update_web_acl(
DefaultAction,
Id,
LockToken,
Name,
Scope,
VisibilityConfig;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"UpdateWebACL",
Dict{String,Any}(
"DefaultAction" => DefaultAction,
"Id" => Id,
"LockToken" => LockToken,
"Name" => Name,
"Scope" => Scope,
"VisibilityConfig" => VisibilityConfig,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_web_acl(
DefaultAction,
Id,
LockToken,
Name,
Scope,
VisibilityConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wafv2(
"UpdateWebACL",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DefaultAction" => DefaultAction,
"Id" => Id,
"LockToken" => LockToken,
"Name" => Name,
"Scope" => Scope,
"VisibilityConfig" => VisibilityConfig,
),
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 | 92137 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: wellarchitected
using AWS.Compat
using AWS.UUIDs
"""
associate_lenses(lens_aliases, workload_id)
associate_lenses(lens_aliases, workload_id, params::Dict{String,<:Any})
Associate a lens to a workload. Up to 10 lenses can be associated with a workload in a
single API operation. A maximum of 20 lenses can be associated with a workload.
Disclaimer By accessing and/or applying custom lenses created by another Amazon Web
Services user or account, you acknowledge that custom lenses created by other users and
shared with you are Third Party Content as defined in the Amazon Web Services Customer
Agreement.
# Arguments
- `lens_aliases`:
- `workload_id`:
"""
function associate_lenses(
LensAliases, WorkloadId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"PATCH",
"/workloads/$(WorkloadId)/associateLenses",
Dict{String,Any}("LensAliases" => LensAliases);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_lenses(
LensAliases,
WorkloadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"PATCH",
"/workloads/$(WorkloadId)/associateLenses",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("LensAliases" => LensAliases), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_profiles(profile_arns, workload_id)
associate_profiles(profile_arns, workload_id, params::Dict{String,<:Any})
Associate a profile with a workload.
# Arguments
- `profile_arns`: The list of profile ARNs to associate with the workload.
- `workload_id`:
"""
function associate_profiles(
ProfileArns, WorkloadId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"PATCH",
"/workloads/$(WorkloadId)/associateProfiles",
Dict{String,Any}("ProfileArns" => ProfileArns);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_profiles(
ProfileArns,
WorkloadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"PATCH",
"/workloads/$(WorkloadId)/associateProfiles",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ProfileArns" => ProfileArns), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_lens_share(client_request_token, lens_alias, shared_with)
create_lens_share(client_request_token, lens_alias, shared_with, params::Dict{String,<:Any})
Create a lens share. The owner of a lens can share it with other Amazon Web Services
accounts, users, an organization, and organizational units (OUs) in the same Amazon Web
Services Region. Lenses provided by Amazon Web Services (Amazon Web Services Official
Content) cannot be shared. Shared access to a lens is not removed until the lens
invitation is deleted. If you share a lens with an organization or OU, all accounts in the
organization or OU are granted access to the lens. For more information, see Sharing a
custom lens in the Well-Architected Tool User Guide. Disclaimer By sharing your custom
lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services
will make your custom lenses available to those other accounts. Those other accounts may
continue to access and use your shared custom lenses even if you delete the custom lenses
from your own Amazon Web Services account or terminate your Amazon Web Services account.
# Arguments
- `client_request_token`:
- `lens_alias`:
- `shared_with`:
"""
function create_lens_share(
ClientRequestToken,
LensAlias,
SharedWith;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"POST",
"/lenses/$(LensAlias)/shares",
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken, "SharedWith" => SharedWith
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_lens_share(
ClientRequestToken,
LensAlias,
SharedWith,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"POST",
"/lenses/$(LensAlias)/shares",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken, "SharedWith" => SharedWith
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_lens_version(client_request_token, lens_alias, lens_version)
create_lens_version(client_request_token, lens_alias, lens_version, params::Dict{String,<:Any})
Create a new lens version. A lens can have up to 100 versions. Use this operation to
publish a new lens version after you have imported a lens. The LensAlias is used to
identify the lens to be published. The owner of a lens can share the lens with other Amazon
Web Services accounts and users in the same Amazon Web Services Region. Only the owner of a
lens can delete it.
# Arguments
- `client_request_token`:
- `lens_alias`:
- `lens_version`: The version of the lens being created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IsMajorVersion"`: Set to true if this new major lens version.
"""
function create_lens_version(
ClientRequestToken,
LensAlias,
LensVersion;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"POST",
"/lenses/$(LensAlias)/versions",
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken, "LensVersion" => LensVersion
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_lens_version(
ClientRequestToken,
LensAlias,
LensVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"POST",
"/lenses/$(LensAlias)/versions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken, "LensVersion" => LensVersion
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_milestone(client_request_token, milestone_name, workload_id)
create_milestone(client_request_token, milestone_name, workload_id, params::Dict{String,<:Any})
Create a milestone for an existing workload.
# Arguments
- `client_request_token`:
- `milestone_name`:
- `workload_id`:
"""
function create_milestone(
ClientRequestToken,
MilestoneName,
WorkloadId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"POST",
"/workloads/$(WorkloadId)/milestones",
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken, "MilestoneName" => MilestoneName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_milestone(
ClientRequestToken,
MilestoneName,
WorkloadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"POST",
"/workloads/$(WorkloadId)/milestones",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken,
"MilestoneName" => MilestoneName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_profile(client_request_token, profile_description, profile_name, profile_questions)
create_profile(client_request_token, profile_description, profile_name, profile_questions, params::Dict{String,<:Any})
Create a profile.
# Arguments
- `client_request_token`:
- `profile_description`: The profile description.
- `profile_name`: Name of the profile.
- `profile_questions`: The profile questions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: The tags assigned to the profile.
"""
function create_profile(
ClientRequestToken,
ProfileDescription,
ProfileName,
ProfileQuestions;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"POST",
"/profiles",
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken,
"ProfileDescription" => ProfileDescription,
"ProfileName" => ProfileName,
"ProfileQuestions" => ProfileQuestions,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_profile(
ClientRequestToken,
ProfileDescription,
ProfileName,
ProfileQuestions,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"POST",
"/profiles",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken,
"ProfileDescription" => ProfileDescription,
"ProfileName" => ProfileName,
"ProfileQuestions" => ProfileQuestions,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_profile_share(client_request_token, profile_arn, shared_with)
create_profile_share(client_request_token, profile_arn, shared_with, params::Dict{String,<:Any})
Create a profile share.
# Arguments
- `client_request_token`:
- `profile_arn`: The profile ARN.
- `shared_with`:
"""
function create_profile_share(
ClientRequestToken,
ProfileArn,
SharedWith;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"POST",
"/profiles/$(ProfileArn)/shares",
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken, "SharedWith" => SharedWith
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_profile_share(
ClientRequestToken,
ProfileArn,
SharedWith,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"POST",
"/profiles/$(ProfileArn)/shares",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken, "SharedWith" => SharedWith
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_review_template(client_request_token, description, lenses, template_name)
create_review_template(client_request_token, description, lenses, template_name, params::Dict{String,<:Any})
Create a review template. Disclaimer Do not include or gather personal identifiable
information (PII) of end users or other identifiable individuals in or via your review
templates. If your review template or those shared with you and used in your account do
include or collect PII you are responsible for: ensuring that the included PII is processed
in accordance with applicable law, providing adequate privacy notices, and obtaining
necessary consents for processing such data.
# Arguments
- `client_request_token`:
- `description`: The review template description.
- `lenses`: Lenses applied to the review template.
- `template_name`: Name of the review template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Notes"`:
- `"Tags"`: The tags assigned to the review template.
"""
function create_review_template(
ClientRequestToken,
Description,
Lenses,
TemplateName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"POST",
"/reviewTemplates",
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken,
"Description" => Description,
"Lenses" => Lenses,
"TemplateName" => TemplateName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_review_template(
ClientRequestToken,
Description,
Lenses,
TemplateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"POST",
"/reviewTemplates",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken,
"Description" => Description,
"Lenses" => Lenses,
"TemplateName" => TemplateName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_template_share(client_request_token, shared_with, template_arn)
create_template_share(client_request_token, shared_with, template_arn, params::Dict{String,<:Any})
Create a review template share. The owner of a review template can share it with other
Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the
same Amazon Web Services Region. Shared access to a review template is not removed until
the review template share invitation is deleted. If you share a review template with an
organization or OU, all accounts in the organization or OU are granted access to the review
template. Disclaimer By sharing your review template with other Amazon Web Services
accounts, you acknowledge that Amazon Web Services will make your review template available
to those other accounts.
# Arguments
- `client_request_token`:
- `shared_with`:
- `template_arn`: The review template ARN.
"""
function create_template_share(
ClientRequestToken,
SharedWith,
TemplateArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"POST",
"/templates/shares/$(TemplateArn)",
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken, "SharedWith" => SharedWith
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_template_share(
ClientRequestToken,
SharedWith,
TemplateArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"POST",
"/templates/shares/$(TemplateArn)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken, "SharedWith" => SharedWith
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_workload(client_request_token, description, environment, lenses, workload_name)
create_workload(client_request_token, description, environment, lenses, workload_name, params::Dict{String,<:Any})
Create a new workload. The owner of a workload can share the workload with other Amazon Web
Services accounts, users, an organization, and organizational units (OUs) in the same
Amazon Web Services Region. Only the owner of a workload can delete it. For more
information, see Defining a Workload in the Well-Architected Tool User Guide. Either
AwsRegions, NonAwsRegions, or both must be specified when creating a workload. You also
must specify ReviewOwner, even though the parameter is listed as not being required in the
following section. When creating a workload using a review template, you must have the
following IAM permissions: wellarchitected:GetReviewTemplate
wellarchitected:GetReviewTemplateAnswer wellarchitected:ListReviewTemplateAnswers
wellarchitected:GetReviewTemplateLensReview
# Arguments
- `client_request_token`:
- `description`:
- `environment`:
- `lenses`:
- `workload_name`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccountIds"`:
- `"Applications"`: List of AppRegistry application ARNs associated to the workload.
- `"ArchitecturalDesign"`:
- `"AwsRegions"`:
- `"DiscoveryConfig"`: Well-Architected discovery configuration settings associated to the
workload.
- `"Industry"`:
- `"IndustryType"`:
- `"JiraConfiguration"`: Jira configuration settings when creating a workload.
- `"NonAwsRegions"`:
- `"Notes"`:
- `"PillarPriorities"`:
- `"ProfileArns"`: The list of profile ARNs associated with the workload.
- `"ReviewOwner"`:
- `"ReviewTemplateArns"`: The list of review template ARNs to associate with the workload.
- `"Tags"`: The tags to be associated with the workload.
"""
function create_workload(
ClientRequestToken,
Description,
Environment,
Lenses,
WorkloadName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"POST",
"/workloads",
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken,
"Description" => Description,
"Environment" => Environment,
"Lenses" => Lenses,
"WorkloadName" => WorkloadName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_workload(
ClientRequestToken,
Description,
Environment,
Lenses,
WorkloadName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"POST",
"/workloads",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken,
"Description" => Description,
"Environment" => Environment,
"Lenses" => Lenses,
"WorkloadName" => WorkloadName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_workload_share(client_request_token, permission_type, shared_with, workload_id)
create_workload_share(client_request_token, permission_type, shared_with, workload_id, params::Dict{String,<:Any})
Create a workload share. The owner of a workload can share it with other Amazon Web
Services accounts and users in the same Amazon Web Services Region. Shared access to a
workload is not removed until the workload invitation is deleted. If you share a workload
with an organization or OU, all accounts in the organization or OU are granted access to
the workload. For more information, see Sharing a workload in the Well-Architected Tool
User Guide.
# Arguments
- `client_request_token`:
- `permission_type`:
- `shared_with`:
- `workload_id`:
"""
function create_workload_share(
ClientRequestToken,
PermissionType,
SharedWith,
WorkloadId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"POST",
"/workloads/$(WorkloadId)/shares",
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken,
"PermissionType" => PermissionType,
"SharedWith" => SharedWith,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_workload_share(
ClientRequestToken,
PermissionType,
SharedWith,
WorkloadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"POST",
"/workloads/$(WorkloadId)/shares",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken,
"PermissionType" => PermissionType,
"SharedWith" => SharedWith,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_lens(client_request_token, lens_alias, lens_status)
delete_lens(client_request_token, lens_alias, lens_status, params::Dict{String,<:Any})
Delete an existing lens. Only the owner of a lens can delete it. After the lens is deleted,
Amazon Web Services accounts and users that you shared the lens with can continue to use
it, but they will no longer be able to apply it to new workloads. Disclaimer By sharing
your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web
Services will make your custom lenses available to those other accounts. Those other
accounts may continue to access and use your shared custom lenses even if you delete the
custom lenses from your own Amazon Web Services account or terminate your Amazon Web
Services account.
# Arguments
- `client_request_token`:
- `lens_alias`:
- `lens_status`: The status of the lens to be deleted.
"""
function delete_lens(
ClientRequestToken,
LensAlias,
LensStatus;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"DELETE",
"/lenses/$(LensAlias)",
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken, "LensStatus" => LensStatus
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_lens(
ClientRequestToken,
LensAlias,
LensStatus,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"DELETE",
"/lenses/$(LensAlias)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken, "LensStatus" => LensStatus
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_lens_share(client_request_token, lens_alias, share_id)
delete_lens_share(client_request_token, lens_alias, share_id, params::Dict{String,<:Any})
Delete a lens share. After the lens share is deleted, Amazon Web Services accounts, users,
organizations, and organizational units (OUs) that you shared the lens with can continue to
use it, but they will no longer be able to apply it to new workloads. Disclaimer By
sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that
Amazon Web Services will make your custom lenses available to those other accounts. Those
other accounts may continue to access and use your shared custom lenses even if you delete
the custom lenses from your own Amazon Web Services account or terminate your Amazon Web
Services account.
# Arguments
- `client_request_token`:
- `lens_alias`:
- `share_id`:
"""
function delete_lens_share(
ClientRequestToken,
LensAlias,
ShareId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"DELETE",
"/lenses/$(LensAlias)/shares/$(ShareId)",
Dict{String,Any}("ClientRequestToken" => ClientRequestToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_lens_share(
ClientRequestToken,
LensAlias,
ShareId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"DELETE",
"/lenses/$(LensAlias)/shares/$(ShareId)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ClientRequestToken" => ClientRequestToken), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_profile(client_request_token, profile_arn)
delete_profile(client_request_token, profile_arn, params::Dict{String,<:Any})
Delete a profile. Disclaimer By sharing your profile with other Amazon Web Services
accounts, you acknowledge that Amazon Web Services will make your profile available to
those other accounts. Those other accounts may continue to access and use your shared
profile even if you delete the profile from your own Amazon Web Services account or
terminate your Amazon Web Services account.
# Arguments
- `client_request_token`:
- `profile_arn`: The profile ARN.
"""
function delete_profile(
ClientRequestToken, ProfileArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"DELETE",
"/profiles/$(ProfileArn)",
Dict{String,Any}("ClientRequestToken" => ClientRequestToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_profile(
ClientRequestToken,
ProfileArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"DELETE",
"/profiles/$(ProfileArn)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ClientRequestToken" => ClientRequestToken), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_profile_share(client_request_token, profile_arn, share_id)
delete_profile_share(client_request_token, profile_arn, share_id, params::Dict{String,<:Any})
Delete a profile share.
# Arguments
- `client_request_token`:
- `profile_arn`: The profile ARN.
- `share_id`:
"""
function delete_profile_share(
ClientRequestToken,
ProfileArn,
ShareId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"DELETE",
"/profiles/$(ProfileArn)/shares/$(ShareId)",
Dict{String,Any}("ClientRequestToken" => ClientRequestToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_profile_share(
ClientRequestToken,
ProfileArn,
ShareId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"DELETE",
"/profiles/$(ProfileArn)/shares/$(ShareId)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ClientRequestToken" => ClientRequestToken), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_review_template(client_request_token, template_arn)
delete_review_template(client_request_token, template_arn, params::Dict{String,<:Any})
Delete a review template. Only the owner of a review template can delete it. After the
review template is deleted, Amazon Web Services accounts, users, organizations, and
organizational units (OUs) that you shared the review template with will no longer be able
to apply it to new workloads.
# Arguments
- `client_request_token`:
- `template_arn`: The review template ARN.
"""
function delete_review_template(
ClientRequestToken, TemplateArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"DELETE",
"/reviewTemplates/$(TemplateArn)",
Dict{String,Any}("ClientRequestToken" => ClientRequestToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_review_template(
ClientRequestToken,
TemplateArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"DELETE",
"/reviewTemplates/$(TemplateArn)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ClientRequestToken" => ClientRequestToken), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_template_share(client_request_token, share_id, template_arn)
delete_template_share(client_request_token, share_id, template_arn, params::Dict{String,<:Any})
Delete a review template share. After the review template share is deleted, Amazon Web
Services accounts, users, organizations, and organizational units (OUs) that you shared the
review template with will no longer be able to apply it to new workloads.
# Arguments
- `client_request_token`:
- `share_id`:
- `template_arn`: The review template ARN.
"""
function delete_template_share(
ClientRequestToken,
ShareId,
TemplateArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"DELETE",
"/templates/shares/$(TemplateArn)/$(ShareId)",
Dict{String,Any}("ClientRequestToken" => ClientRequestToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_template_share(
ClientRequestToken,
ShareId,
TemplateArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"DELETE",
"/templates/shares/$(TemplateArn)/$(ShareId)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ClientRequestToken" => ClientRequestToken), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_workload(client_request_token, workload_id)
delete_workload(client_request_token, workload_id, params::Dict{String,<:Any})
Delete an existing workload.
# Arguments
- `client_request_token`:
- `workload_id`:
"""
function delete_workload(
ClientRequestToken, WorkloadId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"DELETE",
"/workloads/$(WorkloadId)",
Dict{String,Any}("ClientRequestToken" => ClientRequestToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_workload(
ClientRequestToken,
WorkloadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"DELETE",
"/workloads/$(WorkloadId)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ClientRequestToken" => ClientRequestToken), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_workload_share(client_request_token, share_id, workload_id)
delete_workload_share(client_request_token, share_id, workload_id, params::Dict{String,<:Any})
Delete a workload share.
# Arguments
- `client_request_token`:
- `share_id`:
- `workload_id`:
"""
function delete_workload_share(
ClientRequestToken,
ShareId,
WorkloadId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"DELETE",
"/workloads/$(WorkloadId)/shares/$(ShareId)",
Dict{String,Any}("ClientRequestToken" => ClientRequestToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_workload_share(
ClientRequestToken,
ShareId,
WorkloadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"DELETE",
"/workloads/$(WorkloadId)/shares/$(ShareId)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ClientRequestToken" => ClientRequestToken), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_lenses(lens_aliases, workload_id)
disassociate_lenses(lens_aliases, workload_id, params::Dict{String,<:Any})
Disassociate a lens from a workload. Up to 10 lenses can be disassociated from a workload
in a single API operation. The Amazon Web Services Well-Architected Framework lens
(wellarchitected) cannot be removed from a workload.
# Arguments
- `lens_aliases`:
- `workload_id`:
"""
function disassociate_lenses(
LensAliases, WorkloadId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"PATCH",
"/workloads/$(WorkloadId)/disassociateLenses",
Dict{String,Any}("LensAliases" => LensAliases);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_lenses(
LensAliases,
WorkloadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"PATCH",
"/workloads/$(WorkloadId)/disassociateLenses",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("LensAliases" => LensAliases), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_profiles(profile_arns, workload_id)
disassociate_profiles(profile_arns, workload_id, params::Dict{String,<:Any})
Disassociate a profile from a workload.
# Arguments
- `profile_arns`: The list of profile ARNs to disassociate from the workload.
- `workload_id`:
"""
function disassociate_profiles(
ProfileArns, WorkloadId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"PATCH",
"/workloads/$(WorkloadId)/disassociateProfiles",
Dict{String,Any}("ProfileArns" => ProfileArns);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_profiles(
ProfileArns,
WorkloadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"PATCH",
"/workloads/$(WorkloadId)/disassociateProfiles",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ProfileArns" => ProfileArns), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
export_lens(lens_alias)
export_lens(lens_alias, params::Dict{String,<:Any})
Export an existing lens. Only the owner of a lens can export it. Lenses provided by Amazon
Web Services (Amazon Web Services Official Content) cannot be exported. Lenses are defined
in JSON. For more information, see JSON format specification in the Well-Architected Tool
User Guide. Disclaimer Do not include or gather personal identifiable information (PII)
of end users or other identifiable individuals in or via your custom lenses. If your custom
lens or those shared with you and used in your account do include or collect PII you are
responsible for: ensuring that the included PII is processed in accordance with applicable
law, providing adequate privacy notices, and obtaining necessary consents for processing
such data.
# Arguments
- `lens_alias`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LensVersion"`: The lens version to be exported.
"""
function export_lens(LensAlias; aws_config::AbstractAWSConfig=global_aws_config())
return wellarchitected(
"GET",
"/lenses/$(LensAlias)/export";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function export_lens(
LensAlias,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"GET",
"/lenses/$(LensAlias)/export",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_answer(lens_alias, question_id, workload_id)
get_answer(lens_alias, question_id, workload_id, params::Dict{String,<:Any})
Get the answer to a specific question in a workload review.
# Arguments
- `lens_alias`:
- `question_id`:
- `workload_id`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MilestoneNumber"`:
"""
function get_answer(
LensAlias, QuestionId, WorkloadId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"GET",
"/workloads/$(WorkloadId)/lensReviews/$(LensAlias)/answers/$(QuestionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_answer(
LensAlias,
QuestionId,
WorkloadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"GET",
"/workloads/$(WorkloadId)/lensReviews/$(LensAlias)/answers/$(QuestionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_consolidated_report(format)
get_consolidated_report(format, params::Dict{String,<:Any})
Get a consolidated report of your workloads. You can optionally choose to include workloads
that have been shared with you.
# Arguments
- `format`: The format of the consolidated report. For PDF, Base64String is returned. For
JSON, Metrics is returned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IncludeSharedResources"`: Set to true to have shared resources included in the report.
- `"MaxResults"`: The maximum number of results to return for this request.
- `"NextToken"`:
"""
function get_consolidated_report(Format; aws_config::AbstractAWSConfig=global_aws_config())
return wellarchitected(
"GET",
"/consolidatedReport",
Dict{String,Any}("Format" => Format);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_consolidated_report(
Format, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"GET",
"/consolidatedReport",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Format" => Format), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_global_settings()
get_global_settings(params::Dict{String,<:Any})
Global settings for all workloads.
"""
function get_global_settings(; aws_config::AbstractAWSConfig=global_aws_config())
return wellarchitected(
"GET", "/global-settings"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_global_settings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"GET",
"/global-settings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_lens(lens_alias)
get_lens(lens_alias, params::Dict{String,<:Any})
Get an existing lens.
# Arguments
- `lens_alias`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LensVersion"`: The lens version to be retrieved.
"""
function get_lens(LensAlias; aws_config::AbstractAWSConfig=global_aws_config())
return wellarchitected(
"GET",
"/lenses/$(LensAlias)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_lens(
LensAlias,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"GET",
"/lenses/$(LensAlias)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_lens_review(lens_alias, workload_id)
get_lens_review(lens_alias, workload_id, params::Dict{String,<:Any})
Get lens review.
# Arguments
- `lens_alias`:
- `workload_id`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MilestoneNumber"`:
"""
function get_lens_review(
LensAlias, WorkloadId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"GET",
"/workloads/$(WorkloadId)/lensReviews/$(LensAlias)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_lens_review(
LensAlias,
WorkloadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"GET",
"/workloads/$(WorkloadId)/lensReviews/$(LensAlias)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_lens_review_report(lens_alias, workload_id)
get_lens_review_report(lens_alias, workload_id, params::Dict{String,<:Any})
Get lens review report.
# Arguments
- `lens_alias`:
- `workload_id`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MilestoneNumber"`:
"""
function get_lens_review_report(
LensAlias, WorkloadId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"GET",
"/workloads/$(WorkloadId)/lensReviews/$(LensAlias)/report";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_lens_review_report(
LensAlias,
WorkloadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"GET",
"/workloads/$(WorkloadId)/lensReviews/$(LensAlias)/report",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_lens_version_difference(lens_alias)
get_lens_version_difference(lens_alias, params::Dict{String,<:Any})
Get lens version differences.
# Arguments
- `lens_alias`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BaseLensVersion"`: The base version of the lens.
- `"TargetLensVersion"`: The lens version to target a difference for.
"""
function get_lens_version_difference(
LensAlias; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"GET",
"/lenses/$(LensAlias)/versionDifference";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_lens_version_difference(
LensAlias,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"GET",
"/lenses/$(LensAlias)/versionDifference",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_milestone(milestone_number, workload_id)
get_milestone(milestone_number, workload_id, params::Dict{String,<:Any})
Get a milestone for an existing workload.
# Arguments
- `milestone_number`:
- `workload_id`:
"""
function get_milestone(
MilestoneNumber, WorkloadId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"GET",
"/workloads/$(WorkloadId)/milestones/$(MilestoneNumber)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_milestone(
MilestoneNumber,
WorkloadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"GET",
"/workloads/$(WorkloadId)/milestones/$(MilestoneNumber)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_profile(profile_arn)
get_profile(profile_arn, params::Dict{String,<:Any})
Get profile information.
# Arguments
- `profile_arn`: The profile ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ProfileVersion"`: The profile version.
"""
function get_profile(ProfileArn; aws_config::AbstractAWSConfig=global_aws_config())
return wellarchitected(
"GET",
"/profiles/$(ProfileArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_profile(
ProfileArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"GET",
"/profiles/$(ProfileArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_profile_template()
get_profile_template(params::Dict{String,<:Any})
Get profile template.
"""
function get_profile_template(; aws_config::AbstractAWSConfig=global_aws_config())
return wellarchitected(
"GET", "/profileTemplate"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_profile_template(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"GET",
"/profileTemplate",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_review_template(template_arn)
get_review_template(template_arn, params::Dict{String,<:Any})
Get review template.
# Arguments
- `template_arn`: The review template ARN.
"""
function get_review_template(TemplateArn; aws_config::AbstractAWSConfig=global_aws_config())
return wellarchitected(
"GET",
"/reviewTemplates/$(TemplateArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_review_template(
TemplateArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"GET",
"/reviewTemplates/$(TemplateArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_review_template_answer(lens_alias, question_id, template_arn)
get_review_template_answer(lens_alias, question_id, template_arn, params::Dict{String,<:Any})
Get review template answer.
# Arguments
- `lens_alias`:
- `question_id`:
- `template_arn`: The review template ARN.
"""
function get_review_template_answer(
LensAlias, QuestionId, TemplateArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"GET",
"/reviewTemplates/$(TemplateArn)/lensReviews/$(LensAlias)/answers/$(QuestionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_review_template_answer(
LensAlias,
QuestionId,
TemplateArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"GET",
"/reviewTemplates/$(TemplateArn)/lensReviews/$(LensAlias)/answers/$(QuestionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_review_template_lens_review(lens_alias, template_arn)
get_review_template_lens_review(lens_alias, template_arn, params::Dict{String,<:Any})
Get a lens review associated with a review template.
# Arguments
- `lens_alias`:
- `template_arn`: The review template ARN.
"""
function get_review_template_lens_review(
LensAlias, TemplateArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"GET",
"/reviewTemplates/$(TemplateArn)/lensReviews/$(LensAlias)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_review_template_lens_review(
LensAlias,
TemplateArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"GET",
"/reviewTemplates/$(TemplateArn)/lensReviews/$(LensAlias)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_workload(workload_id)
get_workload(workload_id, params::Dict{String,<:Any})
Get an existing workload.
# Arguments
- `workload_id`:
"""
function get_workload(WorkloadId; aws_config::AbstractAWSConfig=global_aws_config())
return wellarchitected(
"GET",
"/workloads/$(WorkloadId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_workload(
WorkloadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"GET",
"/workloads/$(WorkloadId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
import_lens(client_request_token, jsonstring)
import_lens(client_request_token, jsonstring, params::Dict{String,<:Any})
Import a new custom lens or update an existing custom lens. To update an existing custom
lens, specify its ARN as the LensAlias. If no ARN is specified, a new custom lens is
created. The new or updated lens will have a status of DRAFT. The lens cannot be applied to
workloads or shared with other Amazon Web Services accounts until it's published with
CreateLensVersion. Lenses are defined in JSON. For more information, see JSON format
specification in the Well-Architected Tool User Guide. A custom lens cannot exceed 500 KB
in size. Disclaimer Do not include or gather personal identifiable information (PII) of
end users or other identifiable individuals in or via your custom lenses. If your custom
lens or those shared with you and used in your account do include or collect PII you are
responsible for: ensuring that the included PII is processed in accordance with applicable
law, providing adequate privacy notices, and obtaining necessary consents for processing
such data.
# Arguments
- `client_request_token`:
- `jsonstring`: The JSON representation of a lens.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LensAlias"`:
- `"Tags"`: Tags to associate to a lens.
"""
function import_lens(
ClientRequestToken, JSONString; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"PUT",
"/importLens",
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken, "JSONString" => JSONString
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function import_lens(
ClientRequestToken,
JSONString,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"PUT",
"/importLens",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken, "JSONString" => JSONString
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_answers(lens_alias, workload_id)
list_answers(lens_alias, workload_id, params::Dict{String,<:Any})
List of answers for a particular workload and lens.
# Arguments
- `lens_alias`:
- `workload_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 this request.
- `"MilestoneNumber"`:
- `"NextToken"`:
- `"PillarId"`:
- `"QuestionPriority"`: The priority of the question.
"""
function list_answers(
LensAlias, WorkloadId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"GET",
"/workloads/$(WorkloadId)/lensReviews/$(LensAlias)/answers";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_answers(
LensAlias,
WorkloadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"GET",
"/workloads/$(WorkloadId)/lensReviews/$(LensAlias)/answers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_check_details(choice_id, lens_arn, pillar_id, question_id, workload_id)
list_check_details(choice_id, lens_arn, pillar_id, question_id, workload_id, params::Dict{String,<:Any})
List of Trusted Advisor check details by account related to the workload.
# Arguments
- `choice_id`:
- `lens_arn`: Well-Architected Lens ARN.
- `pillar_id`:
- `question_id`:
- `workload_id`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`:
- `"NextToken"`:
"""
function list_check_details(
ChoiceId,
LensArn,
PillarId,
QuestionId,
WorkloadId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"POST",
"/workloads/$(WorkloadId)/checks",
Dict{String,Any}(
"ChoiceId" => ChoiceId,
"LensArn" => LensArn,
"PillarId" => PillarId,
"QuestionId" => QuestionId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_check_details(
ChoiceId,
LensArn,
PillarId,
QuestionId,
WorkloadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"POST",
"/workloads/$(WorkloadId)/checks",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChoiceId" => ChoiceId,
"LensArn" => LensArn,
"PillarId" => PillarId,
"QuestionId" => QuestionId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_check_summaries(choice_id, lens_arn, pillar_id, question_id, workload_id)
list_check_summaries(choice_id, lens_arn, pillar_id, question_id, workload_id, params::Dict{String,<:Any})
List of Trusted Advisor checks summarized for all accounts related to the workload.
# Arguments
- `choice_id`:
- `lens_arn`: Well-Architected Lens ARN.
- `pillar_id`:
- `question_id`:
- `workload_id`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`:
- `"NextToken"`:
"""
function list_check_summaries(
ChoiceId,
LensArn,
PillarId,
QuestionId,
WorkloadId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"POST",
"/workloads/$(WorkloadId)/checkSummaries",
Dict{String,Any}(
"ChoiceId" => ChoiceId,
"LensArn" => LensArn,
"PillarId" => PillarId,
"QuestionId" => QuestionId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_check_summaries(
ChoiceId,
LensArn,
PillarId,
QuestionId,
WorkloadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"POST",
"/workloads/$(WorkloadId)/checkSummaries",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChoiceId" => ChoiceId,
"LensArn" => LensArn,
"PillarId" => PillarId,
"QuestionId" => QuestionId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_lens_review_improvements(lens_alias, workload_id)
list_lens_review_improvements(lens_alias, workload_id, params::Dict{String,<:Any})
List the improvements of a particular lens review.
# Arguments
- `lens_alias`:
- `workload_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 this request.
- `"MilestoneNumber"`:
- `"NextToken"`:
- `"PillarId"`:
- `"QuestionPriority"`: The priority of the question.
"""
function list_lens_review_improvements(
LensAlias, WorkloadId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"GET",
"/workloads/$(WorkloadId)/lensReviews/$(LensAlias)/improvements";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_lens_review_improvements(
LensAlias,
WorkloadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"GET",
"/workloads/$(WorkloadId)/lensReviews/$(LensAlias)/improvements",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_lens_reviews(workload_id)
list_lens_reviews(workload_id, params::Dict{String,<:Any})
List lens reviews for a particular workload.
# Arguments
- `workload_id`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`:
- `"MilestoneNumber"`:
- `"NextToken"`:
"""
function list_lens_reviews(WorkloadId; aws_config::AbstractAWSConfig=global_aws_config())
return wellarchitected(
"GET",
"/workloads/$(WorkloadId)/lensReviews";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_lens_reviews(
WorkloadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"GET",
"/workloads/$(WorkloadId)/lensReviews",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_lens_shares(lens_alias)
list_lens_shares(lens_alias, params::Dict{String,<:Any})
List the lens shares associated with the lens.
# Arguments
- `lens_alias`:
# 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 this request.
- `"NextToken"`:
- `"SharedWithPrefix"`: The Amazon Web Services account ID, organization ID, or
organizational unit (OU) ID with which the lens is shared.
- `"Status"`:
"""
function list_lens_shares(LensAlias; aws_config::AbstractAWSConfig=global_aws_config())
return wellarchitected(
"GET",
"/lenses/$(LensAlias)/shares";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_lens_shares(
LensAlias,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"GET",
"/lenses/$(LensAlias)/shares",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_lenses()
list_lenses(params::Dict{String,<:Any})
List the available lenses.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LensName"`:
- `"LensStatus"`: The status of lenses to be returned.
- `"LensType"`: The type of lenses to be returned.
- `"MaxResults"`:
- `"NextToken"`:
"""
function list_lenses(; aws_config::AbstractAWSConfig=global_aws_config())
return wellarchitected(
"GET", "/lenses"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_lenses(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"GET", "/lenses", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_milestones(workload_id)
list_milestones(workload_id, params::Dict{String,<:Any})
List all milestones for an existing workload.
# Arguments
- `workload_id`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`:
- `"NextToken"`:
"""
function list_milestones(WorkloadId; aws_config::AbstractAWSConfig=global_aws_config())
return wellarchitected(
"POST",
"/workloads/$(WorkloadId)/milestonesSummaries";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_milestones(
WorkloadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"POST",
"/workloads/$(WorkloadId)/milestonesSummaries",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_notifications()
list_notifications(params::Dict{String,<:Any})
List lens notifications.
# 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 this request.
- `"NextToken"`:
- `"ResourceArn"`: The ARN for the related resource for the notification. Only one of
WorkloadID or ResourceARN should be specified.
- `"WorkloadId"`:
"""
function list_notifications(; aws_config::AbstractAWSConfig=global_aws_config())
return wellarchitected(
"POST", "/notifications"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_notifications(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"POST",
"/notifications",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_profile_notifications()
list_profile_notifications(params::Dict{String,<:Any})
List profile notifications.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`:
- `"NextToken"`:
- `"WorkloadId"`:
"""
function list_profile_notifications(; aws_config::AbstractAWSConfig=global_aws_config())
return wellarchitected(
"GET",
"/profileNotifications/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_profile_notifications(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"GET",
"/profileNotifications/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_profile_shares(profile_arn)
list_profile_shares(profile_arn, params::Dict{String,<:Any})
List profile shares.
# Arguments
- `profile_arn`: The profile ARN.
# 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 this request.
- `"NextToken"`:
- `"SharedWithPrefix"`: The Amazon Web Services account ID, organization ID, or
organizational unit (OU) ID with which the profile is shared.
- `"Status"`:
"""
function list_profile_shares(ProfileArn; aws_config::AbstractAWSConfig=global_aws_config())
return wellarchitected(
"GET",
"/profiles/$(ProfileArn)/shares";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_profile_shares(
ProfileArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"GET",
"/profiles/$(ProfileArn)/shares",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_profiles()
list_profiles(params::Dict{String,<:Any})
List profiles.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`:
- `"NextToken"`:
- `"ProfileNamePrefix"`: An optional string added to the beginning of each profile name
returned in the results.
- `"ProfileOwnerType"`: Profile owner type.
"""
function list_profiles(; aws_config::AbstractAWSConfig=global_aws_config())
return wellarchitected(
"GET", "/profileSummaries"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_profiles(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"GET",
"/profileSummaries",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_review_template_answers(lens_alias, template_arn)
list_review_template_answers(lens_alias, template_arn, params::Dict{String,<:Any})
List the answers of a review template.
# Arguments
- `lens_alias`:
- `template_arn`: The ARN of the review 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 for this request.
- `"NextToken"`:
- `"PillarId"`:
"""
function list_review_template_answers(
LensAlias, TemplateArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"GET",
"/reviewTemplates/$(TemplateArn)/lensReviews/$(LensAlias)/answers";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_review_template_answers(
LensAlias,
TemplateArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"GET",
"/reviewTemplates/$(TemplateArn)/lensReviews/$(LensAlias)/answers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_review_templates()
list_review_templates(params::Dict{String,<:Any})
List review templates.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`:
- `"NextToken"`:
"""
function list_review_templates(; aws_config::AbstractAWSConfig=global_aws_config())
return wellarchitected(
"GET", "/reviewTemplates"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_review_templates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"GET",
"/reviewTemplates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_share_invitations()
list_share_invitations(params::Dict{String,<:Any})
List the share invitations. WorkloadNamePrefix, LensNamePrefix, ProfileNamePrefix, and
TemplateNamePrefix are mutually exclusive. Use the parameter that matches your
ShareResourceType.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LensNamePrefix"`: An optional string added to the beginning of each lens name returned
in the results.
- `"MaxResults"`: The maximum number of results to return for this request.
- `"NextToken"`:
- `"ProfileNamePrefix"`: An optional string added to the beginning of each profile name
returned in the results.
- `"ShareResourceType"`: The type of share invitations to be returned.
- `"TemplateNamePrefix"`: An optional string added to the beginning of each review template
name returned in the results.
- `"WorkloadNamePrefix"`:
"""
function list_share_invitations(; aws_config::AbstractAWSConfig=global_aws_config())
return wellarchitected(
"GET", "/shareInvitations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_share_invitations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"GET",
"/shareInvitations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(workload_arn)
list_tags_for_resource(workload_arn, params::Dict{String,<:Any})
List the tags for a resource. The WorkloadArn parameter can be a workload ARN, a custom
lens ARN, a profile ARN, or review template ARN.
# Arguments
- `workload_arn`:
"""
function list_tags_for_resource(
WorkloadArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"GET",
"/tags/$(WorkloadArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
WorkloadArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"GET",
"/tags/$(WorkloadArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_template_shares(template_arn)
list_template_shares(template_arn, params::Dict{String,<:Any})
List review template shares.
# Arguments
- `template_arn`: The review template ARN.
# 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 this request.
- `"NextToken"`:
- `"SharedWithPrefix"`: The Amazon Web Services account ID, organization ID, or
organizational unit (OU) ID with which the profile is shared.
- `"Status"`:
"""
function list_template_shares(
TemplateArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"GET",
"/templates/shares/$(TemplateArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_template_shares(
TemplateArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"GET",
"/templates/shares/$(TemplateArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_workload_shares(workload_id)
list_workload_shares(workload_id, params::Dict{String,<:Any})
List the workload shares associated with the workload.
# Arguments
- `workload_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 this request.
- `"NextToken"`:
- `"SharedWithPrefix"`: The Amazon Web Services account ID, organization ID, or
organizational unit (OU) ID with which the workload is shared.
- `"Status"`:
"""
function list_workload_shares(WorkloadId; aws_config::AbstractAWSConfig=global_aws_config())
return wellarchitected(
"GET",
"/workloads/$(WorkloadId)/shares";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_workload_shares(
WorkloadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"GET",
"/workloads/$(WorkloadId)/shares",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_workloads()
list_workloads(params::Dict{String,<:Any})
Paginated list of workloads.
# 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 this request.
- `"NextToken"`:
- `"WorkloadNamePrefix"`:
"""
function list_workloads(; aws_config::AbstractAWSConfig=global_aws_config())
return wellarchitected(
"POST",
"/workloadsSummaries";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_workloads(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"POST",
"/workloadsSummaries",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(tags, workload_arn)
tag_resource(tags, workload_arn, params::Dict{String,<:Any})
Adds one or more tags to the specified resource. The WorkloadArn parameter can be a
workload ARN, a custom lens ARN, a profile ARN, or review template ARN.
# Arguments
- `tags`: The tags for the resource.
- `workload_arn`:
"""
function tag_resource(Tags, WorkloadArn; aws_config::AbstractAWSConfig=global_aws_config())
return wellarchitected(
"POST",
"/tags/$(WorkloadArn)",
Dict{String,Any}("Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
Tags,
WorkloadArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"POST",
"/tags/$(WorkloadArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Tags" => Tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(workload_arn, tag_keys)
untag_resource(workload_arn, tag_keys, params::Dict{String,<:Any})
Deletes specified tags from a resource. The WorkloadArn parameter can be a workload ARN, a
custom lens ARN, a profile ARN, or review template ARN. To specify multiple tags, use
separate tagKeys parameters, for example: DELETE
/tags/WorkloadArn?tagKeys=key1&tagKeys=key2
# Arguments
- `workload_arn`:
- `tag_keys`: A list of tag keys. Existing tags of the resource whose keys are members of
this list are removed from the resource.
"""
function untag_resource(
WorkloadArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"DELETE",
"/tags/$(WorkloadArn)",
Dict{String,Any}("tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
WorkloadArn,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"DELETE",
"/tags/$(WorkloadArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_answer(lens_alias, question_id, workload_id)
update_answer(lens_alias, question_id, workload_id, params::Dict{String,<:Any})
Update the answer to a specific question in a workload review.
# Arguments
- `lens_alias`:
- `question_id`:
- `workload_id`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ChoiceUpdates"`: A list of choices to update on a question in your workload. The String
key corresponds to the choice ID to be updated.
- `"IsApplicable"`:
- `"Notes"`:
- `"Reason"`: The reason why a question is not applicable to your workload.
- `"SelectedChoices"`:
"""
function update_answer(
LensAlias, QuestionId, WorkloadId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"PATCH",
"/workloads/$(WorkloadId)/lensReviews/$(LensAlias)/answers/$(QuestionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_answer(
LensAlias,
QuestionId,
WorkloadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"PATCH",
"/workloads/$(WorkloadId)/lensReviews/$(LensAlias)/answers/$(QuestionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_global_settings()
update_global_settings(params::Dict{String,<:Any})
Update whether the Amazon Web Services account is opted into organization sharing and
discovery integration features.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DiscoveryIntegrationStatus"`: The status of discovery support settings.
- `"JiraConfiguration"`: The status of Jira integration settings.
- `"OrganizationSharingStatus"`: The status of organization sharing settings.
"""
function update_global_settings(; aws_config::AbstractAWSConfig=global_aws_config())
return wellarchitected(
"PATCH", "/global-settings"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function update_global_settings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"PATCH",
"/global-settings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_integration(client_request_token, integrating_service, workload_id)
update_integration(client_request_token, integrating_service, workload_id, params::Dict{String,<:Any})
Update integration features.
# Arguments
- `client_request_token`:
- `integrating_service`: Which integrated service to update.
- `workload_id`:
"""
function update_integration(
ClientRequestToken,
IntegratingService,
WorkloadId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"POST",
"/workloads/$(WorkloadId)/updateIntegration",
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken,
"IntegratingService" => IntegratingService,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_integration(
ClientRequestToken,
IntegratingService,
WorkloadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"POST",
"/workloads/$(WorkloadId)/updateIntegration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientRequestToken" => ClientRequestToken,
"IntegratingService" => IntegratingService,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_lens_review(lens_alias, workload_id)
update_lens_review(lens_alias, workload_id, params::Dict{String,<:Any})
Update lens review for a particular workload.
# Arguments
- `lens_alias`:
- `workload_id`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"JiraConfiguration"`: Configuration of the Jira integration.
- `"LensNotes"`:
- `"PillarNotes"`:
"""
function update_lens_review(
LensAlias, WorkloadId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"PATCH",
"/workloads/$(WorkloadId)/lensReviews/$(LensAlias)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_lens_review(
LensAlias,
WorkloadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"PATCH",
"/workloads/$(WorkloadId)/lensReviews/$(LensAlias)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_profile(profile_arn)
update_profile(profile_arn, params::Dict{String,<:Any})
Update a profile.
# Arguments
- `profile_arn`: The profile ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ProfileDescription"`: The profile description.
- `"ProfileQuestions"`: Profile questions.
"""
function update_profile(ProfileArn; aws_config::AbstractAWSConfig=global_aws_config())
return wellarchitected(
"PATCH",
"/profiles/$(ProfileArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_profile(
ProfileArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"PATCH",
"/profiles/$(ProfileArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_review_template(template_arn)
update_review_template(template_arn, params::Dict{String,<:Any})
Update a review template.
# Arguments
- `template_arn`: The review template ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The review template description.
- `"LensesToAssociate"`: A list of lens aliases or ARNs to apply to the review template.
- `"LensesToDisassociate"`: A list of lens aliases or ARNs to unapply to the review
template. The wellarchitected lens cannot be unapplied.
- `"Notes"`:
- `"TemplateName"`: The review template name.
"""
function update_review_template(
TemplateArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"PATCH",
"/reviewTemplates/$(TemplateArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_review_template(
TemplateArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"PATCH",
"/reviewTemplates/$(TemplateArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_review_template_answer(lens_alias, question_id, template_arn)
update_review_template_answer(lens_alias, question_id, template_arn, params::Dict{String,<:Any})
Update a review template answer.
# Arguments
- `lens_alias`:
- `question_id`:
- `template_arn`: The review template ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ChoiceUpdates"`: A list of choices to be updated.
- `"IsApplicable"`:
- `"Notes"`:
- `"Reason"`: The update reason.
- `"SelectedChoices"`:
"""
function update_review_template_answer(
LensAlias, QuestionId, TemplateArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"PATCH",
"/reviewTemplates/$(TemplateArn)/lensReviews/$(LensAlias)/answers/$(QuestionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_review_template_answer(
LensAlias,
QuestionId,
TemplateArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"PATCH",
"/reviewTemplates/$(TemplateArn)/lensReviews/$(LensAlias)/answers/$(QuestionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_review_template_lens_review(lens_alias, template_arn)
update_review_template_lens_review(lens_alias, template_arn, params::Dict{String,<:Any})
Update a lens review associated with a review template.
# Arguments
- `lens_alias`:
- `template_arn`: The review template ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LensNotes"`:
- `"PillarNotes"`:
"""
function update_review_template_lens_review(
LensAlias, TemplateArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"PATCH",
"/reviewTemplates/$(TemplateArn)/lensReviews/$(LensAlias)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_review_template_lens_review(
LensAlias,
TemplateArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"PATCH",
"/reviewTemplates/$(TemplateArn)/lensReviews/$(LensAlias)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_share_invitation(share_invitation_action, share_invitation_id)
update_share_invitation(share_invitation_action, share_invitation_id, params::Dict{String,<:Any})
Update a workload or custom lens share invitation. This API operation can be called
independently of any resource. Previous documentation implied that a workload ARN must be
specified.
# Arguments
- `share_invitation_action`:
- `share_invitation_id`: The ID assigned to the share invitation.
"""
function update_share_invitation(
ShareInvitationAction,
ShareInvitationId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"PATCH",
"/shareInvitations/$(ShareInvitationId)",
Dict{String,Any}("ShareInvitationAction" => ShareInvitationAction);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_share_invitation(
ShareInvitationAction,
ShareInvitationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"PATCH",
"/shareInvitations/$(ShareInvitationId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ShareInvitationAction" => ShareInvitationAction),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_workload(workload_id)
update_workload(workload_id, params::Dict{String,<:Any})
Update an existing workload.
# Arguments
- `workload_id`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccountIds"`:
- `"Applications"`: List of AppRegistry application ARNs to associate to the workload.
- `"ArchitecturalDesign"`:
- `"AwsRegions"`:
- `"Description"`:
- `"DiscoveryConfig"`: Well-Architected discovery configuration settings to associate to
the workload.
- `"Environment"`:
- `"ImprovementStatus"`:
- `"Industry"`:
- `"IndustryType"`:
- `"IsReviewOwnerUpdateAcknowledged"`: Flag indicating whether the workload owner has
acknowledged that the Review owner field is required. If a Review owner is not added to the
workload within 60 days of acknowledgement, access to the workload is restricted until an
owner is added.
- `"JiraConfiguration"`: Configuration of the Jira integration.
- `"NonAwsRegions"`:
- `"Notes"`:
- `"PillarPriorities"`:
- `"ReviewOwner"`:
- `"WorkloadName"`:
"""
function update_workload(WorkloadId; aws_config::AbstractAWSConfig=global_aws_config())
return wellarchitected(
"PATCH",
"/workloads/$(WorkloadId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_workload(
WorkloadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"PATCH",
"/workloads/$(WorkloadId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_workload_share(permission_type, share_id, workload_id)
update_workload_share(permission_type, share_id, workload_id, params::Dict{String,<:Any})
Update a workload share.
# Arguments
- `permission_type`:
- `share_id`:
- `workload_id`:
"""
function update_workload_share(
PermissionType, ShareId, WorkloadId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"PATCH",
"/workloads/$(WorkloadId)/shares/$(ShareId)",
Dict{String,Any}("PermissionType" => PermissionType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_workload_share(
PermissionType,
ShareId,
WorkloadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"PATCH",
"/workloads/$(WorkloadId)/shares/$(ShareId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PermissionType" => PermissionType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
upgrade_lens_review(lens_alias, milestone_name, workload_id)
upgrade_lens_review(lens_alias, milestone_name, workload_id, params::Dict{String,<:Any})
Upgrade lens review for a particular workload.
# Arguments
- `lens_alias`:
- `milestone_name`:
- `workload_id`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`:
"""
function upgrade_lens_review(
LensAlias, MilestoneName, WorkloadId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"PUT",
"/workloads/$(WorkloadId)/lensReviews/$(LensAlias)/upgrade",
Dict{String,Any}("MilestoneName" => MilestoneName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function upgrade_lens_review(
LensAlias,
MilestoneName,
WorkloadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"PUT",
"/workloads/$(WorkloadId)/lensReviews/$(LensAlias)/upgrade",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("MilestoneName" => MilestoneName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
upgrade_profile_version(profile_arn, workload_id)
upgrade_profile_version(profile_arn, workload_id, params::Dict{String,<:Any})
Upgrade a profile.
# Arguments
- `profile_arn`: The profile ARN.
- `workload_id`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`:
- `"MilestoneName"`:
"""
function upgrade_profile_version(
ProfileArn, WorkloadId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"PUT",
"/workloads/$(WorkloadId)/profiles/$(ProfileArn)/upgrade",
Dict{String,Any}("ClientRequestToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function upgrade_profile_version(
ProfileArn,
WorkloadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"PUT",
"/workloads/$(WorkloadId)/profiles/$(ProfileArn)/upgrade",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ClientRequestToken" => string(uuid4())), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
upgrade_review_template_lens_review(lens_alias, template_arn)
upgrade_review_template_lens_review(lens_alias, template_arn, params::Dict{String,<:Any})
Upgrade the lens review of a review template.
# Arguments
- `lens_alias`:
- `template_arn`: The ARN of the review template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`:
"""
function upgrade_review_template_lens_review(
LensAlias, TemplateArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return wellarchitected(
"PUT",
"/reviewTemplates/$(TemplateArn)/lensReviews/$(LensAlias)/upgrade";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function upgrade_review_template_lens_review(
LensAlias,
TemplateArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wellarchitected(
"PUT",
"/reviewTemplates/$(TemplateArn)/lensReviews/$(LensAlias)/upgrade",
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 | 63236 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: wisdom
using AWS.Compat
using AWS.UUIDs
"""
create_assistant(name, type)
create_assistant(name, type, params::Dict{String,<:Any})
Creates an Amazon Connect Wisdom assistant.
# Arguments
- `name`: The name of the assistant.
- `type`: The type of assistant.
# 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 assistant.
- `"serverSideEncryptionConfiguration"`: The configuration information for the customer
managed key used for encryption. The customer managed key must have a policy that allows
kms:CreateGrant, kms:DescribeKey, and kms:Decrypt/kms:GenerateDataKey permissions to the
IAM identity using the key to invoke Wisdom. To use Wisdom with chat, the key policy must
also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the
connect.amazonaws.com service principal. For more information about setting up a customer
managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance.
- `"tags"`: The tags used to organize, track, or control access for this resource.
"""
function create_assistant(name, type; aws_config::AbstractAWSConfig=global_aws_config())
return wisdom(
"POST",
"/assistants",
Dict{String,Any}("name" => name, "type" => type, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_assistant(
name,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"POST",
"/assistants",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name, "type" => type, "clientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_assistant_association(assistant_id, association, association_type)
create_assistant_association(assistant_id, association, association_type, params::Dict{String,<:Any})
Creates an association between an Amazon Connect Wisdom assistant and another resource.
Currently, the only supported association is with a knowledge base. An assistant can have
only a single association.
# Arguments
- `assistant_id`: The identifier of the Wisdom assistant. Can be either the ID or the ARN.
URLs cannot contain the ARN.
- `association`: The identifier of the associated resource.
- `association_type`: The type of association.
# 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.
- `"tags"`: The tags used to organize, track, or control access for this resource.
"""
function create_assistant_association(
assistantId,
association,
associationType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"POST",
"/assistants/$(assistantId)/associations",
Dict{String,Any}(
"association" => association,
"associationType" => associationType,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_assistant_association(
assistantId,
association,
associationType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"POST",
"/assistants/$(assistantId)/associations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"association" => association,
"associationType" => associationType,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_content(knowledge_base_id, name, upload_id)
create_content(knowledge_base_id, name, upload_id, params::Dict{String,<:Any})
Creates Wisdom content. Before to calling this API, use StartContentUpload to upload an
asset.
# Arguments
- `knowledge_base_id`: The identifier of the knowledge base. This should not be a
QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be
either the ID or the ARN. URLs cannot contain the ARN.
- `name`: The name of the content. Each piece of content in a knowledge base must have a
unique name. You can retrieve a piece of content using only its knowledge base and its name
with the SearchContent API.
- `upload_id`: A pointer to the uploaded asset. This value is returned by
StartContentUpload.
# 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.
- `"metadata"`: A key/value map to store attributes without affecting tagging or
recommendations. For example, when synchronizing data between an external system and
Wisdom, you can store an external version identifier as metadata to utilize for determining
drift.
- `"overrideLinkOutUri"`: The URI you want to use for the article. If the knowledge base
has a templateUri, setting this argument overrides it for this piece of content.
- `"tags"`: The tags used to organize, track, or control access for this resource.
- `"title"`: The title of the content. If not set, the title is equal to the name.
"""
function create_content(
knowledgeBaseId, name, uploadId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wisdom(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/contents",
Dict{String,Any}(
"name" => name, "uploadId" => uploadId, "clientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_content(
knowledgeBaseId,
name,
uploadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/contents",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name, "uploadId" => uploadId, "clientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_knowledge_base(knowledge_base_type, name)
create_knowledge_base(knowledge_base_type, name, params::Dict{String,<:Any})
Creates a knowledge base. When using this API, you cannot reuse Amazon AppIntegrations
DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you
do, you'll get an InvalidRequestException error. For example, you're programmatically
managing your external knowledge base, and you want to add or remove one of the fields that
is being ingested from Salesforce. Do the following: Call DeleteKnowledgeBase. Call
DeleteDataIntegration. Call CreateDataIntegration to recreate the DataIntegration or a
create different one. Call CreateKnowledgeBase.
# Arguments
- `knowledge_base_type`: The type of knowledge base. Only CUSTOM knowledge bases allow you
to upload your own content. EXTERNAL knowledge bases support integrations with third-party
systems whose content is synchronized automatically.
- `name`: The name of the knowledge base.
# 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.
- `"renderingConfiguration"`: Information about how to render the content.
- `"serverSideEncryptionConfiguration"`: The configuration information for the customer
managed key used for encryption. This KMS key must have a policy that allows
kms:CreateGrant, kms:DescribeKey, and kms:Decrypt/kms:GenerateDataKey permissions to the
IAM identity using the key to invoke Wisdom. For more information about setting up a
customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance.
- `"sourceConfiguration"`: The source of the knowledge base content. Only set this argument
for EXTERNAL knowledge bases.
- `"tags"`: The tags used to organize, track, or control access for this resource.
"""
function create_knowledge_base(
knowledgeBaseType, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return wisdom(
"POST",
"/knowledgeBases",
Dict{String,Any}(
"knowledgeBaseType" => knowledgeBaseType,
"name" => name,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_knowledge_base(
knowledgeBaseType,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"POST",
"/knowledgeBases",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"knowledgeBaseType" => knowledgeBaseType,
"name" => name,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_quick_response(content, knowledge_base_id, name)
create_quick_response(content, knowledge_base_id, name, params::Dict{String,<:Any})
Creates a Wisdom quick response.
# Arguments
- `content`: The content of the quick response.
- `knowledge_base_id`: The identifier of the knowledge base. This should not be a
QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be
either the ID or the ARN. URLs cannot contain the ARN.
- `name`: The name of the quick response.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"channels"`: The Amazon Connect channels this quick response applies to.
- `"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.
- `"contentType"`: The media type of the quick response content. Use
application/x.quickresponse;format=plain for a quick response written in plain text. Use
application/x.quickresponse;format=markdown for a quick response written in richtext.
- `"description"`: The description of the quick response.
- `"groupingConfiguration"`: The configuration information of the user groups that the
quick response is accessible to.
- `"isActive"`: Whether the quick response is active.
- `"language"`: The language code value for the language in which the quick response is
written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT,
ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
- `"shortcutKey"`: The shortcut key of the quick response. The value should be unique
across the knowledge base.
- `"tags"`: The tags used to organize, track, or control access for this resource.
"""
function create_quick_response(
content, knowledgeBaseId, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return wisdom(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/quickResponses",
Dict{String,Any}(
"content" => content, "name" => name, "clientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_quick_response(
content,
knowledgeBaseId,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/quickResponses",
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_session(assistant_id, name)
create_session(assistant_id, name, params::Dict{String,<:Any})
Creates a session. A session is a contextual container used for generating recommendations.
Amazon Connect creates a new Wisdom session for each contact on which Wisdom is enabled.
# Arguments
- `assistant_id`: The identifier of the Wisdom assistant. Can be either the ID or the ARN.
URLs cannot contain the ARN.
- `name`: The name of the session.
# 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.
- `"tags"`: The tags used to organize, track, or control access for this resource.
"""
function create_session(
assistantId, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return wisdom(
"POST",
"/assistants/$(assistantId)/sessions",
Dict{String,Any}("name" => name, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_session(
assistantId,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"POST",
"/assistants/$(assistantId)/sessions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("name" => name, "clientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_assistant(assistant_id)
delete_assistant(assistant_id, params::Dict{String,<:Any})
Deletes an assistant.
# Arguments
- `assistant_id`: The identifier of the Wisdom assistant. Can be either the ID or the ARN.
URLs cannot contain the ARN.
"""
function delete_assistant(assistantId; aws_config::AbstractAWSConfig=global_aws_config())
return wisdom(
"DELETE",
"/assistants/$(assistantId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_assistant(
assistantId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"DELETE",
"/assistants/$(assistantId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_assistant_association(assistant_association_id, assistant_id)
delete_assistant_association(assistant_association_id, assistant_id, params::Dict{String,<:Any})
Deletes an assistant association.
# Arguments
- `assistant_association_id`: The identifier of the assistant association. Can be either
the ID or the ARN. URLs cannot contain the ARN.
- `assistant_id`: The identifier of the Wisdom assistant. Can be either the ID or the ARN.
URLs cannot contain the ARN.
"""
function delete_assistant_association(
assistantAssociationId, assistantId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wisdom(
"DELETE",
"/assistants/$(assistantId)/associations/$(assistantAssociationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_assistant_association(
assistantAssociationId,
assistantId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"DELETE",
"/assistants/$(assistantId)/associations/$(assistantAssociationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_content(content_id, knowledge_base_id)
delete_content(content_id, knowledge_base_id, params::Dict{String,<:Any})
Deletes the content.
# Arguments
- `content_id`: The identifier of the content. Can be either the ID or the ARN. URLs cannot
contain the ARN.
- `knowledge_base_id`: The identifier of the knowledge base. This should not be a
QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be
either the ID or the ARN. URLs cannot contain the ARN.
"""
function delete_content(
contentId, knowledgeBaseId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wisdom(
"DELETE",
"/knowledgeBases/$(knowledgeBaseId)/contents/$(contentId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_content(
contentId,
knowledgeBaseId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"DELETE",
"/knowledgeBases/$(knowledgeBaseId)/contents/$(contentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_import_job(import_job_id, knowledge_base_id)
delete_import_job(import_job_id, knowledge_base_id, params::Dict{String,<:Any})
Deletes the quick response import job.
# Arguments
- `import_job_id`: The identifier of the import job to be deleted.
- `knowledge_base_id`: The identifier of the knowledge base. This should not be a
QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
"""
function delete_import_job(
importJobId, knowledgeBaseId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wisdom(
"DELETE",
"/knowledgeBases/$(knowledgeBaseId)/importJobs/$(importJobId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_import_job(
importJobId,
knowledgeBaseId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"DELETE",
"/knowledgeBases/$(knowledgeBaseId)/importJobs/$(importJobId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_knowledge_base(knowledge_base_id)
delete_knowledge_base(knowledge_base_id, params::Dict{String,<:Any})
Deletes the knowledge base. When you use this API to delete an external knowledge base
such as Salesforce or ServiceNow, you must also delete the Amazon AppIntegrations
DataIntegration. This is because you can't reuse the DataIntegration after it's been
associated with an external knowledge base. However, you can delete and recreate it. See
DeleteDataIntegration and CreateDataIntegration in the Amazon AppIntegrations API
Reference.
# Arguments
- `knowledge_base_id`: The knowledge base to delete content from. Can be either the ID or
the ARN. URLs cannot contain the ARN.
"""
function delete_knowledge_base(
knowledgeBaseId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wisdom(
"DELETE",
"/knowledgeBases/$(knowledgeBaseId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_knowledge_base(
knowledgeBaseId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"DELETE",
"/knowledgeBases/$(knowledgeBaseId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_quick_response(knowledge_base_id, quick_response_id)
delete_quick_response(knowledge_base_id, quick_response_id, params::Dict{String,<:Any})
Deletes a quick response.
# Arguments
- `knowledge_base_id`: The knowledge base from which the quick response is deleted. The
identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base
if you're storing Wisdom Content resource to it.
- `quick_response_id`: The identifier of the quick response to delete.
"""
function delete_quick_response(
knowledgeBaseId, quickResponseId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wisdom(
"DELETE",
"/knowledgeBases/$(knowledgeBaseId)/quickResponses/$(quickResponseId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_quick_response(
knowledgeBaseId,
quickResponseId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"DELETE",
"/knowledgeBases/$(knowledgeBaseId)/quickResponses/$(quickResponseId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_assistant(assistant_id)
get_assistant(assistant_id, params::Dict{String,<:Any})
Retrieves information about an assistant.
# Arguments
- `assistant_id`: The identifier of the Wisdom assistant. Can be either the ID or the ARN.
URLs cannot contain the ARN.
"""
function get_assistant(assistantId; aws_config::AbstractAWSConfig=global_aws_config())
return wisdom(
"GET",
"/assistants/$(assistantId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_assistant(
assistantId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"GET",
"/assistants/$(assistantId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_assistant_association(assistant_association_id, assistant_id)
get_assistant_association(assistant_association_id, assistant_id, params::Dict{String,<:Any})
Retrieves information about an assistant association.
# Arguments
- `assistant_association_id`: The identifier of the assistant association. Can be either
the ID or the ARN. URLs cannot contain the ARN.
- `assistant_id`: The identifier of the Wisdom assistant. Can be either the ID or the ARN.
URLs cannot contain the ARN.
"""
function get_assistant_association(
assistantAssociationId, assistantId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wisdom(
"GET",
"/assistants/$(assistantId)/associations/$(assistantAssociationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_assistant_association(
assistantAssociationId,
assistantId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"GET",
"/assistants/$(assistantId)/associations/$(assistantAssociationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_content(content_id, knowledge_base_id)
get_content(content_id, knowledge_base_id, params::Dict{String,<:Any})
Retrieves content, including a pre-signed URL to download the content.
# Arguments
- `content_id`: The identifier of the content. Can be either the ID or the ARN. URLs cannot
contain the ARN.
- `knowledge_base_id`: The identifier of the knowledge base. This should not be a
QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be
either the ID or the ARN. URLs cannot contain the ARN.
"""
function get_content(
contentId, knowledgeBaseId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wisdom(
"GET",
"/knowledgeBases/$(knowledgeBaseId)/contents/$(contentId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_content(
contentId,
knowledgeBaseId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"GET",
"/knowledgeBases/$(knowledgeBaseId)/contents/$(contentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_content_summary(content_id, knowledge_base_id)
get_content_summary(content_id, knowledge_base_id, params::Dict{String,<:Any})
Retrieves summary information about the content.
# Arguments
- `content_id`: The identifier of the content. Can be either the ID or the ARN. URLs cannot
contain the ARN.
- `knowledge_base_id`: The identifier of the knowledge base. This should not be a
QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be
either the ID or the ARN. URLs cannot contain the ARN.
"""
function get_content_summary(
contentId, knowledgeBaseId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wisdom(
"GET",
"/knowledgeBases/$(knowledgeBaseId)/contents/$(contentId)/summary";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_content_summary(
contentId,
knowledgeBaseId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"GET",
"/knowledgeBases/$(knowledgeBaseId)/contents/$(contentId)/summary",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_import_job(import_job_id, knowledge_base_id)
get_import_job(import_job_id, knowledge_base_id, params::Dict{String,<:Any})
Retrieves the started import job.
# Arguments
- `import_job_id`: The identifier of the import job to retrieve.
- `knowledge_base_id`: The identifier of the knowledge base that the import job belongs to.
"""
function get_import_job(
importJobId, knowledgeBaseId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wisdom(
"GET",
"/knowledgeBases/$(knowledgeBaseId)/importJobs/$(importJobId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_import_job(
importJobId,
knowledgeBaseId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"GET",
"/knowledgeBases/$(knowledgeBaseId)/importJobs/$(importJobId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_knowledge_base(knowledge_base_id)
get_knowledge_base(knowledge_base_id, params::Dict{String,<:Any})
Retrieves information about the knowledge base.
# Arguments
- `knowledge_base_id`: The identifier of the knowledge base. This should not be a
QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be
either the ID or the ARN. URLs cannot contain the ARN.
"""
function get_knowledge_base(
knowledgeBaseId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wisdom(
"GET",
"/knowledgeBases/$(knowledgeBaseId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_knowledge_base(
knowledgeBaseId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"GET",
"/knowledgeBases/$(knowledgeBaseId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_quick_response(knowledge_base_id, quick_response_id)
get_quick_response(knowledge_base_id, quick_response_id, params::Dict{String,<:Any})
Retrieves the quick response.
# Arguments
- `knowledge_base_id`: The identifier of the knowledge base. This should be a
QUICK_RESPONSES type knowledge base.
- `quick_response_id`: The identifier of the quick response.
"""
function get_quick_response(
knowledgeBaseId, quickResponseId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wisdom(
"GET",
"/knowledgeBases/$(knowledgeBaseId)/quickResponses/$(quickResponseId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_quick_response(
knowledgeBaseId,
quickResponseId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"GET",
"/knowledgeBases/$(knowledgeBaseId)/quickResponses/$(quickResponseId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_recommendations(assistant_id, session_id)
get_recommendations(assistant_id, session_id, params::Dict{String,<:Any})
Retrieves recommendations for the specified session. To avoid retrieving the same
recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports
long-polling behavior with the waitTimeSeconds parameter. Short poll is the default
behavior and only returns recommendations already available. To perform a manual query
against an assistant, use QueryAssistant.
# Arguments
- `assistant_id`: The identifier of the Wisdom assistant. Can be either the ID or the ARN.
URLs cannot contain the ARN.
- `session_id`: The identifier of the session. Can be either the ID or the ARN. URLs cannot
contain the ARN.
# 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.
- `"waitTimeSeconds"`: The duration (in seconds) for which the call waits for a
recommendation to be made available before returning. If a recommendation is available, the
call returns sooner than WaitTimeSeconds. If no messages are available and the wait time
expires, the call returns successfully with an empty list.
"""
function get_recommendations(
assistantId, sessionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wisdom(
"GET",
"/assistants/$(assistantId)/sessions/$(sessionId)/recommendations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_recommendations(
assistantId,
sessionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"GET",
"/assistants/$(assistantId)/sessions/$(sessionId)/recommendations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_session(assistant_id, session_id)
get_session(assistant_id, session_id, params::Dict{String,<:Any})
Retrieves information for a specified session.
# Arguments
- `assistant_id`: The identifier of the Wisdom assistant. Can be either the ID or the ARN.
URLs cannot contain the ARN.
- `session_id`: The identifier of the session. Can be either the ID or the ARN. URLs cannot
contain the ARN.
"""
function get_session(
assistantId, sessionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wisdom(
"GET",
"/assistants/$(assistantId)/sessions/$(sessionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_session(
assistantId,
sessionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"GET",
"/assistants/$(assistantId)/sessions/$(sessionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_assistant_associations(assistant_id)
list_assistant_associations(assistant_id, params::Dict{String,<:Any})
Lists information about assistant associations.
# Arguments
- `assistant_id`: The identifier of the Wisdom assistant. Can be either the ID or the ARN.
URLs cannot contain the ARN.
# 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_assistant_associations(
assistantId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wisdom(
"GET",
"/assistants/$(assistantId)/associations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_assistant_associations(
assistantId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"GET",
"/assistants/$(assistantId)/associations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_assistants()
list_assistants(params::Dict{String,<:Any})
Lists information about assistants.
# 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_assistants(; aws_config::AbstractAWSConfig=global_aws_config())
return wisdom(
"GET", "/assistants"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_assistants(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return wisdom(
"GET", "/assistants", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_contents(knowledge_base_id)
list_contents(knowledge_base_id, params::Dict{String,<:Any})
Lists the content.
# Arguments
- `knowledge_base_id`: The identifier of the knowledge base. This should not be a
QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be
either the ID or the ARN. URLs cannot contain the ARN.
# 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_contents(knowledgeBaseId; aws_config::AbstractAWSConfig=global_aws_config())
return wisdom(
"GET",
"/knowledgeBases/$(knowledgeBaseId)/contents";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_contents(
knowledgeBaseId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"GET",
"/knowledgeBases/$(knowledgeBaseId)/contents",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_import_jobs(knowledge_base_id)
list_import_jobs(knowledge_base_id, params::Dict{String,<:Any})
Lists information about import jobs.
# Arguments
- `knowledge_base_id`: The identifier of the knowledge base. This should not be a
QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be
either the ID or the ARN. URLs cannot contain the ARN.
# 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_import_jobs(
knowledgeBaseId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wisdom(
"GET",
"/knowledgeBases/$(knowledgeBaseId)/importJobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_import_jobs(
knowledgeBaseId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"GET",
"/knowledgeBases/$(knowledgeBaseId)/importJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_knowledge_bases()
list_knowledge_bases(params::Dict{String,<:Any})
Lists the knowledge bases.
# 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_knowledge_bases(; aws_config::AbstractAWSConfig=global_aws_config())
return wisdom(
"GET", "/knowledgeBases"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_knowledge_bases(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return wisdom(
"GET",
"/knowledgeBases",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_quick_responses(knowledge_base_id)
list_quick_responses(knowledge_base_id, params::Dict{String,<:Any})
Lists information about quick response.
# Arguments
- `knowledge_base_id`: The identifier of the knowledge base. This should not be a
QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be
either the ID or the ARN. URLs cannot contain the ARN.
# 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_quick_responses(
knowledgeBaseId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wisdom(
"GET",
"/knowledgeBases/$(knowledgeBaseId)/quickResponses";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_quick_responses(
knowledgeBaseId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"GET",
"/knowledgeBases/$(knowledgeBaseId)/quickResponses",
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 wisdom(
"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 wisdom(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
notify_recommendations_received(assistant_id, recommendation_ids, session_id)
notify_recommendations_received(assistant_id, recommendation_ids, session_id, params::Dict{String,<:Any})
Removes the specified recommendations from the specified assistant's queue of newly
available recommendations. You can use this API in conjunction with GetRecommendations and
a waitTimeSeconds input for long-polling behavior and avoiding duplicate recommendations.
# Arguments
- `assistant_id`: The identifier of the Wisdom assistant. Can be either the ID or the ARN.
URLs cannot contain the ARN.
- `recommendation_ids`: The identifiers of the recommendations.
- `session_id`: The identifier of the session. Can be either the ID or the ARN. URLs cannot
contain the ARN.
"""
function notify_recommendations_received(
assistantId,
recommendationIds,
sessionId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"POST",
"/assistants/$(assistantId)/sessions/$(sessionId)/recommendations/notify",
Dict{String,Any}("recommendationIds" => recommendationIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function notify_recommendations_received(
assistantId,
recommendationIds,
sessionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"POST",
"/assistants/$(assistantId)/sessions/$(sessionId)/recommendations/notify",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("recommendationIds" => recommendationIds), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
query_assistant(assistant_id, query_text)
query_assistant(assistant_id, query_text, params::Dict{String,<:Any})
Performs a manual search against the specified assistant. To retrieve recommendations for
an assistant, use GetRecommendations.
# Arguments
- `assistant_id`: The identifier of the Wisdom assistant. Can be either the ID or the ARN.
URLs cannot contain the ARN.
- `query_text`: The text to search 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 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 query_assistant(
assistantId, queryText; aws_config::AbstractAWSConfig=global_aws_config()
)
return wisdom(
"POST",
"/assistants/$(assistantId)/query",
Dict{String,Any}("queryText" => queryText);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function query_assistant(
assistantId,
queryText,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"POST",
"/assistants/$(assistantId)/query",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("queryText" => queryText), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_knowledge_base_template_uri(knowledge_base_id)
remove_knowledge_base_template_uri(knowledge_base_id, params::Dict{String,<:Any})
Removes a URI template from a knowledge base.
# Arguments
- `knowledge_base_id`: The identifier of the knowledge base. This should not be a
QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be
either the ID or the ARN. URLs cannot contain the ARN.
"""
function remove_knowledge_base_template_uri(
knowledgeBaseId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wisdom(
"DELETE",
"/knowledgeBases/$(knowledgeBaseId)/templateUri";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_knowledge_base_template_uri(
knowledgeBaseId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"DELETE",
"/knowledgeBases/$(knowledgeBaseId)/templateUri",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_content(knowledge_base_id, search_expression)
search_content(knowledge_base_id, search_expression, params::Dict{String,<:Any})
Searches for content in a specified knowledge base. Can be used to get a specific content
resource by its name.
# Arguments
- `knowledge_base_id`: The identifier of the knowledge base. This should not be a
QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be
either the ID or the ARN. URLs cannot contain the ARN.
- `search_expression`: The search expression to filter 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.
"""
function search_content(
knowledgeBaseId, searchExpression; aws_config::AbstractAWSConfig=global_aws_config()
)
return wisdom(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/search",
Dict{String,Any}("searchExpression" => searchExpression);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_content(
knowledgeBaseId,
searchExpression,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/search",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("searchExpression" => searchExpression), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_quick_responses(knowledge_base_id, search_expression)
search_quick_responses(knowledge_base_id, search_expression, params::Dict{String,<:Any})
Searches existing Wisdom quick responses in a Wisdom knowledge base.
# Arguments
- `knowledge_base_id`: The identifier of the knowledge base. This should be a
QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain
the ARN.
- `search_expression`: The search expression for querying the quick response.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"attributes"`: The user-defined Amazon Connect contact attributes to be resolved when
search results are returned.
- `"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_quick_responses(
knowledgeBaseId, searchExpression; aws_config::AbstractAWSConfig=global_aws_config()
)
return wisdom(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/search/quickResponses",
Dict{String,Any}("searchExpression" => searchExpression);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_quick_responses(
knowledgeBaseId,
searchExpression,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/search/quickResponses",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("searchExpression" => searchExpression), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_sessions(assistant_id, search_expression)
search_sessions(assistant_id, search_expression, params::Dict{String,<:Any})
Searches for sessions.
# Arguments
- `assistant_id`: The identifier of the Wisdom assistant. Can be either the ID or the ARN.
URLs cannot contain the ARN.
- `search_expression`: The search expression to filter 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.
"""
function search_sessions(
assistantId, searchExpression; aws_config::AbstractAWSConfig=global_aws_config()
)
return wisdom(
"POST",
"/assistants/$(assistantId)/searchSessions",
Dict{String,Any}("searchExpression" => searchExpression);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_sessions(
assistantId,
searchExpression,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"POST",
"/assistants/$(assistantId)/searchSessions",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("searchExpression" => searchExpression), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_content_upload(content_type, knowledge_base_id)
start_content_upload(content_type, knowledge_base_id, params::Dict{String,<:Any})
Get a URL to upload content to a knowledge base. To upload content, first make a PUT
request to the returned URL with your file, making sure to include the required headers.
Then use CreateContent to finalize the content creation process or UpdateContent to modify
an existing resource. You can only upload content to a knowledge base of type CUSTOM.
# Arguments
- `content_type`: The type of content to upload.
- `knowledge_base_id`: The identifier of the knowledge base. This should not be a
QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be
either the ID or the ARN. URLs cannot contain the ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"presignedUrlTimeToLive"`: The expected expiration time of the generated presigned URL,
specified in minutes.
"""
function start_content_upload(
contentType, knowledgeBaseId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wisdom(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/upload",
Dict{String,Any}("contentType" => contentType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_content_upload(
contentType,
knowledgeBaseId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/upload",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("contentType" => contentType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_import_job(import_job_type, knowledge_base_id, upload_id)
start_import_job(import_job_type, knowledge_base_id, upload_id, params::Dict{String,<:Any})
Start an asynchronous job to import Wisdom resources from an uploaded source file. Before
calling this API, use StartContentUpload to upload an asset that contains the resource
data. For importing Wisdom quick responses, you need to upload a csv file including the
quick responses. For information about how to format the csv file for importing quick
responses, see Import quick responses.
# Arguments
- `import_job_type`: The type of the import job. For importing quick response resource,
set the value to QUICK_RESPONSES.
- `knowledge_base_id`: The identifier of the knowledge base. This should not be a
QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be
either the ID or the ARN. URLs cannot contain the ARN. For importing Wisdom quick
responses, this should be a QUICK_RESPONSES type knowledge base.
- `upload_id`: A pointer to the uploaded asset. This value is returned by
StartContentUpload.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: The tags used to organize, track, or control access for this resource.
- `"externalSourceConfiguration"`: The configuration information of the external source
that the resource data are imported from.
- `"metadata"`: The metadata fields of the imported Wisdom resources.
"""
function start_import_job(
importJobType,
knowledgeBaseId,
uploadId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/importJobs",
Dict{String,Any}(
"importJobType" => importJobType,
"uploadId" => uploadId,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_import_job(
importJobType,
knowledgeBaseId,
uploadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/importJobs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"importJobType" => importJobType,
"uploadId" => uploadId,
"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})
Adds the specified tags to the specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
- `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 wisdom(
"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 wisdom(
"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 wisdom(
"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 wisdom(
"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_content(content_id, knowledge_base_id)
update_content(content_id, knowledge_base_id, params::Dict{String,<:Any})
Updates information about the content.
# Arguments
- `content_id`: The identifier of the content. Can be either the ID or the ARN. URLs cannot
contain the ARN.
- `knowledge_base_id`: The identifier of the knowledge base. This should not be a
QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be
either the ID or the ARN
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"metadata"`: A key/value map to store attributes without affecting tagging or
recommendations. For example, when synchronizing data between an external system and
Wisdom, you can store an external version identifier as metadata to utilize for determining
drift.
- `"overrideLinkOutUri"`: The URI for the article. If the knowledge base has a templateUri,
setting this argument overrides it for this piece of content. To remove an existing
overrideLinkOurUri, exclude this argument and set removeOverrideLinkOutUri to true.
- `"removeOverrideLinkOutUri"`: Unset the existing overrideLinkOutUri if it exists.
- `"revisionId"`: The revisionId of the content resource to update, taken from an earlier
call to GetContent, GetContentSummary, SearchContent, or ListContents. If included, this
argument acts as an optimistic lock to ensure content was not modified since it was last
read. If it has been modified, this API throws a PreconditionFailedException.
- `"title"`: The title of the content.
- `"uploadId"`: A pointer to the uploaded asset. This value is returned by
StartContentUpload.
"""
function update_content(
contentId, knowledgeBaseId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wisdom(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/contents/$(contentId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_content(
contentId,
knowledgeBaseId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/contents/$(contentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_knowledge_base_template_uri(knowledge_base_id, template_uri)
update_knowledge_base_template_uri(knowledge_base_id, template_uri, params::Dict{String,<:Any})
Updates the template URI of a knowledge base. This is only supported for knowledge bases of
type EXTERNAL. Include a single variable in {variable} format; this interpolated by Wisdom
using ingested content. For example, if you ingest a Salesforce article, it has an Id
value, and you can set the template URI to
https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*{Id}*/view.
# Arguments
- `knowledge_base_id`: The identifier of the knowledge base. This should not be a
QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be
either the ID or the ARN. URLs cannot contain the ARN.
- `template_uri`: The template URI to update.
"""
function update_knowledge_base_template_uri(
knowledgeBaseId, templateUri; aws_config::AbstractAWSConfig=global_aws_config()
)
return wisdom(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/templateUri",
Dict{String,Any}("templateUri" => templateUri);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_knowledge_base_template_uri(
knowledgeBaseId,
templateUri,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/templateUri",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("templateUri" => templateUri), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_quick_response(knowledge_base_id, quick_response_id)
update_quick_response(knowledge_base_id, quick_response_id, params::Dict{String,<:Any})
Updates an existing Wisdom quick response.
# Arguments
- `knowledge_base_id`: The identifier of the knowledge base. This should not be a
QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be
either the ID or the ARN. URLs cannot contain the ARN.
- `quick_response_id`: The identifier of the quick response.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"channels"`: The Amazon Connect contact channels this quick response applies to. The
supported contact channel types include Chat.
- `"content"`: The updated content of the quick response.
- `"contentType"`: The media type of the quick response content. Use
application/x.quickresponse;format=plain for quick response written in plain text. Use
application/x.quickresponse;format=markdown for quick response written in richtext.
- `"description"`: The updated description of the quick response.
- `"groupingConfiguration"`: The updated grouping configuration of the quick response.
- `"isActive"`: Whether the quick response is active.
- `"language"`: The language code value for the language in which the quick response is
written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT,
ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
- `"name"`: The name of the quick response.
- `"removeDescription"`: Whether to remove the description from the quick response.
- `"removeGroupingConfiguration"`: Whether to remove the grouping configuration of the
quick response.
- `"removeShortcutKey"`: Whether to remove the shortcut key of the quick response.
- `"shortcutKey"`: The shortcut key of the quick response. The value should be unique
across the knowledge base.
"""
function update_quick_response(
knowledgeBaseId, quickResponseId; aws_config::AbstractAWSConfig=global_aws_config()
)
return wisdom(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/quickResponses/$(quickResponseId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_quick_response(
knowledgeBaseId,
quickResponseId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return wisdom(
"POST",
"/knowledgeBases/$(knowledgeBaseId)/quickResponses/$(quickResponseId)",
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 | 63234 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: workdocs
using AWS.Compat
using AWS.UUIDs
"""
abort_document_version_upload(document_id, version_id)
abort_document_version_upload(document_id, version_id, params::Dict{String,<:Any})
Aborts the upload of the specified document version that was previously initiated by
InitiateDocumentVersionUpload. The client should make this call only when it no longer
intends to upload the document version, or fails to do so.
# Arguments
- `document_id`: The ID of the document.
- `version_id`: The ID of the version.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
"""
function abort_document_version_upload(
DocumentId, VersionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return workdocs(
"DELETE",
"/api/v1/documents/$(DocumentId)/versions/$(VersionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function abort_document_version_upload(
DocumentId,
VersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"DELETE",
"/api/v1/documents/$(DocumentId)/versions/$(VersionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
activate_user(user_id)
activate_user(user_id, params::Dict{String,<:Any})
Activates the specified user. Only active users can access Amazon WorkDocs.
# Arguments
- `user_id`: The ID of the user.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
"""
function activate_user(UserId; aws_config::AbstractAWSConfig=global_aws_config())
return workdocs(
"POST",
"/api/v1/users/$(UserId)/activation";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function activate_user(
UserId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return workdocs(
"POST",
"/api/v1/users/$(UserId)/activation",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_resource_permissions(principals, resource_id)
add_resource_permissions(principals, resource_id, params::Dict{String,<:Any})
Creates a set of permissions for the specified folder or document. The resource permissions
are overwritten if the principals already have different permissions.
# Arguments
- `principals`: The users, groups, or organization being granted permission.
- `resource_id`: The ID of the resource.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
- `"NotificationOptions"`: The notification options.
"""
function add_resource_permissions(
Principals, ResourceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return workdocs(
"POST",
"/api/v1/resources/$(ResourceId)/permissions",
Dict{String,Any}("Principals" => Principals);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_resource_permissions(
Principals,
ResourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"POST",
"/api/v1/resources/$(ResourceId)/permissions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Principals" => Principals), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_comment(document_id, text, version_id)
create_comment(document_id, text, version_id, params::Dict{String,<:Any})
Adds a new comment to the specified document version.
# Arguments
- `document_id`: The ID of the document.
- `text`: The text of the comment.
- `version_id`: The ID of the document version.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
- `"NotifyCollaborators"`: Set this parameter to TRUE to send an email out to the document
collaborators after the comment is created.
- `"ParentId"`: The ID of the parent comment.
- `"ThreadId"`: The ID of the root comment in the thread.
- `"Visibility"`: The visibility of the comment. Options are either PRIVATE, where the
comment is visible only to the comment author and document owner and co-owners, or PUBLIC,
where the comment is visible to document owners, co-owners, and contributors.
"""
function create_comment(
DocumentId, Text, VersionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return workdocs(
"POST",
"/api/v1/documents/$(DocumentId)/versions/$(VersionId)/comment",
Dict{String,Any}("Text" => Text);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_comment(
DocumentId,
Text,
VersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"POST",
"/api/v1/documents/$(DocumentId)/versions/$(VersionId)/comment",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Text" => Text), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_custom_metadata(custom_metadata, resource_id)
create_custom_metadata(custom_metadata, resource_id, params::Dict{String,<:Any})
Adds one or more custom properties to the specified resource (a folder, document, or
version).
# Arguments
- `custom_metadata`: Custom metadata in the form of name-value pairs.
- `resource_id`: The ID of the resource.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
- `"versionid"`: The ID of the version, if the custom metadata is being added to a document
version.
"""
function create_custom_metadata(
CustomMetadata, ResourceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return workdocs(
"PUT",
"/api/v1/resources/$(ResourceId)/customMetadata",
Dict{String,Any}("CustomMetadata" => CustomMetadata);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_custom_metadata(
CustomMetadata,
ResourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"PUT",
"/api/v1/resources/$(ResourceId)/customMetadata",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("CustomMetadata" => CustomMetadata), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_folder(parent_folder_id)
create_folder(parent_folder_id, params::Dict{String,<:Any})
Creates a folder with the specified name and parent folder.
# Arguments
- `parent_folder_id`: The ID of the parent folder.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
- `"Name"`: The name of the new folder.
"""
function create_folder(ParentFolderId; aws_config::AbstractAWSConfig=global_aws_config())
return workdocs(
"POST",
"/api/v1/folders",
Dict{String,Any}("ParentFolderId" => ParentFolderId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_folder(
ParentFolderId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"POST",
"/api/v1/folders",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ParentFolderId" => ParentFolderId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_labels(labels, resource_id)
create_labels(labels, resource_id, params::Dict{String,<:Any})
Adds the specified list of labels to the given resource (a document or folder)
# Arguments
- `labels`: List of labels to add to the resource.
- `resource_id`: The ID of the resource.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
"""
function create_labels(
Labels, ResourceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return workdocs(
"PUT",
"/api/v1/resources/$(ResourceId)/labels",
Dict{String,Any}("Labels" => Labels);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_labels(
Labels,
ResourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"PUT",
"/api/v1/resources/$(ResourceId)/labels",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Labels" => Labels), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_notification_subscription(endpoint, organization_id, protocol, subscription_type)
create_notification_subscription(endpoint, organization_id, protocol, subscription_type, params::Dict{String,<:Any})
Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a
confirmation message, and must confirm the subscription. For more information, see Setting
up notifications for an IAM user or role in the Amazon WorkDocs Developer Guide.
# Arguments
- `endpoint`: The endpoint to receive the notifications. If the protocol is HTTPS, the
endpoint is a URL that begins with https.
- `organization_id`: The ID of the organization.
- `protocol`: The protocol to use. The supported value is https, which delivers
JSON-encoded messages using HTTPS POST.
- `subscription_type`: The notification type.
"""
function create_notification_subscription(
Endpoint,
OrganizationId,
Protocol,
SubscriptionType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"POST",
"/api/v1/organizations/$(OrganizationId)/subscriptions",
Dict{String,Any}(
"Endpoint" => Endpoint,
"Protocol" => Protocol,
"SubscriptionType" => SubscriptionType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_notification_subscription(
Endpoint,
OrganizationId,
Protocol,
SubscriptionType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"POST",
"/api/v1/organizations/$(OrganizationId)/subscriptions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Endpoint" => Endpoint,
"Protocol" => Protocol,
"SubscriptionType" => SubscriptionType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_user(given_name, password, surname, username)
create_user(given_name, password, surname, username, params::Dict{String,<:Any})
Creates a user in a Simple AD or Microsoft AD directory. The status of a newly created user
is \"ACTIVE\". New users can access Amazon WorkDocs.
# Arguments
- `given_name`: The given name of the user.
- `password`: The password of the user.
- `surname`: The surname of the user.
- `username`: The login name of the user.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
- `"EmailAddress"`: The email address of the user.
- `"OrganizationId"`: The ID of the organization.
- `"StorageRule"`: The amount of storage for the user.
- `"TimeZoneId"`: The time zone ID of the user.
"""
function create_user(
GivenName,
Password,
Surname,
Username;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"POST",
"/api/v1/users",
Dict{String,Any}(
"GivenName" => GivenName,
"Password" => Password,
"Surname" => Surname,
"Username" => Username,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_user(
GivenName,
Password,
Surname,
Username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"POST",
"/api/v1/users",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GivenName" => GivenName,
"Password" => Password,
"Surname" => Surname,
"Username" => Username,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deactivate_user(user_id)
deactivate_user(user_id, params::Dict{String,<:Any})
Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.
# Arguments
- `user_id`: The ID of the user.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
"""
function deactivate_user(UserId; aws_config::AbstractAWSConfig=global_aws_config())
return workdocs(
"DELETE",
"/api/v1/users/$(UserId)/activation";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deactivate_user(
UserId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return workdocs(
"DELETE",
"/api/v1/users/$(UserId)/activation",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_comment(comment_id, document_id, version_id)
delete_comment(comment_id, document_id, version_id, params::Dict{String,<:Any})
Deletes the specified comment from the document version.
# Arguments
- `comment_id`: The ID of the comment.
- `document_id`: The ID of the document.
- `version_id`: The ID of the document version.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
"""
function delete_comment(
CommentId, DocumentId, VersionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return workdocs(
"DELETE",
"/api/v1/documents/$(DocumentId)/versions/$(VersionId)/comment/$(CommentId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_comment(
CommentId,
DocumentId,
VersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"DELETE",
"/api/v1/documents/$(DocumentId)/versions/$(VersionId)/comment/$(CommentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_custom_metadata(resource_id)
delete_custom_metadata(resource_id, params::Dict{String,<:Any})
Deletes custom metadata from the specified resource.
# Arguments
- `resource_id`: The ID of the resource, either a document or folder.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
- `"deleteAll"`: Flag to indicate removal of all custom metadata properties from the
specified resource.
- `"keys"`: List of properties to remove.
- `"versionId"`: The ID of the version, if the custom metadata is being deleted from a
document version.
"""
function delete_custom_metadata(
ResourceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return workdocs(
"DELETE",
"/api/v1/resources/$(ResourceId)/customMetadata";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_custom_metadata(
ResourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"DELETE",
"/api/v1/resources/$(ResourceId)/customMetadata",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_document(document_id)
delete_document(document_id, params::Dict{String,<:Any})
Permanently deletes the specified document and its associated metadata.
# Arguments
- `document_id`: The ID of the document.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
"""
function delete_document(DocumentId; aws_config::AbstractAWSConfig=global_aws_config())
return workdocs(
"DELETE",
"/api/v1/documents/$(DocumentId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_document(
DocumentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"DELETE",
"/api/v1/documents/$(DocumentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_document_version(document_id, version_id, delete_prior_versions)
delete_document_version(document_id, version_id, delete_prior_versions, params::Dict{String,<:Any})
Deletes a specific version of a document.
# Arguments
- `document_id`: The ID of the document associated with the version being deleted.
- `version_id`: The ID of the version being deleted.
- `delete_prior_versions`: Deletes all versions of a document prior to the current version.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
"""
function delete_document_version(
DocumentId,
VersionId,
deletePriorVersions;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"DELETE",
"/api/v1/documentVersions/$(DocumentId)/versions/$(VersionId)",
Dict{String,Any}("deletePriorVersions" => deletePriorVersions);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_document_version(
DocumentId,
VersionId,
deletePriorVersions,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"DELETE",
"/api/v1/documentVersions/$(DocumentId)/versions/$(VersionId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("deletePriorVersions" => deletePriorVersions),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_folder(folder_id)
delete_folder(folder_id, params::Dict{String,<:Any})
Permanently deletes the specified folder and its contents.
# Arguments
- `folder_id`: The ID of the folder.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
"""
function delete_folder(FolderId; aws_config::AbstractAWSConfig=global_aws_config())
return workdocs(
"DELETE",
"/api/v1/folders/$(FolderId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_folder(
FolderId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"DELETE",
"/api/v1/folders/$(FolderId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_folder_contents(folder_id)
delete_folder_contents(folder_id, params::Dict{String,<:Any})
Deletes the contents of the specified folder.
# Arguments
- `folder_id`: The ID of the folder.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
"""
function delete_folder_contents(FolderId; aws_config::AbstractAWSConfig=global_aws_config())
return workdocs(
"DELETE",
"/api/v1/folders/$(FolderId)/contents";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_folder_contents(
FolderId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"DELETE",
"/api/v1/folders/$(FolderId)/contents",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_labels(resource_id)
delete_labels(resource_id, params::Dict{String,<:Any})
Deletes the specified list of labels from a resource.
# Arguments
- `resource_id`: The ID of the resource.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
- `"deleteAll"`: Flag to request removal of all labels from the specified resource.
- `"labels"`: List of labels to delete from the resource.
"""
function delete_labels(ResourceId; aws_config::AbstractAWSConfig=global_aws_config())
return workdocs(
"DELETE",
"/api/v1/resources/$(ResourceId)/labels";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_labels(
ResourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"DELETE",
"/api/v1/resources/$(ResourceId)/labels",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_notification_subscription(organization_id, subscription_id)
delete_notification_subscription(organization_id, subscription_id, params::Dict{String,<:Any})
Deletes the specified subscription from the specified organization.
# Arguments
- `organization_id`: The ID of the organization.
- `subscription_id`: The ID of the subscription.
"""
function delete_notification_subscription(
OrganizationId, SubscriptionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return workdocs(
"DELETE",
"/api/v1/organizations/$(OrganizationId)/subscriptions/$(SubscriptionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_notification_subscription(
OrganizationId,
SubscriptionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"DELETE",
"/api/v1/organizations/$(OrganizationId)/subscriptions/$(SubscriptionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_user(user_id)
delete_user(user_id, params::Dict{String,<:Any})
Deletes the specified user from a Simple AD or Microsoft AD directory. Deleting a user
immediately and permanently deletes all content in that user's folder structure. Site
retention policies do NOT apply to this type of deletion.
# Arguments
- `user_id`: The ID of the user.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Do not set this field when
using administrative API actions, as in accessing the API using Amazon Web Services
credentials.
"""
function delete_user(UserId; aws_config::AbstractAWSConfig=global_aws_config())
return workdocs(
"DELETE",
"/api/v1/users/$(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 workdocs(
"DELETE",
"/api/v1/users/$(UserId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_activities()
describe_activities(params::Dict{String,<:Any})
Describes the user activities in a specified time period.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
- `"activityTypes"`: Specifies which activity types to include in the response. If this
field is left empty, all activity types are returned.
- `"endTime"`: The timestamp that determines the end time of the activities. The response
includes the activities performed before the specified timestamp.
- `"includeIndirectActivities"`: Includes indirect activities. An indirect activity results
from a direct activity performed on a parent resource. For example, sharing a parent folder
(the direct activity) shares all of the subfolders and documents within the parent folder
(the indirect activity).
- `"limit"`: The maximum number of items to return.
- `"marker"`: The marker for the next set of results.
- `"organizationId"`: The ID of the organization. This is a mandatory parameter when using
administrative API (SigV4) requests.
- `"resourceId"`: The document or folder ID for which to describe activity types.
- `"startTime"`: The timestamp that determines the starting time of the activities. The
response includes the activities performed after the specified timestamp.
- `"userId"`: The ID of the user who performed the action. The response includes activities
pertaining to this user. This is an optional parameter and is only applicable for
administrative API (SigV4) requests.
"""
function describe_activities(; aws_config::AbstractAWSConfig=global_aws_config())
return workdocs(
"GET", "/api/v1/activities"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_activities(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return workdocs(
"GET",
"/api/v1/activities",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_comments(document_id, version_id)
describe_comments(document_id, version_id, params::Dict{String,<:Any})
List all the comments for the specified document version.
# Arguments
- `document_id`: The ID of the document.
- `version_id`: The ID of the document version.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
- `"limit"`: The maximum number of items to return.
- `"marker"`: The marker for the next set of results. This marker was received from a
previous call.
"""
function describe_comments(
DocumentId, VersionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return workdocs(
"GET",
"/api/v1/documents/$(DocumentId)/versions/$(VersionId)/comments";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_comments(
DocumentId,
VersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"GET",
"/api/v1/documents/$(DocumentId)/versions/$(VersionId)/comments",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_document_versions(document_id)
describe_document_versions(document_id, params::Dict{String,<:Any})
Retrieves the document versions for the specified document. By default, only active
versions are returned.
# Arguments
- `document_id`: The ID of the document.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
- `"fields"`: Specify \"SOURCE\" to include initialized versions and a URL for the source
document.
- `"include"`: A comma-separated list of values. Specify \"INITIALIZED\" to include
incomplete versions.
- `"limit"`: The maximum number of versions to return with this call.
- `"marker"`: The marker for the next set of results. (You received this marker from a
previous call.)
"""
function describe_document_versions(
DocumentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return workdocs(
"GET",
"/api/v1/documents/$(DocumentId)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_document_versions(
DocumentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"GET",
"/api/v1/documents/$(DocumentId)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_folder_contents(folder_id)
describe_folder_contents(folder_id, params::Dict{String,<:Any})
Describes the contents of the specified folder, including its documents and subfolders. By
default, Amazon WorkDocs returns the first 100 active document and folder metadata items.
If there are more results, the response includes a marker that you can use to request the
next set of results. You can also request initialized documents.
# Arguments
- `folder_id`: The ID of the folder.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
- `"include"`: The contents to include. Specify \"INITIALIZED\" to include initialized
documents.
- `"limit"`: The maximum number of items to return with this call.
- `"marker"`: The marker for the next set of results. This marker was received from a
previous call.
- `"order"`: The order for the contents of the folder.
- `"sort"`: The sorting criteria.
- `"type"`: The type of items.
"""
function describe_folder_contents(
FolderId; aws_config::AbstractAWSConfig=global_aws_config()
)
return workdocs(
"GET",
"/api/v1/folders/$(FolderId)/contents";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_folder_contents(
FolderId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"GET",
"/api/v1/folders/$(FolderId)/contents",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_groups(search_query)
describe_groups(search_query, params::Dict{String,<:Any})
Describes the groups specified by the query. Groups are defined by the underlying Active
Directory.
# Arguments
- `search_query`: A query to describe groups by group name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
- `"limit"`: The maximum number of items to return with this call.
- `"marker"`: The marker for the next set of results. (You received this marker from a
previous call.)
- `"organizationId"`: The ID of the organization.
"""
function describe_groups(searchQuery; aws_config::AbstractAWSConfig=global_aws_config())
return workdocs(
"GET",
"/api/v1/groups",
Dict{String,Any}("searchQuery" => searchQuery);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_groups(
searchQuery,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"GET",
"/api/v1/groups",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("searchQuery" => searchQuery), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_notification_subscriptions(organization_id)
describe_notification_subscriptions(organization_id, params::Dict{String,<:Any})
Lists the specified notification subscriptions.
# Arguments
- `organization_id`: The ID of the organization.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"limit"`: The maximum number of items to return with this call.
- `"marker"`: The marker for the next set of results. (You received this marker from a
previous call.)
"""
function describe_notification_subscriptions(
OrganizationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return workdocs(
"GET",
"/api/v1/organizations/$(OrganizationId)/subscriptions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_notification_subscriptions(
OrganizationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"GET",
"/api/v1/organizations/$(OrganizationId)/subscriptions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_resource_permissions(resource_id)
describe_resource_permissions(resource_id, params::Dict{String,<:Any})
Describes the permissions of a specified resource.
# Arguments
- `resource_id`: The ID of the resource.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
- `"limit"`: The maximum number of items to return with this call.
- `"marker"`: The marker for the next set of results. (You received this marker from a
previous call)
- `"principalId"`: The ID of the principal to filter permissions by.
"""
function describe_resource_permissions(
ResourceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return workdocs(
"GET",
"/api/v1/resources/$(ResourceId)/permissions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_resource_permissions(
ResourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"GET",
"/api/v1/resources/$(ResourceId)/permissions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_root_folders(authentication)
describe_root_folders(authentication, params::Dict{String,<:Any})
Describes the current user's special folders; the RootFolder and the RecycleBin. RootFolder
is the root of user's files and folders and RecycleBin is the root of recycled items. This
is not a valid action for SigV4 (administrative API) clients. This action requires an
authentication token. To get an authentication token, register an application with Amazon
WorkDocs. For more information, see Authentication and Access Control for User Applications
in the Amazon WorkDocs Developer Guide.
# Arguments
- `authentication`: Amazon WorkDocs authentication token.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"limit"`: The maximum number of items to return.
- `"marker"`: The marker for the next set of results. (You received this marker from a
previous call.)
"""
function describe_root_folders(
Authentication; aws_config::AbstractAWSConfig=global_aws_config()
)
return workdocs(
"GET",
"/api/v1/me/root",
Dict{String,Any}("headers" => Dict{String,Any}("Authentication" => Authentication));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_root_folders(
Authentication,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"GET",
"/api/v1/me/root",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("Authentication" => Authentication)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_users()
describe_users(params::Dict{String,<:Any})
Describes the specified users. You can describe all users or filter the results (for
example, by status or organization). By default, Amazon WorkDocs returns the first 24
active or pending users. If there are more results, the response includes a marker that you
can use to request the next set of results.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
- `"fields"`: A comma-separated list of values. Specify \"STORAGE_METADATA\" to include the
user storage quota and utilization information.
- `"include"`: The state of the users. Specify \"ALL\" to include inactive users.
- `"limit"`: The maximum number of items to return.
- `"marker"`: The marker for the next set of results. (You received this marker from a
previous call.)
- `"order"`: The order for the results.
- `"organizationId"`: The ID of the organization.
- `"query"`: A query to filter users by user name. Remember the following about the Userids
and Query parameters: If you don't use either parameter, the API returns a paginated list
of all users on the site. If you use both parameters, the API ignores the Query
parameter. The Userid parameter only returns user names that match a corresponding user
ID. The Query parameter runs a \"prefix\" search for users by the GivenName, SurName, or
UserName fields included in a CreateUser API call. For example, querying on Ma returns
Márcia Oliveira, María García, and Mateo Jackson. If you use multiple characters, the
API only returns data that matches all characters. For example, querying on Ma J only
returns Mateo Jackson.
- `"sort"`: The sorting criteria.
- `"userIds"`: The IDs of the users.
"""
function describe_users(; aws_config::AbstractAWSConfig=global_aws_config())
return workdocs(
"GET", "/api/v1/users"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_users(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return workdocs(
"GET",
"/api/v1/users",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_current_user(authentication)
get_current_user(authentication, params::Dict{String,<:Any})
Retrieves details of the current user for whom the authentication token was generated. This
is not a valid action for SigV4 (administrative API) clients. This action requires an
authentication token. To get an authentication token, register an application with Amazon
WorkDocs. For more information, see Authentication and Access Control for User Applications
in the Amazon WorkDocs Developer Guide.
# Arguments
- `authentication`: Amazon WorkDocs authentication token.
"""
function get_current_user(Authentication; aws_config::AbstractAWSConfig=global_aws_config())
return workdocs(
"GET",
"/api/v1/me",
Dict{String,Any}("headers" => Dict{String,Any}("Authentication" => Authentication));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_current_user(
Authentication,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"GET",
"/api/v1/me",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("Authentication" => Authentication)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_document(document_id)
get_document(document_id, params::Dict{String,<:Any})
Retrieves details of a document.
# Arguments
- `document_id`: The ID of the document.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
- `"includeCustomMetadata"`: Set this to TRUE to include custom metadata in the response.
"""
function get_document(DocumentId; aws_config::AbstractAWSConfig=global_aws_config())
return workdocs(
"GET",
"/api/v1/documents/$(DocumentId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_document(
DocumentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"GET",
"/api/v1/documents/$(DocumentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_document_path(document_id)
get_document_path(document_id, params::Dict{String,<:Any})
Retrieves the path information (the hierarchy from the root folder) for the requested
document. By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the
requested document and only includes the IDs of the parent folders in the path. You can
limit the maximum number of levels. You can also request the names of the parent folders.
# Arguments
- `document_id`: The ID of the document.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
- `"fields"`: A comma-separated list of values. Specify NAME to include the names of the
parent folders.
- `"limit"`: The maximum number of levels in the hierarchy to return.
- `"marker"`: This value is not supported.
"""
function get_document_path(DocumentId; aws_config::AbstractAWSConfig=global_aws_config())
return workdocs(
"GET",
"/api/v1/documents/$(DocumentId)/path";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_document_path(
DocumentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"GET",
"/api/v1/documents/$(DocumentId)/path",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_document_version(document_id, version_id)
get_document_version(document_id, version_id, params::Dict{String,<:Any})
Retrieves version metadata for the specified document.
# Arguments
- `document_id`: The ID of the document.
- `version_id`: The version ID of the document.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
- `"fields"`: A comma-separated list of values. Specify \"SOURCE\" to include a URL for the
source document.
- `"includeCustomMetadata"`: Set this to TRUE to include custom metadata in the response.
"""
function get_document_version(
DocumentId, VersionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return workdocs(
"GET",
"/api/v1/documents/$(DocumentId)/versions/$(VersionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_document_version(
DocumentId,
VersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"GET",
"/api/v1/documents/$(DocumentId)/versions/$(VersionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_folder(folder_id)
get_folder(folder_id, params::Dict{String,<:Any})
Retrieves the metadata of the specified folder.
# Arguments
- `folder_id`: The ID of the folder.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
- `"includeCustomMetadata"`: Set to TRUE to include custom metadata in the response.
"""
function get_folder(FolderId; aws_config::AbstractAWSConfig=global_aws_config())
return workdocs(
"GET",
"/api/v1/folders/$(FolderId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_folder(
FolderId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"GET",
"/api/v1/folders/$(FolderId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_folder_path(folder_id)
get_folder_path(folder_id, params::Dict{String,<:Any})
Retrieves the path information (the hierarchy from the root folder) for the specified
folder. By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the
requested folder and only includes the IDs of the parent folders in the path. You can limit
the maximum number of levels. You can also request the parent folder names.
# Arguments
- `folder_id`: The ID of the folder.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
- `"fields"`: A comma-separated list of values. Specify \"NAME\" to include the names of
the parent folders.
- `"limit"`: The maximum number of levels in the hierarchy to return.
- `"marker"`: This value is not supported.
"""
function get_folder_path(FolderId; aws_config::AbstractAWSConfig=global_aws_config())
return workdocs(
"GET",
"/api/v1/folders/$(FolderId)/path";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_folder_path(
FolderId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"GET",
"/api/v1/folders/$(FolderId)/path",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resources()
get_resources(params::Dict{String,<:Any})
Retrieves a collection of resources, including folders and documents. The only
CollectionType supported is SHARED_WITH_ME.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: The Amazon WorkDocs authentication token. Not required when using
Amazon Web Services administrator credentials to access the API.
- `"collectionType"`: The collection type.
- `"limit"`: The maximum number of resources to return.
- `"marker"`: The marker for the next set of results. This marker was received from a
previous call.
- `"userId"`: The user ID for the resource collection. This is a required field for
accessing the API operation using IAM credentials.
"""
function get_resources(; aws_config::AbstractAWSConfig=global_aws_config())
return workdocs(
"GET", "/api/v1/resources"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_resources(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return workdocs(
"GET",
"/api/v1/resources",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
initiate_document_version_upload()
initiate_document_version_upload(params::Dict{String,<:Any})
Creates a new document object and version object. The client specifies the parent folder ID
and name of the document to upload. The ID is optionally specified when creating a new
version of an existing document. This is the first step to upload a document. Next, upload
the document to the URL returned from the call, and then call UpdateDocumentVersion. To
cancel the document upload, call AbortDocumentVersionUpload.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
- `"ContentCreatedTimestamp"`: The timestamp when the content of the document was
originally created.
- `"ContentModifiedTimestamp"`: The timestamp when the content of the document was modified.
- `"ContentType"`: The content type of the document.
- `"DocumentSizeInBytes"`: The size of the document, in bytes.
- `"Id"`: The ID of the document.
- `"Name"`: The name of the document.
- `"ParentFolderId"`: The ID of the parent folder.
"""
function initiate_document_version_upload(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return workdocs(
"POST", "/api/v1/documents"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function initiate_document_version_upload(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return workdocs(
"POST",
"/api/v1/documents",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_all_resource_permissions(resource_id)
remove_all_resource_permissions(resource_id, params::Dict{String,<:Any})
Removes all the permissions from the specified resource.
# Arguments
- `resource_id`: The ID of the resource.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
"""
function remove_all_resource_permissions(
ResourceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return workdocs(
"DELETE",
"/api/v1/resources/$(ResourceId)/permissions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_all_resource_permissions(
ResourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"DELETE",
"/api/v1/resources/$(ResourceId)/permissions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_resource_permission(principal_id, resource_id)
remove_resource_permission(principal_id, resource_id, params::Dict{String,<:Any})
Removes the permission for the specified principal from the specified resource.
# Arguments
- `principal_id`: The principal ID of the resource.
- `resource_id`: The ID of the resource.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
- `"type"`: The principal type of the resource.
"""
function remove_resource_permission(
PrincipalId, ResourceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return workdocs(
"DELETE",
"/api/v1/resources/$(ResourceId)/permissions/$(PrincipalId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_resource_permission(
PrincipalId,
ResourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"DELETE",
"/api/v1/resources/$(ResourceId)/permissions/$(PrincipalId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restore_document_versions(document_id)
restore_document_versions(document_id, params::Dict{String,<:Any})
Recovers a deleted version of an Amazon WorkDocs document.
# Arguments
- `document_id`: The ID of the document.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
"""
function restore_document_versions(
DocumentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return workdocs(
"POST",
"/api/v1/documentVersions/restore/$(DocumentId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function restore_document_versions(
DocumentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"POST",
"/api/v1/documentVersions/restore/$(DocumentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_resources()
search_resources(params::Dict{String,<:Any})
Searches metadata and the content of folders, documents, document versions, and comments.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AdditionalResponseFields"`: A list of attributes to include in the response. Used to
request fields that are not normally returned in a standard response.
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
- `"Filters"`: Filters results based on entity metadata.
- `"Limit"`: Max results count per page.
- `"Marker"`: The marker for the next set of results.
- `"OrderBy"`: Order by results in one or more categories.
- `"OrganizationId"`: Filters based on the resource owner OrgId. This is a mandatory
parameter when using Admin SigV4 credentials.
- `"QueryScopes"`: Filter based on the text field type. A Folder has only a name and no
content. A Comment has only content and no name. A Document or Document Version has a name
and content
- `"QueryText"`: The String to search for. Searches across different text fields based on
request parameters. Use double quotes around the query string for exact phrase matches.
"""
function search_resources(; aws_config::AbstractAWSConfig=global_aws_config())
return workdocs(
"POST", "/api/v1/search"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function search_resources(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return workdocs(
"POST",
"/api/v1/search",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_document(document_id)
update_document(document_id, params::Dict{String,<:Any})
Updates the specified attributes of a document. The user must have access to both the
document and its parent folder, if applicable.
# Arguments
- `document_id`: The ID of the document.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
- `"Name"`: The name of the document.
- `"ParentFolderId"`: The ID of the parent folder.
- `"ResourceState"`: The resource state of the document. Only ACTIVE and RECYCLED are
supported.
"""
function update_document(DocumentId; aws_config::AbstractAWSConfig=global_aws_config())
return workdocs(
"PATCH",
"/api/v1/documents/$(DocumentId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_document(
DocumentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"PATCH",
"/api/v1/documents/$(DocumentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_document_version(document_id, version_id)
update_document_version(document_id, version_id, params::Dict{String,<:Any})
Changes the status of the document version to ACTIVE. Amazon WorkDocs also sets its
document container to ACTIVE. This is the last step in a document upload, after the client
uploads the document to an S3-presigned URL returned by InitiateDocumentVersionUpload.
# Arguments
- `document_id`: The ID of the document.
- `version_id`: The version ID of the document.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
- `"VersionStatus"`: The status of the version.
"""
function update_document_version(
DocumentId, VersionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return workdocs(
"PATCH",
"/api/v1/documents/$(DocumentId)/versions/$(VersionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_document_version(
DocumentId,
VersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"PATCH",
"/api/v1/documents/$(DocumentId)/versions/$(VersionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_folder(folder_id)
update_folder(folder_id, params::Dict{String,<:Any})
Updates the specified attributes of the specified folder. The user must have access to both
the folder and its parent folder, if applicable.
# Arguments
- `folder_id`: The ID of the folder.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
- `"Name"`: The name of the folder.
- `"ParentFolderId"`: The ID of the parent folder.
- `"ResourceState"`: The resource state of the folder. Only ACTIVE and RECYCLED are
accepted values from the API.
"""
function update_folder(FolderId; aws_config::AbstractAWSConfig=global_aws_config())
return workdocs(
"PATCH",
"/api/v1/folders/$(FolderId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_folder(
FolderId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return workdocs(
"PATCH",
"/api/v1/folders/$(FolderId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_user(user_id)
update_user(user_id, params::Dict{String,<:Any})
Updates the specified attributes of the specified user, and grants or revokes
administrative privileges to the Amazon WorkDocs site.
# Arguments
- `user_id`: The ID of the user.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Authentication"`: Amazon WorkDocs authentication token. Not required when using Amazon
Web Services administrator credentials to access the API.
- `"GivenName"`: The given name of the user.
- `"GrantPoweruserPrivileges"`: Boolean value to determine whether the user is granted
Power user privileges.
- `"Locale"`: The locale of the user.
- `"StorageRule"`: The amount of storage for the user.
- `"Surname"`: The surname of the user.
- `"TimeZoneId"`: The time zone ID of the user.
- `"Type"`: The type of the user.
"""
function update_user(UserId; aws_config::AbstractAWSConfig=global_aws_config())
return workdocs(
"PATCH",
"/api/v1/users/$(UserId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_user(
UserId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return workdocs(
"PATCH",
"/api/v1/users/$(UserId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
Subsets and Splits
No saved queries yet
Save your SQL queries to embed, download, and access them later. Queries will appear here once saved.