Updates the currently set system settings, which include the IAM Role used for resource snapshot jobs.
Parameters:
-
catalog
(CatalogIdentifier)
–
Specifies the catalog in which the settings will be updated. Acceptable values include AWS for production and Sandbox for testing environments.
-
resource_snapshot_job_role_identifier
(Optional[ResourceSnapshotJobRoleIdentifier], default:
None
)
–
Specifies the ARN of the IAM Role used for resource snapshot job executions.
Raises:
-
AccessDeniedException
–
This error occurs when you don't have permission to perform the requested action.
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.
-
InternalServerException
–
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.
-
ResourceNotFoundException
–
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.
-
ThrottlingException
–
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.
This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.
-
ValidationException
–
The input fails to satisfy the constraints specified by the service or business validation rules.
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_partnercentral_selling/_services/async_partner_central_selling.py
| async def put_selling_system_settings(
self,
catalog: "capo_partnercentral_selling.types.catalog_identifier.CatalogIdentifier",
*,
config_overrides: Optional[AsyncPartnerCentralSellingClientConfig] = None,
resource_snapshot_job_role_identifier: Optional[
"capo_partnercentral_selling.types.resource_snapshot_job_role_identifier.ResourceSnapshotJobRoleIdentifier"
] = None,
) -> "capo_partnercentral_selling.types.put_selling_system_settings_response.PutSellingSystemSettingsResponse":
"""<p>Updates the currently set system settings, which include the IAM Role used for resource snapshot jobs.</p>
Args:
catalog: <p>Specifies the catalog in which the settings will be updated. Acceptable values include <code>AWS</code> for production and <code>Sandbox</code> for testing environments.</p>
resource_snapshot_job_role_identifier: <p>Specifies the ARN of the IAM Role used for resource snapshot job executions.</p>
Raises:
capo_partnercentral_selling.errors.access_denied_exception.AccessDeniedException: <p>This error occurs when you don't have permission to perform the requested action.</p> <p>You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.</p>
capo_partnercentral_selling.errors.internal_server_exception.InternalServerException: <p>This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.</p> <p>Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.</p>
capo_partnercentral_selling.errors.resource_not_found_exception.ResourceNotFoundException: <p>This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.</p> <p>Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.</p>
capo_partnercentral_selling.errors.throttling_exception.ThrottlingException: <p>This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.</p> <p>This error occurs when there are too many requests sent. Review the provided <a href="https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html">Quotas</a> and retry after the provided delay.</p>
capo_partnercentral_selling.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the service or business validation rules.</p> <p>Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.</p>
capo_partnercentral_selling.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_partnercentral_selling.types.put_selling_system_settings_request.PutSellingSystemSettingsRequest]",
) -> AsyncOperationResponse[
"capo_partnercentral_selling.types.put_selling_system_settings_response.PutSellingSystemSettingsResponse"
]:
import capo_partnercentral_selling._operations.aws_partner_central_selling.put_selling_system_settings
(
output,
http_response,
) = await capo_partnercentral_selling._operations.aws_partner_central_selling.put_selling_system_settings.async_put_selling_system_settings(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("PutSellingSystemSettings")
)
input_: capo_partnercentral_selling.types.put_selling_system_settings_request.PutSellingSystemSettingsRequest = {
"catalog": catalog
}
if resource_snapshot_job_role_identifier is not None:
input_["resource_snapshot_job_role_identifier"] = (
resource_snapshot_job_role_identifier
)
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|