Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

PutProfileVisibility

Sets the visibility level for a partner profile, controlling who can view the profile information.

Request Syntax


{
   "Catalog": "string",
   "Identifier": "string",
   "Visibility": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

Catalog

The catalog identifier for the partner account.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9-]+

Required: Yes

Identifier

The unique identifier of the partner account.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: (partner-[A-Za-z0-9]{13}|arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[A-Za-z-_]+/partner/partner-[A-Za-z0-9]{13})

Required: Yes

Visibility

The visibility setting to apply to the partner profile.

Type: String

Valid Values: PRIVATE | PUBLIC

Required: Yes

Response Syntax


{
   "Arn": "string",
   "Catalog": "string",
   "Id": "string",
   "ProfileId": "string",
   "Visibility": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Arn

The Amazon Resource Name (ARN) of the partner account.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[A-Za-z-_]+/partner/partner-[A-Za-z0-9]{13}

Catalog

The catalog identifier for the partner account.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9-]+

Id

The unique identifier of the partner account.

Type: String

Pattern: partner-[A-Za-z0-9]{13}

ProfileId

The unique identifier of the partner profile.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

Pattern: pprofile-[A-Za-z0-9]{13}

Visibility

The updated visibility setting for the partner profile.

Type: String

Valid Values: PRIVATE | PUBLIC

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.

Reason: The specific reason for the access denial.

HTTP Status Code: 400

InternalServerException

An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.

Reason: The specific reason why the resource was not found.

HTTP Status Code: 400

ThrottlingException

The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.

QuotaCode: The quota code associated with the throttling error.
ServiceCode: The service code associated with the throttling error.

HTTP Status Code: 400

ValidationException

The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.

ErrorDetails: A list of detailed validation errors that occurred during request processing.
Reason: The reason for the validation failure.

HTTP Status Code: 400