setDataRetrievalPolicy method

Future<void> setDataRetrievalPolicy({ required String accountId, DataRetrievalPolicy? policy, })

This operation sets and then enacts a data retrieval policy in the region specified in the PUT request. You can set one policy per region for an AWS account. The policy is enacted within a few minutes of a successful PUT operation.

The set policy operation does not affect retrieval jobs that were in progress before the policy was enacted. For more information about data retrieval policies, see Amazon Glacier Data Retrieval Policies.

May throw InvalidParameterValueException. May throw MissingParameterValueException. May throw ServiceUnavailableException.

Parameter accountId : The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID.

Parameter policy : The data retrieval policy in JSON format.

Implementation

Future<void> setDataRetrievalPolicy({
  required String accountId,
  DataRetrievalPolicy? policy,
}) async {
  ArgumentError.checkNotNull(accountId, 'accountId');
  final $payload = <String, dynamic>{
    if (policy != null) 'Policy': policy,
  };
  await _protocol.send(
    payload: $payload,
    method: 'PUT',
    requestUri: '/${Uri.encodeComponent(accountId)}/policies/data-retrieval',
    exceptionFnMap: _exceptionFns,
  );
}